Getting Organization Information

Function

This API is used to get the information about the organization holding the account. It can be called by all accounts in an organization.

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:organizations:get	Read	-	-	-	-

URI

GET /v1/organizations

Request Parameters

**Table 1** 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 2** Response body parameters
Parameter	Type	Description
organization	OrganizationDto object	A structure that contains details about an organization. The accounts are organized hierarchically under organizational units (OUs) in the organization and their access permissions are controlled by policies.

**Table 3** OrganizationDto
Parameter	Type	Description
id	String	Unique ID of an organization.
urn	String	Uniform resource name of the organization.
management_account_id	String	Unique ID of the organization's management account.
management_account_name	String	Name of the organization's management account.
created_at	String	Time when the organization was created.

Example Requests

Getting Organization Information

GET /v1/organizations

Example Responses

Status code: 200

Successful

{
  "organization" : {
    "id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:organization:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv",
    "management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
    "management_account_name" : "paas_iam_573331",
    "created_at" : "2022-08-24T06:31:46Z"
  }
}