更新应用协作者
某个应用(包括自建应用和商店应用)中添加/移除应用协作者,添加后协作者将会收到添加通知。
Tip: 若用 user_access_token 代表某个终端用户操作API,则需确保该用户为应用的所有者或管理员,否则无法操作成功。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/application/v6/applications/:app_id/collaborators |
| HTTP Method | PUT |
| 接口频率限制 | 10 次/分钟 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | application:application.collaborators:write 更新应用协作者信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
app_id | string | 应用 ID,获取方式参见 app_id。 示例值:"cli_a5002df1b6f8d01c" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id_type | string | 否 | 用户 ID 类型 示例值:open_id 可选值有: - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
adds | app_collaborator\[\] | 否 | 添加人员 数据校验规则: - 长度范围: 0 ~ 5 |
└ type | string | 是 | 人员类型 示例值:"administrator" 可选值有: - administrator: 管理员 - developer: 开发者 - operator: 运营 |
└ user_id | string | 是 | 用户 ID,ID 类型与查询参数 user_id_type 取值一致。 示例值:"ou_d317f090b7258ad0372aa53963cda70d" |
removes | string\[\] | 否 | 移除人员 示例值:["ou_84aad35d084aa403a838cf73ee18467"] 数据校验规则: - 长度范围: 0 ~ 5 |
请求体示例
json
{
"adds": [
{
"type": "administrator",
"user_id": "ou_d317f090b7258ad0372aa53963cda70d"
}
],
"removes": [
"ou_84aad35d084aa403a838cf73ee18467"
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 210001 | param is invalid | 参数错误 |
