获取知识空间成员列表
获取知识空间的成员与管理员列表。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/wiki/v2/spaces/:space_id/members |
| HTTP Method | GET |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | wiki:member:retrieve 查看知识空间成员列表 wiki:wiki 查看、编辑和管理知识库 wiki:wiki:readonly 查看知识库 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
space_id | string | 知识空间 ID 示例值:"7375263209671884820" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_size | int | 否 | 分页大小 示例值:1 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:NzA0NDg5NjIzMDA3MzE3MTk3Ml83MzYzMjE4NDkzNDI1NzI5NTM4 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ members | member\[\] | 空间成员列表 |
└ member_type | string | 知识库协作者 ID 类型 |
└ member_id | string | 知识库协作者 ID |
└ member_role | string | 知识库协作者角色 |
└ type | string | 知识库协作者类型(未来支持) 可选值有: - user: 用户 - chat: 群组 - department: 组织架构 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"members": [
{
"member_type": "openid",
"member_id": "ou_67e5ecb64ce1c0bd94612c17999db411",
"member_role": "admin",
"type": "user"
}
],
"page_token": "ou_12345",
"has_more": false
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 131001 | rpc fail | 服务报错,请稍后重试,或者拿响应体的header头里的x-tt-logid咨询oncall定位。 |
| 400 | 131002 | param err | 通常为传参有误,例如数据类型不匹配。请查看具体接口报错信息,报错不明确时请咨询oncall。 |
| 400 | 131004 | invalid user | 非法用户。请咨询oncall。 |
| 400 | 131005 | not found | 未找到相关数据,例如id不存在。相关报错信息参考: - member not found:用户不是知识空间成员(管理员),无法删除。 - identity not found: userid不存在,无法添加/删除成员。 - space not found:知识空间不存在 - node not found:节点不存在 - document not found:文档不存在 报错不明确时请咨询oncall。 |
| 400 | 131006 | permission denied | 权限拒绝,相关报错信息参考: - wiki space permission denied:知识库权限鉴权不通过,需要成为知识空间管理员(成员)。 - node permission denied:文档节点权限鉴权不通过,读操作需要具备节点阅读权限,写操作(创建、移动等)则需要具备节点容器编辑权限。 - no source parent node permission:需要具备原父节点的容器编辑权限。 - no destination parent node permission:需要具备目标父节点的容器编辑权限,若移动到知识空间下,则需要成为知识空间管理员(成员)。 注意:应用访问或操作文档时,除了申请 API 权限,还需授权具体文档资源的阅读、编辑或管理权限。 请参考以下步骤操作: 1. 当遇到资源权限不足的情况:参阅如何给应用授权访问知识库文档资源。 2. 也可直接将应用添加为知识库管理员(成员):参阅如何将应用添加为知识库管理员(成员)。 3. 若无法解决或报错信息不明确时:请咨询技术支持。 |
| 500 | 131007 | internal err | 服务内部错误,请勿重试,拿返回值的header头里的x-tt-logid咨询oncall定位。 |
| 400 | 131101 | invalid operation | 无效知识空间操作。例如公开空间禁止添加成员。 请参考具体接口报错信息和文档描述。 |
