GetUserProvisioning - CloudSSO: Central de Documentação do Alibaba Cloud

Consulta um provisionamento de usuário do Resource Access Management (RAM).

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

cloudsso:GetUserProvisioning

get

*UserProvisioning

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user-provisioning/{#UserProvisioningId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DirectoryId	string	Sim	O ID do diretório de recursos.	d-003qew84****
UserProvisioningId	string	Sim	O ID do provisionamento de usuário RAM.	up-002axzhapcbz6e63****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os resultados retornados.
UserProvisioning	object	As informações sobre o provisionamento de usuário RAM.
Status	string	O status do provisionamento de usuário RAM. Valores válidos: Enabled Disabled	Enabled
Description	string	A descrição.	This is a user provisioning.
UserProvisioningId	string	O ID do provisionamento de usuário RAM.	up-002axzhapcbz6e63****
PrincipalId	string	O ID da identidade do provisionamento de usuário RAM. Valores válidos: Se `Group` for retornado para o parâmetro `PrincipalType`, o valor deste parâmetro é o ID de um grupo de usuários CloudSSO (g-******). Se `User` for retornado para o parâmetro `PrincipalType`, o valor deste parâmetro é o ID de um usuário CloudSSO (u-******).	g-02ha881d*****
TargetPath	string	O caminho do diretório de recursos no qual você cria o provisionamento de usuário RAM para o membro.	rd-****/root/test
UpdateTime	string	A hora de modificação.	2022-11-28T03:55:42Z
DuplicationStrategy	string	A política de tratamento de conflitos. A política é usada quando um usuário RAM tem o mesmo nome de usuário que o usuário CloudSSO sincronizado para o RAM. Valores válidos: KeepBoth: Quando um usuário CloudSSO é sincronizado para o RAM, se existir um usuário RAM com o mesmo nome de usuário que o usuário CloudSSO, o sistema cria um usuário RAM cujo nome de usuário é o nome de usuário do usuário CloudSSO acrescido do sufixo `_sso`. TakeOver: Quando um usuário CloudSSO é sincronizado para o RAM, se existir um usuário RAM com o mesmo nome de usuário que o usuário CloudSSO, o sistema substitui o usuário RAM pelo usuário CloudSSO.	KeepBoth
DeletionStrategy	string	A política de exclusão. A política é usada para gerenciar usuários sincronizados quando você exclui o provisionamento de usuário RAM. Valores válidos: Delete: Quando você exclui o provisionamento de usuário RAM, o sistema exclui os usuários sincronizados. Keep: Quando você exclui o provisionamento de usuário RAM, o sistema mantém os usuários sincronizados.	Delete
PrincipalName	string	O nome da identidade do provisionamento de usuário RAM. Valores válidos: Se `Group` for retornado para o parâmetro `PrincipalType`, o valor deste parâmetro é o nome de um grupo de usuários CloudSSO. Se `User` for retornado para o parâmetro `PrincipalType`, o valor deste parâmetro é o nome de um usuário CloudSSO.	testGroupName
TargetName	string	O nome do objeto para o qual você cria o provisionamento de usuário RAM. O valor é fixado como o nome do membro no diretório de recursos.	testRdMember
TargetId	string	O ID do objeto para o qual você cria o provisionamento de usuário RAM. O valor é fixado como o ID do membro no diretório de recursos.	1743382******
CreateTime	string	A hora de criação.	2022-11-28T03:55:42Z
DirectoryId	string	O ID do diretório de recursos.	d-003qew84****
OwnerPk	string	O ID da conta Alibaba Cloud à qual o diretório de recursos pertence.	1639738******
TargetType	string	O objeto para o qual você cria o provisionamento de usuário RAM. O valor é fixado como `RD-Account`.	RD-Account
PrincipalType	string	O tipo de identidade do provisionamento de usuário RAM. Valores válidos: User: indica que a identidade do provisionamento de usuário RAM é um usuário CloudSSO. Group: indica que a identidade do provisionamento de usuário RAM é um grupo de usuários CloudSSO.	Group
RequestId	string	O ID da solicitação.	F6F90F3D-4502-5877-B80B-97476F6AE2CC

Exemplos

Resposta de sucesso

JSON formato

{
  "UserProvisioning": {
    "Status": "Enabled",
    "Description": "This is a user provisioning.",
    "UserProvisioningId": "up-002axzhapcbz6e63****",
    "PrincipalId": "g-02ha881d*****",
    "TargetPath": "rd-******/root/test**",
    "UpdateTime": "2022-11-28T03:55:42Z",
    "DuplicationStrategy": "KeepBoth",
    "DeletionStrategy": "Delete",
    "PrincipalName": "testGroupName",
    "TargetName": "testRdMember",
    "TargetId": "1743382******",
    "CreateTime": "2022-11-28T03:55:42Z",
    "DirectoryId": "d-003qew84****",
    "OwnerPk": "1639738******",
    "TargetType": "RD-Account",
    "PrincipalType": "Group"
  },
  "RequestId": "F6F90F3D-4502-5877-B80B-97476F6AE2CC"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.