Help Center/ Organizations/ API Reference/ APIs/ Managing Policies/ Listing Entities for the Specified Policy

Updated on 2024-10-21 GMT+08:00

View PDF

Listing Entities for the Specified Policy

Function

This API is used to list all the entities (roots, OUs, and accounts) that the specified policy is attached to. It 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.

URI

GET https://{endpoint}/v1/organizations/policies/{policy_id}/attached-entities

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
policy_id	Yes	String	Unique ID of the policy.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results on a page.
marker	No	String	Pagination marker.

Request Parameters

**Table 3** 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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
attached_entities	Array of EntityDto objects	List of structures, each of which contains details about one of the entities to which the specified policy is attached.
page_info	PageInfoDto object	Pagination information.

**Table 5** EntityDto
Parameter	Type	Description
name	String	Name of the entity.
id	String	Unique ID of the entity.
type	String	Entity type. It can be account, organizational_unit, or root.

**Table 6** 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 entities for the specified policy

GET https://{endpoint}/v1/organizations/policies/{policy_id}/attached-entities

Example Responses

Status code: 200

Successful.

{
  "attached_entities" : [ {
    "name" : "paas_iam_573331",
    "id" : "05261f923e80d3890f33c0056e9b3f80",
    "type" : "account"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}