Querying Group Details

Function

This API is used to query group details.

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:getGroupV5	Read	group *	-	-	-

URI

GET /v5/groups/{group_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
group_id	Yes	String	Definition: User group ID. Constraints: The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
group	group object	Definition: User group. Range: N/A

**Table 3** group
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

Status code: 403

**Table 4** 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.

Status code: 404

**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

Example Requests

Querying group details

GET https://{endpoint}/v5/groups/{group_id}

Example Responses

Status code: 200

Successful

{
  "group" : {
    "group_id" : "string",
    "group_name" : "name",
    "created_at" : "2023-09-11T10:13:25.414Z",
    "urn" : "iam::accountid:group:name",
    "description" : "description"
  }
}