Listing Enrolled Accounts for Governance Policies

Function

This API is used to list enrolled accounts for which governance policies are enabled.

URI

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

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
control_id	No	String	ID of a governance policy.
limit	No	Integer	Maximum number of pages that can be displayed on at once.
marker	No	String	Page marker.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
managed_accounts	Array of ManagedAccount objects	Information about an enrolled account.
page_info	PageInfoDto object	Number of records displayed on the current page.

**Table 3** ManagedAccount
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_name	String	Name 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 4** RegionManagedList
Parameter	Type	Description
region	String	Region name.
region_status	String	Region status. It can be available or unavailable.

**Table 5** PageInfoDto
Parameter	Type	Description
next_marker	String	Used in the marker request parameter to get the next part of the output. Repeat this operation until the response element comes back as null. If present, more output is available than that included in the current response.
current_count	Integer	Number of records displayed on the current page.

Status code: 403

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

Example Requests

Listing enrolled accounts for governance policies

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

Example Responses

Status code: 200

Request succeeded.

{
  "managed_accounts" : [ {
    "landing_zone_version" : "string",
    "manage_account_id" : "string",
    "account_id" : "string",
    "account_name" : "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:37:15.243Z",
    "updated_at" : "2023-11-15T07:37:15.243Z"
  } ],
  "page_info" : {
    "next_marker" : "string",
    "current_count" : 1
  }
}