This page shows you how to use Organization Policy Service custom constraints to restrict specific operations on the following Google Cloud resources: - `apikeys.googleapis.com/Key` 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). ### Benefits - **Cost management**: use organization policies to restrict the VM instance and disk sizes and types that can be used in your organization. You can also restrict the machine family that is used for the VM instance. - **Security, compliance, and governance** : you can use custom organization policies as follows: - To enforce security requirements, you can require specific firewall port rules on VMs. - To support hardware isolation or licensing compliance, you can require all VMs within a specific project or folder to run on [sole-tenant nodes](https://docs.cloud.google.com/compute/docs/nodes/sole-tenant-nodes.md.txt). - To govern automation scripts, you can use custom organization policies to verify that labels match desired expressions. ## 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 custom organization policies, ask your administrator to grant you the [Organization Policy Administrator](https://docs.cloud.google.com/iam/docs/roles-permissions/orgpolicy.md.txt#orgpolicy.policyAdmin) (`roles/orgpolicy.policyAdmin`) IAM role on the organization 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). You might also be able to get the required permissions through [custom roles](https://docs.cloud.google.com/iam/docs/creating-custom-roles) or other [predefined roles](https://docs.cloud.google.com/iam/docs/roles-overview#predefined). ## API Keys supported resources The following table lists the API Keys resources that you can reference in custom constraints. | Resource | Field | |---|---| | apikeys.googleapis.com/Key | `resource.displayName` | | apikeys.googleapis.com/Key | `resource.restrictions.androidKeyRestrictions.allowedApplications.packageName` | | apikeys.googleapis.com/Key | `resource.restrictions.androidKeyRestrictions.allowedApplications.sha1Fingerprint` | | apikeys.googleapis.com/Key | `resource.restrictions.apiTargets.methods` | | apikeys.googleapis.com/Key | `resource.restrictions.apiTargets.service` | | apikeys.googleapis.com/Key | `resource.restrictions.browserKeyRestrictions.allowedReferrers` | | apikeys.googleapis.com/Key | `resource.restrictions.iosKeyRestrictions.allowedBundleIds` | | apikeys.googleapis.com/Key | `resource.restrictions.serverKeyRestrictions.allowedIps` | | apikeys.googleapis.com/Key | `resource.serviceAccountEmail` |
## 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.allowOnlyStartsWithKeyName`. 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.allowOnlyStartsWithKeyName`. 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, `apikeys.googleapis.com/Key`. 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.displayName.startsWith('key-')"`. - For more information about the resources available to write conditions against, see [Supported resources](https://docs.cloud.google.com/api-keys/docs/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. Click **Test changes** to simulate the effect of the organization policy. For more information, see [Test organization policy changes with Policy Simulator](https://docs.cloud.google.com/policy-intelligence/docs/test-organization-policies.md.txt). 10. 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). 11. 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.allowOnlyStartsWithKeyName`. 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 creates a custom constraint and policy that requires the display name of all new API Keys in a specific project should start with the `key-`. Before you begin, you need to know the following: - Your organization ID - A project ID ### Create the constraint 1. Save the following file as `constraint-allow-only-starts-with-key.yaml`: ```yaml name: organizations/ORGANIZATION_ID/customConstraints/custom.allowOnlyStartsWithKeyName resourceTypes: - apikeys.googleapis.com/Key methodTypes: - CREATE condition: "resource.displayName.startsWith('key-')" actionType: ALLOW displayName: Only new API Keys with the display name starting with 'key-' are allowed. description: Restrict all other key creation with the display name starting with 'key-'. ``` This defines a constraint where for every new API Key, if the display name is not starting with `key-`, the operation is denied. 2. Apply the constraint: ```bash gcloud org-policies set-custom-constraint ~/constraint-allow-only-starts-with-key.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.allowOnlyStartsWithKeyName ALLOW CREATE apikeys.googleapis.com/Key Only new API Keys with the display name starting with 'key-' are allowed. ... ### Create the policy 1. Save the following file as `policy-allow-only-starts-with-key.yaml`: ```yaml name: projects/PROJECT_ID/policies/custom.allowOnlyStartsWithKeyName spec: rules: - enforce: true ``` Replace `PROJECT_ID` with your project ID. 2. Apply the policy: ```bash gcloud org-policies set-policy ~/policy-allow-only-starts-with-key.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.allowOnlyStartsWithKeyName - SET COCsm5QGENiXi2E= After you apply the policy, wait for about two minutes for Google Cloud to start enforcing the policy. ### Test the policy Try to create a new API Key with the display name `not-key` in the project: ```bash gcloud services api-keys create --display-name=not-key ``` The output is the following: Operation denied by org policy: ["customConstraints/custom.allowOnlyStartsWithKeyName": "Only new API Keys with the display name starting with 'key-' are allowed."] ## Example custom organization policies for common use cases This table provides syntax examples for some common custom constraints. | Description | Constraint syntax | |---|---| | Only new API Keys with the display name starting with 'key-' are allowed. | ```yaml name: organizations/ORGANIZATION_ID/customConstraints/custom.allowOnlyStartsWithKeyName resourceTypes: - apikeys.googleapis.com/Key methodTypes: - CREATE condition: "resource.displayName.startsWith('key-')" actionType: ALLOW displayName: Only new API Keys with the display name starting with 'key-' are allowed. description: Restrict all other key creation with the display name starting with 'key-'. ``` | | Only API Keys bound to 'test-sa@test-project.iam.gserviceaccount.com' are allowed to be created/updated. | ```yaml name: organizations/ORGANIZATION_ID/customConstraints/custom.denyTestServiceAccountBound resourceTypes: - apikeys.googleapis.com/Key methodTypes: - CREATE - UPDATE condition: "resource.serviceAccountEmail != 'test-sa@test-project.iam.gserviceaccount.com'" actionType: ALLOW displayName: Only API Keys bound to 'test-sa@test-project.iam.gserviceaccount.com' are allowed. description: Restrict all other key creation or update to only be bound to the test service account 'test-sa@test-project.iam.gserviceaccount.com'. ``` | | Only new API Keys with the IP '1.1.1.1' in the allowlist can be created. | ```yaml name: organizations/ORGANIZATION_ID/customConstraints/custom.allowOnlyIP1111 resourceTypes: - apikeys.googleapis.com/Key methodTypes: - CREATE condition: "'1.1.1.1' in resource.restrictions.serverKeyRestrictions.allowedIps" actionType: ALLOW displayName: Only new API Keys with the IP '1.1.1.1' in the allowlist can be created. description: Restrict all other key creation with the IP '1.1.1.1' in the allowlist. ``` | | Deny API Keys update targeting the `myservice.googleapis.com` service. | ```yaml name: organizations/ORGANIZATION_ID/customConstraints/custom.denyUpdateMyService resourceTypes: - apikeys.googleapis.com/Key methodTypes: - UPDATE condition: "resource.restrictions.apiTargets.exists(target, target.service == 'myservice.googleapis.com')" actionType: DENY displayName: Deny API Keys update targeting the `myservice.googleapis.com` service. description: Block `myservice.googleapis.com` service API Keys update. ``` | ## 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).