Listing User Spaces

Updated on 2025-03-07 GMT+08:00

View PDF

Function

List user spaces in a department. If department_id is not specified, the user space list of the organization to which the current sign-in user belongs is queried.

URI

GET /koodrive/ose/v1/space/userList

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
deptId	No	String	Department ID. If this parameter is not specified, the user space list of the organization is queried if the current user is a system administrator, and the user space list of the department is queried if the current user is a department administrator.
isDirect	No	Boolean	Whether the user belongs to the root department. Default value: false.
offset	Yes	String	Offset. Minimum value: 0.
limit	Yes	String	Maximum number of records to be returned. Value range: 1 to 100.
keyWord	No	String	Search keyword. You can use name and mobile as the search criteria.
spaceStatus	No	String	Space status.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	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	Yes	String	Address, which is used for app authentication.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	Integer	Response code.
msg	String	Response message.
users	Array of userSpaceInfo objects	User space information.
total	String	Total number of records.

**Table 4** userSpaceInfo
Parameter	Type	Description
name	String	Username.
deptId	String	Department ID.
deptName	String	Department name.
mobile	String	Mobile number.
role	Integer	User role.
status	Integer	User account status.
containerId	String	Space ID.
capacity	Long	Individual space size.
spaceUsed	Long	Size of the used space.
tenantId	String	Tenant ID.
id	String	User space ID.
userId	String	User ID.
spaceStatus	String	Space status.

Example Requests

Lists user spaces in a department.

GET /koodrive/ose/v1/space/userList?deptId=&isDirect=&offset=0&limit=100&keyWord

Authorization:Bearer+10f88**********4791e9ff

Example Responses

Status code: 200

Information about the user space list.

{
  "total" : 1,
  "users" : [ {
    "tenantId" : "cad444830661464d9da88784a96d960c",
    "status" : 0,
    "capacity" : 10,
    "spaceUsed" : 189,
    "containerId" : "IAAE49hOR8LulgAAA1410765425310141185",
    "id" : "1410765364786334592",
    "role" : 1,
    "name" : "xx",
    "deptName" : "xxx",
    "userId" : "1008600000445114904",
    "deptId" : 1410183811475666000,
    "mobile" : "0086147****6900",
    "spaceStatus" : "0"
  } ],
  "code" : 0,
  "msg" : "OK"
}