LogoLogo
SaaS
  • Immuta Documentation - SaaS
  • Configuration
    • Connect Data Platforms
      • Data Platforms Overview
      • Amazon S3 Integration
      • AWS Lake Formation
        • Getting Started with AWS Lake Formation
        • Register an AWS Lake Formation Connection
        • Reference Guides
          • AWS Lake Formation
          • Security and Compliance
          • Protecting Data
          • Accessing Data
      • Azure Synapse Analytics
        • Getting Started with Azure Synapse Analytics
        • Configure Azure Synapse Analytics Integration
        • Reference Guides
          • Azure Synapse Analytics Overview
          • Azure Synapse Analytics Pre-Configuration Details
      • Databricks
        • Databricks Spark
          • Getting Started with Databricks Spark
          • How-to Guides
            • Configure a Databricks Spark Integration
            • Manually Update Your Databricks Cluster
            • Install a Trusted Library
            • Project UDFs Cache Settings
            • Run R and Scala spark-submit Jobs on Databricks
            • DBFS Access
            • Troubleshooting
          • Reference Guides
            • Databricks Spark Integration Configuration
              • Installation and Compliance
              • Customizing the Integration
              • Setting Up Users
              • Spark Environment Variables
              • Ephemeral Overrides
            • Security and Compliance
            • Registering and Protecting Data
            • Accessing Data
              • Delta Lake API
        • Databricks Unity Catalog
          • Getting Started with Databricks Unity Catalog
          • How-to Guides
            • Configure a Databricks Unity Catalog Integration
            • Migrating to Unity Catalog
          • Databricks Unity Catalog Integration Reference Guide
      • Google BigQuery Integration
      • Redshift
        • Getting Started with Redshift
        • How-to Guides
          • Configure Redshift Integration
          • Configure Redshift Spectrum
        • Reference Guides
          • Redshift Overview
          • Redshift Pre-Configuration Details
      • Snowflake
        • Getting Started with Snowflake
        • How-to Guides
          • Configure a Snowflake Integration
          • Edit or Remove Your Snowflake Integration
          • Integration Settings
            • Snowflake Table Grants Private Preview Migration
            • Enable Snowflake Table Grants
            • Using Snowflake Data Sharing with Immuta
            • Enable Snowflake Low Row Access Policy Mode
              • Upgrade Snowflake Low Row Access Policy Mode
            • Configure Snowflake Lineage Tag Propagation
        • Reference Guides
          • Snowflake Integration
          • Snowflake Table Grants
          • Snowflake Data Sharing with Immuta
          • Snowflake Low Row Access Policy Mode
          • Snowflake Lineage Tag Propagation
          • Warehouse Sizing Recommendations
        • Explanatory Guides
          • Phased Snowflake Onboarding
      • Starburst (Trino)
        • Getting Started with Starburst (Trino)
        • How-to Guides
          • Configure Starburst (Trino) Integration
          • Customize Read and Write Access Policies for Starburst (Trino)
        • Starburst (Trino) Integration Reference Guide
      • Queries Immuta Runs in Your Data Platform
      • Connect Your Data
        • Registering a Connection
          • How-to Guides
            • Register a Snowflake Connection
            • Register a Databricks Unity Catalog Connection
            • Manually Run Object Sync
            • Manage Connection Settings
            • Use the Connection Upgrade Manager
              • Troubleshooting
          • Reference Guides
            • Connections
            • Upgrading to Connections
              • Before You Begin
              • API Changes
              • FAQ
        • Registering Metadata
          • Data Sources in Immuta
          • Register Data Sources
            • Amazon S3 Data Source
            • Azure Synapse Analytics Data Source
            • Databricks Data Source
            • Google BigQuery Data Source
            • Redshift Data Source
            • Snowflake Data Source
              • Bulk Create Snowflake Data Sources
            • Create a Starburst (Trino) Data Source
          • Data Source Settings
            • How-to Guides
              • Manage 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
              • Manage Schema Monitoring
              • Run Schema Monitoring and Column Detection Jobs
            • Reference Guides
              • Schema Monitoring
              • Schema Projects
            • Why Use Schema Monitoring Concept Guide
    • Manage Data Metadata
      • Connect External Catalogs
        • Configure an External Catalog
        • Reference Guides
          • External Catalog Introduction
          • Custom REST Catalog Interface Introduction
          • Custom REST Catalog Interface Endpoints
      • Data Discovery
        • Introduction
        • Getting Started with Data Discovery
        • How-to Guides
          • Use Identifiers in Domains
          • Use Sensitive Data Discovery (SDD)
          • Manage Identification Frameworks
          • Manage Identifiers
          • Run and Manage Sensitive Data Discovery on Data Sources
        • Reference Guides
          • Identifiers in Domains
          • Built-in Identifier Reference
          • Improved Pack: Built-in Identifier Reference
          • Built-in Discovered Tags Reference
          • How Competitive Pattern Analysis Works
      • Data Classification
        • How-to Guides
          • Activate Classification Frameworks
          • Adjust Identification and Classification Framework Tags
          • How to Use a Classification Framework with Your Own Tags
        • Reference Guide
          • Classification Frameworks
      • Manage Tags
        • How-to Guides
          • Create and Manage Tags
          • Add Tags to Data Sources and Projects
        • Tags Reference Guide
    • Manage Users
      • Getting Started with Users
      • Identity Managers (IAMs)
        • How-to Guides
          • Okta LDAP Interface
          • OpenID Connect
            • OpenID Connect Protocol
            • Okta and OpenID Connect
            • OneLogin with OpenID Connect
          • SAML
            • SAML Protocol
            • Microsoft Entra ID
            • Okta SAML SCIM
        • Reference Guides
          • Identity Managers
          • SAML Protocol Configuration Options
          • SAML Single Logout
      • Immuta Users
        • How-to Guides
          • Managing Personas and Permissions
          • User Impersonation
          • Manage Attributes and Groups
          • External User ID Mapping
          • External User Info Endpoint
        • Reference Guides
          • Permissions and Personas
          • Attributes and Groups in Immuta
    • Organize Data into Domains
      • Getting Started with Domains
      • Domains Reference Guide
    • Application Settings
      • How-to Guides
        • App Settings
        • Private Networking Support
          • Data Connection Private Networking
            • AWS PrivateLink for Redshift
            • AWS PrivateLink for API Gateway
            • Databricks Private Connectivity
              • AWS PrivateLink for Databricks
              • Azure Private Link for Databricks
            • Snowflake Private Connectivity
              • AWS PrivateLink for Snowflake
              • Azure Private Link for Snowflake
            • Starburst (Trino) Private Connectivity
              • AWS PrivateLink for Starburst (Trino)
              • Azure Private Link for Starburst (Trino)
          • Immuta SaaS Private Networking
            • Immuta SaaS Private Networking Over AWS PrivateLink
        • BI Tools
          • BI Tool Configuration Recommendations
          • Power BI Configuration Example
          • Tableau Configuration Example
        • IP Filtering
        • System Status Bundle
      • Reference Guides
        • Deployment Options
        • Data Processing
        • Encryption and Masking Practices
  • Marketplace
    • Introduction
      • User Types
      • Walkthrough
    • Share Data Products
      • How-to Guides
        • Manage Data Products
        • View and Respond to Access Requests
        • Manage Request Forms
        • Customize the Marketplace Branding
      • Reference Guides
        • Marketplace App Requirements
        • Data Products
        • Marketplace Permissions Matrix
        • Understanding Access Provisioning and Underlying Policies in Immuta
          • S3 Provisioning Best Practices
        • Integrating with Existing Catalogs
        • Setting Up Domains for Marketplace
    • Access Data Products
      • How-to Guides
        • Logging into Marketplace
        • Requesting Access to a Data Product
      • Reference Guide
        • Data Source Access Status
    • Short-Term Limitations
  • Governance
    • Introduction
      • Automate Data Access Control Decisions
        • The Two Paths
        • 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
    • Author Policies for Data Access Control
      • Introduction
        • Scalability and Evolvability
        • Understandability
        • Distributed Stewardship
        • Consistency
        • Availability of Data
      • Policies
        • Authoring Policies at Scale
        • Data Engineering with Limited Policy Downtime
        • Subscription Policies
          • Overview
          • 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 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
            • Policy Certifications and Diffs
          • 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
      • 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
          • Concept Guide
            • Why Use Purposes?
        • Equalized Access
          • Manage Project Equalization How-to Guide
          • Equalized Access Reference Guide
          • Why Use Project Equalization?
        • Masked Joins
          • Enable Masked Joins How-to Guide
          • Why Use Masked Joins?
        • Writing to Projects
          • How-to Guides
            • Create and Manage Snowflake Project Workspaces
            • Create and Manage Databricks Spark Project Workspaces
            • Write Data to the Workspace
          • Reference Guides
            • Writing to Projects
            • Project UDFs (Databricks)
      • Data Consumers
        • Subscribe to a Data Source
        • Query Data
          • Querying Snowflake Data
          • Querying Databricks Data
          • Querying Starburst (Trino) Data
          • Querying Databricks SQL Data
          • Querying Redshift Data
          • Querying Azure Synapse Analytics Data
        • Subscribe to Projects
    • Observe Access and Activity
      • Introduction
      • Audit
        • How-to Guides
          • Export Audit Logs to S3
          • Export Audit Logs to ADLS
          • Use Immuta Audit
          • Run Governance Reports
        • Reference Guides
          • Universal Audit Model (UAM)
            • UAM Schema Reference Guide
          • Query Audit Logs
            • Snowflake Query Audit Logs
            • Databricks Unity Catalog Query Audit Logs
            • Databricks Spark Query Audit Logs
            • Starburst (Trino) Query Audit Logs
          • Audit Export GraphQL Reference Guide
          • Unknown Users in Audit Logs
          • Governance Report Types
      • Dashboards
        • Use the Audit Dashboards How-To Guide
        • Audit Dashboards Reference Guide
      • Monitors
        • Manage Monitors and Observations
        • Monitors Reference Guide
  • Releases
    • Deployment Notes
      • 2024
      • 2023
      • 2022
    • Scheduled Maintenance Windows
    • Immuta Support Matrix Overview
    • Immuta CLI Release Notes
    • 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
      • Manage Audit Export
    • 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
      • Connections API
        • How-to Guides
          • Register a Connection
            • Register a Snowflake Connection
            • Register a Databricks Unity Catalog Connection
            • Register an AWS Lake Formation Connection
          • Manage a Connection
          • Deregister a Connection
        • Connection Registration Payloads Reference Guide
      • Marketplace API
        • Marketplace API Endpoints
        • Source Controlling Data Products
      • 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 Job Status
          • Manage Frameworks
          • Manage IAMs
          • Manage Licenses
          • Manage Notifications
          • Manage Identifiers in Domains
            • API Changes - Identification Frameworks to Identifiers in Domains
          • 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 a Databricks Data Source
          • Create a Redshift Data Source
          • Create a Snowflake Data Source
          • Create a Starburst (Trino) Data Source
          • Manage the Data Dictionary
        • Use Domains
        • Manage Data Access
          • Manage Access Requests
          • Manage Data and Subscription Policies
          • Manage Write Policies
            • Write Policies Payloads and Response Schema Reference Guide
          • Policy Handler Objects
          • 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

