开发文档
能力中心
应用市场
WebOffice
开发者后台

新建文档权限角色 ​

新增一个权限角色，角色定义成功后可以用来做文件授权。文件权限角色指包含一些文件操作权限的集合，常见的可编辑 / 可查看 / 可评论等都是权限角色。允许在 Drive 下自定义权限角色

请求说明 ​

请求地址https://openapi.wps.cn/v7/drives/{drive_id}/roles/create
请求方法POST
签名方式KSO-1
权限要求查询和管理文件权限（用户授权） kso.file_permission.readwrite

请求头（Header） ​

Header 名称参数类型是否必填说明
Content-Typestring是使用：application/json
X-Kso-Datestring是RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorizationstring是KSO-1 签名值，详见《签名方法》
Authorizationstring是授权凭证，格式为：Bearer {access_token}

路径参数（Path） ​

名称参数类型说明
drive_idstringdrive_id 表示盘 id，参考 drive.list_drives 接口返回的 data.items[?].id

请求体（Body） ​

名称参数类型是否必填说明
namestring是角色名称
permission_bitsobject否文件操作权限
∟ commentboolean否评论
∟ copyboolean否复制
∟ copy_contentboolean否内容复制
∟ deleteboolean否文件删除
∟ downloadboolean否下载
∟ historyboolean否历史版本，仅公网支持
∟ moveboolean否文件移动
∟ new_emptyboolean否新建
∟ perm_ctlboolean否权限管理
∟ printboolean否打印
∟ renameboolean否文件重命名
∟ saveasboolean否另存为，仅公网支持
∟ secretboolean否安全文档，仅公网支持
∟ shareboolean否分享
∟ updateboolean否编辑 / 更新
∟ uploadboolean否上传：手动上传新版本
permissionsobject否权限
∟ commentboolean否评论
∟ copyboolean否复制
∟ copy_contentboolean否内容复制
∟ deleteboolean否文件删除
∟ downloadboolean否下载
∟ historyboolean否历史版本，仅公网支持
∟ moveboolean否文件移动
∟ new_emptyboolean否新建
∟ perm_ctlboolean否权限管理
∟ printboolean否打印
∟ renameboolean否文件重命名
∟ saveasboolean否另存为，仅公网支持
∟ secretboolean否安全文档，仅公网支持
∟ shareboolean否分享
∟ updateboolean否编辑 / 更新
∟ uploadboolean否上传：手动上传新版本
typestring[enum]否角色类型
preset；custom；file_custom

请求地址示例 ​

[POST] https://openapi.wps.cn/v7/drives/{drive_id}/roles/create

请求体示例 ​

json
{
  "name": "string",
  "permission_bits": {
    "comment": false,
    "copy": false,
    "copy_content": false,
    "delete": false,
    "download": false,
    "history": false,
    "move": false,
    "new_empty": false,
    "perm_ctl": false,
    "print": false,
    "rename": false,
    "saveas": false,
    "secret": false,
    "share": false,
    "update": false,
    "upload": false
  },
  "permissions": {
    "comment": false,
    "copy": false,
    "copy_content": false,
    "delete": false,
    "download": false,
    "history": false,
    "move": false,
    "new_empty": false,
    "perm_ctl": false,
    "print": false,
    "rename": false,
    "saveas": false,
    "secret": false,
    "share": false,
    "update": false,
    "upload": false
  },
  "type": "string[enum]"
}

响应体 ​

名称参数类型说明
codeinteger响应代码。非 0 表示失败，参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ idstring权限角色唯一标识；支持可查看 viewable(公网)、仅查看 view_only、可编辑 editable、可评论 commentable、可管理 manageable、可分享 shareable(私有云)、禁止访问 prohibited(私有云）和自定义权限角色
∟ namestring角色名称，展示用
∟ permission_bitsobject文件操作权限
∟ ∟ commentboolean评论
∟ ∟ copyboolean复制
∟ ∟ copy_contentboolean内容复制
∟ ∟ deleteboolean文件删除
∟ ∟ downloadboolean下载
∟ ∟ historyboolean历史版本，仅公网支持
∟ ∟ moveboolean文件移动
∟ ∟ new_emptyboolean新建
∟ ∟ perm_ctlboolean权限管理
∟ ∟ printboolean打印
∟ ∟ renameboolean文件重命名
∟ ∟ saveasboolean另存为，仅公网支持
∟ ∟ secretboolean安全文档，仅公网支持
∟ ∟ shareboolean分享
∟ ∟ updateboolean编辑 / 更新
∟ ∟ uploadboolean上传：手动上传新版本
∟ permissionsobject权限
∟ ∟ commentboolean评论
∟ ∟ copyboolean复制
∟ ∟ copy_contentboolean内容复制
∟ ∟ deleteboolean文件删除
∟ ∟ downloadboolean下载
∟ ∟ historyboolean历史版本，仅公网支持
∟ ∟ moveboolean文件移动
∟ ∟ new_emptyboolean新建
∟ ∟ perm_ctlboolean权限管理
∟ ∟ printboolean打印
∟ ∟ renameboolean文件重命名
∟ ∟ saveasboolean另存为，仅公网支持
∟ ∟ secretboolean安全文档，仅公网支持
∟ ∟ shareboolean分享
∟ ∟ updateboolean编辑 / 更新
∟ ∟ uploadboolean上传：手动上传新版本
∟ typestring[enum]角色类型
preset；custom；file_custom
moreobject更多的错误信息

响应体示例 ​

json
{
  "code": 0,
  "data": {
    "id": "string",
    "name": "string",
    "permission_bits": {
      "comment": false,
      "copy": false,
      "copy_content": false,
      "delete": false,
      "download": false,
      "history": false,
      "move": false,
      "new_empty": false,
      "perm_ctl": false,
      "print": false,
      "rename": false,
      "saveas": false,
      "secret": false,
      "share": false,
      "update": false,
      "upload": false
    },
    "permissions": {
      "comment": false,
      "copy": false,
      "copy_content": false,
      "delete": false,
      "download": false,
      "history": false,
      "move": false,
      "new_empty": false,
      "perm_ctl": false,
      "print": false,
      "rename": false,
      "saveas": false,
      "secret": false,
      "share": false,
      "update": false,
      "upload": false
    },
    "type": "string[enum]"
  },
  "msg": "string"
}
回到旧版