Help Center/ KooDrive/ API Reference/ API/ Refined Authorization/ Obtaining the User Permissions List
Updated on 2025-08-28 GMT+08:00

Obtaining the User Permissions List

Function

Obtain the user permissions list.

URI

GET /koodrive/ose/v1/permission/userList

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

templateId

No

String

Permissions template ID.

  • -1: anonymous template.

  • Other values: ID of a named template.

spaceType

Yes

Integer

Space type.

  • 0: department.

  • 1: group.

groupId

No

String

Group ID (mandatory when the space type is set to 1).

deptId

No

String

Department ID (mandatory when the space type is set to 0).

count

No

Integer

Number of records to be returned. Maximum value: 100.

cursor

No

String

Cursor, which is not transferred for the first call. (For subsequent calls, obtain the cursor from the previous response body to return results starting from the user next to the last user in the previous response.)

containerId

Yes

String

Space ID.

userName

No

String

Username.

fileId

No

String

File ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

  1. The format is Bearer {app_access_token}. The application-level token needs to be passed for calling by an application server. The token is obtained by calling an API using clientid and clientSecret obtained during application creation.

2. The application is the KooDrive server.

X-Traceid

No

String

Message log trace ID. The value contains 58 bits.

language

No

String

Language code, which complies with the internationalization specifications. For example, en_us indicates English (United States).

X-User-Id

Yes

String

User ID, which is used for app authentication.

X-Date

Yes

String

Date, which is used for app authentication.

Host

No

String

Address, which is used for app authentication.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

userPermissonList

Array of userPermisson objects

User permissions list.

code

String

Response code.

msg

String

Response message.

nextCursor

String

Cursor.

Table 4 userPermisson

Parameter

Type

Description

userName

String

Username.

mobile

String

Mobile number.

deptName

String

Department name.

deptId

String

Department ID.

templateId

String

Template ID.

groupName

String

Group name.

description

String

Permissions description returned when an anonymous template is used.

userId

String

User ID.

templateName

String

Template name.

deptRole

Integer

Role in the department (under the transferred deptId).

groupRole

Integer

Role in the group (under the transferred group).

capabilities

Array of Capabilities objects

Permissions value.

Table 5 Capabilities

Parameter

Type

Description

addChildNodePermission

Boolean

Permission to create a file or folder. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

copyPermission

Boolean

Copy permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

deletePermission

Boolean

Delete permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

downloadPermission

Boolean

Download permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

editPermission

Boolean

Edit permissions. true: granted; false: not granted (editing is not supported.)

listChildNodePermission

Boolean

Permission to view the list. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

removeChildNodePermission

Boolean

Move permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

renameFilePermission

Boolean

Rename permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

shareFilePermission

Boolean

Share permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

uploadPermission

Boolean

Upload permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

viewPermission

Boolean

Preview permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

Example Requests

Example request for obtaining the user permissions list.

/koodrive/ose/v1/permission/userList?spaceType=0&deptId=1570902*****4673&count=100&containerId=IAAFW*******054209

Authorization:Bearer+7b8d5d009443187d149432249b2482fbc87d1be0c1dd3f6f

Example Responses

Status code: 200

Response to the request for obtaining the user permissions list.

{
  "userPermissionList" : [ {
    "userName" : "111",
    "userId" : "15842******45888",
    "mobile" : "0086137****6060",
    "deptName" : "ce**i-1",
    "templateId" : "1568195451952301579",
    "capabilities" : {
      "addChildNodePermission" : true,
      "copyPermission" : true,
      "deletePermission" : false,
      "downloadPermission" : true,
      "editPermission" : true,
      "listChildNodePermission" : true,
      "removeChildNodePermission" : true,
      "renameFilePermission" : true,
      "shareFilePermission" : true,
      "uploadPermission" : true,
      "viewPermission" : true
    },
    "templateName" : "Unable to Delete",
    "deptRole" : 1
  } ],
  "code" : 0,
  "msg" : "Successful."
}

Status Codes

Status Code

Description

200

Response to the request for obtaining the user permissions list.