通过 OpenAPI 搜索组织成员列表。
适用版本 | 企业标准版、企业专属版 |
专属版“组织”对应标准版“企业”概念,本文在专属版中代表组织相关接口,在标准版中代表企业相关接口。
服务接入点与授权信息
获取服务接入点,替换 API 请求语法中的 <domain> :服务接入点(domain)。
获取个人访问令牌,具体操作,请参见获取个人访问令牌。
请求语法
POST https://<doamin>/oapi/v1/platform/organizations/<organizationId>/members:search
请求头
参数 | 类型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 个人访问令牌。 | pt-0fh3****0fbG_35af****0484 |
请求参数
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
organizationId | string | path | 是 | 组织 ID。 | 99d1****71d4 |
deptIds | string | body | 否 | 所属部门列表,默认可空。 | |
includeChildren | boolean | body | 否 | [专属版适用] 是否包含子部门,默认 false,不包含;当 deptIds 为空时,该字段无意义。 | |
page | integer | body | 否 | 页码,从1开始。 | |
perPage | integer | body | 否 | 1-100,默认100。 | |
query | string | body | 否 | 字段查询,支持成员名/昵称、邮箱、工号等基本信息的模糊匹配及对应全/简拼音查询。 | |
roleIds | string | body | 否 | 角色列表,默认可空。 | |
statuses | string | body | 否 | 成员状态过滤,默认返回状态为 ENABLED 的成员。ENABLED=NORMAL_USING+UNVISITED;UNDELETED=ENABLED+DISABLED。 |
请求示例
curl -X 'POST' \
'https://test.rdc.aliyuncs.com/oapi/v1/platform/organizations/99d1****71d4/members:search' \
-H 'accept: application/json' \
-H 'Content-Type: */*' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
-d '{
"deptIds": [
"string"
],
"includeChildren": false,
"page": 1,
"perPage": 100,
"query": "string",
"roleIds": [
"string"
],
"statuses": [
"ENABLED",
"DISABLED",
"UNDELETED",
"DELETED",
"NORMAL_USING",
"UNVISITED"
]
}'
返回参数
参数 | 类型 | 描述 | 示例值 |
deptIds | string | 部门 ID。 | 8446****ce9f |
id | string | 成员 ID。 | 3a41****3eca |
joined | string | 加入时间。 | 2024-07-04T03:45:11.547648Z |
name | string | 成员名称。 | name1 |
organizationId | string | 组织 ID。 | 99d1****71d4 |
roleIds | string | 角色 ID。 | org_member |
status | string | 状态。 | ENABLED |
userId | string | 用户 ID。 | 3ab3****b634 |
visited | string | 访问组织时间。 | 2024-07-05T12:45:11.547345Z |
返回示例
{
"deptIds": [
"8446****ce9f"
],
"id": "3a41****3eca",
"joined": "2024-07-04T03:45:11.547648Z",
"name": "name1",
"organizationId": "99d1****71d4",
"roleIds": [
"org_member"
],
"status": "ENABLED",
"userId": "3ab3****b634",
"visited": "2024-07-05T12:45:11.347345Z"
}
响应头
参数 | 描述 | 示例值 |
x-next-page | 下一页。 | 1 |
x-per-page | 每页数据条数。 | 100 |
x-prev-page | 上一页。 | 1 |
x-total | 总数据量。 | 2 |
x-total-pages | 总分页数。 | 1 |
响应头示例
connection: keep-alive
content-length: 481
content-type: application/json; charset=UTF-8
date: Thu,04 Jul 2024 13:44:21 GMT
x-next-page: 1
x-per-page: 100 //每页大小
x-prev-page: 1
x-total: 1 //总条数
x-total-pages: 1 //总页数
错误码
访问错误码中心查看 API 相关错误码。