Help Center/ Organizations/ API Reference/ APIs/ Managing Organizations/ Listing the Roots of an Organization
Updated on 2026-03-05 GMT+08:00
View PDF

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.

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

    -

    -

    -

    -

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

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

roots

Array of RootDto objects

List of roots defined in an organization.

page_info

PageInfoDto object

Pagination information.
Table 4 RootDto

Parameter

Type

Description

id

String

Unique ID of a root.

urn

String

Uniform resource name of the root.

name

String

Root name.

policy_types

Array of PolicyTypeSummaryDto objects

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.

created_at

String

Time when a root was created.
Table 5 PolicyTypeSummaryDto

Parameter

Type

Description

status

String

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.

type

String

Name of a policy type. It can be service_control_policy or tag_policy.
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 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
  }
}

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.

Parent topic: Managing Organizations