Skip to content

添加知识空间成员

添加知识空间成员或管理员。

前提条件

调用此接口前,请确保调用身份对应的应用或用户为知识空间的管理员。

注意事项

  • 使用 tenant access token 身份操作时,无法使用部门 ID (opendepartmentid) 添加知识空间成员。
  • 公开知识空间(即 visibility 可见性为 public 的空间)对租户所有用户可见,因此不支持再添加成员,但可以添加管理员。
  • 个人知识空间 (即 type 类型为 person 的空间)为个人管理的知识空间,不支持添加其他管理员(包括应用/机器人)。但可以添加成员。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/wiki/v2/spaces/:space_id/members
HTTP MethodPOST
接口频率限制100 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可wiki:member:create 新增知识空间成员 wiki:wiki 查看、编辑和管理知识库

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
space_idstring知识空间 ID。可通过以下两种方式获取。了解更多,参考知识库概述。 - 调用 获取知识空间列表获取 - 如果你是知识库管理员,可以进入知识库设置页面,复制地址栏的数字部分:https://sample.feishu.cn/wiki/settings/==6870403571079249922==
示例值:"1565676577122621"

查询参数

名称类型必填描述
need_notificationboolean添加权限后是否通知对方
示例值:true

请求体

名称类型必填描述
member_typestring要添加的成员或管理员的身份类型。可选值:
- openchat:群组 ID。参考群 ID 说明获取
- userid:用户 ID。详情参考如何获取 User ID
- email:用户邮箱
- opendepartmentid:部门 ID。参考部门资源介绍获取
- openid:用户的 Open ID。详情参考如何获取 Open ID
- unionid:用户的 Union ID。详情参考如何获取 Union ID
示例值:"openid"
member_idstring成员或管理员的 ID,值的类型由 member_type 参数决定。参考 member_type 的描述获取不同类型的 ID。
示例值:"ou_449b53ad6aee526f7ed311b216aabcef"
member_rolestring成员的角色类型。可选值:
- admin:管理员
- member:成员
示例值:"admin"

请求体示例

json
{
    "member_type": "openid",
    "member_id": "ou_449b53ad6aee526f7ed311b216aabcef",
    "member_role": "admin"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ membermember知识空间成员
    └ member_typestring要添加的成员或管理员的身份类型。枚举值:
- openchat:群组 ID。参考群 ID 说明获取
- userid:用户 ID。详情参考如何获取 User ID
- email:用户邮箱
- opendepartmentid:部门 ID。参考部门资源介绍获取
- openid:用户的 Open ID。详情参考如何获取 Open ID
- unionid:用户的 Union ID。详情参考如何获取 Union ID
    └ member_idstring成员或管理员的 ID,值的类型由 member_type 参数决定。
    └ member_rolestring成员的角色类型。可选值:
- admin:管理员
- member:成员
    └ typestring知识库协作者类型(未来支持)
可选值有
- user: 用户 - chat: 群组 - department: 组织架构

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "member": {
            "member_type": "openid",
            "member_id": "ou_449b53ad6aee526f7ed311b216aabcef",
            "member_role": "admin",
            "type": "user"
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
400131001rpc fail服务报错,请稍后重试,或者拿响应体的header头里的x-tt-logid咨询oncall定位。
400131002param err通常为传参有误,例如数据类型不匹配。请查看具体接口报错信息,报错不明确时请咨询oncall
400131003out of limit超出操作限制,例如节点数量限制。请参阅下表。 - 原/目标知识空间总节点数不超过40万。 - 原/目标知识空间目录树不超过50层。 - 目的父节点下单层节点数不超过2000。 - 单次移动节点数(带子节点)不超过2000。
400131004invalid user非法用户。请咨询oncall
400131005not found未找到相关数据,例如id不存在。相关报错信息参考: - member not found:用户不是知识空间成员(管理员),无法删除。 - identity not found: userid不存在,无法添加/删除成员。 - space not found:知识空间不存在 - node not found:节点不存在 - document not found:文档不存在 报错不明确时请咨询oncall
400131006permission denied权限拒绝,相关报错信息参考: - wiki space permission denied:知识库权限鉴权不通过,需要成为知识空间管理员(成员)。 - node permission denied:文档节点权限鉴权不通过,读操作需要具备节点阅读权限,写操作(创建、移动等)则需要具备节点容器编辑权限。 - no source parent node permission:需要具备原父节点的容器编辑权限。 - no destination parent node permission:需要具备目标父节点的容器编辑权限,若移动到知识空间下,则需要成为知识空间管理员(成员)。 注意:应用访问或操作文档时,除了申请 API 权限,还需授权具体文档资源的阅读、编辑或管理权限。 请参考以下步骤操作: 1. 当遇到资源权限不足的情况:参阅如何给应用授权访问知识库文档资源。 2. 也可直接将应用添加为知识库管理员(成员):参阅如何将应用添加为知识库管理员(成员)。 3. 若无法解决或报错信息不明确时:请咨询技术支持
400131007internal err服务内部错误,请勿重试,拿返回值的header头里的x-tt-logid咨询oncall定位。
400131008already exist数据已存在,请勿重复操作。
400131101invalid operation无效知识空间操作。例如公开空间禁止添加成员。 请参考具体接口报错信息和文档描述。

内容来源:飞书开放平台 · 自动爬取整理