LogoLogo
2024.2
  • Immuta Documentation - 2024.2
  • What is Immuta?
  • Self-Managed Deployment
    • Getting Started
    • Deployment Requirements
    • Install
      • Managed Public Cloud
      • Red Hat OpenShift
      • Generic Installation
      • Immuta in an Air-Gapped Environment
      • Deploy Immuta without Elasticsearch
    • Configure
      • Ingress Configuration
      • Cosign Verification
      • TLS Configuration
      • Immuta in Production
      • External Cache Configuration
      • Rotating Credentials
      • Enabling Legacy Query Engine and Fingerprint
    • Upgrade
      • Upgrade Immuta
      • Upgrade to Immuta 2024.2 LTS
    • Disaster Recovery
    • Troubleshooting
    • Conventions
    • Release Notes
  • Data and Integrations
    • Immuta Integrations
    • Snowflake
      • Getting Started
      • How-to Guides
        • Configure a Snowflake Integration
        • Snowflake Table Grants Migration
        • Edit or Remove Your Snowflake Integration
        • Integration Settings
          • Enable Snowflake Table Grants
          • Use Snowflake Data Sharing with Immuta
          • Configure Snowflake Lineage Tag Propagation
          • Enable Snowflake Low Row Access Policy Mode
            • Upgrade Snowflake Low Row Access Policy Mode
      • Reference Guides
        • Snowflake Integration
        • Snowflake Data Sharing
        • Snowflake Lineage Tag Propagation
        • Snowflake Low Row Access Policy Mode
        • Snowflake Table Grants
        • Warehouse Sizing Recommendations
      • Phased Snowflake Onboarding Concept Guide
    • Databricks Unity Catalog
      • Getting Started
      • How-to Guides
        • Configure a Databricks Unity Catalog Integration
        • Migrate to Unity Catalog
      • Databricks Unity Catalog Integration Reference Guide
    • Databricks Spark
      • How-to Guides
        • Configuration
          • Simplified Databricks Configuration
          • Manual Databricks Configuration
          • Manually Update Your Databricks Cluster
          • Install a Trusted Library
        • DBFS Access
        • Limited Enforcement in Databricks
        • Hide the Immuta Database in Databricks
        • Run spark-submit Jobs on Databricks
        • Configure Project UDFs Cache Settings
        • External Metastores
      • Reference Guides
        • Databricks Spark Integration
        • Databricks Spark Pre-Configuration Details
        • Configuration Settings
          • Cluster Policies
            • Python & SQL
            • Python & SQL & R
            • Python & SQL & R with Library Support
            • Scala
            • Sparklyr
          • Environment Variables
          • Ephemeral Overrides
          • Py4j Security Error
          • Scala Cluster Security Details
          • Databricks Security Configuration for Performance
        • Databricks Change Data Feed
        • Databricks Libraries Introduction
        • Delta Lake API
        • Spark Direct File Reads
        • Databricks Metastore Magic
    • Starburst (Trino)
      • Getting Started
      • How-to Guides
        • Configure Starburst (Trino) Integration
        • Customize Read and Write Access Policies for Starburst (Trino)
      • Starburst (Trino) Integration Reference Guide
    • Redshift
      • Getting Started
      • How-to Guides
        • Configure Redshift Integration
        • Configure Redshift Spectrum
      • Reference Guides
        • Redshift Integration
        • Redshift Pre-Configuration Details
    • Azure Synapse Analytics
      • Getting Started
      • Configure Azure Synapse Analytics Integration
      • Reference Guides
        • Azure Synapse Analytics Integration
        • Azure Synapse Analytics Pre-Configuration Details
    • Amazon S3
    • Google BigQuery
    • Legacy Integrations
      • Securing Hive and Impala Without Sentry
      • Enabling ImmutaGroupsMapping
    • Registering Metadata
      • Data Sources in Immuta
      • Register Data Sources
        • Create a Data Source
        • Create an Amazon S3 Data Source
        • Create a Google BigQuery Data Source
        • Bulk Create Snowflake Data Sources
      • Data Source Settings
        • How-to Guides
          • Manage Data Sources and Data Source Settings
          • Manage Data Source Members
          • Manage Access Requests and Tasks
          • Manage Data Dictionary Descriptions
          • Disable Immuta from Sampling Raw Data
        • Data Source Health Checks Reference Guide
      • Schema Monitoring
        • How-to Guides
          • Run Schema Monitoring and Column Detection Jobs
          • Manage Schema Monitoring
        • Reference Guides
          • Schema Monitoring
          • Schema Projects
        • Why Use Schema Monitoring?
    • Catalogs
      • Getting Started with External Catalogs
      • Configure an External Catalog
      • Reference Guides
        • External Catalogs
        • Custom REST Catalogs
          • Custom REST Catalog Interface Endpoints
    • Tags
      • How-to Guides
        • Create and Manage Tags
        • Add Tags to Data Sources and Projects
      • Tags Reference Guide
  • People
    • Getting Started
    • Identity Managers (IAMs)
      • How-to Guides
        • Microsoft Entra ID
        • Okta LDAP Interface
        • Okta and OpenID Connect
        • Integrate Okta SAML SCIM with Immuta
        • OneLogin with OpenID
        • Configure SAML IAM Protocol
      • Reference Guides
        • Identity Managers
        • SAML Single Logout
        • SAML Protocol Configuration Options
    • Immuta Users
      • How-to Guides
        • Managing Personas and Permissions
        • Manage Attributes and Groups
        • User Impersonation
        • External User ID Mapping
        • External User Info Endpoint
      • Reference Guides
        • Attributes and Groups in Immuta
        • Permissions and Personas
  • Discover Your Data
    • Getting Started
    • Introduction
    • Architecture
    • Data Discovery
      • How-to Guides
        • Enable Sensitive Data Discovery (SDD)
        • Manage Identification Frameworks
        • Manage Patterns
        • Manage Rules
        • Manage SDD on Data Sources
        • Manage Global SDD Settings
        • Migrate From Legacy to Native SDD
      • Reference Guides
        • How Competitive Pattern Analysis Works
        • Built-in Pattern Reference
        • Built-in Discovered Tags Reference
    • Data Classification
      • How-to Guides
        • Activate Classification Frameworks
        • Adjust Identification and Classification Framework Tags
        • How to Use a Built-In Classification Framework with Your Own Tags
      • Built-in Classification Frameworks Reference Guide
  • Detect Your Activity
    • Getting Started
      • Monitor and Secure Sensitive Data Platform Query Activity
        • User Identity Best Practices
        • Integration Architecture
        • Snowflake Roles Best Practices
        • Register Data Sources
        • Automate Entity and Sensitivity Discovery
        • Detect with Discover: Onboarding Guide
        • Using Immuta Detect
      • General Immuta Configuration
        • User Identity Best Practices
        • Integration Architecture
        • Databricks Roles Best Practices
        • Register Data Sources
    • Introduction
    • Audit
      • How-to Guides
        • Export Audit Logs to S3
        • Export Audit Logs to ADLS
        • Run Governance Reports
      • Reference Guides
        • Universal Audit Model (UAM)
        • Snowflake Query Audit Logs
        • Databricks Unity Catalog Audit Logs
        • Databricks Query Audit Logs
        • Starburst (Trino) Query Audit Logs
        • UAM Schema
        • Audit Export CLI
        • Governance Report Types
      • Deprecated Audit Guides
        • Legacy to UAM Migration
        • Download Audit Logs
        • System Audit Logs
    • Detection
      • Use the Detect Dashboards
      • Reference Guides
        • Detect
        • Detect Dashboards
        • Unknown Users in Audit Logs
    • Monitors
      • Manage Monitors and Observations
      • Detect Monitors Reference Guide
  • Secure Your Data
    • Getting Started with Secure
      • Automate Data Access Control Decisions
        • The Two Paths: Orchestrated RBAC and ABAC
        • Managing User Metadata
        • Managing Data Metadata
        • Author Policy
        • Test and Deploy Policy
      • Compliantly Open More Sensitive Data for ML and Analytics
        • Managing User Metadata
        • Managing Data Metadata
        • Author Policy
      • Federated Governance for Data Mesh and Self-Serve Data Access
        • Defining Domains
        • Managing Data Products
        • Managing Data Metadata
        • Apply Federated Governance
        • Discover and Subscribe to Data Products
    • Introduction
      • Scalability and Evolvability
      • Understandability
      • Distributed Stewardship
      • Consistency
      • Availability of Data
    • Authoring Policies in Secure
      • Authoring Policies at Scale
      • Data Engineering with Limited Policy Downtime
      • Subscription Policies
        • How-to Guides
          • Author a Subscription Policy
          • Author an ABAC Subscription Policy
          • Subscription Policies Advanced DSL Guide
          • Author a Restricted Subscription Policy
          • Clone, Activate, or Stage a Global Policy
        • Reference Guides
          • Subscription Policies
          • Subscription Policy Access Types
          • Advanced Use of Special Functions
      • Data Policies
        • Overview
        • How-to Guides
          • Author a Masking Data Policy
          • Author a Minimization Policy
          • Author a Purpose-Based Restriction Policy
          • Author a Restricted Data Policy
          • Author a Row-Level Policy
          • Author a Time-Based Restriction Policy
          • Certifications Exemptions and Diffs
          • External Masking Interface
        • Reference Guides
          • Data Policy Types
          • Masking Policies
          • Row-Level Policies
          • Custom WHERE Clause Functions
          • Data Policy Conflicts and Fallback
          • Custom Data Policy Certifications
          • Orchestrated Masking Policies
    • Domains
      • Getting Started with Domains
      • Domains Reference Guide
    • Projects and Purpose-Based Access Control
      • Projects and Purpose Controls
        • Getting Started
        • How-to Guides
          • Create a Project
          • Create and Manage Purposes
          • Adjust a Policy
          • Project Management
            • Manage Projects and Project Settings
            • Manage Project Data Sources
            • Manage Project Members
        • Reference Guides
          • Projects and Purposes
          • Policy Adjustments
        • Why Use Purposes?
      • Equalized Access
        • Manage Project Equalization
        • Project Equalization Reference Guide
        • Why Use Project Equalization?
      • Masked Joins
        • Enable Masked Joins
        • Why Use Masked Joins?
      • Writing to Projects
        • How-to Guides
          • Create and Manage Snowflake Project Workspaces
          • Create and Manage Databricks Project Workspaces
          • Write Data to the Workspace
        • Reference Guides
          • Project Workspaces
          • Project UDFs (Databricks)
    • Data Consumers
      • Subscribe to a Data Source
      • Query Data
        • Querying Snowflake Data
        • Querying Databricks Data
        • Querying Databricks SQL Data
        • Querying Starburst (Trino) Data
        • Querying Redshift Data
        • Querying Azure Synapse Analytics Data
      • Subscribe to Projects
  • Application Settings
    • How-to Guides
      • App Settings
      • BI Tools
        • BI Tool Configuration Recommendations
        • Power BI Configuration Example
        • Tableau Configuration Example
      • Add a License Key
      • Add ODBC Drivers
      • Manage Encryption Keys
      • System Status Bundle
    • Reference Guides
      • Data Processing, Encryption, and Masking Practices
      • Metadata Ingestion
  • Releases
    • Immuta v2024.2 Release Notes
    • Immuta Release Lifecycle
    • Immuta LTS Changelog
    • Immuta Support Matrix Overview
    • Immuta CLI Release Notes
    • Immuta Image Digests
    • Preview Features
      • Features in Preview
    • Deprecations
  • Developer Guides
    • The Immuta CLI
      • Install and Configure the Immuta CLI
      • Manage Your Immuta Tenant
      • Manage Data Sources
      • Manage Sensitive Data Discovery
        • Manage Sensitive Data Discovery Rules
        • Manage Identification Frameworks
        • Run Sensitive Data Discovery on Data Sources
      • Manage Policies
      • Manage Projects
      • Manage Purposes
    • The Immuta API
      • Integrations API
        • Getting Started
        • How-to Guides
          • Configure an Amazon S3 Integration
          • Configure an Azure Synapse Analytics Integration
          • Configure a Databricks Unity Catalog Integration
          • Configure a Google BigQuery Integration
          • Configure a Redshift Integration
          • Configure a Snowflake Integration
          • Configure a Starburst (Trino) Integration
        • Reference Guides
          • Integrations API Endpoints
          • Integration Configuration Payload
          • Response Schema
          • HTTP Status Codes and Error Messages
      • Immuta V2 API
        • Data Source Payload Attribute Details
        • Data Source Request Payload Examples
        • Create Policies API Examples
        • Create Projects API Examples
        • Create Purposes API Examples
      • Immuta V1 API
        • Authenticate with the API
        • Configure Your Instance of Immuta
          • Get Fingerprint Status
          • Get Job Status
          • Manage Frameworks
          • Manage IAMs
          • Manage Licenses
          • Manage Notifications
          • Manage Sensitive Data Discovery (SDD)
          • Manage Tags
          • Manage Webhooks
          • Search Filters
        • Connect Your Data
          • Create and Manage an Amazon S3 Data Source
          • Create an Azure Synapse Analytics Data Source
          • Create an Azure Blob Storage Data Source
          • Create a Databricks Data Source
          • Create a Presto Data Source
          • Create a Redshift Data Source
          • Create a Snowflake Data Source
          • Create a Starburst (Trino) Data Source
          • Manage the Data Dictionary
        • Manage Data Access
          • Manage Access Requests
          • Manage Data and Subscription Policies
          • Manage Domains
          • Manage Write Policies
            • Write Policies Payloads and Response Schema Reference Guide
          • Policy Handler Objects
          • Search Audit Logs
          • Search Connection Strings
          • Search for Organizations
          • Search Schemas
        • Subscribe to and Manage Data Sources
        • Manage Projects and Purposes
          • Manage Projects
          • Manage Purposes
        • Generate Governance Reports
