添加知识库成员

通过 OpenAPI 添加知识库成员。

适用版本

企业专属版、企业标准版

服务接入点

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

授权信息

产品

资源

所需权限

通义灵码

知识库成员

读写

请求语法

POST https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases/{kbId}/members

请求说明

企业标准版

添加知识库成员

curl -X 'POST' \
  'https://openapi-rdc.aliyuncs.com/oapi/v1/lingma/organizations/6826e1d0516a9f85a08c****/knowledgeBases/b15aef8442c0fc45492b****/members' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
  {
    "members": [
             {
                "creatorId": "66a6f60e368d88cff5a513fc",
                "kbNo": "b15aef8442c0fc45492bdf38",
                "userId": "672aca1cbecc937b9f5108e9",
                "userType": "USER",
                "roleList": [
                    "MEMBER"
                ]
             }
        ]
}'

企业专属版

添加知识库成员

curl -X 'POST' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/lingma/organizations/6826e1d0516a9f85a08c****/knowledgeBases/b15aef8442c0fc45492b****/members' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
  {
    "members": [
             {
                "creatorId": "66a6f60e368d88cff5a513fc",
                "kbNo": "b15aef8442c0fc45492bdf38",
                "userId": "672aca1cbecc937b9f5108e9",
                "userType": "USER",
                "roleList": [
                    "MEMBER"
                ]
             }
        ]
}'

请求头(Headers)

x-yunxiao-token string (必选)

个人访问令牌。您可参考个人访问令牌获取。

示例:pt-0fh3****0fbG_35af****0484。

请求参数

organizationId string (必选)

所属组织ID。您可以前往组织管理后台基本信息页面获取organizationId

kbId string (必选)

知识库 ID。请参见获取知识库列表获取知识库ID。

members array[object] (必选)

待添加成员列表。

属性

creatorId string (必选)

添加者ID。请参见获取知识库成员列表获取添加者ID。

kbNo string (必选)

知识库ID。请参见获取知识库列表获取知识库ID。

userId string (必选)

成员ID。请参加查询成员列表获取成员 ID。

userType string (可选)默认值为USER

用户类型:

  • USER:用户类型。

  • TEAM:部门类型。

roleList array[string] (可选)默认值为MEMBER

成员角色列表:

  • MANAGER:管理员。

  • MEMBER:可见成员。

返回参数

返回示例

{
    "success": true
}

success boolean

是否成功添加知识库成员。

错误码

访问错误码中心查看 API 相关错误码。