Updated on 2025-08-22 GMT+08:00

Creating an Account

Function

This API is used to create an account in a registered OU of an organization.

URI

POST https://{endpoint}/v1/managed-organization/managed-accounts

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

account_name

Yes

String

Name of an enrolled account.

account_email

No

String

Email address of an enrolled account.

phone

No

String

Mobile number.

identity_store_user_name

No

String

Name of an IAM Identity Center user.

identity_store_email

No

String

Email address used for IAM Identity Center.

parent_organizational_unit_id

Yes

String

ID of a registered parent OU.

parent_organizational_unit_name

Yes

String

Name of a registered parent OU.

blueprint

No

Blueprint object

Templates.

Table 2 Blueprint

Parameter

Mandatory

Type

Description

blueprint_product_id

No

String

Template ID.

blueprint_product_version

No

String

Template version.

variables

No

String

Parameters for template deployment.

is_blueprint_has_multi_account_resource

No

Boolean

Whether the template contains multi-account resources.

Response Parameters

Status code: 201

Table 3 Response body parameters

Parameter

Type

Description

operation_id

String

Operation ID for creating an account, enrolling an account, or registering an OU.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of the request.

encoded_authorization_message

String

Encrypted error message.

details

Array of ForbiddenErrorDetail objects

Error message indicating no permissions for cross-service invoking.

Table 5 ForbiddenErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Creating an account in a registered OU of an organization

POST https://{endpoint}/v1/managed-organization/managed-accounts

{
  "account_name" : "string",
  "account_email" : "string",
  "phone" : "string",
  "identity_store_user_name" : "string",
  "identity_store_email" : "string",
  "parent_organizational_unit_id" : "string",
  "parent_organizational_unit_name" : "string",
  "blueprint" : {
    "blueprint_product_id" : "string",
    "blueprint_product_version" : "string",
    "variables" : "string",
    "is_blueprint_has_multi_account_resource" : "boolean"
  }
}

Example Responses

Status code: 201

Successful

{
  "operation_id" : "string"
}

Status Codes

Status Code

Description

201

Successful

403

No permissions.

Error Codes

See Error Codes.