Use custom organization policies

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

• healthcare.googleapis.com/Dataset
• healthcare.googleapis.com/FhirStore
• healthcare.googleapis.com/DicomStore
• healthcare.googleapis.com/Hl7V2Store
• healthcare.googleapis.com/ConsentStore

To learn more about Organization Policy, see 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 , 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 . You can enforce organization policies at the organization, folder, or project level.

Organization Policy provides built-in managed constraints 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 .

Limitations

The following healthcare.googleapis.com/Hl7V2Store fields are not supported:

• parserConfig.schema.schemas.messageSchemaConfigs

The following healthcare.googleapis.com/FhirStore fields are not supported:

• notificationConfig . Use notificationConfigs instead.

Before you begin

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project : Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project : To create a project, you need the Project Creator ( roles/resourcemanager.projectCreator ), which contains the resourcemanager.projects.create permission. Learn how to grant roles .

Go to project selector

Verify that billing is enabled for your Google Cloud project .

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity .

To initialize the gcloud CLI, run the following command:

gcloud  
init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project : Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project : To create a project, you need the Project Creator ( roles/resourcemanager.projectCreator ), which contains the resourcemanager.projects.create permission. Learn how to grant roles .

Go to project selector

Verify that billing is enabled for your Google Cloud project .

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity .

To initialize the gcloud CLI, run the following command:

gcloud  
init

1. Ensure that you know 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 ( roles/orgpolicy.policyAdmin ) IAM role on the organization resource. For more information about granting roles, see Manage access to projects, folders, and organizations .

You might also be able to get the required permissions through custom roles or other predefined roles .

Create 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) . For more information about how to build conditions in custom constraints using CEL, see the CEL section of Creating and managing custom constraints .

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

  name 
 : 
  
 organizations/ ORGANIZATION_ID 
/customConstraints/ CONSTRAINT_NAME 
 
 resourceTypes 
 : 
 - 
  
  RESOURCE_NAME 
 
 methodTypes 
 : 
 - 
  
 CREATE 
 - 
  
 UPDATE 
 condition 
 : 
  
 " CONDITION 
" 
 actionType 
 : 
  
  ACTION 
 
 displayName 
 : 
  
  DISPLAY_NAME 
 
 description 
 : 
  
  DESCRIPTION 
 
 

Replace the following:

• ORGANIZATION_ID : your organization ID, such as 123456789 .

• CONSTRAINT_NAME : the name you want for your new custom constraint. A custom constraint must start with custom. , and can only include uppercase letters, lowercase letters, or numbers. For example, custom.enableHealthcareCMEK . The maximum length of this field is 70 characters.

• RESOURCE_NAME : the fully qualified name of the Google Cloud resource containing the object and field you want to restrict. For example, healthcare.googleapis.com/Dataset .

• CONDITION : a CEL condition that is written against a representation of a supported service resource. This field has a maximum length of 1000 characters. See Supported resources for more information about the resources available to write conditions against. For example, "!has(resource.encryptionSpec)" .

• ACTION : the action to take if the condition is met. Possible values are ALLOW and DENY .

• DISPLAY_NAME : a human-friendly name for the constraint. This field has a maximum length of 200 characters.

• DESCRIPTION : a human-friendly description of the constraint to display as an error message when the policy is violated. This field has a maximum length of 2000 characters.

For more information about how to create a custom constraint, see Defining custom constraints .

Set up a custom constraint

gcloud  
org-policies  
set-custom-constraint  
 CONSTRAINT_PATH 

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

Enforce a custom organization policy

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

  
gcloud  
org-policies  
set-policy  
 POLICY_PATH 
  

Test the custom organization policy

The following example creates a custom constraint and policy that requires all new datasets in a specific project to be encrypted with a customer-managed encryption key (CMEK).

Before you begin, you must know the following:

• Your organization ID
• A project ID

Create the constraint

1. Save the following file as constraint-enable-healthcare-cmek.yaml :

     name 
    : 
     
    organizations/ ORGANIZATION_ID 
   /customConstraints/custom.enableHealthcareCMEK 
    resourceTypes 
    : 
    - 
     
    healthcare.googleapis.com/Dataset 
    methodTypes 
    : 
    - 
     
    CREATE 
    condition 
    : 
     
    "!has(resource.encryptionSpec)" 
    actionType 
    : 
     
    DENY 
    displayName 
    : 
     
    Enable Healthcare CMEK 
    description 
    : 
     
    All new datasets must be CMEK-encrypted. 
    
   

   This defines a constraint where for every new dataset, if the dataset is not CMEK-encrypted, the operation is denied.

2. Apply the constraint:

    gcloud  
   org-policies  
   set-custom-constraint  
   ~/constraint-enable-healthcare-cmek.yaml 
   

3. Verify that the constraint exists:

    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.enableHealthcareCMEK             DENY         CREATE         healthcare.googleapis.com/Dataset   Enable Healthcare CMEK
   ... 
   

Create the policy

1. Save the following file as policy-enable-healthcare-cmek.yaml :

     name 
    : 
     
    projects/ PROJECT_ID 
   /policies/custom.enableHealthcareCMEK 
    spec 
    : 
     
    rules 
    : 
     
    - 
     
    enforce 
    : 
     
    true 
    
   

   Replace PROJECT_ID with your project ID.

2. Apply the policy:

    gcloud  
   org-policies  
   set-policy  
   ~/policy-enable-healthcare-cmek.yaml 
   

3. Verify that the policy exists:

    gcloud  
   org-policies  
   list  
   --project = 
    PROJECT_ID 
    
   

   The output is similar to the following:

    CONSTRAINT                    LIST_POLICY    BOOLEAN_POLICY    ETAG
   custom.enableHealthcareCMEK   -              SET               COCsm5QGENiXi2E= 
   

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

Test the policy

Try to create a Cloud Healthcare API dataset without providing a CMEK key in the project:

 curl  
-X  
POST  
 \ 
  
-H  
 "Authorization: Bearer 
 $( 
gcloud  
auth  
print-access-token ) 
 " 
  
 \ 
  
-H  
 "Content-Type: application/json; charset=utf-8" 
  
 \ 
  
-d  
 "" 
  
 \ 
  
 "https://healthcare.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION 
/datasets?datasetId= DATASET_ID 
" 
 

The output is the following:

 Operation denied by custom org policies: ["customConstraints/custom.enableHealthcareCMEK": "All new datasets must be CMEK-encrypted."] 

Cloud Healthcare API supported resources

What's next

• Learn more about Organization Policy Service .
• Learn more about how to create and manage organization policies .
• See the full list of managed organization policy constraints .