Creating an OU

Function

This API is used to create an OU in a root or a parent OU. An OU is a container of accounts. It enables you to group your accounts to apply policies based on your business requirements. This API can be called only from the organization's management account.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST https://{endpoint}/v1/organizations/organizational-units

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.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Name to be assigned to the new OU.
parent_id	Yes	String	Unique ID of the root or OU in which you want to create a new OU.
tags	No	Array of TagDto objects	List of tags you want to attach to the new OU.

**Table 3** tags
Parameter	Mandatory	Type	Description
key	Yes	string	Identifier or name of the tag key.
value	Yes	string	String value associated with the tag key. You can set the tag value to an empty string, but cannot set it to NULL.

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
organizational_unit	OrganizationalUnitDto object	Details about a newly created organizational unit (OU).

**Table 5** OrganizationalUnitDto
Parameter	Type	Description
id	String	Unique ID of an OU.
urn	String	Uniform resource name of the OU.
name	String	OU name.
created_at	String	Time when the OU was created.

Example Requests

Creating an OU

POST https://{endpoint}/v1/organizations/organizational-units

{
  "name" : "autoOU0923152728692gqQc",
  "parent_id" : "ou-kz0blhbszb6w9a2lzb",
  "tags" : [ {
    "key" : "keystring",
    "value" : "keystring"
  } ]
}

Example Responses

Status code: 201

Successful

{
  "organizational_unit" : {
    "id" : "ou-fi0rv9jbjgc6nifokh65jjo8c24fnujv",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-fi0rv9jbjgc6nifokh65jjo8c24fnujv",
    "name" : "autoOU0923152728692gqQc",
    "created_at" : "2022-09-23T07:27:28Z"
  }
}