Skip to content

Commit

Permalink
fix api docs bug on policy enforcement defaults
Browse files Browse the repository at this point in the history
  • Loading branch information
mrinalirao committed Nov 18, 2022
1 parent 81d1857 commit 2b7552f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion website/docs/cloud-docs/api-docs/policies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Properties without a default value are required.
| `data.attributes.query` | string | | The OPA query to run. Only valid for OPA policies. |
| `data.attributes.enforce` | array\[object] | | An array of enforcement configurations that map policy file paths to their enforcement modes. Policies support a single file, so this array should consist of a single element. For Sentinel, if the path in the enforcement map does not match the Sentinel policy (`<NAME>.sentinel`), then Terraform Cloud uses the default `hard-mandatory` enforcement level. For OPA, the default enforcement level is `advisory`. |
| `data.attributes.enforce[].path` | string | | For Sentinel, must be `<NAME>.sentinel`, where `<NAME>` has the same value as `data.attributes.name`. For OPA, must be `<NAME>.rego`. |
| `data.attributes.enforce[].mode` | string | `hard-mandatory`(Sentinel) , `advisory` (OPA) | The enforcement level of the policy. For Sentinel, valid values are `"hard-mandatory"`, `"soft-mandatory"`, and `"advisory"`. For OPA, Valid values are `"mandatory"`and `"advisory"`. Refer to [Managing Policies](/cloud-docs/policy-enforcement/manage-policy-sets) for details. |
| `data.attributes.enforce[].mode` | string | | The enforcement level of the policy. For Sentinel, valid values are `"hard-mandatory"`, `"soft-mandatory"`, and `"advisory"`. For OPA, Valid values are `"mandatory"`and `"advisory"`. Refer to [Managing Policies](/cloud-docs/policy-enforcement/manage-policy-sets) for details. |
| `data.relationships.policy-sets.data[]` | array\[object] | `[]` | A list of resource identifier objects to define which policy sets include the new policy. These objects must contain `id` and `type` properties, and the `type` property must be `policy-sets`. For example,`{ "id": "polset-3yVQZvHzf5j3WRJ1","type": "policy-sets" }`. |

### Sample Payload (Sentinel)
Expand Down

0 comments on commit 2b7552f

Please sign in to comment.