Console
    Contact Us Start free

    Configure 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:

    • securitycenter.googleapis.com/BigQueryExport
    • securitycenter.googleapis.com/MuteConfig
    • securitycenter.googleapis.com/NotificationConfig
    • securitycenter.googleapis.com/ResourceValueConfig
    • securitycenter.googleapis.com/ContainerThreatDetectionSettings
    • securitycenter.googleapis.com/EventThreatDetectionSettings
    • securitycenter.googleapis.com/SecurityHealthAnalyticsSettings
    • securitycenter.googleapis.com/VirtualMachineThreatDetectionSettings
    • securitycenter.googleapis.com/WebSecurityScannerSettings
    • securitycentermanagement.googleapis.com/SecurityCenterService
    • securitycentermanagement.googleapis.com/SecurityHealthAnalyticsCustomModule
    • securitycentermanagement.googleapis.com/EventThreatDetectionCustomModule
    • websecurityscanner.googleapis.com/ScanConfig

    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 .

    Before you begin

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

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

      Go to project selector

    3. Verify that billing is enabled for your Google Cloud project .

    4. Install the Google Cloud CLI.

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

    6. To initialize the gcloud CLI, run the following command:

      gcloud  
init

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

      Go to project selector

    8. Verify that billing is enabled for your Google Cloud project .

    9. Install the Google Cloud CLI.

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

    11. To initialize the gcloud CLI, run the following command:

      gcloud  
init
    12. 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.SccNotificationConfig . 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, securitycenter.googleapis.com/NotificationConfig .

    • 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, "resource.pubsubTopic != 'projects/ PROJECT_ID /topics/ TOPIC_ID '" .

    • 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

    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 command: 
    gcloud  
org-policies  
set-custom-constraint  
 CONSTRAINT_PATH
    Replace CONSTRAINT_PATH with the full path to your custom constraint file. For example, /home/user/customconstraint.yaml . Once completed, your custom constraints are available as organization policies in your list of Google Cloud organization policies. To verify that the custom constraint exists, use the gcloud org-policies list-custom-constraints command: 
    gcloud  
org-policies  
list-custom-constraints  
--organization = 
 ORGANIZATION_ID
    Replace ORGANIZATION_ID with the ID of your organization resource. For more information, see 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

    2. From the project picker, select the project for which you want to set the organization policy.
    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 enforcement of this organization policy is on or off.
    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 Setting an organization policy with tags .
    9. Click Test changes to simulate the effect of the organization policy. Policy simulation isn't available for legacy managed constraints. For more information, see Test organization policy changes with Policy Simulator .
    10. To finish and apply the organization policy, click Set policy . The policy requires up to 15 minutes to take effect.

    gcloud

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

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

    Replace the following:

    • PROJECT_ID : the project on which you want to enforce your constraint.
    • CONSTRAINT_NAME : the name you defined for your custom constraint. For example, custom.SccNotificationConfig .

    To enforce the organization policy containing the constraint, run the following command:

      
gcloud  
org-policies  
set-policy  
 POLICY_PATH

    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 for the securitycenter.googleapis.com/NotificationConfig resource. This constraint only lets users create or modify notification configs that are subscribed to a specified Pub/Sub topic.

    Before you begin, you must know the following:

    • Your organization ID
    • A project ID
    • A Pub/Sub topic ID

    Create the constraint

    1. Create a YAML file called notificationConfig_constraint.yaml that defines the custom constraint:

         
 name 
 : 
  
 organizations/ ORGANIZATION_ID 
/customConstraints/custom.SccNotificationConfig 
  
 resourceTypes 
 : 
  
 - 
  
 securitycenter.googleapis.com/NotificationConfig 
  
 methodTypes 
 : 
  
 - 
  
 CREATE 
  
 - 
  
 UPDATE 
  
 condition 
 : 
  
 "resource.pubsubTopic 
  
 != 
  
 'projects/ PROJECT_ID 
/topics/ TOPIC_ID 
'" 
  
 actionType 
 : 
  
 DENY 
  
 displayName 
 : 
  
 Only let users create or modify notification configs that 
  
 are subscribed to a specific Pub/Sub topic. 
  
 description 
 : 
  
 "Can't 
  
 create 
  
 or 
  
 modify 
  
 notification 
  
 configs 
  
 that 
  
 are 
  
 subscribed 
  
 to 
  
 the 
  
 specified 
  
 Pub/Sub 
  
 topic."

    2. Apply the constraint:

       gcloud  
org-policies  
set-custom-constraint  
~/notificationConfig_constraint.yaml

    3. Verify that the constraint exists:

       gcloud  
org-policies  
list-custom-constraints  
--organization = 
 ORGANIZATION_ID 
