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 CloudSSO.	d-00fc2p61****
Status	string	Não	O status do usuário. Este parâmetro é usado como condição de filtro. Valores válidos: Enabled Disabled	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 de um IdP externo.	Manual
Filter	string	Não	A condição de filtro. O formato é `<Attribute> <Operator> <Value>`. O filtro não diferencia maiúsculas de minúsculas. O `<Attribute>` suporta apenas `UserName`. O `<Operator>` suporta apenas `eq` (igual a) e `sw` (começa com). Exemplos: Se você configurar este parâmetro como `UserName sw test`, o sistema consulta todos os usuários cujos nomes de usuário começam com `test`. Se você configurar este parâmetro como `UserName eq testuser`, o sistema consulta o usuário cujo nome de usuário é `testuser`.	UserName sw test
MaxResults	integer	Não	O número máximo de entradas a serem retornadas em cada página. Valores válidos: 1 a 100. Valor padrão: 10.	10
NextToken	string	Não	O token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Você não precisa especificar este parâmetro para a primeira solicitação. Se o número total de entradas exceder o valor de `MaxResults`, as entradas serão truncadas. O sistema retorna o valor de `MaxResults` e um `NextToken`. O parâmetro `IsTruncated` é definido como `true`. Você pode usar o `NextToken` retornado na próxima chamada para consultar as entradas restantes. Mantenha os outros parâmetros de solicitação inalterados. Repita este processo até que o parâmetro `IsTruncated` seja `false`. Isso indica que todas as entradas foram retornadas.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
Tags	array<object>	Não	The tags attached to the user.
	object	Não	The tag attached to the user.
Key	string	Não	The tag key.
Value	string	Não	The tag value.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
NextToken	string	Um token de paginação. Pode ser usado na próxima solicitação para recuperar uma nova 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 retornadas por página.	10
TotalCounts	integer	O número total de entradas que atendem às condições de filtro.	2
IsTruncated	boolean	Indica se os resultados estão truncados. Valores válidos: true false	false
Users	array<object>	A lista de usuários.
	array<object>	Os detalhes do usuário.
Status	string	O status do usuário. Valores válidos: Enabled Disabled	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.	This is a user.
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. A hora está em 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 de um IdP 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. A hora está em UTC.	2021-06-30T09:20:08Z
LastName	string	O sobrenome do usuário.	Lee
ExternalId	object	O identificador do usuário em um IdP externo.
Id	string	The identifier of the user in the external IdP.	c73******a5fdd5
Issuer	string	The channel for external user synchronization. Currently, only SCIM synchronization is supported.	SCIM
Tags	array<object>	The tags attached to the user.
	object	The tag attached to the user.
Key	string	The tag key.
Value	string	The tag value.

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": "",
          "Value": ""
        }
      ]
    }
  ]
}

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.