Skip to main content

ListMembers - Query the list of organization members

Queries the list of members through OpenAPI.
Applies to: Enterprise Dedicated Edition, Enterprise Standard Edition
Access Point: Get the service access point and replace {domain} in the API request syntax.

Authorization

ProductResourceRequired permission
Organization ManagementOrganization memberRead-only

Request Syntax

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

Request examples

  • Enterprise Standard Edition
  • Enterprise Dedicated Edition
  • Query the list of members
curl -X 'GET' \
  'https://openapi-rdc.aliyuncs.com/oapi/v1/platform/organizations/99d1****71d4/members' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Request Headers

x-yunxiao-token string (Required) Personal access token. For details, see Personal Access Token. Example: pt-0fh30fbG_35af0484.

Request Parameters

​
string
path
required
Organization ID. You can go to the Basic Information page of the Organization Management Console to obtain the organizationId.
​
integer
path
default:"1"
[Applies to Dedicated Edition only] Current page.
​
integer
path
default:"100"
[Applies to Dedicated Edition only] Number of data entries per page. Value range: [1, 100].

Response Fields

  • Response example
[
    {
        "deptIds": ["99d1****6124"],
        "id": "99d1****6124",
        "joined": "2023-08-31T03:59:16.201Z",
        "lastUpdated": "2023-08-31T03:59:16.201Z",
        "name": "Example Name",
        "email": "example@example.com",
        "organizationId": "99d1****6124",
        "roleIds": ["99d1****6124"],
        "status": "ENABLED",
        "userId": "99d1****6124",
        "visited": "2023-08-31T03:59:16.201Z"
    }
]
​
array[string]
List of organization departments to which the member belongs.
​
string
Member ID.
​
string
Join time, equal to the creation time in the database.
​
string
Last update time, equal to the update time in the database.
​
string
Member name.
​
string
Email.
​
string
Organization ID.
​
array[string]
Role information.
​
string
Member status.Valid values: ENABLED, DISABLED, UNDELETED, DELETED, NORMAL_USING, UNVISITED.
​
string
User ID.
​
string
Last access time.

Response Headers

ParameterDescriptionExample value
x-next-page[Applies to Dedicated Edition only] Next page.1
x-page[Applies to Dedicated Edition only] Current page.2
x-per-page[Applies to Dedicated Edition only] Number of data entries per page.1
x-prev-page[Applies to Dedicated Edition only] Previous page.2
x-total[Applies to Dedicated Edition only] Total number of data entries.1
x-total-pages[Applies to Dedicated Edition only] Total number of pages.3

Error Codes

For more information, see the API error codes.