Listing Enabled Governance Policies

Updated on 2025-02-20 GMT+08:00

View PDF

Function

This API is used to list all enabled governance policies in an organization.

URI

GET https://{endpoint}/v1/governance/enabled-controls

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
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
enabled_controls	Array of EnabledControl objects	Enabled governance policies.
page_info	PageInfoDto object	Number of records displayed on the current page.

**Table 3** EnabledControl
Parameter	Type	Description
manage_account_id	String	ID of a managed account.
control_identifier	String	Governance policy ID.
name	String	Name of a governance policy.
description	String	Description of a governance policy.
control_objective	String	Pre-defined objective that the governance policy helps you enforce.
behavior	String	Type of a governance policy. A governance policy can be preventive, detective, or proactive.
owner	String	Source where a managed account was created. It can be CUSTOM or RGC.
regional_preference	String	Region options. It can be regional or global.

**Table 4** 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 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

Listing all enabled governance policies in an organization

GET https://{endpoint}/v1/governance/enabled-controls

Example Responses

Status code: 200

Request succeeded.

{
  "enabled_controls" : [ {
    "manage_account_id" : "string",
    "control_identifier" : "string",
    "name" : "string",
    "description" : "string",
    "control_objective" : "string",
    "behavior" : "string",
    "owner" : "string",
    "regional_preference" : "string"
  } ],
  "page_info" : {
    "next_marker" : "string",
    "current_count" : 0
  }
}