Self-managed versions

  • 2024.3
  • 2024.2

Resources

  • Immuta Changelog

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

On this page
  • Connection object
  • Snowflake connection object
  • Databricks Unity Catalog connection object
  • AWS Lake Formation connection object
  • Settings object
  • Options object
  • Native integration object
  • Snowflake config object
  • Databricks Unity Catalog config object
  • Snowflake specific objects
  • Snowflake private key object
  • Snowflake OAuth object
  • Snowflake OAuth private key
  • Snowflake impersonation object
  • Snowflake workspace object
  • Snowflake lineage object
  • Snowflake user role pattern object
  • Databricks Unity Catalog specific objects
  • Databricks group pattern object
  • Databricks Unity Catalog job config object
  • Databricks Unity Catalog OAuth object
  • Audit object

Was this helpful?

Export as PDF
  1. Developer Guides
  2. The Immuta API
  3. Connections API

Connection Registration Payloads Reference Guide

The parameters for configuring an integration in Immuta are outlined in the table below.

Attribute
Description
Required or optional
Accepted values

connectionKey string

A unique name for the connection.

Required

-

connection object

Required

-

settings object

Optional

-

options object

Optional

-

nativeIntegration object

Required

-

Connection object

The connection object configures the connection between the technology and Immuta. The sections below outline the child parameters specific to each technology.

