更新应用可用范围

调用该接口更新指定应用的可用范围，支持更新当前企业内自建应用的可用范围，或者已安装的商店应用的可用范围，包括可用人员与禁用人员。更新可用范围后对线上立即生效。

注意事项

• 该接口仅支持被企业自建应用调用，但传入的路径参数 app_id 可以是企业自建应用的 app_id，也可以是商店应用的 app_id。

• 当通过接口新增用户或部门时，提前判断对应用户或部门是否已在禁用名单中，如果已在禁用名单中，则即便将用户或部门添加到可用名单，该用户或部门也无法看到该应用，即禁用名单优先级高于可用名单。

• 同一个成员(user_id) 在30s内不能重复添加到禁用名单，否则会导致调用失败。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/application/v6/applications/:app_id/visibility
HTTP Method	PATCH
接口频率限制	20 次/分钟
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	admin:app.visibility 管理应用可见范围
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
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 示例值："cli_9b445f5258795107"

查询参数

名称	类型	必填	描述
department_id_type	string	否	部门id 类型 示例值：open_department_id 可选值有： - open_department_id: 以open_department_id标识部门 - department_id: 以department_id标识部门 默认值：open_department_id
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

请求体

名称	类型	必填	描述
add_visible_list	app_visibility_id_list	否	添加可用人员列表，如果参数is_visible_to_all不设置且当前已经是全员可见，或者参数is_visible_to_all设置为true，则该参数不生效
└ user_ids	string\[\]	否	成员id列表 id类型根据user_id_type参数指定 示例值：["ou_84aad35d084aa403a838cf73ee18467"] 数据校验规则： - 最大长度：100
└ department_ids	string\[\]	否	部门id列表 id类型根据department_id_type参数指定 示例值：["od-4e6ac4d14bcd5071a37a39de902c7141"] 数据校验规则： - 最大长度：100
└ group_ids	string\[\]	否	用户组id列表 示例值：["g193821"] 数据校验规则： - 最大长度：100
del_visible_list	app_visibility_id_list	否	删除可用人员列表，如果参数is_visible_to_all不设置且当前已经是全员可见，或者参数is_visible_to_all设置为true，则该参数不生效
└ user_ids	string\[\]	否	成员id列表 id类型根据user_id_type参数指定 示例值：["ou_84aad35d084aa403a838cf73ee18467"] 数据校验规则： - 最大长度：100
└ department_ids	string\[\]	否	部门id列表 id类型根据department_id_type参数指定 示例值：["od-4e6ac4d14bcd5071a37a39de902c7141"] 数据校验规则： - 最大长度：100
└ group_ids	string\[\]	否	用户组id 示例值：["g193821"] 数据校验规则： - 最大长度：100
add_invisible_list	app_visibility_id_list	否	添加禁用人员列表
└ user_ids	string\[\]	否	成员id列表 id类型根据user_id_type参数指定 相同的成员不能在30s内重复添加到禁用列表，否则会导致调用失败 示例值：["ou_84aad35d084aa403a838cf73ee18467"] 数据校验规则： - 最大长度：100
└ department_ids	string\[\]	否	部门id列表 id类型根据department_id_type参数指定 示例值：["od-4e6ac4d14bcd5071a37a39de902c7141"] 数据校验规则： - 最大长度：100
└ group_ids	string\[\]	否	用户组id列表 示例值：["g193821"] 数据校验规则： - 最大长度：100
del_invisible_list	app_visibility_id_list	否	删除禁用人员列表
└ user_ids	string\[\]	否	成员id列表 id类型根据user_id_type参数指定 示例值：["ou_84aad35d084aa403a838cf73ee18467"] 数据校验规则： - 最大长度：100
└ department_ids	string\[\]	否	部门id列表 id类型根据department_id_type参数指定 示例值：["od-4e6ac4d14bcd5071a37a39de902c7141"] 数据校验规则： - 最大长度：100
└ group_ids	string\[\]	否	用户组id列表 示例值：["g193821"] 数据校验规则： - 最大长度：100
is_visible_to_all	boolean	否	是否全员可见 false：否 true：是 不设置：继续保持当前状态不改变 如果参数不设置且当前已经是全员可见，或者设置为true，则add_visible_list/del_visible_list不生效 示例值：false

请求体示例

{
    "add_visible_list": {
        "user_ids": [
            "ou_84aad35d084aa403a838cf73ee18467"
        ],
        "department_ids": [
            "od-4e6ac4d14bcd5071a37a39de902c7141"
        ],
        "group_ids": [
            "g193821"
        ]
    },
    "del_visible_list": {
        "user_ids": [
            "ou_84aad35d084aa403a838cf73ee18467"
        ],
        "department_ids": [
            "od-4e6ac4d14bcd5071a37a39de902c7141"
        ],
        "group_ids": [
            "g193821"
        ]
    },
    "add_invisible_list": {
        "user_ids": [
            "ou_84aad35d084aa403a838cf73ee18467"
        ],
        "department_ids": [
            "od-4e6ac4d14bcd5071a37a39de902c7141"
        ],
        "group_ids": [
            "g193821"
        ]
    },
    "del_invisible_list": {
        "user_ids": [
            "ou_84aad35d084aa403a838cf73ee18467"
        ],
        "department_ids": [
            "od-4e6ac4d14bcd5071a37a39de902c7141"
        ],
        "group_ids": [
            "g193821"
        ]
    },
    "is_visible_to_all": false
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码	错误码	描述	排查建议
400	210001	invalid request	检查请求参数是否正确
200	210002	invalid app_id or app not exists	检查app_id是否存在或者企业是否安装了该应用
200	210003	please check if param is empty or if there is conflicts between add and del list	检查参数add_visible_list/del_visible 或 add_invisible_list/del_invisible_list 中的元素是否有冲突
200	210004	server internal error	服务内部错误
200	210005	invalid group_ids	检查group_id 是否有效
200	210006	can not modify visibility of special app	检查要修改的应用是否为企业管理后台无法修改可用性的应用