获取知识库成员列表_通义灵码_智能编码助手_智能编码助手通义灵码(Lingma)-阿里云帮助中心

通过 OpenAPI 获取知识库成员列表。

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

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。
获取organizationId，请前往组织管理后台的基本信息页面获取组织 ID，具体请参见 organizationId 获取方式。

请求语法

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

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是	组织 ID。	99d1****71d4
kbId	string	path	是	知识库 ID。	3a41****3eca
query	string	query	否	成员名称模糊查询。
orderBy	string	query	否	排序列，支持如下排序字段：gmt_created。
sort	string	query	否	排序顺序，支持倒序和正序：desc，asc。
page	integer	query	否	当前页，默认1。
perPage	integer	query	否	每页数据条数，默认20。

请求示例

curl -X 'GET' \
  'https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases/{kbId}/members?query={query}&orderBy={orderBy}&sort={sort}&page={page}&perPage={perPage}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数


参数	类型	描述	示例值
-	array
-	object
avatarUrl	string	成员头像。	/objects/ajax/default/avatars/bGluZ21hMDA0
creator	object	成员添加者。
avatarUrl	string	添加者头像。	/objects/ajax/default/avatars/bGluZ21h
displayName	string	添加者登录名。	lingma
id	string	添加者 id。	d402****9ae6
userName	string	添加者昵称。	lingma004
displayName	string	成员登录名。	lingma005
gmtCreated	integer	添加日期。	1722148166491
kbNo	string	知识库 id。	3a41****3eca
roleList	array[string]	成员角色列表, MANAGER 代表管理员，MEMBER 代表可见成员。
userName	string	成员昵称。	lingma

返回示例

[
    {
        "avatarUrl": "/objects/ajax/default/avatars/bGluZ21hMDA0",
        "creator": {
            "avatarUrl": "/objects/ajax/default/avatars/bGluZ21h",
            "displayName": "lingma",
            "id": "d402****9ae6",
            "userName": "lingma004"
        },
        "displayName": "lingma005",
        "gmtCreated": 0,
        "kbNo": "3a41****3eca",
        "roleList": [
        ],
        "userId": "8582****cd4f",
        "userName": "lingma"
    }
]

响应头

参数	描述	示例值
x-next-page	下一页。	1
x-per-page	每页数据条数。	100
x-prev-page	上一页。	1
x-total	总数据量。	2
x-total-pages	总分页数。	1

错误码

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