Listing Governance Policies Enabled for an Enrolled Account
Function
This API is used to list all governance policies enabled for an enrolled account in an organization.
URI
GET https://{endpoint}/v1/governance/managed-accounts/{managed_account_id}/controls
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
managed_account_id |
Yes |
String |
ID of an enrolled account. |
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
Parameter |
Type |
Description |
---|---|---|
control_summaries |
Array of TargetControl objects |
Summary of governance policies. |
page_info |
PageInfoDto object |
Number of records displayed on the current page. |
Parameter |
Type |
Description |
---|---|---|
manage_account_id |
String |
Management account ID. |
control_identifier |
String |
Governance policy ID. |
state |
String |
Controls if governance policies are enabled. |
version |
String |
Version of the current governance policy. |
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 of a governance policy. |
regional_preference |
String |
Region options. It can be regional or global. |
guidance |
String |
Necessity of a governance policy. |
service |
String |
Service the governance policy applies to. |
implementation |
String |
Policy type. |
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
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. |
Example Requests
Listing all governance policies enabled for an enrolled account in an organization
GET https://{endpoint}/v1/governance/managed-accounts/{managed_account_id}/controls
Example Responses
Status code: 200
Request succeeded.
{ "control_summaries" : [ { "manage_account_id" : "string", "control_identifier" : "string", "state" : "string", "version" : "string", "name" : "string", "description" : "string", "control_objective" : "string", "behavior" : "string", "owner" : "string", "regional_preference" : "string", "guidance" : "string", "service" : "string" } ], "page_info" : { "next_marker" : "string", "current_count" : 0 } }
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
403 |
No permissions. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot