> [!WARNING]
>
> **Preview**
>
>
> This feature is
>
> subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
> [Service Specific
> Terms](https://docs.cloud.google.com/terms/service-terms#1).
>
> Pre-GA features are available "as is" and might have limited support.
>
> For more information, see the
> [launch stage descriptions](https://cloud.google.com/products/#product-launch-stages).

Custom organization policies let you restrict how users create and modify
[Privileged Access Manager (PAM)](https://docs.cloud.google.com/iam/docs/pam-overview.md.txt) entitlements and create grants. You
can enforce custom constraints on your organization, folders, or projects to
limit request durations or require approver justifications.

<br />

This page shows you how to use Organization Policy Service custom constraints to restrict
specific operations on the following Google Cloud resources:

- `privilegedaccessmanager.googleapis.com/Entitlement`
- `privilegedaccessmanager.googleapis.com/Grant`

To learn more about Organization Policy, see
[Custom organization policies](https://docs.cloud.google.com/organization-policy/overview.md.txt#custom-organization-policies).

## About organization policies and constraints

The Google Cloud Organization Policy Service gives you centralized, programmatic
control over your organization's resources. As the
[organization policy administrator](https://docs.cloud.google.com/iam/docs/roles-permissions/orgpolicy.md.txt#orgpolicy.policyAdmin), you can define an organization
policy, which is a set of restrictions called *constraints* that apply to
Google Cloud resources and descendants of those resources in the
[Google Cloud resource hierarchy](https://docs.cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy.md.txt). You can enforce organization
policies at the organization, folder, or project level.

Organization Policy provides built-in [managed constraints](https://docs.cloud.google.com/organization-policy/reference/org-policy-constraints.md.txt)
for various Google Cloud services. However, if you want more granular,
customizable control over the specific fields that are restricted in your
organization policies, you can also create *custom constraints* and use those
custom constraints in an organization policy.

### Policy inheritance

By default, organization policies are inherited by the descendants of the
resources on which you enforce the policy. For example, if you enforce a policy
on a folder, Google Cloud enforces the policy on all projects in the
folder. To learn more about this behavior and how to change it, refer to
[Hierarchy evaluation rules](https://docs.cloud.google.com/organization-policy/hierarchy-evaluation.md.txt#disallow_inheritance).

## Limitations


Like all organization policy constraints, policy changes don't apply retroactively to existing resources.

- A new policy doesn't affect existing resource configurations.
- An existing resource configuration remains valid even if it has non-compliant values, unless it is updated.

## Before you begin

1. Ensure that you know your [organization ID](https://docs.cloud.google.com/resource-manager/docs/creating-managing-organization.md.txt#retrieving_your_organization_id).

### Required roles


To get the permissions that
you need to manage organization policies,

ask your administrator to grant you the
following IAM roles:

- To manage organization policies: [Organization Policy Administrator](https://docs.cloud.google.com/iam/docs/roles-permissions/orgpolicy.md.txt#orgpolicy.policyAdmin) (`roles/orgpolicy.policyAdmin`) on the organization resource
- To create and manage entitlements: [Privileged Access Manager Admin](https://docs.cloud.google.com/iam/docs/roles-permissions/privilegedaccessmanager.md.txt#privilegedaccessmanager.admin) (`roles/privilegedaccessmanager.admin`) on the project resource


For more information about granting roles, see [Manage access to projects, folders, and organizations](https://docs.cloud.google.com/iam/docs/granting-changing-revoking-access.md.txt).


These predefined roles contain

the permissions required to manage organization policies. To see the exact permissions that are
required, expand the **Required permissions** section:


#### Required permissions

The following permissions are required to manage organization policies:

- To manage organization policies:
  - `orgpolicy.constraints.list`
  - `orgpolicy.policies.create`
  - `orgpolicy.policies.delete`
  - `orgpolicy.policies.list`
  - `orgpolicy.policies.update`
  - `orgpolicy.policy.get`
  - `orgpolicy.policy.set`
- To manage entitlements:
  - `privilegedaccessmanager.entitlements.create`
  - `privilegedaccessmanager.entitlements.update`


You might also be able to get
these permissions
with [custom roles](https://docs.cloud.google.com/iam/docs/creating-custom-roles.md.txt) or
other [predefined roles](https://docs.cloud.google.com/iam/docs/roles-overview.md.txt#predefined).

## Identity and Access Management supported resources

The following table lists the Identity and Access Management resources that you can reference in custom constraints.


| Resource | Field |
|---|---|
| privilegedaccessmanager.googleapis.com/Entitlement | `resource.additionalNotificationTargets.adminEmailRecipients` |
| privilegedaccessmanager.googleapis.com/Entitlement | `resource.additionalNotificationTargets.requesterEmailRecipients` |
| privilegedaccessmanager.googleapis.com/Entitlement | `resource.approvalWorkflow.manualApprovals.requireApproverJustification` |
| privilegedaccessmanager.googleapis.com/Entitlement | `resource.approvalWorkflow.manualApprovals.steps.approvalsNeeded` |
| privilegedaccessmanager.googleapis.com/Entitlement | `resource.approvalWorkflow.manualApprovals.steps.approverEmailRecipients` |
| privilegedaccessmanager.googleapis.com/Entitlement | `resource.maxRequestDuration` |
| privilegedaccessmanager.googleapis.com/Entitlement | `resource.name` |
| privilegedaccessmanager.googleapis.com/Entitlement | `resource.privilegedAccess.gcpIamAccess.resource` |
| privilegedaccessmanager.googleapis.com/Entitlement | `resource.privilegedAccess.gcpIamAccess.resourceType` |
| privilegedaccessmanager.googleapis.com/Entitlement | `resource.privilegedAccess.gcpIamAccess.roleBindings.conditionExpression` |
| privilegedaccessmanager.googleapis.com/Entitlement | `resource.privilegedAccess.gcpIamAccess.roleBindings.role` |
| privilegedaccessmanager.googleapis.com/Grant | `resource.additionalEmailRecipients` |
| privilegedaccessmanager.googleapis.com/Grant | `resource.justification.unstructuredJustification` |
| privilegedaccessmanager.googleapis.com/Grant | `resource.name` |
| privilegedaccessmanager.googleapis.com/Grant | `resource.requestedDuration` |

<br />

## Set up a custom constraint

A custom constraint is defined in a YAML file by the resources, methods,
conditions, and actions that are supported by the service on which you are
enforcing the organization policy. Conditions for your custom constraints are
defined using
[Common Expression Language (CEL)](https://github.com/google/cel-spec/blob/master/doc/intro.md). For more information about how to build
conditions in custom constraints using CEL, see the CEL section of
[Creating and managing custom constraints](https://docs.cloud.google.com/organization-policy/create-custom-constraints.md.txt#common_expression_language).

### Console


To create a custom constraint, do the following:

1. In the Google Cloud console, go to the **Organization policies** page.

   [Go to Organization policies](https://console.cloud.google.com/iam-admin/orgpolicies)
2. From the project picker, select the project that you want to set the organization policy for.
3. Click **Custom constraint**.
4. In the **Display name** box, enter a human-readable name for the constraint. This name is used in error messages and can be used for identification and debugging. Don't use personally identifiable information (PII) or sensitive data in display names because this name could be exposed in error messages. This field can contain up to 200 characters.
5. In the **Constraint ID** box, enter the ID that you want for your new custom constraint. A custom constraint can only contain letters (including upper and lowercase) or numbers, for example `custom.allowEntitlementWithMaxRequestDurationLessThan2h`. This field can contain up to 70 characters, not counting the prefix (`custom.`), for example, `organizations/123456789/customConstraints/custom`. Don't include PII or sensitive data in your constraint ID, because it could be exposed in error messages.
6. In the **Description** box, enter a human-readable description of the constraint. This description is used as an error message when the policy is violated. Include details about why the policy violation occurred and how to resolve the policy violation. Don't include PII or sensitive data in your description, because it could be exposed in error messages. This field can contain up to 2000 characters.
7. In the **Resource type** box, select the name of the Google Cloud REST resource containing the object and field that you want to restrict---for example, `container.googleapis.com/Cluster`. Most resource types support up to 20 custom constraints. If you attempt to create more custom constraints, the operation fails.
8. Under **Enforcement method** , select whether to enforce the constraint on a REST `CREATE` method or both `CREATE` and `UPDATE` methods. If you enforce the constraint with the `UPDATE` method on a resource that violates the constraint, changes to that resource are blocked by the organization policy unless the change resolves the violation.
9. To see supported methods for each service, find the service in [Services that support custom constraints](https://docs.cloud.google.com/organization-policy/reference/custom-constraint-supported-services.md.txt).
10. To define a condition, click **Edit condition**.
    1. In the **Add condition** panel, create a CEL condition that refers to a supported service resource, for example, `resource.autopilot.enabled == false`. This field can contain up to 1,500 characters. For details about CEL usage, see [Common Expression Language](https://docs.cloud.google.com/resource-manager/docs/organization-policy/creating-managing-custom-constraints#common_expression_language). For more information about the service resources you can use in your custom constraints, see [Custom constraint supported services](https://docs.cloud.google.com/resource-manager/docs/organization-policy/custom-constraint-supported-services).
    2. Click **Save**.
11. Under **Action**, select whether to allow or deny the evaluated method if the condition is met.
12. The deny action means that the operation to create or update the resource is blocked if the condition evaluates to true.
13. The allow action means that the operation to create or update the resource is permitted only if the condition evaluates to true. Every other case except those explicitly listed in the condition is blocked.
14. Click **Create constraint**.
15. When you have entered a value into each field, the equivalent YAML configuration for this custom constraint appears on the right.

### gcloud

1. To create a custom constraint, create a YAML file using the following format:

```yaml
name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes: RESOURCE_NAME
methodTypes:
  - CREATE
  - UPDATE 
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION
```
2. Replace the following:
   - `ORGANIZATION_ID`: your organization ID, such as `123456789`.
   - `CONSTRAINT_NAME`: the name that you want for your new custom constraint. A custom constraint can only contain letters (including upper and lowercase) or numbers, for example, `custom.allowEntitlementWithMaxRequestDurationLessThan2h`. This field can contain up to 70 characters, not counting the prefix (`custom.`)--- for example, `organizations/123456789/customConstraints/custom`. Don't include PII or sensitive data in your constraint ID, because it could be exposed in error messages.
   - `RESOURCE_NAME`: the fully qualified name of the Google Cloud resource containing the object and field that you want to restrict. For example, `privilegedaccessmanager.googleapis.com/Entitlement`. Most resource types support up to 20 custom constraints. If you attempt to create more custom constraints, the operation fails.
   - `methodTypes`: the REST methods that the constraint is enforced on. Can be `CREATE` or both `CREATE` and `UPDATE`. If you enforce the constraint with the `UPDATE` method on a resource that violates the constraint, changes to that resource are blocked by the organization policy unless the change resolves the violation.
   - To see the supported methods for each service, find the service in [Services that support custom constraints](https://docs.cloud.google.com/organization-policy/reference/custom-constraint-supported-services.md.txt).
   - `CONDITION`: a [CEL condition](https://docs.cloud.google.com/resource-manager/docs/organization-policy/creating-managing-custom-constraints#common_expression_language) that is written against a representation of a supported service resource. This field can contain up to 1,500 characters. For example, `"resource.maxRequestDuration < duration('7200s')"`.
   - For more information about the resources available to write conditions against, see [Supported resources](https://docs.cloud.google.com/iam/docs/pam-custom-constraints.md.txt#supported_resources).
   - `ACTION`: the action to take if the `condition` is met. Possible values are `ALLOW` and `DENY`.
   - The allow action means that if the condition evaluates to true, the operation to create or update the resource is permitted. This also means that every other case except the one explicitly listed in the condition is blocked.
   - The deny action means that if the condition evaluates to true, the operation to create or update the resource is blocked.
   - `DISPLAY_NAME`: a human-readable name for the constraint. This name is used in error messages and can be used for identification and debugging. Don't use PII or sensitive data in display names because this name could be exposed in error messages. This field can contain up to 200 characters.
   - `DESCRIPTION`: a human-friendly description of the constraint to display as an error message when the policy is violated. This field can contain up to 2000 characters.
3. After you have created the YAML file for a new custom constraint, you must set it up to make it available for organization policies in your organization. To set up a custom constraint, use the [`gcloud org-policies set-custom-constraint`](https://docs.cloud.google.com/sdk/gcloud/reference/org-policies/set-custom-constraint) command:

```bash
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
```
4. Replace `CONSTRAINT_PATH` with the full path to your custom constraint file. For example, `/home/user/customconstraint.yaml`.
5. After this operation is complete, your custom constraints are available as organization policies in your list of Google Cloud organization policies.
6. To verify that the custom constraint exists, use the [`gcloud org-policies list-custom-constraints`](https://docs.cloud.google.com/sdk/gcloud/reference/org-policies/list-custom-constraints) command:

```bash
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
```
7. Replace `ORGANIZATION_ID` with the ID of your organization resource.
8. For more information, see [Viewing organization policies](https://docs.cloud.google.com/resource-manager/docs/organization-policy/creating-managing-policies#viewing_organization_policies).

## Enforce a custom organization policy

You can enforce a constraint by creating an organization policy that references it, and then applying that organization policy to a Google Cloud resource.

### Console

1. In the Google Cloud console, go to the **Organization policies** page.

   [Go to Organization policies](https://console.cloud.google.com/iam-admin/orgpolicies)
2. From the project picker, select the project that you want to set the organization policy for.
3. From the list on the **Organization policies** page, select your constraint to view the **Policy details** page for that constraint.
4. To configure the organization policy for this resource, click **Manage policy**.
5. On the **Edit policy** page, select **Override parent's policy**.
6. Click **Add a rule**.
7. In the **Enforcement** section, select whether this organization policy is enforced or not.
8. Optional: To make the organization policy conditional on a tag, click **Add condition** . Note that if you add a conditional rule to an organization policy, you must add at least one unconditional rule or the policy cannot be saved. For more information, see [Scope organization policies with tags](https://docs.cloud.google.com/organization-policy/scope-policies.md.txt).
9. To enforce the organization policy in dry-run mode, click **Set dry run policy** . For more information, see [Test organization policies](https://docs.cloud.google.com/organization-policy/test-policies.md.txt).
10. After you verify that the organization policy in dry-run mode works as intended, set the live policy by clicking **Set policy**.

### gcloud

1. To create an organization policy with boolean rules, create a policy YAML file that references the constraint:

```yaml
name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
spec:
  rules:
  - enforce: true

dryRunSpec:
  rules:
  - enforce: true
```
2. Replace the following:
   - `PROJECT_ID`: the project that you want to enforce your constraint on.
   - `CONSTRAINT_NAME`: the name you defined for your custom constraint. For example, `custom.allowEntitlementWithMaxRequestDurationLessThan2h`.
3. To enforce the organization policy in [dry-run mode](https://docs.cloud.google.com/organization-policy/test-policies.md.txt), run the following command with the `dryRunSpec` flag:

```bash
gcloud org-policies set-policy POLICY_PATH --update-mask=dryRunSpec
```
4. Replace `POLICY_PATH` with the full path to your organization policy YAML file. The policy requires up to 15 minutes to take effect.
5. After you verify that the organization policy in dry-run mode works as intended, set the live policy with the `org-policies set-policy` command and the `spec` flag:

```bash
gcloud org-policies set-policy POLICY_PATH --update-mask=spec
```
6. Replace `POLICY_PATH` with the full path to your organization policy YAML file. The policy requires up to 15 minutes to take effect.

## Test the custom organization policy


The following example restricts the maximum request duration for Privileged Access Manager entitlements to less than two hours.

Before you begin, you must know the following:

- Your organization ID
- A project ID

### Create the constraint

1. Save the following file as `constraint-limit-pam-duration.yaml`:

   ```yaml
   name: organizations/ORGANIZATION_ID/customConstraints/custom.allowEntitlementWithMaxRequestDurationLessThan2h
   resourceTypes:
   - privilegedaccessmanager.googleapis.com/Entitlement
   methodTypes:
   - CREATE
   - UPDATE
   condition: "resource.maxRequestDuration < duration('7200s')"
   actionType: ALLOW
   displayName: Restrict maximum PAM request duration
   description: Entitlements must have a maximum request duration of less than two hours.
   ```

   This constraint lets you create or update entitlements only if their maximum
   request duration is less than two hours.
2. Apply the constraint:

   ```bash
   gcloud org-policies set-custom-constraint ~/constraint-limit-pam-duration.yaml
   ```
3. Verify that the constraint exists:

   ```bash
   gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
   ```

   The output is similar to the following:

       CUSTOM_CONSTRAINT                                       ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                                     DISPLAY_NAME
       custom.allowEntitlementWithMaxRequestDurationLessThan2h ALLOW        CREATE,UPDATE  privilegedaccessmanager.googleapis.com/Entitlement Restrict maximum PAM request duration
       ...

### Create the policy

1. Save the following file as `policy-restrict-duration.yaml`:

   ```yaml
   name: projects/PROJECT_ID/policies/custom.allowEntitlementWithMaxRequestDurationLessThan2h
   spec:
     rules:
     - enforce: true
   ```

   Replace `PROJECT_ID` with your project ID.
2. Apply the policy:

   ```bash
   gcloud org-policies set-policy ~/policy-restrict-duration.yaml
   ```
3. Verify that the policy exists:

   ```bash
   gcloud org-policies list --project=PROJECT_ID
   ```

   The output is similar to the following:

       CONSTRAINT                                              LIST_POLICY  BOOLEAN_POLICY        ETAG
       custom.allowEntitlementWithMaxRequestDurationLessThan2h -            SET                   CPHYssIGEOi23pAB-

After you apply the policy, wait about two minutes for Google Cloud to
start enforcing the policy.

### Test the policy

To test the custom organization policy, try to create an entitlement with a maximum request duration of 3 hours (10,800 seconds) in your test project:

```bash
gcloud beta pam entitlements create ent-test-id \
    --project=PROJECT_ID \
    --location=global \
    --max-request-duration=3h \
    --eligible-users="user:user@example.com" \
    --privileged-resources="projects/test-project" \
    --privileged-roles="roles/viewer"
```

The output is similar to the following:

    Operation denied by custom org policies: ["customConstraints/custom.allowEntitlementWithMaxRequestDurationLessThan2h": "Entitlements must have a maximum request duration of less than 2 hours."]

## Example custom organization policies for common use cases

This table provides syntax examples for some common custom constraints.

| Description | Constraint syntax |
|---|---|
| Limit maximum request duration for all entitlements to 4 hours | ```yaml name: organizations/ORGANIZATION_ID/customConstraints/custom.limitPamEntitlementDuration resourceTypes: - privilegedaccessmanager.googleapis.com/Entitlement methodTypes: - CREATE - UPDATE condition: "resource.maxRequestDuration <= duration('14400s')" actionType: ALLOW displayName: Limit PAM entitlement duration description: >- Entitlements cannot have a maximum request duration of more than 4 hours. ``` |
| Require approver justification for all entitlements | ```yaml name: organizations/ORGANIZATION_ID/customConstraints/custom.requirePamApproverJustification resourceTypes: - privilegedaccessmanager.googleapis.com/Entitlement methodTypes: - CREATE - UPDATE condition: >- has(resource.approvalWorkflow.manualApprovals) && resource.approvalWorkflow.manualApprovals.requireApproverJustification == true actionType: ALLOW displayName: Require PAM approver justification description: >- Approvers must provide a justification for all PAM entitlement grants. ``` |
| Restrict grants from being requested for more than 1 hour | ```yaml name: organizations/ORGANIZATION_ID/customConstraints/custom.limitPamGrantDuration resourceTypes: - privilegedaccessmanager.googleapis.com/Grant methodTypes: - CREATE condition: "resource.requestedDuration <= duration('3600s')" actionType: ALLOW displayName: Limit PAM grant duration description: Grants cannot be requested for more than 1 hour. ``` |

## What's next

- Learn more about [Organization Policy Service](https://docs.cloud.google.com/organization-policy/overview.md.txt).
- Learn more about how to [create and manage organization policies](https://docs.cloud.google.com/organization-policy/create-organization-policies.md.txt).
- See the full list of managed [organization policy constraints](https://docs.cloud.google.com/organization-policy/reference/org-policy-constraints.md.txt).