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

Consulta uma lista de usuários.

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:ListUsers

list

*User

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DirectoryId	string	Sim	O ID do diretório.	d-00fc2p61****
Status	string	Não	O status do usuário. Este parâmetro é usado como condição de filtro. Valores válidos: Enabled: O usuário está ativado. Disabled: O usuário está desativado.	Enabled
ProvisionType	string	Não	O tipo de usuário. Este parâmetro é usado como condição de filtro. Valores válidos: Manual: O usuário foi criado manualmente. Synchronized: O usuário foi sincronizado a partir de um provedor de identidade externo.	Manual
Filter	string	Não	A condição de filtro. Formato: `<Attribute> <Operator> <Value>`. Este valor não diferencia maiúsculas de minúsculas. Atualmente, `<Attribute>` suporta apenas `UserName`, e `Operator` suporta apenas `eq` (Igual) e `sw` (Começa com). Exemplo: Filter = "UserName sw test" consulta todos os usuários cujos nomes de usuário começam com test. Filter = "UserName eq testuser" consulta o usuário cujo nome de usuário é `testuser`.	UserName sw test
MaxResults	integer	Não	O número máximo de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.	10
NextToken	string	Não	O token para a próxima página de resultados. Você não precisa especificar `NextToken` na primeira chamada da API. Quando você chama a API pela primeira vez, se o número total de entradas exceder o limite de `MaxResults`, os dados serão truncados e apenas as entradas de `MaxResults` serão retornadas. Nesse caso, o parâmetro de resposta `IsTruncated` é `true` e um `NextToken` é retornado. Você pode usar o `NextToken` retornado da chamada anterior para continuar chamando a API, mantendo os outros parâmetros de solicitação inalterados, para consultar os dados truncados. Você pode repetir esse processo até que `IsTruncated` seja `false`, o que indica que todos os dados foram recuperados.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
Tags	array<object>	Não	A lista de tags.
	object	Não
Key	string	Não	A chave da tag.	TestKey
Value	string	Não	O valor da tag.	TestValue

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
NextToken	string	O token para a próxima página de resultados. Nota Este parâmetro é retornado apenas quando `IsTruncated` é `true`.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	O ID da solicitação.	734D9AAC-9A8E-5DF6-A633-ADE70FF2A9B1
MaxResults	integer	O número máximo de entradas por página.	10
TotalCounts	integer	O número total de entradas que correspondem aos parâmetros da solicitação.	2
IsTruncated	boolean	Indica se os resultados estão truncados. Valores válidos: true: Os resultados estão truncados. false: Os resultados não estão truncados.	false
Users	array<object>	A lista de usuários.
	array<object>	A lista de usuários.
Status	string	O status do usuário. Valores válidos: Enabled: O usuário está ativado. Disabled: O usuário está desativado.	Enabled
UserName	string	O nome de usuário.	AliceLee@example.onmicrosoft.com
Email	string	O endereço de e-mail do usuário.	AliceLee@example.onmicrosoft.com
Description	string	A descrição do usuário.	Este é um usuário
UserId	string	O ID do usuário.	u-00bikzkuzbb58luh****
FirstName	string	O primeiro nome do usuário.	Alice
CreateTime	string	A hora em que o usuário foi criado (UTC).	2021-06-30T09:20:08Z
ProvisionType	string	O tipo do usuário. Valores válidos: Manual: O usuário foi criado manualmente. Synchronized: O usuário foi sincronizado a partir de um provedor de identidade externo.	Synchronized
DisplayName	string	O nome de exibição do usuário.	AliceLee
UpdateTime	string	A hora em que o usuário foi modificado pela última vez (UTC).	2021-06-30T09:20:08Z
LastName	string	O sobrenome do usuário.	Lee
ExternalId	object	As informações de identificador do usuário provenientes do provedor de identidade externo.
Id	string	O identificador do usuário no IdP externo.	c73******a5fdd5
Issuer	string	O canal para sincronização de usuários externos. Atualmente, apenas a sincronização SCIM é suportada.	SCIM
Tags	array<object>	A lista de tags.
	object
Key	string	A chave da tag.	TestKey
Value	string	O valor da tag.	TestValue

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "734D9AAC-9A8E-5DF6-A633-ADE70FF2A9B1",
  "MaxResults": 10,
  "TotalCounts": 2,
  "IsTruncated": false,
  "Users": [
    {
      "Status": "Enabled",
      "UserName": "AliceLee@example.onmicrosoft.com",
      "Email": "AliceLee@example.onmicrosoft.com",
      "Description": "This is a user.",
      "UserId": "u-00bikzkuzbb58luh****",
      "FirstName": "Alice",
      "CreateTime": "2021-06-30T09:20:08Z",
      "ProvisionType": "Synchronized",
      "DisplayName": "AliceLee",
      "UpdateTime": "2021-06-30T09:20:08Z",
      "LastName": "Lee",
      "ExternalId": {
        "Id": "c73******a5fdd5\n",
        "Issuer": "SCIM"
      },
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ]
    }
  ]
}

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.