Queries member information.
Prerequisites
Replace <domain> in your API request URL with the endpoint that you obtain. For more information, see Endpoint.
Obtain your access token. For more information, see Obtain an access token.
Authorization information
Application | Resource | Required permission |
Administration | Member | Read-only |
Request syntax
GET https://{domain}/oapi/v1/platform/organizations/members/{id}Request headers
Parameter | Type | Required | Description | Example |
x-yunxiao-token | string | Yes | The access token. | pt-0fh3****0fbG_35af****0484 |
Request parameters
Parameter | Type | Position | Required | Description | Example |
id | string | path | Yes | Organization member ID. | 3a41****3eca |
Sample request
curl -X 'GET' \
'https://test.rdc.aliyuncs.com/oapi/v1/platform/organizations/members/{id}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Response parameters
Parameter | Type | Description | Example |
- | object | ||
deptIds | array[string] | The List of departments to which the member belongs. | [99d1****6124] |
id | string | The member ID. | 99d1****6124 |
joined | string | The time when the member joined the organization. | 2023-08-31T03:59:16.201Z |
name | string | The member name. | Example Name |
organizationId | string | The organization ID. | 99d1****6124 |
roleIds | array[string] | The information about the roles. | [99d1****6124] |
status | string | The member status. Valid values: ENABLED, DISABLED, UNDELETED, DELETED, NORMAL_USING, and UNVISITED. | ENABLED |
userId | string | The user ID. | 99d1****6124 |
visited | string | The last visit time. | 2023-08-31T03:59:16.201Z |
Sample success responses
{
"deptIds": [99d1****6124],
"id": "99d1****6124",
"joined": "2023-08-31T03:59:16.201Z",
"name": "Example Name",
"organizationId": "99d1****6124",
"roleIds": [99d1****6124],
"status": "ENABLED",
"userId": "99d1****6124",
"visited": "2023-08-31T03:59:16.201Z"
}Error codes
For a list of error codes, see Service error codes.