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

Consulta os provisionamentos de usuários 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:ListUserProvisionings

list

*All Resource

*

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****
PrincipalId	string	Não	O ID de identidade do provisionamento de usuário do RAM. Valores válidos: Se `Group` for retornado para o parâmetro `PrincipalType`, o valor deste parâmetro será o ID de um grupo de usuários do CloudSSO (g-******). Se `User` for retornado para o parâmetro `PrincipalType`, o valor deste parâmetro será o ID de um usuário do CloudSSO (u-******).	u-88d73u*****
PrincipalType	string	Não	O tipo de identidade do provisionamento de usuário do RAM. Valores válidos: User: A identidade do provisionamento de usuário do RAM é um usuário do CloudSSO. Group: A identidade do provisionamento de usuário do RAM é um grupo de usuários do CloudSSO.	RD-Account
TargetId	string	Não	O ID do objeto para o qual você cria o provisionamento de usuário do RAM. O valor é fixo como o ID do membro no diretório de recursos.	1743382******
TargetType	string	Não	O objeto para o qual você cria o provisionamento de usuário do RAM. O valor é fixo como `RD-Account`.	User
MaxResults	integer	Não	O número máximo de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.	100
NextToken	string	Não	O token usado para iniciar a próxima solicitação. Se esta for a primeira vez que você chama esta operação, não é necessário especificar o parâmetro `NextToken`. Quando você chama esta operação pela primeira vez, se o número total de entradas a serem retornadas for maior que o valor de `MaxResults`, as entradas serão truncadas. O sistema retorna as entradas com base no valor de `MaxResults` e não retorna as entradas excedentes. Nesse caso, o valor do parâmetro de resposta `IsTruncated` é `true` e `NextToken` é retornado. Na próxima chamada, você pode usar o valor de `NextToken` e manter as configurações dos outros parâmetros de solicitação para consultar as entradas excedentes. Você pode repetir a chamada até que o valor de `IsTruncated` se torne `false`. Dessa forma, todas as entradas são retornadas.	27EbL9j4ZgZjsMZFqbZFgbwQ1VXFU1Khcpx9e2vrW1zwzTBmTGWaM7ixHhRin8SCsxaJdazYVCzeKc2UF2QkyGb83cPhr8ZxrzoaiTd****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os resultados retornados.
NextToken	string	O token usado para iniciar a próxima solicitação. Nota Este parâmetro é retornado apenas quando o parâmetro `IsTruncated` é definido como `true`.	27EbL9j4ZgZjsMZFqbZFgbwQ1VXFU1Khcpx9e2vrW1zwzTBmTGWaM7ixHhRin8SCsxaJdazYVCzeKc2UF2QkyGb83cPhr8ZxrzoaiTd****
RequestId	string	O ID da solicitação.	F76AF4FC-**--B7CB-74F3******
MaxResults	integer	O número máximo de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.	100
TotalCounts	integer	O número total de entradas retornadas.	110
UserProvisionings	array<object>	Os provisionamentos de usuários do RAM.
	object
Status	string	O status do provisionamento de usuário do 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 do RAM.	up-002axzhapcbz6e63****
PrincipalId	string	O ID de identidade do provisionamento de usuário do RAM. Valores válidos: Se `Group` for retornado para o parâmetro `PrincipalType`, o valor deste parâmetro será o ID de um grupo de usuários do CloudSSO (g-******). Se `User` for retornado para o parâmetro `PrincipalType`, o valor deste parâmetro será o ID de um usuário do CloudSSO (u-******).	g-02ha881d*****
TargetPath	string	O caminho do diretório de recursos no qual você cria o provisionamento de usuário do RAM para o objeto.	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 do RAM tem o mesmo nome de usuário que o usuário do CloudSSO que é sincronizado com o RAM. Valores válidos: KeepBoth: Quando um usuário do CloudSSO é sincronizado com o RAM, se existir um usuário do RAM com o mesmo nome de usuário do usuário do CloudSSO, o sistema cria um usuário do RAM cujo nome de usuário é o nome de usuário do usuário do CloudSSO mais o sufixo `_sso`. TakeOver: Quando um usuário do CloudSSO é sincronizado com o RAM, se existir um usuário do RAM com o mesmo nome de usuário do usuário do CloudSSO, o sistema substitui o usuário do RAM pelo usuário do 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 do RAM. Valores válidos: Delete: Quando você exclui o provisionamento de usuário do RAM, o sistema exclui os usuários sincronizados. Keep: Quando você exclui o provisionamento de usuário do RAM, o sistema retém os usuários sincronizados.	Delete
PrincipalName	string	O nome de identidade do provisionamento de usuário do RAM. Valores válidos: Se `Group` for retornado para o parâmetro `PrincipalType`, o valor deste parâmetro será o nome de um grupo de usuários do CloudSSO. Se `User` for retornado para o parâmetro `PrincipalType`, o valor deste parâmetro será o nome de um usuário do CloudSSO.	testGroupName
TargetName	string	O objeto para o qual você cria o provisionamento de usuário do RAM. O valor é fixo como `RD-Account`.	testRdMember
TargetId	string	O ID do objeto para o qual você cria o provisionamento de usuário do RAM. O valor é fixo 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 do RAM. O valor é fixo como `RD-Account`.	RD-Account
PrincipalType	string	O tipo de identidade do provisionamento de usuário do RAM. Valores válidos: User: A identidade do provisionamento de usuário do RAM é um usuário do CloudSSO. Group: A identidade do provisionamento de usuário do RAM é um grupo de usuários do CloudSSO.	Group
IsTruncated	boolean	Indica se as entradas consultadas estão truncadas. Valores válidos: true false	true

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "27EbL9j4ZgZjsMZFqbZFgbwQ1VXFU1Khcpx9e2vrW1zwzTBmTGWaM7ixHhRin8SCsxaJdazYVCzeKc2UF2QkyGb83cPhr8ZxrzoaiTd****",
  "RequestId": "F76AF4FC-****-****-B7CB-74F3********",
  "MaxResults": 100,
  "TotalCounts": 110,
  "UserProvisionings": [
    {
      "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"
    }
  ],
  "IsTruncated": true
}

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.