判断用户权限
判断当前请求的应用或用户是否具有指定云文档的指定权限,权限包括阅读、编辑、分享、评论、导出等权限。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/drive/v1/permissions/:token/members/auth |
| HTTP Method | GET |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | bitable:app 查看、评论、编辑和管理多维表格 wiki:wiki 查看、编辑和管理知识库 docs:doc 查看、评论、编辑和管理文档 docs:permission.member:auth 判断当前用户是否有云文档权限 drive:drive 查看、评论、编辑和管理云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 bitable:bitable 查看、评论、编辑和管理多维表格(套件内) |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
token | string | 云文档的 token,需要与 type 参数指定的云文档类型相匹配。可参考如何获取云文档资源相关 token。 示例值:"doccnBKgoMyY5OMbUG6Fioabcef" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
type | string | 是 | 云文档类型,需要与云文档的 token 相匹配。 示例值:docx 可选值有: - doc: 旧版文档。了解更多,参考新旧版本文档说明。 - sheet: 电子表格 - file: 云空间文件 - wiki: 知识库节点 - bitable: 多维表格 - docx: 新版文档 - mindnote: 思维笔记 - minutes: 妙记 - slides: 幻灯片 |
action | string | 是 | 需要判断的权限 示例值:view 可选值有: - view: 阅读 - edit: 编辑 - share: 分享 - comment: 评论 - export: 导出 - copy: 拷贝 - print: 打印 - manage_public: 管理权限设置 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ auth_result | boolean | 当前应用或用户是否有指定的权限。可选值: - true:当前应用或用户具有该权限 - false:当前应用或用户没有该权限 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"auth_result": true
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1063001 | Invalid parameter | 参数异常,可能是如下原因: - 参数类型不匹配,如: - 云文档的 token 和 type 不匹配 - 云文档不存在 - 添加协作者的 member_id 和 member_type 不匹配 - 添加的协作者不存在 - 不支持的参数调用,如: - 使用 tenant_access_token 添加部门协作者 - 给妙记添加可管理角色 |
| 400 | 1063003 | Invalid operation | 非法操作。该错误码表示基本参数校验没有问题,但操作不被允许,可能是如下原因: - 云文档的协作者数量到达上限,请减少协作者数量 - 因企业设置的管控策略而无法修改权限 - 受可见性限制无法修改权限。例如: - 添加用户协作者:需要调用身份与被授权对象为联系人或同组织内可搜索,且互相未屏蔽。 - 添加群协作者:需要调用身份在群内。要使用 tenant_access_token 身份添加群协作者,则需要将该应用作为机器人添加至群组中,使应用对群可见。详细步骤参考如何为应用开通云文档相关资源的权限。 - 添加部门协作者:需要调用身份对部门可见。由于应用对企业内的组织架构都不可见,所以暂不支持通过 tenant_access_token 添加部门协作者。 - 给文档所有者添加权限(不允许对文档所有者操作权限) - 协作者本身已有的权限大于请求参数内设置的权限 |
| 404 | 1063005 | Resource is deleted | 资源已删除,请确认云文档是否还存在。 |
| 429 | 1063006 | Too many request | 请求发生限频,请降低请求频率并稍后重试。 |
| 500 | 1066001 | Internal Error | 服务内部错误,包括服务端内部超时、错误码没处理等,请联系技术支持排查。 |
| 500 | 1066002 | Concurrency error, please retry | 服务内部错误,请重试或联系技术支持排查。 |
