更新应用可用范围
该接口用于更新当前企业内自建应用或已安装的商店应用的可见范围,包括可用人员与禁用人员。更新后对线上立即生效。
Note 当通过接口新增用户或部门时,提前判断对应用户或部门是否已在禁用名单中,如果已在禁用名单中,则即便将用户或部门添加到可用名单,该用户或部门也无法看到该应用,即禁用名单优先级高于可用名单。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/application/v3/app/update_visibility |
| HTTP Method | POST |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | admin:app.visibility 管理应用可见范围 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
请求体
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| app_id | string | 是 | 目标应用的 ID |
| del_users | - | 否 | 删除的用户列表,元素个数不超过 500,先增加后删除 |
| ∟open_id | string | 否 | 与 user_id 至少给其中之一,user_id 优先于 open_id |
| ∟user_id | string | 否 | |
| add_users | - | 否 | 增加的用户列表,元素个数不超过500,先增加后删除 |
| ∟open_id | string | 否 | 与 user_id 至少给其中之一,user_id 优先于 open_id |
| ∟user_id | string | 否 | |
| is_visiable_to_all | int | 否 | 是否全员可见,0:否;1:是;不填:继续当前状态不改变 |
| add_departments | string[] | 否 | 添加的部门列表,元素个数不超过 500,先增加后删除 |
| del_departments | string[] | 否 | 删除的部门列表,元素个数不超过 500,先增加后删除 |
请求体示例
json
{
"app_id" : "cli_9db45f86b7799104",
"add_users": [
{
"open_id": "ou_d317f090b7258ad0372aa53963cda70d",
"user_id":"79affdge"
}
],
"del_users": [
],
"is_visiable_to_all" : 0,
"add_departments": [
"od-4b4a6907ad726ea07b27b0d2882b7c65",
"od-2a0c3396b2cbd9a0befb104eccd1209f"
],
"del_departments": [
]
}响应
响应体
| 参数 | 说明 |
|---|---|
| code | 返回码,非 0 表示失败 |
| msg | 返回码的描述 |
| data | 返回的业务信息 |
响应示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 200 | 50003 | invalid app_id | 请检查 app_id 是否正确,以及应用是否被安装到当前企业 |
