RunSynchronizationJob - Identity as a Service: Central de Documentação do Alibaba Cloud

Executa uma tarefa de sincronização. Esta operação cria uma nova tarefa de sincronização e a executa imediatamente.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

eiam:RunSynchronizationJob

create

*SynchronizationJob.

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
TargetId	string	Sim	O ID do destino de sincronização.	idp_my664lwkhpicbyzirog3ngxxxxx
TargetType	string	Sim	O tipo de destino de sincronização. Valores válidos: identity_provider: provedor de identidade application: aplicativo	identity_provider
Description	string	Não	A descrição da tarefa de sincronização.	description_text
UserIdentityTypes	array	Não	A lista de identificadores exclusivos de usuário.
	string	Não	O identificador exclusivo de usuário. Valores válidos: phoneNumber : Número de telefone. externalId : ID externo. email : E-mail. username : Nome de usuário.	username
SynchronizationScopeConfig	object	Não	A configuração do escopo de sincronização.
OrganizationalUnitIds	array	Não	A lista de IDs de unidades organizacionais.
	string	Não	O ID da unidade organizacional.	ou_denmyslajnzh4f4hkuob5sxxxx
GroupIds	array	Não	A lista de IDs de grupo.
	string	Não	O ID do grupo.	group_hrgy65sk32ry4d7476bkexxxx
UserIds	array	Não	A lista de IDs de usuário.
	string	Não	O ID do usuário.	user_rgy65sk32ry4d747xxxx
PasswordInitialization	boolean	Não	Especifica se a senha deve ser inicializada.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
SynchronizationJobId	string	O ID da tarefa de sincronização.	sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "SynchronizationJobId": "sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx\n"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	UnsupportedAction.IdentityProviderBeingLocked	The current identity source is locked, temporarily unable to operate.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.