Query member information
Retrieves information about a specific organization member.
The new Qoder CN documentation site is now available. Content on this site may not reflect the latest product features and changes. Visit docs.qoder.cn for the latest product documentation.
|
Applicable versions |
Enterprise Dedicated Edition, Enterprise Standard Edition |
Service endpoints and authorization
Get the service endpoint to replace <domain> in the API request syntax with your endpoint.
Obtain the access token.
-
Obtain the
organizationId. Go to the Lingma console and view the organization ID on the Basic Information page under .Product
Resource
Required permission
Tenant Management
Organization members
Read-Only
Request syntax
GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/members/{id}
Request header
|
Parameter |
Type |
Required |
Description |
Example |
|
x-yunxiao-token |
string |
Yes |
Personal access token. |
pt-0fh3****0fbG_35af****0484 |
Request parameters
|
Parameter |
Type |
Position |
Required |
Description |
Example |
|
organizationId |
string |
path |
Yes |
Organization ID. |
99d1****71d4 |
|
id |
string |
path |
Yes |
Member ID. |
3a41****3eca |
Request example
curl -X 'GET' \
'https://{domain}/oapi/v1/platform/organizations/{organizationId}/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] |
IDs of departments the member belongs to. |
["99d1****6124"] |
|
id |
string |
Member ID. |
99d1****6124 |
|
joined |
string |
Time when the member joined the organization, which equals the creation time in the database. |
2023-08-31T03:59:16.201Z |
|
name |
string |
Member name. |
Example Name |
|
organizationId |
string |
Organization ID. |
99d1****6124 |
|
roleIds |
array[string] |
IDs of roles assigned to the member. |
["99d1****6124"] |
|
status |
string |
Member status. Valid values: ENABLED, DISABLED, UNDELETED, DELETED, NORMAL_USING, UNVISITED. |
ENABLED |
|
userId |
string |
User ID. |
99d1****6124 |
|
visited |
string |
Last access time. |
2023-08-31T03:59:16.201Z |
Response example
{
"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 more information, see Error code center.