Querying an Enrolled Account

Function

This API is used to query an organization account that is enrolled by 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:get	Read	-	-	-	-

URI

GET /v1/managed-organization/managed-accounts/{managed_account_id}

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

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
landing_zone_version	String	Landing zone version of an enrolled account.
manage_account_id	String	Management account ID.
account_id	String	ID of an enrolled account.
account_type	String	Type of an enrolled account.
owner	String	Source where an enrolled account was created. It can be CUSTOM or RGC.
state	String	Status of an enrolled account.
message	String	Description of the error status.
parent_organizational_unit_id	String	ID of a registered parent OU.
parent_organizational_unit_name	String	Name of a registered parent OU.
identity_store_user_name	String	Name of an IAM Identity Center user.
blueprint_product_id	String	Template ID.
blueprint_product_version	String	Template version.
blueprint_status	String	Template deployment status. It can be failed, completed, or processing.
is_blueprint_has_multi_account_resource	Boolean	Whether the template contains multi-account resources.
regions	Array of RegionManagedList objects	Region information.
created_at	String	Time when an enrolled account was created.
updated_at	String	Time when an enrolled account was updated.

**Table 3** RegionManagedList
Parameter	Type	Description
region	String	Region name.
region_status	String	Region status. It can be available or unavailable.

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

Querying an organization account that is enrolled by RGC

GET https://{endpoint}/v1/managed-organization/managed-accounts/{managed_account_id}

Example Responses

Status code: 200

Request succeeded.

{
  "manage_account_id" : "string",
  "account_id" : "string",
  "account_type" : "string",
  "owner" : "string",
  "state" : "string",
  "message" : "string",
  "parent_organizational_unit_id" : "string",
  "parent_organizational_unit_name" : "string",
  "identity_store_user_name" : "string",
  "blueprint_product_id" : "string",
  "blueprint_product_version" : "string",
  "blueprint_status" : "string",
  "is_blueprint_has_multi_account_resource" : "boolean",
  "regions" : [ {
    "region" : "string",
    "region_status" : "string"
  } ],
  "created_at" : "2023-11-15T07:32:12.283Z",
  "updated_at" : "2023-11-15T07:32:12.283Z"
}