删除文档权限角色
即将被删除的文档权限角色可能被授权引用,需要指明删除后已存在的授权如何处理,目前支持替换、删除两种方式
请求说明
请求地址 | https://openapi.wps.cn/v7/drives/{drive_id}/roles/{role_id}/delete |
---|---|
请求方法 | 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.list_drives 接口返回的 data.items[?].id |
role_id | string | role_id 表示权限角色 id, 参考 list_roles 接口返回的 data.imems[?].id |
请求体(Body)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
policy | string[enum] | 是 | 删除策略 remove ;replace |
replace_role_id | string | 否 | 权限角色。支持仅查看 / 可查看 / 可评论 / 可编辑 / 可管理 (对应接口传参:可查看 viewable(公网)、仅查看 view_only、可编辑 editable、可评论 commentable、可管理 manageable、可分享 shareable(私有云)、禁止访问 prohibited(私有云)) 和自定义权限角色 (自定义权限角色请通过获取权限角色列表 v7_list_drive_roles 获取 role_id;) |
请求地址示例
[POST] https://openapi.wps.cn/v7/drives/{drive_id}/roles/{role_id}/delete
1
请求体示例
json
{
"policy": "string[enum]",
"replace_role_id": "string"
}
1
2
3
4
2
3
4
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"msg": "string"
}
1
2
3
4
2
3
4