On this page

Show all

Help Center/ KooDrive/ API Reference/ API/ Group Management/ Listing Members in a User Group

Listing Members in a User Group

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

View PDF

Function

List members in a group.

URI

GET /koodrive/ose/v1/usergroups/{group_id}/members

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
group_id	Yes	String	Group ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	Yes	Integer	Offset. Minimum value: 0.
limit	Yes	Integer	Maximum number of records to be returned. Value range: 1 to 100.
keyWord	No	String	Search keyword. You can use name and ownerNamer as the search criteria.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.
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). English (United States) is used by default.
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 4** Response body parameters
Parameter	Type	Description
code	Integer	Response code.
msg	String	Response information.
total	Integer	Total number of members in a user group.
userGroupMemberInfos	Array of MemberInfo objects	Member list.

**Table 5** MemberInfo
Parameter	Type	Description
userId	String	Member user ID.
userName	String	Username.
deptId	String	Department ID.
deptName	String	Department name.
mobile	String	Mobile number.
createdTime	String	Time when the member is added.
updatedTime	String	Update time.
role	Integer	Role.
top	Integer	Top ID. 1: top. 0: display in sequence. Default value: 0.

Example Requests

Lists members in group 369528171409614001.

GET /koodrive/ose/v1/usergroups/369528171409614001/members

Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad

Example Responses

Status code: 200

Group member list.

{
  "data" : {
    "tenantId" : "40086000004871666",
    "creator" : "369528171409614001",
    "createTime" : "2023-11-07T20:36:35.000Z",
    "modifier" : "369528171409614001",
    "updateTime" : "2023-12-26T11:40:07.000Z",
    "ownerId" : "369528171409614001",
    "type" : 1,
    "status" : 0,
    "capacity" : 800,
    "spaceUsed" : 91966408,
    "containerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
    "rootFileId" : "HFFdIb642fU51JWKAUlP6mwUVc8oDNKbO",
    "bizRootFileId" : "DEUI7pa0C24ArootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
    "bizSboxFileId" : "DEUI7pa0C24AsboxIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4"
  },
  "code" : 0,
  "msg" : "OK"
}