# 权限概述

权限是指在云文档相关资源中，应用或用户对各类云文档资源，如文件夹、文档、电子表格、多维表格、知识库等的可阅读、可编辑、可管理等权限。本文档介绍云文档权限相关的基本概念、接入流程、方法列表等。

![image.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/a7cacfdf42252efc5b796eae7081dd12_6XW39EJYzg.png?height=763&lazyload=true&maxWidth=300&width=595)
## 基本概念
以下为云文档权限相关的基础概念。了解更多，参考飞书帮助中心文档[云文档权限概念介绍](https://www.feishu.cn/hc/zh-CN/articles/329948394104-%E4%BA%91%E6%96%87%E6%A1%A3%E6%9D%83%E9%99%90%E6%A6%82%E5%BF%B5%E4%BB%8B%E7%BB%8D)。

概念 | 描述
---|---
云文档 | 飞书提供文档、表格、多维表格等多种内容类型，你也可以将本地文件上传至飞书云文档。以上内容统称为云文档。
所有者 | 云文档、文件、文件夹的所有者。
协作者 | 有可阅读、可编辑或可管理权限的云文档、文件、文件夹的成员。
协作者权限 | 云文档和文件夹支持 3 种权限类型：阅读、编辑、管理。
可阅读 | - 有可阅读权限的协作者只能阅读文档和文件夹内的文档内容。<br>- 可移除同为可阅读权限的协作者。
可编辑 | - 有可编辑权限的协作者可以阅读、编辑文档和文件夹内的文档内容。<br>- 可修改、移除有阅读、可编辑权限的协作者。
可管理 | - 有可管理权限的协作者可以阅读、编辑文档和文件夹内的文档内容。<br>- 可修改、移除有阅读、编辑、可管理权限的协作者。<br>- 可管理文档权限设置。<br>- 文档所有者的权限类型也是可管理权限，且可转移文档所有权。

## 接入流程

序号 | 步骤 | 操作方法
---|---|---
1 | 创建应用 | 根据应用的使用场景选择[创建企业自建应用](https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process) 或[创建应用商店应用](https://open.feishu.cn/document/uMzNwEjLzcDMx4yM3ATM/uYzNwEjL2cDMx4iN3ATM)
2 | 申请接口调用权限 | 根据需要调用的[接口文档](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/create)中描述的「**权限要求**」到[开发者后台](https://open.feishu.cn/app)[申请应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN#af863cb3)
3 | 访问应用自有资源 | [访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)使用 tenant_access_token 可以直接访问应用自有资源： [文件夹](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction)、[文档](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/docs-doc-overview)、[电子表格](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)、[多维表格](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)
4 | 访问用户自有资源 | [访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)使用 user_access_token 可以直接访问用户自有资源： [文件夹](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction)、[文档](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/docs-doc-overview)、[电子表格](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)、[多维表格](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)
5 | 使用tenant_access_token<br>访问应用非自有资源 | 1. 访问其他用户的[文档](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/docs-doc-overview)、[电子表格](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)、[多维表格](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)<br>需要取得[文档所有者](https://open.feishu.cn/document/ukTMukTMukTM/uQzNzUjL0czM14CN3MTN)的授权<br>- 需要**应用**开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bot-v3/bot-overview)<br>- 需要所有者打开对应的文档，在页面右上方「**...**」->「**...更多**」-> 「**添加文档应用**」入口添加<br>2. 访问 [知识库](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview)需要获得知识库管理员的授权<br>- 需要**应用**开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bot-v3/bot-overview)<br>- 需要知识库管理员打开知识库节点文档，在页面右上方「**...**」->「**...更多**」-> 「**添加文档应用**」入口添加
6 | 使用user_access_token<br>访问用户非自有资源 | 1. 访问其他用户的[文档](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/docs-doc-overview)、[电子表格](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)、[多维表格](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)<br>需要取得[文档所有者](https://open.feishu.cn/document/ukTMukTMukTM/uQzNzUjL0czM14CN3MTN)的授权<br>- 需要所有者打开对应的文档，在页面右上方「**分享**」入口添加<br>2. 访问其他用户[文件夹](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction)需要取得文件夹所有者的授权<br>- 需要所有者在**我的空间**找到目标文件夹，右键菜单中「**分享**」入口添加<br>3. 访问[知识库](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview)需要获得知识库管理员的授权<br>- 需要知识库管理员打开知识库节点文档，在页面右上方「**分享**」入口添加
7 | 接口测试 | 你可以在 [API 调试台![API cn.svg](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/90b013d1fc7c191381d3edd6cf147707_3VtIkELbfg.svg?height=24&lazyload=true&width=87)](https://open.feishu.cn/api-explorer?from=guide)中快速调试这些 API ，使用方法参见[API 调试台使用指南](https://open.feishu.cn/document/tools-and-resources/api-explorer-guide)
8 | 事件订阅 | 需要到[开发者后台](https://open.feishu.cn/app)[配置事件回调地址](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM#2eb3504a),确保回调地址公网可访问。可参考[事件监听示例](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)、[事件订阅概述](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM#2eb3504a)
9 | 日志检索 | 当调用接口返回失败时，从返回的header部分获取 X-Tt-Logid: `20220501181xxx8035096193288FA`。<br>再到应用管理后台，用[服务端日志检索](https://open.feishu.cn/document/tools-and-resources/open-api-log-query) 分析问题。

## 资源介绍

云文档的权限由 **成员** 和 **设置** 两部分资源组成。参考本小节了解权限相关接口的资源说明。

### 成员

权限成员分为 **文档所有者** 和 **文档协作者**。

成员 | 描述 | 支持成员及 ID 类型
---|---|---
文档所有者 | 云文档、文件、文件夹的所有者。 | - 用户，支持用户邮箱、用户的 OpenID、UnionID 或 UserID。获取方式参考[如何获取不同的用户 ID](https://open.feishu.cn/document/home/user-identity-introduction/open-id)<br>- 应用，支持应用的 OpenID。获取方式参考[如何获取应用 open_id](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#6dbaa8df)
文档协作者 | 有可阅读、可编辑或可管理权限的云文档、文件、文件夹的成员。 | - 用户，支持用户邮箱、用户的 OpenID、UnionID 或 UserID。获取方式参考[如何获取不同的用户 ID](https://open.feishu.cn/document/home/user-identity-introduction/open-id)<br>- 应用，支持应用的 OpenID。获取方式参考[如何获取应用 open_id](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#6dbaa8df)<br>- 群组，支持 `chat_id`，获取方式参考[群 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)<br>- 部门，支持 `open_department_id`，获取方式参考[部门资源介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)<br>- 自定义用户组，支持 `group_id` ，获取方式参考[用户组资源介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/overview)<br>- 知识库成员，支持 `wikispaceid`，获取方式参考[知识库概述](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview)

### 设置
权限设置具体的权限点如下所示：

权限点 | 描述
---|---
允许内容被分享到组织外 | 支持允许内容仅被分享给关联组织。解关联组织，参考飞书帮助中心文档[关联组织介绍](https://www.feishu.cn/hc/zh-CN/articles/657083794612-%E5%85%B3%E8%81%94%E7%BB%84%E7%BB%87%E4%BB%8B%E7%BB%8D)。
可以复制内容 | 设置谁可以复制内容，支持设置仅可阅读、仅可编辑、仅可管理的人可复制内容。
可以创建副本、打印、下载 | 设置谁可以创建副本、打印、下载，支持设置仅可阅读、仅可编辑、仅可管理的人可创建副本、打印、下载。
可以评论 | 设置谁可以评论，支持设置仅可阅读、仅可编辑的人可评论。
谁可以查看、添加、移除协作者 | 支持两个维度设置：<br>-   从企业组织维度，设置谁可以查看、添加、移除协作者<br>- 从协作者维度，设置设置谁可以查看、添加、移除协作者
链接分享设置 | 支持设置仅关联组织的可通过链接编辑或阅读。
密码 | **链接分享** 设置为“互联网获得链接的人可编辑/可阅读”后，支持启用密码。

## 方法列表

### 成员

**[方法 (API)](https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM)** | 权限要求（满足任一） | **[访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)（选择其一）** | 商店 | 自建
---|---|---|---|---
[增加协作者权限](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/create)<br>`POST` /open-apis/drive/v1/permissions/:token/members | 查看、评论、编辑和管理文档(docs:doc)<br>查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>上传、下载文件到云空间(drive:file)<br>查看、评论、编辑和管理电子表格(sheets:spreadsheet)<br>查看、编辑和管理知识库(wiki:wiki) | `tenant_access_token`<br>`user_access_token` | **✓** | **✓**
[更新协作者权限](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/update)<br>`PUT` /open-apis/drive/v1/permissions/:token/members/:member_id | 查看、评论、编辑和管理文档(docs:doc)<br>查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>上传、下载文件到云空间(drive:file)<br>查看、评论、编辑和管理电子表格(sheets:spreadsheet)<br>查看、编辑和管理知识库(wiki:wiki) | `tenant_access_token`<br>`user_access_token` | **✓** | **✓**
[移除协作者权限](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/delete)<br>`DELETE` /open-apis/drive/v1/permissions/:token/members/:member_id | 查看、评论、编辑和管理文档(docs:doc)<br>查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>上传、下载文件到云空间(drive:file)<br>查看、评论、编辑和管理电子表格(sheets:spreadsheet)<br>查看、编辑和管理知识库(wiki:wiki) | `tenant_access_token`<br>`user_access_token` | **✓** | **✓**
[判断协作者是否有某权限](https://open.feishu.cn/document/ukTMukTMukTM/uYzN3UjL2czN14iN3cTN)<br>`POST` /open-apis/drive/permission/member/permitted | 查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>查看、评论和下载云空间中所有文件(drive:drive:readonly)<br>上传、下载文件到云空间(drive:file)<br>查看和下载云空间中的文件(drive:file:readonly)<br>查看、评论、编辑和管理文档(docs:doc)<br>查看、评论和导出文档(docs:doc:readonly)<br>查看、评论、编辑和管理表格(sheets:spreadsheet)<br>查看、评论和导出表格(sheets:spreadsheet:readonly) | `tenant_access_token`<br>`user_access_token` | **✓** | **✓**
[获取协作者列表](https://open.feishu.cn/document/ukTMukTMukTM/uATN3UjLwUzN14CM1cTN)<br>`POST` /open-apis/drive/permission/member/list | 查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>查看、评论和下载云空间中所有文件(drive:drive:readonly)<br>上传、下载文件到云空间(drive:file)<br>查看和下载云空间中的文件(drive:file:readonly)<br>查看、评论、编辑和管理文档(docs:doc)<br>查看、评论和导出文档(docs:doc:readonly)<br>查看、评论、编辑和管理表格(sheets:spreadsheet)<br>查看、评论和导出表格(sheets:spreadsheet:readonly) | `tenant_access_token`<br>`user_access_token` | **✓** | **✓**
[转移拥有者](https://open.feishu.cn/document/ukTMukTMukTM/uQzNzUjL0czM14CN3MTN)<br>`POST` /open-apis/drive/permission/member/transfer | 查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>上传、下载文件到云空间(drive:file)<br>查看、评论、编辑和管理文档(docs:doc)<br>查看、评论、编辑和管理表格(sheets:spreadsheet) | `tenant_access_token`<br>`user_access_token` | **✓** | **✓**

### 权限设置

**[方法 (API)](https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM)** | 权限要求（满足任一） | **[访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)（选择其一）** | 商店 | 自建
---|---|---|---|---
[获取云文档权限设置](https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/get)<br>`GET` /open-apis/drive/v2/permissions/:token/public | 查看、评论、编辑和管理文档(docs:doc)<br>查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>查看、评论和下载云空间中所有文件(drive:drive:readonly)<br>上传、下载文件到云空间(drive:file)<br>查看、评论、编辑和管理电子表格(sheets:spreadsheet)<br>查看、编辑和管理知识库(wiki:wiki) | `tenant_access_token`<br>`user_access_token` | **✓** | **✓**
[更新云文档权限设置](https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/patch)<br>`PATCH` /open-apis/drive/v2/permissions/:token/public | 查看、评论、编辑和管理文档(docs:doc)<br>查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>上传、下载文件到云空间(drive:file)<br>查看、评论、编辑和管理电子表格(sheets:spreadsheet)<br>查看、编辑和管理知识库(wiki:wiki) | `tenant_access_token`<br>`user_access_token` | **✓** | **✓**
[启用云文档密码](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/create)<br>`POST` /open-apis/drive/v2/permissions/:token/public/password | 查看、评论、编辑和管理文档(docs:doc)<br>查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>上传、下载文件到云空间(drive:file)<br>查看、评论、编辑和管理电子表格(sheets:spreadsheet)<br>查看、编辑和管理知识库(wiki:wiki) | `tenant_access_token`<br>`user_access_token` | **✓** | **✓**
[刷新云文档密码](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/update)<br>`PUT` /open-apis/drive/v2/permissions/:token/public/password | 查看、评论、编辑和管理文档(docs:doc)<br>查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>上传、下载文件到云空间(drive:file)<br>查看、评论、编辑和管理电子表格(sheets:spreadsheet)<br>查看、编辑和管理知识库(wiki:wiki) | `tenant_access_token`<br>`user_access_token` | **✓** | **✓**
[停用云文档密码](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/delete)<br>`DELETE` /open-apis/drive/v2/permissions/:token/public/password | 查看、评论、编辑和管理文档(docs:doc)<br>查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>上传、下载文件到云空间(drive:file)<br>查看、评论、编辑和管理电子表格(sheets:spreadsheet)<br>查看、编辑和管理知识库(wiki:wiki) | `tenant_access_token`<br>`user_access_token` | **✓** | **✓**

