Querying User Group Attributes

Function

This API is used to query user group attributes.

Authorization Information

Each account root user 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-summary

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Number of records displayed per page. Constraints: N/A Range: The value ranges from 1 to 200. Default Value: The default value is 100.
marker	No	String	Definition: Pagination marker automatically generated by the service to mark the start position of this request. The value can be obtained from next_marker in the response body of the previous pagination request. Constraints: The value contains 4 to 400 characters. Only letters, digits, plus signs (+), slashes (/), equal signs (=), hyphens (-), and underscores (_) are allowed. Range: N/A Default Value: N/A
user_id	No	String	Definition: IAM user ID, which is automatically generated when the IAM user is created. Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
groups	Array of groups objects	Definition: User groups. Range: N/A
page_info	page_info object	Definition: Pagination information. Range: N/A

**Table 3** groups
Parameter	Type	Description
group_id	String	Definition: User group ID. Range: N/A
group_name	String	Definition: User group name. Range: N/A
created_at	String	Definition: Time when the user group was created. Range: N/A
urn	String	Definition : Uniform Resource Name (URN). For details, see Reference. Range: N/A.
description	String	Definition: User group description. Range: N/A
user_count	Integer	Definition: Number of users. Range: The value ranges from 0 to 5000.

**Table 4** page_info
Parameter	Type	Description
next_marker	String	Definition: Start position marker for the next pagination invoking, which is automatically generated by the service. Range: N/A
current_count	Integer	Definition: Number of records returned on this page. Range: N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A
encoded_authorization_message	String	Definition : Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link. Range: N/A.

Example Requests

Query the attributes of all user groups.

GET https://{endpoint}/v5/groups-summary

Query all user groups to which IAM user xxx belongs.

GET https://{endpoint}/v5/groups-summary?user_id=xxx

Example Responses

Status code: 200

Request succeeded.

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