Listing Entities in an Organization

Function

This API is used to list all the entities (roots, OUs, and accounts) in an organization. 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. You can filter entities you want to view by specifying the parent OU ID and child OU ID.

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:entities:list

List

-

-

-

-

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

URI

GET /v1/organizations/entities

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
parent_id	No	String	Definition Unique ID of a parent node (root or OU). Constraints N/A Range The value must comply with the regular expression ^(?:r-[0-9a-z]{4,32}\|ou-[0-9a-z]{8,32})$. The value contains a maximum of 100 characters. Default Value No default value
child_id	No	String	Definition Unique ID of a child node (OU). Constraints N/A Range The value must comply with the regular expression ^(?:[\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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
entities	Array of EntityDto objects	Definition List of roots, OUs, and accounts 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** EntityDto
Parameter	Type	Description
name	String	Definition Name of the entity. 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
id	String	Definition Unique ID of the entity. Constraints Mandatory 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
type	String	Definition Entity type. It can be account, organizational_unit, or root. 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 entities in an organization

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

Example Responses

Status code: 200

Successful

{
  "entities" : [ {
    "name" : "paas_iam_573331",
    "id" : "019e3a3392d37b948a45904af114f03b",
    "type" : "account"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}