Query the list of organization members - Alibaba Cloud DevOps

Query the members of an organization using OpenAPI.

Endpoint and authorization information

Obtain an endpoint and use it to replace {domain} in the API request syntax.
Obtain a personal access token.

Product	Resource	Required permission
Organization Management	Organization member	Read-only

Request syntax

GET https://{domain}/oapi/v1/platform/organizations/members

Request headers

Parameter	Type	Required	Description	Example value
x-yunxiao-token	string	Yes	Personal access token.	pt-0fh3**0fbG_35af**0484

Request parameters

Parameter	Type	Location	Required	Description	Example value
page	integer	query	No	The current page number. The default value is 1.
perPage	integer	query	No	The number of entries per page. The value must be between 1 and 100. The default value is 100.

Request examples

curl -X 'GET' \
  'https://{domain}/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 value
-	array
-	object
deptIds	array[string]	The list of department IDs in the organization.	["99d1****6124"]
email	string	The email address.	example@example.com
id	string	The member ID.	99d1****6124
joined	string	The time when the member joined.	2023-08-31T03:59:16.201Z
lastUpdated	string	The time of the last update. This 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 details	["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 time of the last access.	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 value
x-next-page	Next page
x-page	The current page number.
x-per-page	The number of entries per page.
x-prev-page	Previous
x-total	Total data volume.
x-total-pages	The total number of pages.

Error codes

For more information about API error codes, see Error Code Center.