# 更新妙搭应用可用范围
更新妙搭应用可用范围
## 请求
基本 |
---|---
HTTP URL | https://open.feishu.cn/open-apis/spark/v1/apps/:app_id/access-scope
HTTP Method | PUT
接口频率限制 | [特殊频控](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 创建与更新妙搭应用(spark:app:write)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `user_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"
### 路径参数
名称 | 类型 | 描述
---|---|---
app_id | string | 妙搭应用的唯一标识，用于指定需要更新可见范围的目标应用。可通过调用「获取妙搭应用列表」接口或在妙搭控制台应用详情页获取。
**示例值**："app_4k6af8utt2s0n"
### 查询参数
名称 | 类型 | 必填 | 描述
---|---|---|---
user_id_type | string | 否 | 用户 ID 类型
**示例值**：open_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly)
### 请求体
名称 | 类型 | 必填 | 描述
---|---|---|---
users | string\[\] | 否 | 仅 Scope = Range 时生效，授权用户 open_id 列表
**示例值**：["ou_1234567890abcdef1234567890abcdef"]
departments | string\[\] | 否 | 仅 Scope = Range 时生效，授权部门 department_id 列表
**示例值**：["od_1234567890abcdef1234567890abcdef"]
**数据校验规则**：
- 长度范围：`1` ～ `200`
chats | string\[\] | 否 | 仅 Scope= Range 时生效，授权群聊 chat_id 列表
**示例值**：["oc_1234567890abcdef1234567890abcdef"]
apply_config | apply_config | 否 | 申请访问配置（含审批人，仅支持单个用户 open_id）
enabled | boolean | 否 | 控制审批流程是否启用。设为true时，提交申请后将触发配置的审批流程；设为false时，申请将直接通过无需审批。
**示例值**：true
approvers | string\[\] | 否 | 仅支持配置一个用户 open_id
**示例值**：["ou_1234567890abcdef1234567890abcdef"]
require_login | boolean | 否 | 访问 Share URL 是否需要登录
**示例值**：true
scope | string | 是 | 可见范围类型：Public / Tenant / Range
Public: 互联网公开可见
Tenant: 组织内可见
Range: 部分人员/部门/租户可见
**示例值**："Range"
### 请求体示例
```json
{
"users": [
"ou_1234567890abcdef1234567890abcdef"
],
"departments": [
"od_1234567890abcdef1234567890abcdef"
],
"chats": [
"oc_1234567890abcdef1234567890abcdef"
],
"apply_config": {
"enabled": true,
"approvers": [
"ou_1234567890abcdef1234567890abcdef"
]
},
"require_login": true,
"scope": "Range"
}
```
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
### 响应体示例
```json
{
"code": 0,
"msg": "success",
"data": {}
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 3340001 | param is invalid | 输入参数不合法，请检查输入参数
409 | 3340002 | Application has not been published yet. Access scope operations require the app to be published first. | 应用尚未发布，请先发布应用后再操作可用范围