Renaming an OU

Function

This API is used to rename the specified OU. After an OU is renamed, its ID does not change, its child OUs and accounts remain in place, and any attached policies of the OU remain unchanged. 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

PATCH https://{endpoint}/v1/organizations/organizational-units/{organizational_unit_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
organizational_unit_id	Yes	String	Unique ID of an OU.

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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Name to be assigned to the new OU.

Response Parameters

Status code: 200

**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

Renaming an OU

PATCH https://{endpoint}/v1/organizations/organizational-units/{organizational_unit_id}

{
  "name" : "autoOU0923152728692gqQc"
}

Example Responses

Status code: 200

Successful

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