ListMembers - 查询成员列表

通过 OpenAPI 查询成员列表。

适用版本：企业专属版、企业标准版

服务接入点：获取服务接入点，替换 API 请求语法中的 {domain} 。

授权信息

产品	资源	所需权限
组织管理	组织成员	只读

请求语法

GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/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'

查询成员列表

curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/organizations/99d1****71d4/members?page=1&perPage=100' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

请求头（Headers）

x-yunxiao-token string （必选）个人访问令牌。您可参考个人访问令牌获取。示例：pt-0fh30fbG_35af0484。

请求参数

string

path

required

组织 ID。您可前往组织管理后台的基本信息页面获取组织ID（organizationId）。

integer

path

default:"1"

【仅专属版适用】当前页。

integer

path

default:"100"

【仅专属版适用】每页数据条数，取值范围：[1，100]。

返回参数

返回示例

[
    {
        "deptIds": ["99d1****6124"],
        "id": "99d1****6124",
        "joined": "2023-08-31T03:59:16.201Z",
        "lastUpdated": "2023-08-31T03:59:16.201Z",
        "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]

所属组织部门列表。

string

成员 ID。

string

加入时间，等于数据库的创建时间。

string

最后更新时间，等于数据库的更新时间。

string

成员名。

string

邮箱。

string

组织 ID。

array[string]

角色信息。

string

成员状态。可选值：ENABLED,DISABLED,UNDELETED,DELETED,NORMAL_USING,UNVISITED。

string

用户 ID。

string

最后访问时间。

响应头

参数	描述	示例值
x-next-page	【仅专属版适用】下一页。	1
x-page	【仅专属版适用】当前页。	2
x-per-page	【仅专属版适用】每页数据条数。	1
x-prev-page	【仅专属版适用】上一页。	2
x-total	【仅专属版适用】总数据量。	1
x-total-pages	【仅专属版适用】总分页数。	3

错误码

访问查看 API 相关错误码。

​授权信息

​请求语法

​请求说明

​请求头（Headers）

​请求参数

​返回参数

​响应头

​错误码

授权信息

请求语法

请求说明

请求头（Headers）

请求参数

返回参数

响应头

错误码