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

Realiza uma consulta paginada das informações de contas do EIAM.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

GET /v2/{instanceId}/{applicationId}/users HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
applicationId	string	Sim	O ID da aplicação.	app_mkv7rgt4d7i4u7zqtzev2mxxxx

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Authorization	string	Sim	As informações de autenticação. Formato: Bearer ${access_token}. Exemplo: Bearer ATxxxx.	Bearer AT8csE2seYxxxxxij
organizationalUnitId	string	Não	O ID da organização.	ou_wovwffm62xifdziem7an7xxxxx
pageNumber	integer	Não	O número da página. O valor padrão é 1.	1
pageSize	integer	Não	O número de registros a serem retornados em cada página. O valor padrão é 20. O valor deve estar no intervalo de 1 a 100.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto de resposta.
totalCount	integer	O número total de registros.	1000
data	array<object>	A lista de objetos de dados retornados.
	object	O objeto de dados retornado.
instanceId	string	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
userId	string	O ID da conta.	user_d6sbsuumeta4h66ec3il7yxxxx
username	string	O nome da conta.	name001
displayName	string	O nome de exibição da conta.	display_name001
passwordSet	boolean	Indica se uma senha foi definida.	true
phoneRegion	string	O código de área do número de telefone celular. Por exemplo, o código de área para um número de telefone celular na China continental é 86. Não adicione 00 ou o sinal de mais (+).	86
phoneNumber	string	O número de telefone celular da conta.	156xxxxxxx
phoneNumberVerified	boolean	Indica se o número de telefone celular foi verificado. O valor true indica que o número de telefone celular foi verificado pelo usuário ou definido como verificado pelo administrador. O valor false indica que o número de telefone celular não foi verificado.	true
email	string	O endereço de e-mail da conta.	example@example.com
emailVerified	boolean	Indica se o endereço de e-mail foi verificado. O valor true indica que o endereço de e-mail foi verificado pelo usuário ou definido como verificado pelo administrador. O valor false indica que o endereço de e-mail não foi verificado.	true
userExternalId	string	O ID externo da conta. Este ID é usado para mapear dados externos para a conta do IDaaS. Por padrão, este parâmetro é igual ao ID da conta do IDaaS. Nota: O ID externo deve ser exclusivo para o mesmo tipo de origem e ID de origem.	user_d6sbsuumeta4h66ec3il7yxxxx
userSourceType	string	O tipo de origem da conta. Valores válidos: build_in: A conta é criada no IDaaS. ding_talk: A conta é importada do DingTalk. ad: A conta é importada do Active Directory (AD). ldap: A conta é importada do LDAP.	build_in
userSourceId	string	O ID de origem da conta. Para contas criadas no IDaaS, o valor padrão é o ID da instância. Para outros tipos de contas, o valor é o ID da empresa da origem. Por exemplo, para uma conta do DingTalk, o valor é o corpId da empresa do DingTalk.	idaas_ue2jvisn35ea5lmthk267xxxxx
status	string	O status da conta. Valores válidos: enabled: A conta está ativada. disabled: A conta está desativada.	enabled
accountExpireTime	integer	A hora em que a conta expira. Este valor é um carimbo de data e hora UNIX. Unidade: milissegundos.	1652085686179
registerTime	integer	A hora em que a conta foi registrada. Este valor é um carimbo de data e hora UNIX. Unidade: milissegundos.	1652085686179
lockExpireTime	integer	A hora em que o bloqueio da conta expira. Este valor é um carimbo de data e hora UNIX. Unidade: milissegundos.	1652085686179
createTime	integer	A hora em que a conta foi criada. Este valor é um carimbo de data e hora UNIX. Unidade: milissegundos.	1652085686179
updateTime	integer	A hora em que a conta foi atualizada pela última vez. Este valor é um carimbo de data e hora UNIX. Unidade: milissegundos.	1652085686179
description	string	A descrição da conta.	测试账户

Exemplos

Resposta de sucesso

JSON formato

{
  "totalCount": 1000,
  "data": [
    {
      "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "userId": "user_d6sbsuumeta4h66ec3il7yxxxx",
      "username": "name001",
      "displayName": "display_name001",
      "passwordSet": true,
      "phoneRegion": "86",
      "phoneNumber": "156xxxxxxx",
      "phoneNumberVerified": true,
      "email": "example@example.com",
      "emailVerified": true,
      "userExternalId": "user_d6sbsuumeta4h66ec3il7yxxxx",
      "userSourceType": "build_in",
      "userSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "status": "enabled",
      "accountExpireTime": 1652085686179,
      "registerTime": 1652085686179,
      "lockExpireTime": 1652085686179,
      "createTime": 1652085686179,
      "updateTime": 1652085686179,
      "description": "测试账户"
    }
  ]
}

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.