This topic describes how to use the ListMembers operation to query a list of organization members.
Prerequisites
Replace
<domain>in your API request URL with the endpoint that you obtain.
Authorization information
Product | Resource | Required permission |
Basic Service | Organization member | Read-only |
Request syntax
GET https://<domain>/oapi/v1/platform/organizations/members?page=<page>&perPage=<perPage>Request headers
Parameter | Type | Required | Description | Example |
x-yunxiao-token | string | Yes | The personal access token. | pt-0fh3****0fbG_35af****0484 |
Request parameters
Parameter | Type | Location | Required | Description | Example |
page | integer | query | No | The page number. Default value: 1. | 1 |
perPage | integer | query | No | The number of entries to return on each page. Valid values: 1 to 100. Default value: 100. | 100 |
Request example
curl -X 'GET' \
'https://test.rdc.aliyuncs.com/oapi/v1/platform/organizations/members?page={page}&perPage={perPage}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Response parameters
Parameter | Type | Description | Example |
- | array | ||
- | object | ||
deptIds | array[string] | A list of department IDs to which the member belongs. | [99d1****6124] |
string | The email address that is attached in personal settings. | example@example.com | |
id | string | The member ID. | 99d1****6124 |
joined | string | The time when the member joined the organization. This value is the creation time in the database. | 2023-08-31T03:59:16.201Z |
lastUpdated | string | The time when the member information was last updated. This value is the update time in the database. | 2023-08-31T03:59:16.201Z |
name | string | The member name. | ExampleName |
organizationId | string | The organization ID. | 99d1****6124 |
roleIds | array[string] | Role information | [99d1****6124] |
status | string | The status of the member. Valid values: ENABLED, DISABLED, UNDELETED, DELETED, NORMAL_USING, and UNVISITED. | ENABLED |
userId | string | The user ID. | 99d1****6124 |
visited | string | The last time the member accessed the organization. | 2023-08-31T03:59:16.201Z |
Response example
[
{
"deptIds": [99d1****6124],
"email": "example@example.com",
"id": "99d1****6124",
"joined": "2023-08-31T03:59:16.201Z",
"lastUpdated": "2023-08-31T03:59:16.201Z",
"name": "ExampleName",
"organizationId": "99d1****6124",
"roleIds": [99d1****6124],
"status": "ENABLED",
"userId": "99d1****6124",
"visited": "2023-08-31T03:59:16.201Z"
}
]Response headers
Parameter | Description | Example |
x-next-page | The next page number. | 1 |
x-page | The current page number. | 2 |
x-per-page | The number of entries on each page. | 1 |
x-prev-page | The previous page number. | 2 |
x-total | The total number of entries. | 1 |
x-total-pages | The total number of pages. | 1 |
Error codes
For more information about error codes, see Error Code Center.