Updated on 2024-03-15 GMT+08:00

Moving an Account

Function

This API is used to move an account from its current source location (root or OU) to the specified destination location (root or OU).

URI

POST /v1/organizations/accounts/{account_id}/move

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

account_id

Yes

String

Unique ID of an account.

Maximum: 36

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.

Minimum: 1

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

source_parent_id

Yes

String

Unique ID of the root or OU which you want to move the account from.

Maximum: 100

destination_parent_id

Yes

String

Unique ID of the root or OU which you want to move the account to.

Maximum: 100

Response Parameters

None

Example Requests

Moving an account

POST https://{hostname}/v1/organizations/accounts/{account_id}/move

{
  "source_parent_id" : "r-upg5m6wbw042",
  "destination_parent_id" : "ou-a6bjn4hat8o2txs5wduj19unte80"
}

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.