Listing Groups

Function

This API is used to list groups.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iam:groups:listGroupsV5	List	group *	-	-	-

URI

GET /v5/groups

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records displayed on each page. The value ranges from 1 to 200. The default value is 100. Minimum: 1 Maximum: 200 Default: 100
marker	No	String	Pagination marker. The value contains 4 to 400 characters, including only letters, digits, and the following special characters: +/=-_ Minimum: 4 Maximum: 400
user_id	No	String	IAM user ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
groups	Array of Group objects	Group list.
page_info	PageInfo object	Pagination information.

**Table 3** Group
Parameter	Type	Description
group_id	String	Group ID.
group_name	String	User group name. The value can contain 1 to 128 characters, including letters, digits, spaces, underscores (_), hyphens (-), and braces ({ and }).
created_at	String	Time when a group was created.
urn	String	Uniform resource name.
description	String	User group description. The value can contain 0 to 255 characters and cannot contain the following special characters: @, #, %, &, <, >, \, $, ^, and *.

**Table 4** PageInfo
Parameter	Type	Description
next_marker	String	If this parameter exists, there are subsequent items that are not displayed in the current response body. The value can be used as the pagination marker parameter for the next request to obtain information about the next page. This API can be repeatedly called until this field does not exist.
current_count	Integer	Number of items returned on this page.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.
encoded_authorization_message	String	Encrypted authentication failure information, which can be decrypted using the STS5 decryption API.

Example Requests

Listing all groups
```
GET https://{endpoint}/v5/groups
```
Listing all groups to which IAM user xxx belongs
```
GET https://{endpoint}/v5/groups?user_id=xxx
```

Example Responses

Status code: 200

Successful

{
  "groups" : [ {
    "group_id" : "string",
    "group_name" : "name",
    "created_at" : "2023-09-11T10:13:25.414Z",
    "urn" : "iam::accountid:group:name",
    "description" : "description"
  } ],
  "page_info" : {
    "next_marker" : "marker",
    "current_count" : 1
  }
}