# Manage CA Service resources using custom constraints

<br />

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

- `privateca.googleapis.com/CaPool`
- `privateca.googleapis.com/CertificateAuthority`
- `privateca.googleapis.com/CertificateTemplate`

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).

## 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).

## Certificate Authority Service supported resources

The following table lists the Certificate Authority Service resources that you can reference in custom constraints.


| Resource | Field |
|---|---|
| privateca.googleapis.com/CaPool | `resource.encryptionSpec.cloudKmsKey` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.allowedIssuanceModes.allowConfigBasedIssuance` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.allowedIssuanceModes.allowCsrBasedIssuance` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.allowedKeyTypes.ellipticCurve.signatureAlgorithm` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.allowedKeyTypes.rsa.maxModulusSize` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.allowedKeyTypes.rsa.minModulusSize` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.allowRequesterSpecifiedNotBeforeTime` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.backdateDuration` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.additionalExtensions.critical` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.additionalExtensions.objectId.objectIdPath` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.additionalExtensions.value` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.aiaOcspServers` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.caOptions.isCa` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.caOptions.maxIssuerPathLength` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.baseKeyUsage.certSign` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.baseKeyUsage.contentCommitment` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.baseKeyUsage.crlSign` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.baseKeyUsage.dataEncipherment` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.baseKeyUsage.decipherOnly` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.baseKeyUsage.digitalSignature` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.baseKeyUsage.encipherOnly` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.baseKeyUsage.keyAgreement` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.baseKeyUsage.keyEncipherment` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.extendedKeyUsage.clientAuth` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.extendedKeyUsage.codeSigning` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.extendedKeyUsage.emailProtection` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.extendedKeyUsage.ocspSigning` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.extendedKeyUsage.serverAuth` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.extendedKeyUsage.timeStamping` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.keyUsage.unknownExtendedKeyUsages.objectIdPath` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.nameConstraints.critical` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.nameConstraints.excludedDnsNames` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.nameConstraints.excludedEmailAddresses` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.nameConstraints.excludedIpRanges` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.nameConstraints.excludedUris` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.nameConstraints.permittedDnsNames` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.nameConstraints.permittedEmailAddresses` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.nameConstraints.permittedIpRanges` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.nameConstraints.permittedUris` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.baselineValues.policyIds.objectIdPath` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.identityConstraints.allowSubjectAltNamesPassthrough` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.identityConstraints.allowSubjectPassthrough` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.identityConstraints.celExpression` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.maximumLifetime` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.passthroughExtensions.additionalExtensions.objectIdPath` |
| privateca.googleapis.com/CaPool | `resource.issuancePolicy.passthroughExtensions.knownExtensions` |
| privateca.googleapis.com/CaPool | `resource.name` |
| privateca.googleapis.com/CaPool | `resource.publishingOptions.encodingFormat` |
| privateca.googleapis.com/CaPool | `resource.publishingOptions.publishCaCert` |
| privateca.googleapis.com/CaPool | `resource.publishingOptions.publishCrl` |
| privateca.googleapis.com/CaPool | `resource.tier` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.publicKey.format` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.publicKey.key` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subject.commonName` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subject.countryCode` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subject.locality` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subject.organization` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subject.organizationalUnit` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subject.postalCode` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subject.province` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subject.rdnSequence.attributes.objectId.objectIdPath` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subject.rdnSequence.attributes.type` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subject.rdnSequence.attributes.value` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subject.streetAddress` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subjectAltName.customSans.critical` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subjectAltName.customSans.objectId.objectIdPath` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subjectAltName.customSans.value` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subjectAltName.dnsNames` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subjectAltName.emailAddresses` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subjectAltName.ipAddresses` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectConfig.subjectAltName.uris` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.subjectKeyId.keyId` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.additionalExtensions.critical` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.additionalExtensions.objectId.objectIdPath` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.additionalExtensions.value` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.aiaOcspServers` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.caOptions.isCa` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.caOptions.maxIssuerPathLength` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.baseKeyUsage.certSign` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.baseKeyUsage.contentCommitment` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.baseKeyUsage.crlSign` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.baseKeyUsage.dataEncipherment` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.baseKeyUsage.decipherOnly` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.baseKeyUsage.digitalSignature` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.baseKeyUsage.encipherOnly` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.baseKeyUsage.keyAgreement` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.baseKeyUsage.keyEncipherment` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.extendedKeyUsage.clientAuth` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.extendedKeyUsage.codeSigning` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.extendedKeyUsage.emailProtection` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.extendedKeyUsage.ocspSigning` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.extendedKeyUsage.serverAuth` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.extendedKeyUsage.timeStamping` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.keyUsage.unknownExtendedKeyUsages.objectIdPath` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.nameConstraints.critical` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.nameConstraints.excludedDnsNames` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.nameConstraints.excludedEmailAddresses` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.nameConstraints.excludedIpRanges` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.nameConstraints.excludedUris` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.nameConstraints.permittedDnsNames` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.nameConstraints.permittedEmailAddresses` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.nameConstraints.permittedIpRanges` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.nameConstraints.permittedUris` |
| privateca.googleapis.com/CertificateAuthority | `resource.config.x509Config.policyIds.objectIdPath` |
| privateca.googleapis.com/CertificateAuthority | `resource.gcsBucket` |
| privateca.googleapis.com/CertificateAuthority | `resource.keySpec.algorithm` |
| privateca.googleapis.com/CertificateAuthority | `resource.keySpec.cloudKmsKeyVersion` |
| privateca.googleapis.com/CertificateAuthority | `resource.lifetime` |
| privateca.googleapis.com/CertificateAuthority | `resource.name` |
| privateca.googleapis.com/CertificateAuthority | `resource.subordinateConfig.certificateAuthority` |
| privateca.googleapis.com/CertificateAuthority | `resource.subordinateConfig.pemIssuerChain.pemCertificates` |
| privateca.googleapis.com/CertificateAuthority | `resource.type` |
| privateca.googleapis.com/CertificateAuthority | `resource.userDefinedAccessUrls.aiaIssuingCertificateUrls` |
| privateca.googleapis.com/CertificateAuthority | `resource.userDefinedAccessUrls.crlAccessUrls` |
| privateca.googleapis.com/CertificateTemplate | `resource.description` |
| privateca.googleapis.com/CertificateTemplate | `resource.identityConstraints.allowSubjectAltNamesPassthrough` |
| privateca.googleapis.com/CertificateTemplate | `resource.identityConstraints.allowSubjectPassthrough` |
| privateca.googleapis.com/CertificateTemplate | `resource.identityConstraints.celExpression` |
| privateca.googleapis.com/CertificateTemplate | `resource.maximumLifetime` |
| privateca.googleapis.com/CertificateTemplate | `resource.name` |
| privateca.googleapis.com/CertificateTemplate | `resource.passthroughExtensions.additionalExtensions.objectIdPath` |
| privateca.googleapis.com/CertificateTemplate | `resource.passthroughExtensions.knownExtensions` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.additionalExtensions.critical` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.additionalExtensions.objectId.objectIdPath` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.additionalExtensions.value` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.aiaOcspServers` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.caOptions.isCa` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.caOptions.maxIssuerPathLength` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.baseKeyUsage.certSign` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.baseKeyUsage.contentCommitment` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.baseKeyUsage.crlSign` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.baseKeyUsage.dataEncipherment` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.baseKeyUsage.decipherOnly` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.baseKeyUsage.digitalSignature` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.baseKeyUsage.encipherOnly` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.baseKeyUsage.keyAgreement` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.baseKeyUsage.keyEncipherment` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.extendedKeyUsage.clientAuth` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.extendedKeyUsage.codeSigning` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.extendedKeyUsage.emailProtection` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.extendedKeyUsage.ocspSigning` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.extendedKeyUsage.serverAuth` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.extendedKeyUsage.timeStamping` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.keyUsage.unknownExtendedKeyUsages.objectIdPath` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.nameConstraints.critical` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.nameConstraints.excludedDnsNames` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.nameConstraints.excludedEmailAddresses` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.nameConstraints.excludedIpRanges` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.nameConstraints.excludedUris` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.nameConstraints.permittedDnsNames` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.nameConstraints.permittedEmailAddresses` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.nameConstraints.permittedIpRanges` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.nameConstraints.permittedUris` |
| privateca.googleapis.com/CertificateTemplate | `resource.predefinedValues.policyIds.objectIdPath` |

<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.enforceCaPoolEncodingFormat`. 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.enforceCaPoolEncodingFormat`. 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, `privateca.googleapis.com/CaPool`. 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.publishingOptions.encodingFormat == 'DER'"`.
   - For more information about the resources available to write conditions against, see [Supported resources](https://docs.cloud.google.com/certificate-authority-service/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.enforceCaPoolEncodingFormat`.
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 require all Certificate Authority Pool (CaPool) resources in a specific project to issue certificates with a maximum certificate lifetime of no more than 30 days.

Before you begin, you should know the following:

- Your organization ID
- A project ID

### Required roles


To get the permissions that
you need to manage custom constraints, enable APIs, and manage CA Service resources for this guide,

ask your administrator to grant you the
following IAM roles:

- [Organization Policy Administrator](https://docs.cloud.google.com/iam/docs/roles-permissions/orgpolicy.md.txt#orgpolicy.policyAdmin) (`roles/orgpolicy.policyAdmin`) on organization
- [CA Service Admin](https://docs.cloud.google.com/iam/docs/roles-permissions/privateca.md.txt#privateca.admin) (`roles/privateca.admin`) on project
- [Service Usage Admin](https://docs.cloud.google.com/iam/docs/roles-permissions/serviceusage.md.txt#serviceusage.serviceUsageAdmin) (`roles/serviceusage.serviceUsageAdmin`) on project


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).

### Enable the Organization Policy Service API

The `gcloud org-policies` commands require the `orgpolicy.googleapis.com` API. Enable this API in your project:

```bash
     gcloud services enable orgpolicy.googleapis.com --project=PROJECT_ID
```

Replace `PROJECT_ID` with your project ID.

### Create the constraint

1. Save the following file as `constraint-cas-capool-lifetime.yaml`:

   ```yaml
   name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceCasMaxLifetime30d
   resourceTypes:
   - privateca.googleapis.com/CaPool
   methodTypes:
   - CREATE
   - UPDATE
   condition: "!has(resource.issuancePolicy.maximumLifetime) || duration(resource.issuancePolicy.maximumLifetime) > duration('2592000s')"
   actionType: DENY
   displayName: Enforce Max Certificate Lifetime (30 Days)
   description: Only allows CaPools where the issuancePolicy.maximumLifetime field is set to 30 days (2592000 seconds) or less.
   ```

   Replace `ORGANIZATION_ID` with your organization ID.
2. Apply the following constraint:

   ```bash
   gcloud org-policies set-custom-constraint ~/constraint-cas-capool-lifetime.yaml
   ```
3. Verify that the constraint exists:

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

   Replace `ORGANIZATION_ID` with your organization ID.

### Create the policy

1. Save the following file as `policy-cas-capool-lifetime.yaml`:

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

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

   ```bash
   gcloud org-policies set-policy ~/policy-cas-capool-lifetime.yaml
   ```
3. Verify that the policy exists:

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

   Replace `PROJECT_ID` with your project ID.

After you apply the policy, wait about 15 minutes for Google Cloud to
start enforcing the policy. For more information, see [Creating and managing organization policies](https://docs.cloud.google.com/resource-manager/docs/organization-policy/creating-managing-policies).

### Test the policy

To test the custom constraint, you'll create and update a
CA Service pool using the gcloud CLI.

Define variables for your test resources:

- `PROJECT_ID`: your Google Cloud project ID
- `LOCATION`: the region for the CA pool, for example, `us-west1`
- `POOL_NAME`: a name for your test CA pool, such as `my-test-pool`

1. Create a CA Pool with a maximum lifetime more than 30 days:

   Create a YAML file named `capool_violating.yaml` with a `maximumLifetime` more than 30 days (for example, 31 days, which is 2,678,400 seconds). The `maximumLifetime` field is set in seconds.

   ```yaml
   # capool_violating.yaml
   maximumLifetime: 2678400s
   ```

   To create a CA Pool that violates the policy, run the following command:

   ```bash
   # This creation should be blocked by the policy
   gcloud privateca pools create POOL_NAME-violating \
     --location LOCATION \
     --project PROJECT_ID \
     --issuance-policy capool_violating.yaml
   ```

   The command fails with a `FAILED_PRECONDITION` error, indicating a violation of the `customConstraints/custom.enforceCasMaxLifetime30d` constraint.
2. Create a CA pool with a compliant maximum lifetime:

   Create a YAML file named `capool_compliant.yaml` with a `maximumLifetime` of 30
   days (2,592,000 seconds). The `maximumLifetime` field is set in seconds.

   ```yaml
   # capool_compliant.yaml
   maximumLifetime: 2592000s
   ```

   To create the CA pool, run the following command:

   ```bash
   gcloud privateca pools create POOL_NAME \
     --location "LOCATION" \
     --project "PROJECT_ID" \
     --issuance-policy capool_compliant.yaml
   ```

   The command completes successfully.
3. Try to update the CA pool to a non-compliant maximum lifetime:

   Run the following command to apply the settings from
   `capool_violating.yaml`:

   ```bash
   # This update is blocked by the policy
   gcloud privateca pools update POOL_NAME \
     --location "LOCATION" \
     --project "PROJECT_ID" \
     --issuance-policy capool_violating.yaml
   ```

   This command fails with a `FAILED_PRECONDITION` error, indicating a violation of the `customConstraints/custom.enforceCasMaxLifetime30d` constraint.
4. Update the CA pool to a different compliant maximum lifetime

   Create a YAML file named `capool_compliant_update.yaml` with a
   `maximumLifetime` of 15 days (1,296,000 seconds). The `maximumLifetime` field is set in seconds.

   ```yaml
   # capool_compliant_update.yaml
   maximumLifetime: 1296000s
   ```

   To update the CA pool, run the following command:

   ```bash
   gcloud privateca pools update POOL_NAME \
     --location "LOCATION" \
     --project "PROJECT_ID" \
     --issuance-policy capool_compliant_update.yaml
   ```

   The command completes successfully.
5. Clean up the test resources.

   Delete the CA pool created during the test:

   ```bash
   gcloud privateca pools delete POOL_NAME \
     --location "LOCATION" \
     --project "PROJECT_ID" \
   ```

## Example custom organization policies for common use cases

This table provides syntax examples for some common custom constraints.

| Description | Constraint syntax |
|---|---|
| Enforce specific key algorithms for all CAs | Ensures any new Certificate Authority uses one of the allowed key algorithms. ```yaml name: organizations/ORGANIZATION_ID/customConstraints/custom.casAllowedKeyAlgos resourceTypes: - privateca.googleapis.com/CertificateAuthority methodTypes: - CREATE - UPDATE condition: "resource.keySpec.algorithm in ['EC_P256_SHA256', 'RSA_PSS_3072_SHA256']" actionType: ALLOW displayName: Restrict CA Key Algorithms description: Only allows specific key algorithms for new CAs. ``` |
| Require a specific organization name in the CA subject | Ensures all new CAs have a standardized `organization` field in their subject. ```yaml name: organizations/ORGANIZATION_ID/customConstraints/custom.casRequireSubjectOrg resourceTypes: - privateca.googleapis.com/CertificateAuthority methodTypes: - CREATE - UPDATE condition: "resource.config.subjectConfig.subject.organization == 'Example Company Inc.'" actionType: ALLOW displayName: Enforce CA Subject Organization description: Requires new CAs to have the specified organization name. ``` |
| Enforce Maximum Certificate Lifetime for CaPools | Ensures that CaPools are configured to issue certificates with a maximum lifetime of no more than 30 days. ```yaml name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceCasMaxLifetime30d resourceTypes: - privateca.googleapis.com/CaPool methodTypes: - CREATE - UPDATE condition: "!has(resource.issuancePolicy.maximumLifetime) || duration(resource.issuancePolicy.maximumLifetime) > duration('2592000s')" actionType: DENY displayName: Enforce Max Certificate Lifetime (30 Days) description: Only allows CaPools where the issuancePolicy.maximumLifetime field is set to 30 days (2592000 seconds) or less. ``` |

## 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).