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.
URI
GET https://{endpoint}/v1/organizations/policies
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 a page. |
marker |
No |
String |
Pagination marker. |
Request 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
Parameter |
Type |
Description |
---|---|---|
policies |
Array of PolicySummaryDto objects |
List of policies in an organization. |
page_info |
PageInfoDto object |
Pagination information. |
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. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.