Performs a paged query for EIAM account information.
Try it now
Test
RAM authorization
Request syntax
GET /v2/{instanceId}/{applicationId}/users HTTP/1.1Request 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 organization ID. |
ou_wovwffm62xifdziem7an7xxxxx |
| pageNumber |
integer |
No |
The page number. The default value is 1. |
1 |
| pageSize |
integer |
No |
The number of records to return on each page. The default value is 20. The value must be in the range of 1 to 100. |
20 |
Response parameters
|
Parameter |
Type |
Description |
Example |
|
object |
The response object. |
||
| totalCount |
integer |
The total number of records. |
1000 |
| data |
array<object> |
The list of returned data objects. |
|
|
object |
The returned data object. |
||
| instanceId |
string |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| userId |
string |
The account ID. |
user_d6sbsuumeta4h66ec3il7yxxxx |
| username |
string |
The account name. |
name001 |
| displayName |
string |
The display name of the account. |
display_name001 |
| passwordSet |
boolean |
Indicates whether a password is set. |
true |
| phoneRegion |
string |
The area code for the mobile phone number. For example, the area code for a mobile phone number in the Chinese mainland is 86. Do not add 00 or a plus sign (+). |
86 |
| phoneNumber |
string |
The mobile phone number of the account. |
156xxxxxxx |
| phoneNumberVerified |
boolean |
Indicates whether the mobile phone number is verified. A value of true indicates that the mobile phone number is verified by the user or set to verified by the administrator. A value of false indicates that the mobile phone number is not verified. |
true |
|
string |
The email address of the account. |
example@example.com |
|
| emailVerified |
boolean |
Indicates whether the email address is verified. A value of true indicates that the email address is verified by the user or set to verified by the administrator. A value of false indicates that the email address is not verified. |
true |
| userExternalId |
string |
The external ID of the account. This ID is used to map external data to the IDaaS account. By default, this parameter is the same as the IDaaS account ID. Note: The external ID must be unique for the same source type and source ID. |
user_d6sbsuumeta4h66ec3il7yxxxx |
| userSourceType |
string |
The source type of the account. Valid values:
|
build_in |
| userSourceId |
string |
The source ID of the account. For accounts created in IDaaS, the default value is the instance ID. For other types of accounts, the value is the enterprise ID from the source. For example, for an account from DingTalk, the value is the corpId of the DingTalk enterprise. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| status |
string |
The status of the account. Valid values: enabled: The account is enabled. disabled: The account is disabled. |
enabled |
| accountExpireTime |
integer |
The time when the account expires. This value is a UNIX timestamp. Unit: milliseconds. |
1652085686179 |
| registerTime |
integer |
The time when the account was registered. This value is a UNIX timestamp. Unit: milliseconds. |
1652085686179 |
| lockExpireTime |
integer |
The time when the account lock expires. This value is a UNIX timestamp. Unit: milliseconds. |
1652085686179 |
| createTime |
integer |
The time when the account was created. This value is a UNIX timestamp. Unit: milliseconds. |
1652085686179 |
| updateTime |
integer |
The time when the account was last updated. This value is a UNIX timestamp. Unit: milliseconds. |
1652085686179 |
| description |
string |
The description of the account. |
测试账户 |
Examples
Success response
JSON format
{
"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
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.