Snowflake connection object

Attribute
Description
Required or optional
Accepted values

technology string

The technology backing the new connection.

Required

  • Snowflake

  • Databricks

  • Glue

hostname string

The URL of your Snowflake account. This is the same as host.

Required

-

port integer

The port to use when registering your Snowflake account. Defaults to 443.

Required

0-65535

warehouse string

The default pool of compute resources the Immuta system user will use to run queries and perform other Snowflake operations.

Required

-

role string

The privileged Snowflake role used by the Immuta system account when configuring the Snowflake connection. It must be able to see the data that Immuta will govern.

Required

-

authenticationType string

The authentication type to register the connection. Make sure this auth type is the same used when requesting the script.

Required

  • keyPair

  • oAuthClientCredentials

  • userPassword

username string

The username of the system account that can act on Snowflake objects and register the connection.

Required when authenticationType is keyPair or userPassword.

-

password string

The password of the system account that can act on Snowflake objects and register the connection.

Required when authenticationType is userPassword.

-

privateKeyPassword string

The Snowflake private key password.

Required when authenticationType is keyPair and the private key is encrypted.

-

privateKey object

Required when authenticationType is keyPair.

-

oAuthClientConfig object

Required when authenticationType is oAuthClientCredentials.

-

Databricks Unity Catalog connection object

