Lists users.
Try it now
Test
RAM authorization
Request syntax
POST /v2/user/list HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| domain_id |
string |
Yes |
||
| body |
object |
No |
The request body. |
|
| marker |
string |
No |
The pagination token that specifies the starting position of the results. The results are returned in alphabetical order. If you omit this parameter, results are returned from the start of the list. |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
| limit |
integer |
No |
The maximum number of users to return. |
100 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response body. |
||
| next_marker |
string |
The token for retrieving the next page of results. This parameter is empty when all results have been returned. |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
| items |
array |
A list of users. |
|
| User |
The user information. |
Examples
Success response
JSON format
{
"next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
"items": [
{
"domain_id": "bj1",
"user_id": "c9b7a5aa04d14ae3867fdc886fa01da4",
"avatar": "http://aa.com/1.jpg",
"created_at": 1639762579768,
"updated_at": 1639762579768,
"email": "a@aliyunpds.com",
"nick_name": "001",
"phone": "13900001111",
"role": "user",
"status": "enabled",
"user_name": "pds",
"description": "vipuser",
"default_drive_id": "1",
"creator": "user1",
"last_login_time": 0,
"last_refresh_token_time": 0,
"user_data": {
"key": ""
}
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.