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

批量授权(单个文件)

批量新建文件权限项。如授权主体已存在时,则会更新相应权限角色。

请求说明

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

请求头(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.v7_list_drives 接口返回的 data.items[?].id
file_idstringfile_id 表示文件 id, 参考 drive.v7_list_files 接口返回的 data.items[?].id,支持传 0,表示盘的根目录

请求体(Body)

名称参数类型是否必填说明
notify_subject_userboolean授权后是否通知被授权用户,默认通知
overwriteboolean是否覆盖子文件
role_idstring权限角色。支持仅查看 / 可查看 / 可评论 / 可编辑 / 可管理 (对应接口传参:可查看 viewable(公网)、仅查看 view_only、可编辑 editable、可评论 commentable、可管理 manageable、可分享 shareable(私有云)、禁止访问 prohibited(私有云)) 和自定义权限角色 (自定义权限角色请通过获取权限角色列表 v7_list_drive_roles 获取 role_id;)
subjectsarray[object]授权主体列表
∟ subject_attrobject主体限制条件
∟ ∟ company_idstringsubject_type = dept 时,传递 dept 所在的 company_id
∟ ∟ member_tagstring团队内自定义标签组
∟ subject_idstring权限主体标识
∟ subject_typestring[enum]权限主体类型,支持授权给用户、部门、企业、用户组
companydeptgroupuserdevice

请求地址示例

[POST] https://openapi.wps.cn/v7/drives/{drive_id}/files/{file_id}/permissions/batch_create

请求体示例

json
{
  "notify_subject_user": false,
  "overwrite": false,
  "role_id": "string",
  "subjects": [
    {
      "subject_attr": {
        "company_id": "string",
        "member_tag": "string"
      },
      "subject_id": "string",
      "subject_type": "string[enum]"
    }
  ]
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "msg": "string"
}
回到旧版