Powered by GitBook

Other versions

  • SaaS
  • 2024.3

Copyright © 2014-2024 Immuta Inc. All rights reserved.

On this page
  • Create policy handler
  • Request parameters
  • Update policy handler
  • Request parameters
  • Policy handler object
  • Defining policy rules
  • Prerequisite policy rule type
  • Visibility policy rule type
  • Masking policy rule type
  • Minimization rule type
  • Time-based rule type
  • Policy conditions
  • Group policy condition
  • Attribute policy condition
  • Attribute object
  • Purpose policy condition

Was this helpful?

Export as PDF
  1. Developer Guides
  2. The Immuta API
  3. Immuta V1 API
  4. Manage Data Access

Policy Handler Objects

PreviousWrite Policies Payloads and Response Schema Reference GuideNextSearch Audit Logs

Last updated 11 months ago

Was this helpful?

This page describes how to update policies using the Policy Handler API.

Create policy handler

Method
Path
Successful Status Code

POST

/policy/handler

200

Request parameters

The create policy handler endpoint must be a .

Update policy handler

Method
Path
Successful Status Code

PUT

/policy/handler

200

Request parameters

The update policy handler endpoint must be a .

Policy handler object

  • dataSourceId (integer): ID of the data source the policy will be applied to.

    • Example: 1

  • jsonRules (array[object]): Array of JSON rules objects.

    • Example: See

