Querying the Compliance of External Config Rules for Enrolled Accounts

Function

This API is used to query the compliance of the external Config rules for enrolled accounts.

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:externalConfigRuleCompliance:list	List	-	-	-	-

URI

GET /v1/governance/managed-accounts/{managed_account_id}/external-config-rule-compliances

**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
account_id	String	ID of an enrolled account.
config_rule_compliances	Array of ExternalConfigRuleCompliance objects	Compliance of Config rules.

**Table 3** ExternalConfigRuleCompliance
Parameter	Type	Description
rule_name	String	Compliance rule.
status	String	Compliance status.
control_id	String	ID of an external rule.

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 the compliance of external Config rules for an enrolled account in an organization

GET https://{endpoint}/v1/governance/managed-accounts/{managed_account_id}/external-config-rule-compliances

Example Responses

Status code: 200

Request succeeded.

{
  "account_id" : "string",
  "config_rule_compliances" : [ {
    "rule_name" : "string",
    "status" : "string",
    "control_id" : "string"
  } ]
}