Querying All Identity Policies

Function

This API is used to query all identity policies, including system-defined identity policies and custom identity policies.

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:policies:listV5	List	policy *	-	-	-

URI

GET /v5/policies

**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
policy_type	No	String	Identity policy type. The value can be custom or system-defined.
path_prefix	No	String	Resource path prefix, which consists of multiple character strings. Each character string must end with a slash (/) and can only contain letters, digits, and the following special characters: .,+@=_-, for example, foo/bar/. Maximum: 512
only_attached	No	Boolean	Indicates whether to only list the identity policies with entities attached. Default: false

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Language	No	String	Language of the returned message. The value can be zh-cn or en-us and is zh-cn by default. Default: zh-cn

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
policies	Array of Policy objects	Identity policy list.
page_info	PageInfo object	Pagination information.

**Table 4** Policy
Parameter	Type	Description
policy_type	String	Identity policy type. The value can be custom or system-defined.
policy_name	String	Identity policy name. The value contains 1 to 128 characters, including only letters, digits, and the following special characters: _+=.@-
policy_id	String	Identity policy ID. The value contains 1 to 64 characters, including only letters, digits, and hyphens (-).
urn	String	Uniform resource name.
path	String	Resource path, which is an empty string by default. It consists of multiple character strings. Each character string must end with a slash (/) and can only contain letters, digits, and the following special characters: .,+@=_-, for example, foo/bar/.
default_version_id	String	Default version number.
attachment_count	Integer	Number of entities to which an identity policy is attached.
description	String	Identity policy description.
created_at	String	Time when an identity policy was created.
updated_at	String	Time when the default version of an identity policy was last updated.

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

Querying all identity policies

GET https://{endpoint}/v5/policies

Example Responses

Status code: 200

Successful

{
  "policies" : [ {
    "policy_type" : "custom",
    "policy_name" : "name",
    "policy_id" : "string",
    "urn" : "iam::accountid:policy:name",
    "path" : "",
    "default_version_id" : "v1",
    "attachment_count" : 0,
    "description" : "description",
    "created_at" : "2023-09-25T07:49:11.582Z",
    "updated_at" : "2023-09-25T07:49:11.582Z"
  } ],
  "page_info" : {
    "next_marker" : "marker",
    "current_count" : 1
  }
}