Lists group members.
Try it now
Test
RAM authorization
Request syntax
POST /v2/group/list_member HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| domain_id |
string |
No |
The ID of the domain. |
|
| body |
object |
No |
The request body. |
|
| group_id |
string |
Yes |
The ID of the group. |
3e5***2c2 |
| member_type |
string |
No |
The member type to list. If you do not specify this parameter, the API returns both users and groups.
Note: A group can be a member of only one other group. A user can be a member of multiple groups. |
user |
| limit |
integer |
No |
The maximum number of results to return. The value must be an integer from 1 to 100. The API may return fewer results than the specified limit. |
50 |
| marker |
string |
No |
The pagination marker. The API returns results starting from the first entry that follows the marker in alphabetical order. If you do not specify this parameter, the API returns results from the beginning of the collection. |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response object. |
||
| user_items |
array |
The user list. |
|
| User |
The user information. |
||
| group_items |
array |
The group list. |
|
| Group |
The group information. |
||
| next_marker |
string |
The marker to retrieve the next page of results. This parameter is empty if no more results are available. |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1 |
Examples
Success response
JSON format
{
"user_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": ""
}
}
],
"group_items": [
{
"domain_id": "bj1",
"group_id": "b45c0c0c373c41ec9ebb5c85a025a08f",
"group_name": "test group",
"description": "created by system",
"created_at": 0,
"updated_at": 0,
"creator": "c9b7a5aa04d14ae3867fdc886fa01da4",
"is_sync": true
}
],
"next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.