The connection object configures the Databricks Unity Catalog connection information. The table below outlines its child parameters.

Attribute
Description
Required or optional
Accepted values

technology string

The technology backing the new connection.

Required

  • Databricks

  • Snowflake

  • Glue

hostname string

Your Databricks workspace URL. This is the same as host and workspaceURL.

Required

-

port integer

The port to use when registering your Databricks account connection. Defaults to 443.

Required

0-65535

httpPath string

The HTTP path of your Databricks cluster or SQL warehouse.

Required

-

authenticationType string

The authentication type to register the connection. Make sure this auth type is the same used when requesting the script.

Required

  • token

  • oAuthM2M

token string

The Databricks personal access token for the service principal created for Immuta.

Required if authenticationType is token

-

oAuthClientConfig object

Required if authenticationType is oAuthM2M

-

AWS Lake Formation connection object

The connection object configures the AWS Lake Formation connection information. The table below outlines its child parameters.

Attribute
Description
Required
Accepted values

technology string

The technology backing the new connection.

Yes

  • Glue

  • Snowflake

  • Databricks

authenticationType string

The authentication type to register the connection.

Yes

  • accessKey

  • assumedRole

serviceARN string

The Amazon resource name of the Glue Data Catalog that contains the data you want to register.

Yes

-

accessKeyId string

Required if authenticationType is accessKey.

-

secretAccessKey string

Required if authenticationType is accessKey.

-

roleARN string

The Amazon resource name of the role Immuta will assume from Immuta's AWS account in order to perform any operations in your AWS account.

Required if authenticationType is assumedRole.

-

externalId string

The external ID provided in a condition on the trust relationship for the cross-account IAM specified above.

Optional

-

Settings object

The settings object configures connection settings. The table below outlines its child parameters.

Attribute
Description
Required or optional
Accepted values

isActive boolean

If true, data objects will be active (enabled) by default when created in Immuta.

Optional

  • true

  • false

