获取文档权限角色列表

获取文档权限角色列表

请求说明

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

请求头（Header）

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

路径参数（Path）

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

请求地址示例

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

响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	响应数据
∟ items	array[object]
∟ ∟ id	string	权限角色唯一标识；支持可查看 viewable(公网)、仅查看 view_only、可编辑 editable、可评论 commentable、可管理 manageable、可分享 shareable(私有云)、禁止访问 prohibited(私有云）和自定义权限角色
∟ ∟ name	string	角色名称，展示用
∟ ∟ permission_bits	object	文件操作权限
∟ ∟ ∟ comment	boolean	评论
∟ ∟ ∟ copy	boolean	复制
∟ ∟ ∟ copy_content	boolean	内容复制
∟ ∟ ∟ delete	boolean	文件删除
∟ ∟ ∟ download	boolean	下载
∟ ∟ ∟ history	boolean	历史版本，仅公网支持
∟ ∟ ∟ move	boolean	文件移动
∟ ∟ ∟ new_empty	boolean	新建
∟ ∟ ∟ perm_ctl	boolean	权限管理
∟ ∟ ∟ print	boolean	打印
∟ ∟ ∟ rename	boolean	文件重命名
∟ ∟ ∟ saveas	boolean	另存为，仅公网支持
∟ ∟ ∟ secret	boolean	安全文档，仅公网支持
∟ ∟ ∟ share	boolean	分享
∟ ∟ ∟ update	boolean	编辑 / 更新
∟ ∟ ∟ upload	boolean	上传：手动上传新版本
∟ ∟ permissions	object	权限
∟ ∟ ∟ comment	boolean	评论
∟ ∟ ∟ copy	boolean	复制
∟ ∟ ∟ copy_content	boolean	内容复制
∟ ∟ ∟ delete	boolean	文件删除
∟ ∟ ∟ download	boolean	下载
∟ ∟ ∟ history	boolean	历史版本，仅公网支持
∟ ∟ ∟ move	boolean	文件移动
∟ ∟ ∟ new_empty	boolean	新建
∟ ∟ ∟ perm_ctl	boolean	权限管理
∟ ∟ ∟ print	boolean	打印
∟ ∟ ∟ rename	boolean	文件重命名
∟ ∟ ∟ saveas	boolean	另存为，仅公网支持
∟ ∟ ∟ secret	boolean	安全文档，仅公网支持
∟ ∟ ∟ share	boolean	分享
∟ ∟ ∟ update	boolean	编辑 / 更新
∟ ∟ ∟ upload	boolean	上传：手动上传新版本
∟ ∟ type	string[enum]	角色类型 preset；custom；file_custom
more	object	更多的错误信息

响应体示例

{
  "code": 0,
  "data": {
    "items": [
      {
        "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"
}