Todos os produtos
Search
Central de documentação

Identity as a Service:ListUsers

Última atualização: Jun 24, 2026

Consulta as informações de contas EIAM usando paginação.

Descrição da operação

Esta operação consulta apenas as permissões diretas de uma unidade organizacional, que são os aplicativos atribuídos diretamente à unidade organizacional. Ao chamar esta operação, você pode usar o parâmetro ApplicationIds para filtrar aplicativos.

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.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

InstanceId

string

Sim

O ID da instância.

idaas_ue2jvisn35ea5lmthk267xxxxx

PageNumber

integer

Não

O número da página. Valor padrão: 1.

1

PageSize

integer

Não

O número de entradas por página. Valor padrão: 20. Valor máximo: 100.

20

UserIds

array

Não

A lista de IDs de contas.

20

string

Não

O ID da conta.

user_d6sbsuumeta4h66ec3il7yxxxx

UsernameStartsWith

string

Não

O prefixo do nome de usuário. É utilizada uma consulta de correspondência à esquerda.

name_001

DisplayNameStartsWith

string

Não

O prefixo do nome de exibição. É utilizada uma consulta de correspondência à esquerda.

name

PhoneRegion

string

Não

O código de região do telefone. Exemplo: o código de região para a parte continental da China é 86, sem o prefixo 00 ou +.

86

PhoneNumber

string

Não

O número de telefone da conta.

156xxxxxxx

Email

string

Não

O endereço de e-mail da conta.

user@example.com

UserExternalId

string

Não

O ID externo, que é usado para associar dados externos a contas IDaaS.

Nota: o ID externo deve ser exclusivo dentro do mesmo tipo de origem e ID de origem.

id_wovwffm62xifdziem7an7xxxxx

UserSourceId

string

Não

O ID de origem da conta.

Para contas nativas, o valor padrão é o ID da instância. Para outros tipos, o valor corresponde ao ID da empresa da respectiva origem. Por exemplo, para uma origem DingTalk, o valor corresponde ao corpId da empresa DingTalk.

idaas_ue2jvisn35ea5lmthk267xxxxx

UserSourceType

string

Não

O tipo de origem da conta. Valores válidos:

  • build_in: nativa.

  • ding_talk: importada do DingTalk.

  • ad: importada do AD.

  • ldap: importada do LDAP.

  • we_com: importada do WeCom.

build_in

Status

string

Não

O status da conta. Valores válidos:

  • enabled: Ativada.

  • disabled: Desativada.

enable

OrganizationalUnitId

string

Não

O ID da unidade organizacional.

ou_wovwffm62xifdziem7an7xxxxx

NextToken

string

Não

O token de paginação.

NTxxxxexample

MaxResults

integer

Não

O número de entradas por página para paginação.

20

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Os parâmetros de resposta.

RequestId

string

O ID da solicitação.

0441BD79-92F3-53AA-8657-F8CE4A2B912A

TotalCount

integer

O número total de entradas retornadas.

100

Users

array<object>

A lista de dados das contas.

object

Os dados da conta.

UserId

string

O ID da conta.

user_d6sbsuumeta4h66ec3il7yxxxx

Username

string

O nome de usuário.

name001

DisplayName

string

O nome de exibição da conta.

display_name001

PasswordSet

boolean

Indica se uma senha foi definida.

false

PhoneRegion

string

O código de região do telefone. Exemplo: o código de região para a parte continental da China é 86, sem o prefixo 00 ou +.

86

PhoneNumber

string

O número de telefone da conta.

156xxxxxxx

PhoneNumberVerified

boolean

Indica se o número de telefone foi verificado. Um valor true indica que o número de telefone foi verificado pelo usuário ou definido como verificado pelo administrador. Um valor false indica que o número de telefone não foi verificado.

true

Email

string

O endereço de e-mail da conta.

user@example.com

EmailVerified

boolean

Indica se o endereço de e-mail foi verificado. Um valor true indica que o endereço de e-mail foi verificado pelo usuário ou definido como verificado pelo administrador. Um valor false indica que o endereço de e-mail não foi verificado.

true

UserExternalId

string

O ID externo da conta, que é usado para associar dados externos a contas IDaaS. O valor padrão é o ID da conta IDaaS.

Nota: o ID externo deve ser exclusivo dentro do mesmo tipo de origem e ID de origem.

user_d6sbsuumeta4h66ec3il7yxxxx

UserSourceType

string

O tipo de origem da conta. Valores válidos:

  • build_in: nativa.

  • ding_talk: importada do DingTalk.

  • ad: importada do AD.

  • ldap: importada do LDAP.

build_in

UserSourceId

string

O ID de origem da conta.

Para contas nativas, o valor padrão é o ID da instância. Para outros tipos, o valor corresponde ao ID da empresa da respectiva origem. Por exemplo, para uma origem DingTalk, o valor corresponde ao corpId da empresa DingTalk.

idaas_ue2jvisn35ea5lmthk267xxxxx

Status

string

O status da conta. Valores válidos:

  • enabled: Ativada.

  • disabled: Desativada.

enabled

AccountExpireTime

integer

A hora de expiração da conta, em formato de timestamp UNIX. Unidade: milissegundos.

1652085686179

PasswordExpireTime

integer

A hora de expiração da senha, em formato de timestamp UNIX. Unidade: milissegundos.

1652085686179

RegisterTime

integer

A hora de registro da conta, em formato de timestamp UNIX. Unidade: milissegundos.

1652085686179

LockExpireTime

integer

A hora de expiração do bloqueio da conta, em formato de timestamp UNIX. Unidade: milissegundos.

1652085686179

CreateTime

integer

A hora de criação da conta, em formato de timestamp UNIX. Unidade: milissegundos.

1652085686179

UpdateTime

integer

A hora da última atualização da conta, em formato de timestamp UNIX. Unidade: milissegundos.

1652085686179

Description

string

A descrição da conta.

xxxx

InstanceId

string

O ID da instância.

idaas_ue2jvisn35ea5lmthk267xxxxx

NextToken

string

O token de paginação.

NTxxxxxexample

MaxResults

integer

O número de entradas por página para paginação.

20

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "Users": [
    {
      "UserId": "user_d6sbsuumeta4h66ec3il7yxxxx",
      "Username": "name001",
      "DisplayName": "display_name001",
      "PasswordSet": false,
      "PhoneRegion": "86",
      "PhoneNumber": "156xxxxxxx",
      "PhoneNumberVerified": true,
      "Email": "user@example.com",
      "EmailVerified": true,
      "UserExternalId": "user_d6sbsuumeta4h66ec3il7yxxxx",
      "UserSourceType": "build_in",
      "UserSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "Status": "enabled",
      "AccountExpireTime": 1652085686179,
      "PasswordExpireTime": 1652085686179,
      "RegisterTime": 1652085686179,
      "LockExpireTime": 1652085686179,
      "CreateTime": 1652085686179,
      "UpdateTime": 1652085686179,
      "Description": "xxxx",
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
    }
  ],
  "NextToken": "NTxxxxxexample",
  "MaxResults": 20
}

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.