Enrolling an Account

Function

This API is used to enroll an organization account in RGC.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rgc:managedAccount:enroll	Write	-	-	-	-

URI

POST /v1/managed-organization/accounts/{managed_account_id}/enroll

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
managed_account_id	Yes	String	ID of an enrolled account.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
parent_organizational_unit_id	Yes	String	ID of a registered parent OU.
blueprint	No	Blueprint object	Templates.

**Table 3** 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: 200

**Table 4** 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 5** 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 6** ForbiddenErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Enrolling an organization account in RGC

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

{
  "parent_organizational_unit_id" : "string",
  "blueprint" : {
    "blueprint_product_id" : "string",
    "blueprint_product_version" : "string",
    "variables" : "string",
    "is_blueprint_has_multi_account_resource" : "boolean"
  }
}