批量授权(单个文件)
批量新建文件权限项。如授权主体已存在时,则会更新相应权限角色。
请求说明
请求地址 | https://openapi.wps.cn/v7/drives/{drive_id}/files/{file_id}/permissions/batch_create |
---|---|
请求方法 | POST |
签名方式 | KSO-1 |
权限要求 | 查询和管理文件权限(用户授权) kso.file_permission.readwrite |
请求头(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.v7_list_drives 接口返回的 data.items[?].id |
file_id | string | file_id 表示文件 id, 参考 drive.v7_list_files 接口返回的 data.items[?].id,支持传 0,表示盘的根目录 |
请求体(Body)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
notify_subject_user | boolean | 否 | 授权后是否通知被授权用户,默认通知 |
overwrite | boolean | 是 | 是否覆盖子文件 |
role_id | string | 是 | 权限角色。支持仅查看 / 可查看 / 可评论 / 可编辑 / 可管理 (对应接口传参:可查看 viewable(公网)、仅查看 view_only、可编辑 editable、可评论 commentable、可管理 manageable、可分享 shareable(私有云)、禁止访问 prohibited(私有云)) 和自定义权限角色 (自定义权限角色请通过获取权限角色列表 v7_list_drive_roles 获取 role_id;) |
subjects | array[object] | 是 | 授权主体列表 |
∟ subject_attr | object | 否 | 主体限制条件 |
∟ ∟ company_id | string | 否 | subject_type = dept 时,传递 dept 所在的 company_id |
∟ ∟ member_tag | string | 否 | 团队内自定义标签组 |
∟ subject_id | string | 是 | 权限主体标识 |
∟ subject_type | string[enum] | 是 | 权限主体类型,支持授权给用户、部门、企业、用户组 company ;dept ;group ;user ;device |
请求地址示例
[POST] https://openapi.wps.cn/v7/drives/{drive_id}/files/{file_id}/permissions/batch_create
1
请求体示例
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]"
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"msg": "string"
}
1
2
3
4
2
3
4