--filter = 
 "RESOURCE_TYPES='securitycenter.googleapis.com/NotificationConfig'"

    Create the policy

    1. Create a YAML file called notificationConfig_policy.yaml that defines the organization policy:

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

    2. Apply the policy:

       gcloud  
org-policies  
set-policy  
~/notificationConfig_policy.yaml

    3. Verify that the policy exists:

       gcloud  
org-policies  
list  
--organization = 
 ORGANIZATION_ID 
--filter = 
 "constraint:custom.SccNotificationConfig"

    Test the policy

    Try to create a notification config that violates the org policy:

       
gcloud  
scc  
notifications  
create  
NOTIFICATION_CONFIG_ID  
 \ 
  
--pubsub-topic = 
projects/ PROJECT_ID 
/topics/example_topic  
 \ 
  
--project = 
 PROJECT_ID 
  
 \ 
  
--filter = 
 "state=\"ACTIVE\""

    The output is the following:

     Operation denied by custom org policies:
  ["customConstraints/SccNotificationConfig": "Can't create or modify
  notification configs that are subscribed to the specified Pub/Sub
  topic."]

    Example custom organization policies for common use cases

    This table provides syntax examples for some common custom constraints.

    Description Constraint syntax
    Only let users create or modify notification configs that are subscribed to a specific Pub/Sub topic. 
      
 name 
 : 
  
 organizations/ ORGANIZATION_ID 
/customConstraints/custom.SccNotificationConfig 
  
 resourceTypes 
 : 
  
 - 
  
 securitycenter.googleapis.com/NotificationConfig 
  
 methodTypes 
 : 
  
 - 
  
 CREATE 
  
 - 
  
 UPDATE 
  
 condition 
 : 
  
 "resource.pubsubTopic 
  
 != 
  
 'projects/ PROJECT_ID 
/topics/ TOPIC_ID 
'" 
  
 actionType 
 : 
  
 DENY 
  
 displayName 
 : 
  
 Only let users create or modify notification configs 
  
 that are subscribed to a specific Pub/Sub topic. 
  
 description 
 : 
  
 "Can't 
  
 create 
  
 or 
  
 modify 
  
 notification 
  
 configs 
  
 that 
  
 are 
  
 subscribed 
  
 to 
  
 the 
  
 specified 
  
 Pub/Sub 
  
 topic."
    Only let users export a specific BigQuery dataset. 
      
 name 
 : 
  
 organizations/ ORGANIZATION_ID 
/customConstraints/custom.SccBigQueryExport 
  
 resourceTypes 
 : 
  
 - 
  
 securitycenter.googleapis.com/BigQueryExport 
  
 methodTypes 
 : 
  
 - 
  
 CREATE 
  
 - 
  
 UPDATE 
  
 condition 
 : 
  
 "resource.dataset 
  
 != 
  
 'projects/ PROJECT_ID 
/datasets/ DATASET_ID 
'" 
  
 actionType 
 : 
  
 DENY 
  
 displayName 
 : 
  
 Only let users export a specific BigQuery dataset. 
  
 description 
 : 
  
 "Can't 
  
 export 
  
 the 
  
 specified 
  
 BigQuery 
  
 dataset."
    Prevent users from changing the service enablement state of Container Threat Detection settings resource. This use case also applies to the Event Threat Detection, Security Health Analytics, Virtual Machine Threat Detection, and Web Security Scanner settings resources. 
      
 name 
 : 
  
 organizations/ ORGANIZATION_ID 
/customConstraints/custom.SccKtdSettings 
  
 resourceTypes 
 : 
  
 - 
  
 securitycenter.googleapis.com/securitycenter.googleapis.com/ContainerThreatDetectionSettings 
  
 methodTypes 
 : 
  
 - 
  
 CREATE 
  
 - 
  
 UPDATE 
  
 condition 
 : 
  
 "resource.serviceEnablementState 
  
 != 
  
 ENABLED" 
  
 actionType 
 : 
  
 DENY 
  
 displayName 
 : 
  
 Prevent users from changing the Container Threat Detection service 
  
 enablement state. 
  
 description 
 : 
  
 "Can't 
  
 change 
  
 the 
  
 Container 
  
 Threat 
  
 Detection 
  
 service 
  
 enablement 
  
 state."
    Prevent a user from changing the enablement state of the Security Health Analytics custom module resource. This use case also applies to the Event Threat Detection custom module resource. 
      
 name 
 : 
  
 organizations/ ORGANIZATION_ID 
/customConstraints/custom.SccShaCustomModule 
  
 resourceTypes 
 : 
  
 - 
  
 securitycentermanagement.googleapis.com/SecurityHealthAnalyticsCustomModule 
  
 methodTypes 
 : 
  
 - 
  
 CREATE 
  
 - 
  
 UPDATE 
  
 condition 
 : 
  
 "resource.serviceEnablementState 
  
 != 
  
 ENABLED" 
  
 actionType 
 : 
  
 DENY 
  
 displayName 
 : 
  
 Prevent users from changing the Security Health Analytics custom 
  
 module enablement state. 
  
 description 
 : 
  
 "Can't 
  
 change 
  
 the 
  
 Security 
  
 Health 
  
 Analytics 
  
 custom 
  
 module 
  
 enablement 
  
 state."
    Prevent a user from creating or modifying a Web Security Scanner scan config with a maximum QPS limit greater than 10. 
      
 name 
 : 
  
 organizations/ ORGANIZATION_ID 
/customConstraints/custom.WssScanConfig 
  
 resourceTypes 
 : 
  
 - 
  
 websecurityscanner.googleapis.com/ScanConfig 
  
 methodTypes 
 : 
  
 - 
  
 CREATE 
  
 - 
  
 UPDATE 
  
 condition 
 : 
  
 "resource.maxQps 
 > 
 10" 
  
 actionType 
 : 
  
 DENY 
  
 displayName 
 : 
  
 Only let users create or modify scan configs with a maximum 
  
 QPS limit of 10 or less. 
  
 description 
 : 
  
 "Can't 
  
 create 
  
 or 
  
 modify 
  
 scan 
  
 configs 
  
 that 
  
 have 
  
 a 
  
 maximum 
  
 QPS 
  
 limit 
  
 greater 
  
 than 
  
 10."

    Security Command Center supported resources

    The following table lists the Security Command Center resources that you can reference in custom constraints.
    Resource
    Field
    securitycenter.googleapis.com/BigQueryExport
    resource.dataset
    resource.description
    resource.name
    securitycenter.googleapis.com/ContainerThreatDetectionSettings
    resource.modules[*].moduleEnablementState
    resource.name
    resource.serviceEnablementState
    securitycenter.googleapis.com/EventThreatDetectionSettings
    resource.modules[*].moduleEnablementState
    resource.name
    resource.serviceEnablementState
    securitycenter.googleapis.com/MuteConfig
    resource.description
    resource.expiryTime
    resource.name
    resource.type
    securitycenter.googleapis.com/NotificationConfig
    resource.description
    resource.name
    resource.pubsubTopic
    securitycenter.googleapis.com/ResourceValueConfig
    resource.cloudProvider
    resource.description
    resource.name
    resource.resourceLabelsSelector
    resource.resourceType
    resource.resourceValue
    resource.scope
    resource.tagValues
    securitycenter.googleapis.com/SecurityHealthAnalyticsSettings
    resource.modules[*].moduleEnablementState
    resource.name
    resource.serviceEnablementState
    securitycenter.googleapis.com/VirtualMachineThreatDetectionSettings
    resource.modules[*].moduleEnablementState
    resource.name
    resource.serviceEnablementState
    securitycenter.googleapis.com/WebSecurityScannerSettings
    resource.modules[*].moduleEnablementState
    resource.name
    resource.serviceEnablementState
    securitycentermanagement.googleapis.com/EventThreatDetectionCustomModule
    resource.description
    resource.displayName
    resource.enablementState
    resource.name
    resource.type
    securitycentermanagement.googleapis.com/SecurityCenterService
    resource.intendedEnablementState
    resource.modules[*].intendedEnablementState
    resource.name
    securitycentermanagement.googleapis.com/SecurityHealthAnalyticsCustomModule
    resource.customConfig.customOutput.properties.name
    resource.customConfig.description
    resource.customConfig.recommendation
    resource.customConfig.resourceSelector.resourceTypes
    resource.customConfig.severity
    resource.displayName
    resource.enablementState
    resource.name
    websecurityscanner.googleapis.com/ScanConfig
    resource.authentication.customAccount.loginUrl
    resource.authentication.customAccount.password
    resource.authentication.customAccount.username
    resource.authentication.googleAccount.password
    resource.authentication.googleAccount.username
    resource.authentication.iapCredential.iapTestServiceAccountInfo.targetAudienceClientId
    resource.blacklistPatterns
    resource.displayName
    resource.exportToSecurityCommandCenter
    resource.ignoreHttpStatusErrors
    resource.managedScan
    resource.maxQps
    resource.name
    resource.riskLevel
    resource.schedule.intervalDurationDays
    resource.schedule.scheduleTime
    resource.startingUrls
    resource.staticIpScan
    resource.targetPlatforms
    resource.userAgent

    What's next
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: