Listing Policies

Function

This API is used to list all policies in an organization. If a resource ID (such as an OU ID or account ID) is specified, this API will return a list of policies attached to the resource. This API can be called only from the organization's management account or from a member account that is a delegated administrator for a cloud service.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

organizations:policies:list

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
organizations:policies:list	List	-	-	-	-

URI

GET /v1/organizations/policies

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
attached_entity_id	No	String	Definition Unique ID of the root, OU, or account. Constraints N/A Range The value must comply with the regular expression ^(?:r-[0-9a-z]{4,32}\|[\w-]+\|ou-[0-9a-z]{8,32})$. The value contains a maximum of 100 characters. Default Value No default value
limit	No	Integer	Maximum number of results on the page. If the limit is not specified, the default value is 1,000.
marker	No	String	Definition Pagination marker. Constraints N/A Range The value must comply with the regular expression ^[A-Za-z0-9+/=-_.]+$. The value contains 4 to 400 characters. Default Value No default value

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Definition Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Constraints N/A Range The value contains 0 to 32,768 characters. Default Value No default value
X-Language	No	String	Definition Language of the returned results. Constraints Mandatory Range None Default Value None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
policies	Array of PolicySummaryDto objects	Definition List of policies in an organization. Constraints Mandatory Range None Default Value None
page_info	PageInfoDto object	Definition Pagination information. Constraints N/A Range N/A Default Value No default value

**Table 4** PolicySummaryDto
Parameter	Type	Description
is_builtin	Boolean	Definition A boolean value indicating whether the specified policy is a system-defined policy. If the value is true, the policy is a system-defined policy. You can attach the policy to roots, OUs, or accounts, but you cannot edit it. Constraints Mandatory Range Boolean value: true or false Default Value None
description	String	Definition Policy description. Constraints Mandatory Range The value must comply with the regular expression ^[\s\S]$. The value contains a maximum of 512 characters. Default Value* No default value
id	String	Definition Unique ID of a policy. Constraints Mandatory Range The value must comply with the regular expression ^p-[0-9a-zA-Z_]{8,128}$. The value contains 1 to 130 characters. Default Value No default value
urn	String	Definition Uniform resource name of the policy. Constraints Mandatory Range The value contains 1 to 1,500 characters. Default Value No default value
name	String	Definition Policy name. Constraints Mandatory Range The value must comply with the regular expression ^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$. The value contains 1 to 64 characters. Default Value No default value
type	String	Definition Policy type. The value can be service_control_policy or tag_policy. Constraints Mandatory Range The value contains 1 to 64 characters. Default Value No default value

**Table 5** PageInfoDto
Parameter	Type	Description
next_marker	String	Definition Marker for the next set of results. If present, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the next_marker response element comes back as null. Constraints Mandatory Range The value must comply with the regular expression ^[A-Za-z0-9+/=-_]+$. Default Value No default value
current_count	Integer	Definition Number of records returned on this page. Constraints N/A Range The value ranges from 1 to 2000. Default Value No default value

Example Requests

Listing policies

GET https://{endpoint}/v1/organizations/policies

Example Responses

Status code: 200

Successful.

{
  "policies" : [ {
    "is_builtin" : true,
    "description" : "NFZ",
    "id" : "p-M5lVaiMgFXD6Hmq6o4dvqbGk",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:policy:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/service_control_policy/p-M5lVaiMgFXD6Hmq6o4dvqbGk",
    "name" : "auto092316064293806EYPolicyName",
    "type" : "service_control_policy"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}