activateNewChildren boolean

If true, all new children found during object sync will be registered as active (enabled).

Optional

  • true

  • false

dataOwners array

A list of users and groups that are data owners on the connection. These users will be data owners for all the data sources under the data object they are assigned to.

Optional

-

Options object

The options object configures an option for your connection. The table below outlines its child parameter.

Attribute
Description
Required or optional
Accepted values

forceRecursiveCrawl boolean

When true, both active (enabled) and inactive (disabled) objects will be found by object sync.

Optional

  • true

  • false

Native integration object

The nativeIntegration object configures integration information and options. The table below outlines its child parameters.

Attribute
Description
Required or optional
Accepted values

type string

The type of technology.

Required

  • Snowflake

  • Databricks

autoBootstrap boolean

When false, you must set up your environment manually before registering the connection with the API.

Required

false

config object

Required

-

unityCatalog boolean

When true, the integration is for Databricks Unity Catalog.

Required if type is Databricks.

true

Snowflake config object

The config object configures the Snowflake integration information and options. The table below outlines its child parameters.

Attribute
Description
Required or optional
Accepted values

authenticationType string

The authentication type to register the connection. Make sure this auth type is the same as the config object.

Required

  • keyPair

  • oAuthClientCredentials

  • userPassword

username string

The username of the system account that can act on Snowflake objects and register the connection.

Required when authenticationType is keyPair or userPassword.

-

password string

The password of the system account that can act on Snowflake objects and register the connection.

Required when authenticationType is userPassword.

-

privateKeyPassword string

The Snowflake private key password.

Required when authenticationType is keyPair and the private key is encrypted**.**

-

keyName string

The Immuta-given name of your private key.

Required when authenticationType is keyPair.

PRIV_KEY_FILE

userFilename string

The name of the private key file on your machine.

Required when authenticationType is keyPair.

-

content string

Required when authenticationType is keyPair.

-

oAuthClientConfig object

Required when authenticationType is oAuthClientCredentials.

-

host string

The URL of your Snowflake account.

Required

-

port integer

The port to use when registering your Snowflake account.

Optional. Defaults to 443.

0-65535

warehouse string

The default pool of compute resources the Immuta system user will use to run queries and perform other Snowflake operations.

Required

-

database string

The name of the Snowflake database Immuta will create to store internal entitlements and other user data specific to Immuta. This database will only be readable for the Immuta user and should not be granted to other users. The database name may only contain letters, numbers, and underscores and cannot start with a number.

Required

-

impersonation object

Optional

-

audit object

Optional

-

workspaces object

Optional

-

lineage object

Optional

-

userRolePattern object

Optional

-

Databricks Unity Catalog config object

The config object configures the Databricks Unity Catalog integration information and options. The table below outlines its child parameters.

Attribute
Description
Required or optional
Accepted values

host string

Your Databricks workspace URL. This is the same as hostname and workspaceURL.

Required

-

port integer

The port to use when registering your Databricks account connection. Defaults to 443.

Optional. Defaults to 443.

0-65535

httpPath string

The HTTP path of your Databricks cluster or SQL warehouse.

Required

-

catalog string

The name of the Databricks catalog Immuta will create to store internal entitlements and other user data specific to Immuta. This catalog will only be readable for the Immuta service principal and should not be granted to other users. The catalog name may only contain letters, numbers, and underscores and cannot start with a number.

Required

-

authenticationType string

The authentication type to register the connection. Make sure this auth type is the same used when requesting the script.

Required

  • token

  • oAuthM2M

token string

The Databricks personal access token for the service principal created for Immuta.

Required if authenticationType is token

-

oAuthClientConfig object

Required if authenticationType is oAuthM2M

-

audit object

Optional

-

workspaceIds array

The optional workspaces to filter audit to.

Optional

-

enableNativeQueryParsing boolean

If true, query parsing is enabled.

Optional

false

groupPattern object

Optional

-

jobConfig object

Optional

-

Snowflake specific objects

Snowflake private key object

