Updated on 2024-10-21 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).

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/accounts/{account_id}/move

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

account_id

Yes

String

Unique ID of an account.

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

source_parent_id

Yes

String

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

destination_parent_id

Yes

String

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

Response Parameters

None

Example Requests

Moving an account

POST https://{endpoint}/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.