服务端 API/云文档/权限/设置 v1/更新文档公共设置 # 更新文档公共设置 该接口用于根据 filetoken 更新文档的公共设置。 ## 请求 基本 |   ---|--- HTTP URL | https://open.larksuite.com/open-apis/drive/v1/permissions/:token/public HTTP Method | PATCH 支持的应用类型 | Custom App、Store App 权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用**
开启任一权限即可 | 上传、下载文件到云空间(drive:file)
查看、编辑和管理知识库(wiki:wiki)
查看、评论、编辑和管理云空间中所有文件(drive:drive)
查看、评论、编辑和管理文档(docs:doc)
查看、评论、编辑和管理电子表格(sheets:spreadsheet) ### 请求头 名称 | 类型 | 必填 | 描述 ---|---|---|--- Authorization | string | 是 | `tenant_access_token`
或
`user_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：获取与使用access_token](https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM) Content-Type | string | 是 | **固定值**："application/json; charset=utf-8" 关于云文档接口的 AccessToken 调用说明详见 [云文档接口快速入门](https://open.larksuite.com/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN) ### 路径参数 名称 | 类型 | 描述 ---|---|--- token | string | 文件的 token，获取方式见 [概述](https://open.larksuite.com/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction)
**示例值**："doccnBKgoMyY5OMbUG6FioTXuBe" ### 查询参数 名称 | 类型 | 必填 | 描述 ---|---|---|--- type | string | 是 | 权限客体类型，放于query参数中，如：`?type=doc`
**示例值**："doc"
**可选值有**：
- `doc`：文档
- `sheet`：电子表格
- `file`：云空间文件
- `wiki`：知识库节点（部分支持）
- `bitable`：多维表格
- `docx`：文档（暂不支持） **提示** `wiki`: 知识库节点 暂不支持以下设置： - `external_access`: 是否允许分享到租户外开关 - `share_entity`: 谁可以添加和管理协作者 - `invite_external`: 非所有权限者/所有者是否允许邀请外部人 - `link_share_entity`: 链接共享 - `tenant_readable`: 获得链接的任何人可阅读 - `tenant_editable`: 获得链接的任何人可编辑 ### 请求体 名称 | 类型 | 必填 | 描述 ---|---|---|--- external_access | boolean | 否 | 是否允许分享到租户外开关
**示例值**：true security_entity | string | 否 | 可创建副本/打印/导出/复制设置
**示例值**："anyone_can_view"
**可选值有**：
- `anyone_can_view`：所有可访问此文档的用户
- `anyone_can_edit`：有编辑权限的用户 comment_entity | string | 否 | 可评论设置
**示例值**："anyone_can_view"
**可选值有**：
- `anyone_can_view`：所有可访问此文档的用户
- `anyone_can_edit`：有编辑权限的用户 share_entity | string | 否 | 谁可以添加和管理协作者
**示例值**："anyone"
**可选值有**：
- `anyone`：所有可阅读或编辑此文档的用户
- `same_tenant`：组织内所有可阅读或编辑此文档的用户
- `only_full_access`：只有所有权限者可以 link_share_entity | string | 否 | 链接共享
**示例值**："tenant_readable"
**可选值有**：
- `tenant_readable`：组织内获得链接的人可阅读
- `tenant_editable`：组织内获得链接的人可编辑
- `anyone_readable`：获得链接的任何人可阅读（仅`external_access=true`时有效）
- `anyone_editable`：获得链接的任何人可编辑（仅`external_access=true`时有效）
- `closed`：关闭链接分享 invite_external | boolean | 否 | 非所有权限者/所有者是否允许邀请外部人
**示例值**：true ### 请求体示例 ```json { "external_access": true, "security_entity": "anyone_can_view", "comment_entity": "anyone_can_view", "share_entity": "anyone", "link_share_entity": "tenant_readable", "invite_external": true } ``` ## 响应 ### 响应体 名称 | 类型 | 描述 ---|---|--- code | int | 错误码，非 0 表示失败 msg | string | 错误描述 data | \- | \-  ∟ permission_public | permission_public | 本次更新后的文档公共设置   ∟ external_access | boolean | 是否允许分享到租户外开关   ∟ security_entity | string | 可创建副本/打印/导出/复制设置
**可选值有**：
- `anyone_can_view`：所有可访问此文档的用户
- `anyone_can_edit`：有编辑权限的用户   ∟ comment_entity | string | 可评论设置
**可选值有**：
- `anyone_can_view`：所有可访问此文档的用户
- `anyone_can_edit`：有编辑权限的用户   ∟ share_entity | string | 谁可以添加和管理协作者
**可选值有**：
- `anyone`：所有可阅读或编辑此文档的用户
- `same_tenant`：组织内所有可阅读或编辑此文档的用户
- `only_full_access`：只有所有权限者可以   ∟ link_share_entity | string | 链接共享
**可选值有**：
- `tenant_readable`：组织内获得链接的人可阅读
- `tenant_editable`：组织内获得链接的人可编辑
- `anyone_readable`：获得链接的任何人可阅读（仅`external_access=true`时有效）
- `anyone_editable`：获得链接的任何人可编辑（仅`external_access=true`时有效）
- `closed`：关闭链接分享   ∟ invite_external | boolean | 非所有权限者/所有者是否允许邀请外部人 ### 响应体示例 ```json { "code": 0, "msg": "success", "data": { "permission_public": { "external_access": true, "security_entity": "anyone_can_view", "comment_entity": "anyone_can_view", "share_entity": "anyone", "link_share_entity": "tenant_readable", "invite_external": true } } } ``` ### 错误码 HTTP状态码 | 错误码 | 描述 | 排查建议 ---|---|---|--- 400 | 1061001 | internal error | 服务内部错误，包括超时，错误码没处理。 403 | 1061002 | params error. | 请检查请求参数是否正确，如：`member_id`是否正确、协作者是否真实存在等。 400 | 1061003 | not found. | 请确认对应上传节点是否存在。 403 | 1061004 | forbidden. | 请确认当前身份是否有对应上传节点的的权限，如用户是否有上传到指定doc的编辑权限。 404 | 1061005 | auth failed. | 请使用正确身份访问该接口。 500 | 1066001 | Internal Error | 服务内部错误，包括超时，错误码没处理。 500 | 1066002 | Concurrency error, please retry | 服务内部错误，请重试。