ListUsers - Identity as a Service - Alibaba Cloud Documentation Center

Queries the information of Employee Identity and Access Management (EIAM) accounts by page.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
Authorization	string	Yes	The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.	Bearer AT8csE2seYxxxxxij
instanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
applicationId	string	Yes	The application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
organizationalUnitId	string	No	The ID of the organizational unit.	ou_wovwffm62xifdziem7an7xxxxx
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries per page. Default value: 20. Valid values: 1 to 100.	20

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
totalCount	long	The total number of entries returned.	1000
data	array<object>	The queried EIAM accounts.
	object	The queried EIAM account.
instanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
userId	string	The account ID.	user_d6sbsuumeta4h66ec3il7yxxxx
username	string	The username of the account.	name001
displayName	string	The display name of the account.	display_name001
phoneRegion	string	The country code of the mobile number. For example, the country code of China is 86 without 00 or +.	86
phoneNumber	string	The mobile number of the user who owns the account.	156xxxxxxx
phoneNumberVerified	boolean	Indicates whether the mobile number has been verified. A value of true indicates that the mobile number has been verified by the user or has been set to the verified status by the administrator. A value of false indicates that the mobile number has not been verified.	true
email	string	The email address of the user who owns the account.	example@example.com
emailVerified	boolean	Indicates whether the email address has been verified. A value of true indicates that the email address has been verified by the user or has been set to the verified status by the administrator. A value of false indicates that the email address has not been verified.	true
userExternalId	string	The external ID of the account. The external ID can be used to map external data to the data of the account in EIAM of Identity as a Service (IDaaS). By default, the external ID is the account ID. Note: For accounts with the same source type and source ID, each account has a unique external ID.	user_d6sbsuumeta4h66ec3il7yxxxx
userSourceType	string	The source type of the account. Valid values: build_in: The account was created in IDaaS. ding_talk: The account was imported from DingTalk. ad: The account was imported from Microsoft Active Directory (AD). ldap: The account was imported from a Lightweight Directory Access Protocol (LDAP) service.	build_in
userSourceId	string	The source ID of the account. If the account was created in IDaaS, its source ID is the ID of the IDaaS instance. If the account was imported, its source ID is the enterprise ID in the source. For example, if the account was imported from DingTalk, its source ID is the corpId value of the enterprise in DingTalk.	idaas_ue2jvisn35ea5lmthk267xxxxx
status	string	The status of the account. Valid values: enabled disabled	enabled
accountExpireTime	long	The time when the account expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1652085686179
registerTime	long	The time when the account was registered. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1652085686179
lockExpireTime	long	The time when the account lock expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1652085686179
createTime	long	The time when the account was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1652085686179
updateTime	long	The time when the account was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1652085686179

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-10-24	The internal configuration of the API is changed, but the call is not affected	View Change Details