Defining policy rules

The jsonRules array contains rules objects. The following types of policy rules are supported:

Not all combination of policy rules are valid. The examples below are supported policy rule combinations:

  • Prerequisite, Visibility, Masking

  • Prerequisite, Masking, Minimization

Prerequisite policy rule type

Prerequisite policies are used to limit usage to one or more purposes.

  • type (string): Policy rule type. Must be prerequisite for prerequisite policy rules.

    • Example: "prerequisite"

  • operator (string): Operator to be applied on conditions. Possible values: and, or.

    • Example: "or"

  • conditions (array[object]): Conditions to be applied for the rule. Multiple values will be evaluated according to the operator.

Example:

In this example, users will only have access to data from this data source when they are acting under the purpose named Purpose Name.

{
    "type": "prerequisite",
    "operator": "or",
    "conditions": [{
        "type": "purposes",
        "value": "Purpose Name"
    }]
}

Visibility policy rule type

Visibility policies are used to enforce row-level security.

  • type (string): Policy rule type. Must be visibility for row-level security policy rules.

    • Example: "visibility"

  • operator (string): Operator to be applied on conditions. Possible values: and, or.

    • Example: "or"

  • conditions (array[object]): Conditions to be applied for the rule. Multiple values will be evaluated according to the operator.

Note: When adding conditions to a visibility policy rule, the field is required, and the condition value should be left empty. For example, for a group policy condition, the group name is not specified.

