Help Center> Workspace> API Reference> Workspace APIs> User Group> Querying User Groups

Updated on 2024-01-10 GMT+08:00

View PDF

Querying User Groups

Function

Query user groups. Pagination is supported.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	String	Limits the quantity of returned user groups in pagination query. If this parameter is not specified or is set to 0, the default value 100 is used. The value starts from 1 and the maximum value is 100.
offset	No	String	Specifies the start position of pagination query. The value starts from 0. The default value is 0. This parameter must be used together with limit.
keyword	No	String	Specifies the search keyword of a user group. For example, fuzzy query by group name.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body, for example, application/json.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Total number of user groups that meet the search criteria.
user_groups	Array of UserGroupInfo objects	User groups.

**Table 5** UserGroupInfo
Parameter	Type	Description
name	String	User group name.
id	String	User group ID.
create_time	String	Time when a user group is created. The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss.SSSZ.
description	String	User group description.
user_quantity	Integer	Number of users in the user list.
parent	UserGroupInfo object	Upper-level user group of a user group.
realm_id	String	User group domain ID.
platform_type	String	Type of a user group. AD: AD domain user group LOCAL: local LiteAS user group
group_dn	String	Name of a user group.
domain	String	Domain name of a user group.
sid	String	SID of a user group.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 405

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 503

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

GET /v2/92c84e5bce3d48d7ab5714a44901eb08/groups?limit=10&offset=20

Example Responses

Status code: 200

Response to the request for querying a user group.

{
  "total_count" : 2,
  "user_groups" : [ {
    "id" : "99558194716db7d601719f9b61850042",
    "sid" : "99558194716db7d601719f9b61850042",
    "name" : "group1",
    "realm_id" : "695581943266db7a601719f9e61850058",
    "domian" : "local.com",
    "description" : "for test",
    "platform_type" : "LOCAL",
    "create_time" : "2023-02-15T02:27:05.000Z",
    "user_quantity" : 10
  }, {
    "id" : "99558194716db7d601719f9b61850000",
    "sid" : "99558194716db7d601719f9b61850000",
    "name" : "group2",
    "realm_id" : "453381943266db7a601719f9e61850044",
    "domian" : "local.com",
    "description" : "for test2",
    "platform_type" : "LOCAL",
    "create_time" : "2023-01-16T02:27:05.000Z",
    "user_quantity" : 20
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for querying a user group.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	The service is unavailable.