The privateKey object represents your private key in Snowflake. This object is required if you set privateKey as your authentication type. The table below outlines the object's child parameters

Attribute
Description
Accepted values

keyName string

The Immuta-given name of your private key.

PRIV_KEY_FILE

userFilename string

The name of the private key file on your machine.

-

content string

The private key. Replace new lines in the private key with a backslash before the new line character: "\n". If you are using another means of configuration, such as a Python script, the "\n" should not be added.

-

Snowflake OAuth object

The oAuthClientConfig object represents your OAuth configuration in Snowflake. This object is required if you set oAuthClientCredentials as your authentication type. The table below outlines the object's child parameters

Attribute
Description
Required or optional
Accepted values

useCertificate boolean

Specifies whether or not to use a certificate and private key for authenticating with OAuth.

Required

  • true

  • false

clientId string

The client identifier of your registered application.

Required

-

authorityUrl string

Authority URL of your identity provider.

Required

-

scope string

The scope limits the operations and roles allowed in Snowflake by the access token.

Required

session:role-any

resource string

An optional resource to pass to the token provider.

Optional

-

publicCertificateThumbprint string

Your certificate thumbprint.

Required if useCertificate is true.

-

oauthPrivateKey object

Required if useCertificate is true.

-

clientSecret string

Client secret of the application.

Required if useCertificate is false.

-

Snowflake OAuth private key

The oauthPrivateKey object represents your OAuth private key in Snowflake. This object is required if you set oAuthClientCredentials as your authentication type, and useCertificate is set to true. The table below outlines the object's child parameters.

Attribute
Description
Accepted values

keyName string

The Immuta-given name of your private key.

oauth client certificate

userFilename string

The name of your private key file on your machine.

-

content string

The private key. Replace new lines in the private key with a backslash before the new line character: "\n". If you are using another means of configuration, such as a Python script, the "\n" should not be added.

-

Snowflake impersonation object

The impersonation object enables and defines roles for user impersonation for Snowflake. The table below outlines its child parameters.

Parameter
Description
Accepted values

enabled boolean

When true, enables user impersonation.

true or false

role string

The name of the user impersonation role.

-

Snowflake workspace object

The workspaces object represents an Immuta project workspace configured for Snowflake. The table below outlines its child parameters.

Parameter
Description
Accepted values

enabled boolean

This setting enables or disables Snowflake project workspaces. If you use Snowflake secure data sharing with Immuta, set this property to true, as project workspaces are required. If you use Snowflake table grants, set this property to false; project workspaces cannot be used when Snowflake table grants are enabled.

true or false

warehouses array[string]

This array is a list of warehouses workspace users have usage privileges on.

-

Snowflake lineage object

The lineage object enables Snowflake lineage ingestion. When this setting is enabled, Immuta automatically applies tags added to a Snowflake table to its descendant data source columns in Immuta so you can build policies using those tags to restrict access to sensitive data. The table below outlines its child parameters.

Parameter
Description
Required or optional
Accepted values

enabled boolean

When true, enables Snowflake lineage so that Immuta can apply tags added to Snowflake data sources to their descendant data source columns in Immuta.

Optional

true or false

lineageConfig object

Configures what tables Immuta will ingest lineage history for, the number of rows to ingest per batch, and what tags to propagate. Child parameters include tableFilter, tagFilterRegex, and ingestBatchSize.

Required if enabled is true.

-

lineageConfig.tableFilter string

This child parameter of lineageConfig determines which tables Immuta will ingest lineage for. Use a regular expression that excludes / from the beginning and end to filter tables. Without this filter, Immuta will attempt to ingest lineage for every table on your Snowflake instance.

Optional

Regular expression that excludes / from the beginning and end.

lineageConfig.tagFilterRegex string

This child parameter of lineageConfig determines which tags to propagate using lineage. Use a regular expression that excludes / from the beginning and end to filter tags. Without this filter, Immuta will ingest lineage for every tag on your Snowflake instance.

Optional

Regular expression that excludes / from the beginning and end.

lineageConfig.ingestBatchSize number

