Help Center/Organizations/API Reference/APIs/Managing Policies/Listing Policies
Updated on 2026-03-05 GMT+08:00
View PDF

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.

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

    -

    -

    -

    -

URI

GET /v1/organizations/policies

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

attached_entity_id

No

String

Unique ID of the root, OU, or account.

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

Pagination marker.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

X-Language

No

String

Language of the returned results.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

policies

Array of PolicySummaryDto objects

List of policies in an organization.

page_info

PageInfoDto object

Pagination information.

Table 4 PolicySummaryDto

Parameter

Type

Description

is_builtin

Boolean

A boolean value indicating whether the specified policy is a system policy. If the value is true, the policy is a system policy. You can attach the policy to roots, OUs, or accounts, but you cannot edit it.

description

String

Description of the policy.

id

String

Unique ID of the policy.

urn

String

Uniform resource name of the policy.

name

String

Name of the policy.

type

String

Policy type. It can be service_control_policy or tag_policy.

Table 5 PageInfoDto

Parameter

Type

Description

next_marker

String

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.

current_count

Integer

Number of items returned on the current page.

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" : "string",
    "name" : "9`P41WII9Yn]",
    "type" : "service_control_policy"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.

Parent topic:Managing Policies