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

列举文件权限列表

列举文件权限列表

请求说明

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

请求头(Header)

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

路径参数(Path)

名称参数类型说明
drive_idstringdrive_id 表示盘 id,参考 drive.list_drives 接口返回的 data.items[?].id
file_idstringfile_id 表示文件 id, 参考 drive.list_file 接口返回的 data.items[?].id,支持传 0,表示盘的根目录

查询参数(Query)

名称参数类型是否必填说明
subject_idsarray传入授权主体 id
subject_typeobject类型筛选

请求地址示例

[GET] https://openapi.wps.cn/v7/drives/{drive_id}/files/{file_id}/permissions?subject_ids={array_1}&subject_ids={array_2}&subject_type={object}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ has_custom_permissionboolean是否有自定义权限,用于重置功能
∟ itemsarray[object]
∟ ∟ idstring权限 id
∟ ∟ role_idstring角色 id
∟ ∟ role_namestring角色名称
∟ ∟ subject_attr
∟ ∟ subject_avatarstring权限主体头像信息
∟ ∟ subject_idstring权限主体标识
∟ ∟ subject_namestring权限主体名称
∟ ∟ subject_typestring[enum]权限主体类型
companydeptgroupuserdevice
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "has_custom_permission": false,
    "items": [
      {
        "id": "string",
        "role_id": "string",
        "role_name": "string",
        "subject_attr": "",
        "subject_avatar": "string",
        "subject_id": "string",
        "subject_name": "string",
        "subject_type": "string[enum]"
      }
    ]
  },
  "msg": "string"
}
回到旧版