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.

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:ous:update

Write

ou *

g:ResourceTag/<tag-key>

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
organizations:ous:update	Write	ou *	g:ResourceTag/<tag-key>	-	-

URI

PATCH /v1/organizations/organizational-units/{organizational_unit_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
organizational_unit_id	Yes	String	Definition Unique ID of the OU. Constraints Mandatory Range The value must comply with the regular expression ^ou-[0-9a-z]{8,32}$. The value contains a maximum of 35 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Name of the new OU. Constraints Mandatory Range The value must comply with the regular expression ^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$. The value contains 1 to 64 characters. Default Value No default value

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
organizational_unit	OrganizationalUnitDto object	Definition OU details. Constraints Mandatory Range N/A Default Value No default value

**Table 5** OrganizationalUnitDto
Parameter	Type	Description
id	String	Definition Unique ID of the OU. Constraints Mandatory Range The value must comply with the regular expression ^ou-[0-9a-z]{8,32}$. The value contains 1 to 35 characters. Default Value No default value
urn	String	Definition Uniform resource name of the OU. Constraints Mandatory Range The value contains 1 to 1,500 characters. Default Value No default value
name	String	Definition Name of the OU. Constraints Mandatory Range The value must comply with the regular expression ^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$. The value contains 1 to 64 characters. Default Value No default value
created_at	String	Definition Time when an OU was created Constraints Mandatory Range The value must be in ISO 8601 format. Default Value No default value

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"
  }
}