列举文件权限列表
适用版本>=v7.0.2410as.20241017
接口说明:获取文件权限列表
请求说明
| 请求地址 | 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/permissions |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 查询和管理文件权限(用户授权) kso.file_permission.readwrite 查询文件权限(用户授权) kso.file_permission.read |
请求头(Header)
| Header | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| 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 | 是 | 驱动盘id,<= 1024 characters |
| file_id | string | 是 | 文件id,<= 1024 characters |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| subject_ids | string[] | 否 | Array of strings <= 1024 items [ items <= 1024 characters ]授权主体id列表,需要与subject_type参数配合使用 |
| subject_type | string | 否 | 授权主体类型,可选值:dept:部门;group:团队;user:用户; |
| with_subject_tags | boolean | 否 | 是否返回授权对象的附属属性标记信息 默认为false |
| user_ids | string[] | 否 | 用户id列表(待废弃,推荐使用subject_ids和subject_type参数) |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 |
| detail | string | 详细信息 |
| msg | string | 状态信息 |
| data | object | 列表信息 |
| ∟ has_custom_permission | bool | 是否有自定义权限,用于重置功能 |
| ∟ items | object | Array of objects <= 1024 items |
| ∟ ∟ id | string | <= 1024 characters,权限id |
| ∟ ∟ role_id | string | <= 1024 characters,角色id |
| ∟ ∟ role_name | string | <= 1024 characters,角色名称 |
| ∟ ∟ subject_avatar | string | <= 1024 characters,权限主体头像信息 |
| ∟ ∟ subject_id | string | <= 1024 characters,权限主体标识 |
| ∟ ∟ subject_name | string | <= 1024 characters,权限主体名称 |
| ∟ ∟ subject_type | string | <= 1024 characters,Enum: “dept” “group” "user"权限主体类型 |
| ∟ ∟ subject_tags | string[] | 传递权限授权对象的附属属性标签group_member:文件所在团队内成员;external_contact:(是 或 包含)外部联系人;enterprise_partner:(是 或 包含)关联组织成员; |
响应体示例
json
{
"data": {
"has_custom_permission": true,
"items": [
{
"id": "string",
"role_id": "string",
"role_name": "string",
"subject_avatar": "string",
"subject_id": "string",
"subject_name": "string",
"subject_tags": ["group_member"],
"subject_type": "group"
}
]
},
"code": 0,
"detail": "string",
"msg": "string"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20