Help Center/ KooDrive/ API Reference/ API/ Group Management/ Querying Group Details

Updated on 2025-10-22 GMT+08:00

View PDF

Querying Group Details

Function

Query group details.

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET /koodrive/ose/v1/usergroups/{groupId}

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
sourceType	Yes	Integer	User group type. 0: group 1: user group

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	String	Error code.
msg	String	Error message.
userGroup	userGroup object	User group information.

**Table 5** userGroup
Parameter	Type	Description
id	String	id
groupName	String	Group name.
ownerId	String	Owner ID.
tenantId	String	Tenant ID.
sourceType	Integer	Source type.
iconUrl	String	URL.
createdTime	String	Creation time.
updatedTime	String	Update time.

Example Requests

Query the group information about a user.

GET /koodrive/ose/v1/usergroups/1

Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad

Example Responses

Status code: 200

Group information.

{
  "userGroup": {
      "id": "1407237551361847809",
      "groupName": "7",
      "ownerId": "1395476983395324033",
      "tenantId":'1',
      "ownerId":'1',
      "sourceTye":1,
      "iconUrl":'https://******/icon.jpg'
      "createdTime": "2024-04-25T06:49:49.000Z",
      "updatedTime": "2024-04-25T06:49:49.000Z"
    }
  "code": 0,
  "msg": "success"
}