This child parameter of lineageConfig configures the number of rows Immuta ingests per batch when streaming Access History data from your Snowflake instance.

Optional

Minimum value of 1.

Snowflake user role pattern object

The userRolePattern object excludes roles and users from authorization checks in the Snowflake integration. The table below outlines its child parameter.

Parameter
Description
Accepted values

exclude array[string]

This array is a list of roles and users (both case-sensitive) to exclude from authorization checks. Wildcards are unsupported.

-

Databricks Unity Catalog specific objects

Databricks group pattern object

The groupPattern object excludes the listed group from having data policies applied in the Databricks Unity Catalog integration. This account-level group should be used for privileged users and service accounts that require an unmasked view of data. The table below outlines its child parameter.

Parameter
Description
Default values
Accepted values

deny string

The name of a group in Databricks that will be excluded from having data policies applied. This account-level group should be used for privileged users and service accounts that require an unmasked view of data.

immuta_exemption_group

-

Databricks Unity Catalog job config object

The jobConfig object controls configuration settings for Databricks Unity Catalog query parsing. The table below outlines its child parameters.

Attribute
Description
Accepted values

workspaceDirectoryPath string

The file path of the workspace directory.

/Workspace/ImmutaArtifacts

jobClusterId string

The ID of the job cluster.

undefined

Databricks Unity Catalog OAuth object

The oAuthClientConfig object represents your OAuth configuration in Databricks Unity Catalog. This object is required if you set oAuthM2M as your authentication type. The table below outlines the object's child parameters

Attribute
Description
Required or optional
Accepted values

useCertificate boolean

Specifies whether or not to use a certificate and private key for authenticating with OAuth.

Required

false

clientId string

The client identifier of your registered application.

Required

-

authorityUrl string

Authority URL of your identity provider.

Required

-

scope string

Required

all-apis

clientSecret string

Required

-

Audit object

The audit object enables query audit. The table below outlines its child parameter.

Attribute
Description
Accepted values

enabled boolean

If true, query audit is enabled. Set to true for the recommended configuration.

  • true

  • false

PreviousDeregister a ConnectionNextMarketplace API

Last updated 1 month ago

Was this helpful?

See , , or the .

See .

See .

See .

See .

See .

See .

The access key ID of an AWS account with the .

The secret access key of an AWS account with the .

This object specifies the integration settings. See the config object description for your technology: or .

The private key. Replace new lines in the private key with a backslash before the new line character: "\n". If you are using another means of configuration, such as a Python script, the "\n" should not be added. In the , this is the config.privateKey attribute.

See .

Enables user impersonation. See the .

This object enables Snowflake query audit. See the .

This object represents an Immuta project workspace configured for Snowflake. See the .

Enables Snowflake lineage ingestion so that Immuta can apply tags added to Snowflake tables to their descendant data source columns. See the .

This object excludes roles and users from authorization checks. See the user .

See .

This object enables Databricks Unity Catalog query audit. See the .

Excludes the listed group from having data policies applied in the Databricks Unity Catalog integration. See the .

This object controls query parsing configuration. See the .

In the , this is the config.privateKey attribute.

See

In the , this is the config.oauthPrivateKey attribute.

The scope limits the operations and roles allowed in Databricks. See the for details about scopes.

.

integrations API
OAuth 2.0 documentation
Client secret created for the Immuta service principal
Snowflake connection object
Databricks Unity Catalog connection object
AWS Lake Formation connection object
Settings object
Options object
Native integration object
Snowflake private key object
Snowflake OAuth object
Databricks Unity Catalog OAuth object
AWS permissions listed in the set up the Immuta service principal section
AWS permissions listed in the set up the Immuta service principal section
Snowflake
Databricks Unity Catalog
Snowflake OAuth object
impersonation object
audit object
workspaces object
lineage object
role pattern object
Databricks Unity Catalog OAuth object
audit object
Databricks Unity Catalog group pattern object
Databricks Unity Catalog job config object
Snowflake OAuth with certificate/private key.
integrations API
integrations API