{
    "type": "groups",
    "field": "organization",
    "group": {
        "iam": "active_directory"
    }
}

The user must possess the group, attribute, or purpose that matches the value stored in the field.

Example:

In this example, users will only see rows when they have an authorization that matches the value in the field department and they belong to a group that matches the value in the field organization.

{
    "type": "visibility",
    "operator": "and",
    "conditions": [{
        "type": "authorizations",
        "field": "department",
        "authorization": {
            "auth": "accesses",
            "iam": "active_directory"
        }
    }, {
        "type": "groups",
        "field": "organization",
        "group": {
            "iam": "active_directory"
        }
    }]
}

Masking policy rule type

Masking policy rules will mask the value in one or more columns.

  • type (string): Policy rule type. Must be masking for masking policy rules.

    • Example: "masking"

  • fields (array[string]): Fields that will be masked when a user does not fulfill policy conditions.

    • Example: ["email", "location"]

  • operator (string): Operator to be applied on conditions. Possible values: and, or.

    • Example: "or"

  • conditions (array[object]): Conditions to be applied for the rule. Multiple values will be evaluated according to the operator.

Note: When adding conditions to a masking policy rule, the field will be left blank, and the condition value should be populated.

{
    "type": "groups",
    "group": {
        "name": "users",
        "iam": "active_directory"
    }
  • name (string): Name of the field being masked.

    • Example: "social"

  • type (string): Type of masking to apply. Supported values are "Consistent Value", "Grouping", "Regular Expression"

    • Example: "Consistent Value"

  • metadata (object): Extra metadata used when masking the value.

Masking configuration metadata

Consistent value

  • constant (string|null): Constant value to mask to. If this field is not defined, the value will be hashed.

    • Example: "REDACTED"

Regular expression

  • regex (string): Regex to match against when masking columns.

    • Example: "[0-9]{3}-[0-9]{2}"

  • replacement (string): String used to replace the matched regex.

    • Example: "xxx-xx"

Grouping

  • bucketSize (integer): For number fields. Size of buckets to round numbers to.

    • Example: 100

  • timePrecision (string): For time fields. Time precision to round to. Possible values: "MIN", "HOUR", "DAY", "WEEK", "MONTH", "YEAR"

    • Example: "HOUR"

Example policy handler update with masking configuration metadata:

{
    "policyHandler": {
        "maskingConfiguration": [{
            "type": "Consistent Value",
            "name": "age",
            "metadata": {
                "constant": "REDACTED"
            }
        }]
    }
}

Example:

In this example, the fields email and location will be masked unless the user belongs to the group admins.

{
    "type":"masking",
    "fields": ["email", "location"],
    "operator":"or",
    "conditions":[{
        "type":"groups",
        "group":{
            "name":"admins",
            "iam":"active_directory"
        }
    }]
}

Minimization rule type

Minimization policy rules will show a limited percentage of the data, based on a high cardinality column, for everyone unless the user fulfills the policy conditions.

  • type (string): Policy rule type. Must be additional for minimization policy rules.

    • Example: "additional"

  • name (string): Name of additional policy. Must be minimization for minimization policy rules.

    • Example: "minimization"

  • operator (string): Operator to be applied on conditions. Possible values: and, or.

    • Example: "or"

  • conditions (array[object]): Conditions to be applied for the rule. Multiple values will be evaluated according to the operator.

Note: When adding conditions to a minimization policy rule the field will be left blank.

{
    "type": "groups",
    "group": {
        "name": "users",
        "iam": "active_directory"
    }
  • percent (integer): Percentage of the data to show to the users. This percentage will be based off of unique values in the hashPhrase column.

    • Example: 50

  • hashPhrase (string): Column to base the percentage off of. This should be a high cardinality column in the data source.

    • Example: "name"

Example policy handler rule:

In this example, 50 percent of the data, based on the name field, will be visible to users unless they fulfill the policy conditions.

{
    "type": "additional",
    "name": "minimization",
    "operator": "or",
    "conditions": {
        "type":"groups",
        "group":{
            "name":"admins",
            "iam":"active_directory"
        }
    }
}

Example data source update (partial):

{
    "policyHandler": {
        "additionalFilters": {
            "minimization": {
                "percent": 50,
                "hashPhrase": "name"
            }
        }
    }
}

Time-based rule type

Time-based rules will make a limited portion of the data available based on event time. The data source must contain an event time column in order for this policy type to be valid. For instance, users who do not fulfill the policy conditions will only see data from within the defined time window.

  • type (string): Policy rule type. Must be additional for minimization policy rules.

    • Example: "additional"

  • name (string): Name of additional policy. Must be time for time based policy rules.

    • Example: "time"

  • operator (string): Operator to be applied on conditions. Possible values: and, or.

    • Example: "or"

  • conditions (array[object]): Conditions to be applied for the rule. Multiple values will be evaluated according to the operator.

Note: When adding conditions to a time based policy rule the field will be left blank.

{
    "type": "groups",
    "group": {
        "name": "users",
        "iam": "active_directory"
    }
  • time (integer): Age in seconds of the oldest data a user will be allowed to see. This counts backward from the present.

    • Example: 14400

Example policy handler rule:

In this example, only data from the last 4 hours will be visible to users unless they fulfill the policy conditions.

{
    "type": "additional",
    "name": "time",
    "operator": "or",
    "conditions": {
        "type":"groups",
        "group":{
            "name":"admins",
            "iam":"active_directory"
        }
    }
}

Example data source update (partial):

{
    "policyHandler": {
        "additionalFilters": {
            "time": 14400
        }
    }
}

Policy conditions

There are three types of policy conditions:

Group policy condition

The group policy condition restricts access to the condition when a user is a member of a group.

  • type (string): Type of policy condition. Must be "groups" for the group policy condition.

    • Example: "groups"

  • group (object): Object describing group user must belong to in order to satisfy the policy condition.

  • field (string): Data field to match group name against when checking policy.

    • Example: "department"

Example:

{
    "type": "groups",
    "group": {
        "name": "users",
        "iam": "active_directory"
    },
    "field": "department"
}

Group object

  • name (string): Name of group user must belong to in order to satisfy the policy condition.

    • Example: "users"

  • iam (string): ID of the IAM containing the group.

    • Example: "active_directory"

Attribute policy condition

The attribute policy condition restricts access to the condition when a user possesses an attribute.

  • type (string): Type of policy condition. Must be "authorizations" for the attribute policy condition.

    • Example: "authorizations"

  • authorization (object): Object describing attribute user must possess in order to satisfy the policy condition.

  • field (string): Data field to match attribute value against when checking policy.

    • Example: "department"

Example:

{
    "type": "authorizations",
    "authorization": {
        "auth": "accesses",
        "value": "PII",
        "iam": "active_directory"
    },
    "field": "department"
}

Attribute object

  • auth (string): Name of attribute to check for attribute value.

    • Example: "accesses"

  • value (string): Value of attribute user must possess in order to satisfy the policy condition.

    • Example: "PII"

  • iam (string): ID of the IAM user must receive the attribute from.

    • Example: "active_directory"

Purpose policy condition

The purpose policy condition restricts access to the condition when a user is acting under a purpose.

  • type (string): Type of policy condition. Must be "purposes" for the purpose policy condition.

    • Example: "purpopses"

  • value (string): Purpose name user must be acting under in order to satisfy the policy condition.

    • Example: "Purpose"

  • field (string): Data field to match purpose name against when checking policy.

    • Example: "department"

Example:

{
    "type": "purposes",
    "value": "Purpose",
    "field": "department"
}

Example: See

Example: See

Example: See

When using a masking rule, there is an additional field that needs to be sent in the in the policyHandler.maskingConfiguration array field.

Example: See

Example: See

When using a minimization rule, there is an additional field that needs to be sent in the in the policyHandler.additionalFilters.minimization field.

Example: See

When using a time based rule, there is an additional field that needs to be sent in the in the policyHandler.additionalFilters field.

Example: See

Example: See

policy handler object
policy handler object
defining policy rules
Prerequisite
Visibility
Masking
Minimization
Time-based
purpose condition object
policy conditions
policy conditions
update data source request
masking configuration metadata
policy conditions
update data source request
policy conditions
update data source request
Groups
Attributes
Purposes
group object
group object