Querying All Identity Policies Attached to a Specified Group

Function

This API is used to query all identity policies attached to a specified group.

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:listAttachedPoliciesV5	List	group *	-	-	-

URI

GET /v5/groups/{group_id}/attached-policies

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

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

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
attached_policies	Array of attached_policies objects	Definition: Identity policy list. Range: N/A
page_info	page_info object	Definition: Pagination information. Range: N/A

**Table 4** attached_policies
Parameter	Type	Description
policy_name	String	Definition: Name of an identity policy. Range: N/A
policy_id	String	Definition: Identity policy ID. Range: N/A
urn	String	Definition : Uniform Resource Name (URN). For details, see Reference. Range: N/A.
attached_at	String	Definition: Time when an identity policy is attached. Range: N/A

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

Status code: 403

**Table 7** 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 8** 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 all identity policies attached to a specified group

GET https://{endpoint}/v5/groups/{group_id}/attached-policies

Example Responses

Status code: 200

Successful

{
  "attached_policies" : [ {
    "policy_name" : "name",
    "policy_id" : "string",
    "urn" : "iam::accountid:policy:name",
    "attached_at" : "2023-09-25T09:31:44.935Z"
  } ],
  "page_info" : {
    "next_marker" : "marker",
    "current_count" : 1
  }
}