Updated on 2025-08-22 GMT+08:00

Enabling a Governance Policy

Function

This API is used to enable a governance policy for an OU in an organization.

URI

POST https://{endpoint}/v1/governance/controls/enable

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

identifier

Yes

String

ID of a governance policy.

target_identifier

Yes

String

ID of an OU.

parameters

No

Array of EnableControlParameters objects

Policy parameters.

Table 2 EnableControlParameters

Parameter

Mandatory

Type

Description

key

Yes

String

Name of a policy parameter.

value

Yes

Object

Value of a policy parameter.

Response Parameters

Status code: 201

Table 3 Response body parameters

Parameter

Type

Description

control_operate_request_id

String

Operation ID of a governance policy.

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

Enabling a governance policy for an OU in an organization

POST https://{endpoint}/v1/governance/controls/enable

{
  "identifier" : "string",
  "target_identifier" : "string"
}

Example Responses

Status code: 201

Request succeeded.

{
  "control_operate_request_id" : "string"
}

Status Codes

Status Code

Description

201

Request succeeded.

403

No permissions.

Error Codes

See Error Codes.