Listing the Roots of an Organization

Function

This API is used to list the roots of 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.

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

List

-

-

-

-

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

URI

GET /v1/organizations/roots

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
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
roots	Array of RootDto objects	Definition List of roots defined in an organization. Constraints Mandatory Range N/A Default Value No default value
page_info	PageInfoDto object	Definition Pagination information. Constraints N/A Range N/A Default Value No default value

**Table 4** RootDto
Parameter	Type	Description
id	String	Definition Unique ID of a root. Constraints Mandatory Range The value must comply with the regular expression ^r-[0-9a-z]{4,32}$. The value contains 1 to 34 characters. Default Value No default value
urn	String	Definition Uniform resource name of the root Constraints Mandatory Range The value contains 1 to 1,500 characters. Default Value No default value
name	String	Definition Name of the root. Constraints Mandatory Range The value must comply with the regular expression ^[a-zA-Z][0-9a-zA-Z_-]+$. The value contains 1 to 64 characters. Default Value No default value
policy_types	Array of PolicyTypeSummaryDto objects	Definition Policy types that are currently enabled for the root. The policies of these types can be attached to the root or to its OUs or accounts. Constraints Mandatory Range None Default Value No default value
created_at	String	Definition Time when a root was created. Constraints Mandatory Range The value must be in ISO 8601 format. Default Value No default value

**Table 5** PolicyTypeSummaryDto
Parameter	Type	Description
status	String	Definition Status of the policy type associated with a root. To attach a policy of a specified type to a root or an OU or account in the root, the policy must be available in the organization and enabled for the root. It can be enabled, pending_enable, disabled, or pending_disable. Constraints Mandatory Range The value contains 1 to 64 characters. Default Value No default value
type	String	Definition Name of a 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 6** 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 the roots of an organization

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

Example Responses

Status code: 200

Successful.

{
  "roots" : [ {
    "id" : "r-rpjghpbmumu2hffplsj5edt1z3vybb94",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:root:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/r-rpjghpbmumu2hffplsj5edt1z3vybb94",
    "name" : "root",
    "policy_types" : [ {
      "status" : "enabled",
      "type" : "service_control_policy"
    } ],
    "created_at" : "2022-08-24T06:31:46Z"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}