Skip to content

列举文件权限列表

适用版本>=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-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型是否必填说明
drive_idstring驱动盘id,<= 1024 characters
file_idstring文件id,<= 1024 characters

查询参数(Query)

名称参数类型是否必填说明
subject_idsstring[]Array of strings <= 1024 items [ items <= 1024 characters ]授权主体id列表,需要与subject_type参数配合使用
subject_typestring授权主体类型,可选值:dept:部门;group:团队;user:用户;
with_subject_tagsboolean是否返回授权对象的附属属性标记信息 默认为false
user_idsstring[]用户id列表(待废弃,推荐使用subject_idssubject_type参数)

响应体(Response)

名称类型说明
codeint错误码
detailstring详细信息
msgstring状态信息
dataobject列表信息
has_custom_permissionbool是否有自定义权限,用于重置功能
itemsobjectArray of objects <= 1024 items
idstring<= 1024 characters,权限id
role_idstring<= 1024 characters,角色id
role_namestring<= 1024 characters,角色名称
subject_avatarstring<= 1024 characters,权限主体头像信息
subject_idstring<= 1024 characters,权限主体标识
subject_namestring<= 1024 characters,权限主体名称
subject_typestring<= 1024 characters,Enum: “dept” “group” "user"权限主体类型
subject_tagsstring[]传递权限授权对象的附属属性标签
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"
}