权限概述
... 2026-2-4 大约 3 分钟
# 权限概述
# 文件权限 Permission
文件的权限属性,描述了用户在这个文件上持有的API权限信息,如可查看、可编辑、可导出、可删除等,每个权限项对应该用户是否具备对该文件通过 API 发起某个操作的权限。 支持根据members直接修改协作者文档权限
| 参数名 | 类型 | 描述 |
|---|---|---|
| accessPolicy | enum(Policy) | 企业内用户文档权限策略 |
| externalAccessPolicy | enum(Policy) | 企业外用户文档权限策略 |
| members | array(User) | 文件协作者 |
| setting | oneof(SpaceSetting) | 文档权限设置 |
# 权限策略 Policy
| 字段 | 描述 | 可用 fileId 类型 |
|---|---|---|
| PRIVATE | 仅我可查看 | 文档、文件夹、共享空间 |
| MEMBERS | 指定人可查看/编辑 | 文档、文件夹 |
| ANYONE_CAN_VIEW | 所有人可查看 | 文档、文件夹、共享空间 |
| ANYONE_CAN_EDIT | 所有人可编辑 | 文档、文件夹、共享空间 |
| REVIEWED_BY_MEMBER | 由成员审核权限 | 文件夹、共享空间 |
| REVIEWED_BY_ADMIN | 由管理员审核权限 | 文件夹、共享空间 |
| ANYONE_CAN_UPLOAD_DOWNLOAD | 可上传下载 | 文件夹、共享空间 |
| ANYONE_CAN_DOWNLOAD | 可下载 | 文件夹、共享空间 |
# 文档成员 Member
| 参数名 | 类型 | 描述 |
|---|---|---|
| user | array(User) | 文件协作者 |
| role | enum(Role) | 权限允许的角色 |
| actions | array(Action) | 权限允许的行为,仅角色为 CUSTOMIZED_ROLE 时可用 |
# 权限角色 Role
| 字段 | 描述 |
|---|---|
| VIEWER | 查看者 |
| PREVIEWER | 仅预览 |
| EDITOR | 编辑者 |
| ADMIN | 管理员 |
| SUPER_ADMIN | 超级管理员 |
| CAN_DOWNLOAD | 可下载 |
| CAN_UPLOAD_DOWNLOAD | 可上传下载 |
| CUSTOMIZED_ROLE | 自定义角色 |
| BANNED_USER | 拒绝访问 |
| RESPONDENT | 可填写收集表(仅支持收集表品类) |
# 权限行为 Action
权限允许的行为,仅角色为 CUSTOMIZED_ROLE 时有效
| 字段 | 描述 | 备注 |
|---|---|---|
| VIEW | 浏览 | |
| EDIT | 更新 | |
| COPY | 复制 | |
| DOWNLOAD | 下载 | |
| SHARE | 分享 | |
| CREATE_FOLDER | 新建文件夹 | 仅空间/空间内文件夹可设置 |
| UPLOAD | 上传 | 仅空间/空间内文件夹可设置 |
| CREATE_DUPLICATE | 创建副本 | |
| MANAGE_SHAREING_SCOPE | 管理分享范围 | |
| DELETE_PERMANENTLY | 彻底删除 | 仅空间/空间内文件夹/空间内文档可设置 |
| DELETE | 删除 | 仅空间/空间内文件夹/空间内文档可设置 |
| RECOVER | 恢复 | 仅空间/空间内文件夹/空间内文档可设置 |
| MOVE | 移动 | 仅空间/空间内文件夹/空间内文档可设置 |
| ANNOTATION | 标柱 | 仅PDF支持 |
| EDIT_FOLDER | 更新文件夹 | 仅空间/空间内文件夹可设置 |
# 共享空间权限设置 SpaceSetting
| 参数名 | 类型 | 描述 |
|---|---|---|
| confidentialMode | boolean | 是否为保密模式 |
| defaultViewRange | object(ViewRange) | 新建文档/文件夹的默认加入规则(旧,请尽快迁移使用新的接口,旧的会停止维护) |
| defaultFileViewRange | object(FileViewRange) | 新建文档/文件夹的默认加入规则(新) |
| onlyAdminCanManage | boolean | 仅管理员可以增减空间成员和修改文件查看范围 |
| previewWatermark | boolean | 开启文档预览水印 |
| needReview | boolean | 通过链接/二维码加入空间是否需要审批 |
# 默认加入规则 ViewRange
| 字段 | 描述 |
|---|---|
| COLLABORATORS | 仅成员 |
| CORPORATION | 企业内 |
# 默认加入规则 FileViewRange
| 字段 | 描述 |
|---|---|
| NEED_COLLAB_APPROVE | 由文档成员审批权限 |
| VIEW_RANGE_WITH_ENTERPRISE | 可获得浏览权限 |
| EDIT_WITH_ENTERPRISE | 可获得编辑权限 |
| NEED_ADMIN_APPROVE | 仅由管理员审批权限 |