Requirement: GOVERNANCE or APPLICATION_ADMIN global permission or Infrastructure Admin or Data Owner within the hierarchy

Prerequisite: A connection for Snowflake or Databricks Unity Catalog

Run object sync on a connection

1. Click Data and select the Connections tab in the navigation menu.

2. Click the more actions menu for the connection you want and select Run Object Sync.

3. Opt to click the checkbox to Also scan all inactive objects.

4. Click Run Object Sync.

Run object sync on a database

1. Click Data and select the Connections tab in the navigation menu.

2. Select the connection.

3. Click the more actions menu in the Action column for the database you want to sync and select Run Object Sync.

4. Opt to click the checkbox to Also scan all inactive objects.

5. Click Run Object Sync.

Run object sync on a schema

1. Click Data and select the Connections tab in the navigation menu.

2. Select the connection.

3. Select the database.

4. Click the more actions menu in the Action column for the schema you want to sync and select Run Object Sync.

5. Opt to click the checkbox to Also scan all inactive objects.

6. Click Run Object Sync.

Run object sync on a data source

You can run object sync from the data source health check or from the connection,

1. Click Data and select the Connections tab in the navigation menu.

2. Select the connection.

3. Select the database.

4. Select the schema

5. Click the more actions menu in the Action column for the data object you want to sync and select Run Object Sync.

6. Opt to click the checkbox to Also scan all inactive objects.

7. Click Run Object Sync

Supported technologies

• Databricks Unity Catalog

• Snowflake

Requirements

• An integration enabled on the Immuta app settings page

• Data sources registered

• Immuta global GOVERNANCE and APPLICATION_ADMIN permissions

To complete your upgrade,

1. Select Upgrade Manager in the navigation menu. This tab will only be available if you have integrations ready for upgrade.

2. Click Start Upgrade.

3. Display Name: The display name represents the unique name of your connection and will be used as prefix in the name for all data objects associated with this connection. It will also appear as the display name in the UI and will be used in all API calls made to update or delete the connection.

4. Click Next.

5. Ensure Immuta has the correct credentials to connect to Databricks Unity Catalog or Snowflake. Select the tab below for more information:

1. Click Next.

2. Click Upgrade Connection.

3. Click the link to the docs to understand the impacts of the upgrade.

4. Click the checkbox to confirm understanding of the upgrade effects, and click Yes, Upgrade Connection.

If you attempted the upgrade and receive the message that your upgrade is Partially Complete, find the un-upgraded data sources by navigating to the Upgrade Manager and clicking the number in the Available column for the relevant connection.

Use the options below to resolve those un-upgraded data sources in order to finish your upgrade. See the linked how-to's for more details on the actions to take.

Note that these un-upgraded data sources still exist and are still protected by policy.

1. Delete the remaining data sources: The easiest solution is to delete the data sources that did not upgrade. Note that disabled data sources that no longer exist in your data platform will never be upgraded. Only do this if you no longer need these data sources in Immuta.

2. Adjust the privileges of the system user used to connect Immuta and your data platform: Ensure that the Immuta system user can also access all remaining un-upgraded data sources in your data platform.

   1. Expand permissions in Snowflake or Databricks (recommended): Extend the Immuta system user's permissions in your data platform by granting it access to all remaining un-upgraded data sources.

   2. Change the system user credentials used by Immuta: You can also provide Immuta with a different set of credentials that already have the required permissions on the un-upgraded data sources.

Required Snowflake permissions

Ensure that the role you specified in the upgrade has the required permissions to register a Snowflake connection and has been granted to the Immuta system user.

Required Databricks Unity Catalog permissions

Ensure the Databricks service principal you created and connected with Immuta has the required permissions to register a Databricks Unity Catalog connection.

Delete the data sources

Expand permissions in Snowflake

GRANT ROLE <name> TO USER <user_name>;

Expand permissions in Databricks Unity Catalog

Change the system user credentials used by Immuta

If you have another set of credentials on hand with wider permissions, you can edit the connection to use these credentials instead to resolve the un-upgraded data sources.

Requirements

The following permissions and personas are used in the registration process.

An Immuta user with the APPLICATION_ADMIN Immuta permission must register the Databricks Unity Catalog connection.

A Databricks user authorized to create a Databricks service principal must create one for Immuta. This service principal is used continuously by Immuta to orchestrate Unity Catalog policies and maintain state between Immuta and Databricks. This service principal needs the following Databricks privileges:

• USE CATALOG and MANAGE on all catalogs containing securables registered as Immuta data sources and USE SCHEMA on all schemas containing securables registered as Immuta data sources.

• MODIFY and SELECT on all securables registered as Immuta data sources. MANAGE and MODIFY are required so that the service principal can apply row filters and column masks on the securable; to do so, the service principal must also have SELECT on the securable as well as USE CATALOG on its parent catalog and USE SCHEMA on its parent schema. Since privileges are inherited, you can grant the service principal the MODIFY and SELECT privilege on all catalogs or schemas containing Immuta data sources, which automatically grants the service principal the MODIFY and SELECT privilege on all current and future securables in the catalog or schema. The service principal also inherits MANAGE from the parent catalog for the purpose of applying row filters and column masks, but that privilege must be set directly on the parent catalog in order for grants to be fully applied.

See the Databricks documentation for more details about Unity Catalog privileges and securable objects.

Optionally, to include audit, the service principal needs the following additional privileges:

• USE CATALOG on system catalog

• USE SCHEMA on system.access schema

• SELECT on system.access.audit table

• SELECT on system.access.table_lineage table

• SELECT on system.access.column_lineage table

Access to system tables is governed by Unity Catalog. No user has access to these system schemas by default. To grant access, a user that is both a metastore admin and an account admin must grant USE and SELECT permissions on the system schemas to the service principal. See Manage privileges in Unity Catalog. The system.access schema must also be enabled on the metastore before it can be used.

Prerequisites

• Unity Catalog metastore created and attached to a Databricks workspace. See the Databricks Unity Catalog reference guide for information on workspaces and catalog isolation support with Immuta.

• Unity Catalog enabled on your Databricks cluster or SQL warehouse. All SQL warehouses have Unity Catalog enabled if your workspace is attached to a Unity Catalog metastore. Immuta recommends linking a SQL warehouse to your Immuta tenant rather than a cluster for both performance and availability reasons.

Register a connection

1. Click Data and select the Connections tab in the navigation menu.

2. Click the + Add Connection button.

3. Select the Databricks data platform tile.

4. Enter the connection information:

   • Host: The hostname of your Databricks workspace.

   • Port: Your Databricks port.

   • HTTP Path: The HTTP path of your Databricks cluster or SQL warehouse.

   • Immuta Catalog: The name of the 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.

   • Display Name: The display name represents the unique name of your connection and will be used as prefix in the name for all data objects associated with this connection. It will also appear as the display name in the UI and will be used in all API calls made to update or delete the connection.

5. Click Next.

6. Select your authentication method from the dropdown:

   • Access Token: Enter the Access Token in the Immuta System Account Credentials section. This is the access token for the Immuta service principal, which can be an on-behalf token created in Databricks. This service principal must have the metastore privileges listed in the requirements section for the metastore associated with the Databricks workspace. If this token is configured to expire, update this field regularly for the connection to continue to function. This authentication information will be included in the script populated later on the page.

   • OAuth M2M:

     • AWS Databricks:

       • Follow Databricks documentation to create a client secret for the Immuta service principal and assign this service principal the privileges listed above for the metastore associated with the Databricks workspace.

       • Fill out the Token Endpoint with the full URL of the identity provider. This is where the generated token is sent. The default value is https://<your workspace name>.cloud.databricks.com/oidc/v1/token.

       • Fill out the Client ID. This is a combination of letters, numbers, or symbols, used as a public identifier and is the client ID displayed in Databricks when creating the client secret for the service principal.

       • Enter the Scope (string). The scope limits the operations and roles allowed in Databricks by the access token. See the OAuth 2.0 documentation for details about scopes.

       • Enter the Client Secret you created above. Immuta uses this secret to authenticate with the authorization server when it requests a token.

     • Azure Databricks:

       • Follow Databricks documentation to create a service principal within Azure and then populate to your Databricks account and workspace.

       • Assign this service principal the privileges listed above for the metastore associated with the Databricks workspace.

       • Within Databricks, create an OAuth client secret for the service principal. This completes your Databricks-based service principal setup.

       • Within Immuta, fill out the Token Endpoint with the full URL of the identity provider. This is where the generated token is sent. The default value is https://<your workspace name>.azuredatabricks.net/oidc/v1/token.

       • Fill out the Client ID. This is a combination of letters, numbers, or symbols, used as a public identifier and is the client ID displayed in Databricks when creating the client secret for the service principal (note that Azure Databricks uses the Azure SP Client ID; it will be identical).

       • Enter the Scope (string). The scope limits the operations and roles allowed in Databricks by the access token. See the OAuth 2.0 documentation for details about scopes.

       • Enter the Client Secret you created above. Immuta uses this secret to authenticate with the authorization server when it requests a token.

7. Copy the provided script and run it in Databricks as a user with the CREATE CATALOG privilege on the Unity Catalog metastore.

8. Click Validate Connection.

9. If the connection is successful, click Next. If there are any errors, check the connection details and credentials to ensure they are correct and try again.

10. Ensure all the details are correct in the summary and click Complete Setup.

Requirements

The following permissions and personas are used in the registration process:

• Immuta permission: APPLICATION_ADMIN

• Snowflake permissions for the user registering the connection and running the script:

  • CREATE DATABASE ON ACCOUNT WITH GRANT OPTION

  • CREATE ROLE ON ACCOUNT WITH GRANT OPTION

  • CREATE USER ON ACCOUNT WITH GRANT OPTION

  • MANAGE GRANTS ON ACCOUNT WITH GRANT OPTION

  • APPLY MASKING POLICY ON ACCOUNT WITH GRANT OPTION

  • APPLY ROW ACCESS POLICY ON ACCOUNT WITH GRANT OPTION

  • REFERENCES on all tables

  • USAGE on the schema and database to register data sources

• Snowflake permissions for the new Immuta system user that is created:

  • APPLY MASKING POLICY ON ACCOUNT

  • APPLY ROW ACCESS POLICY ON ACCOUNT

  • Additional grants associated with the IMMUTA database

Prerequisite

No Snowflake integration configured in Immuta. If your Snowflake integration is already configured on the app settings page, follow the Use the connection upgrade manager guide.

Register a connection

To register a Snowflake connection, follow the instructions below.

1. Click Data and select the Connections tab in the navigation menu.

2. Click the + Add Connection button.

3. Select the Snowflake data platform tile.

4. Enter the connection information:

   • Host: The URL of your Snowflake account.

   • Port: Your Snowflake port.

   • Warehouse: The warehouse the Immuta system account user will use to run queries and perform Snowflake operations.

   • Immuta Database: The new, empty database for Immuta to manage. This is where system views, user entitlements, row access policies, column-level policies, procedures, and functions managed by Immuta will be created and stored.

   • Role: The default Snowflake role for the Immuta system account user.

   • Display Name: The display name represents the unique name of your connection and will be used as prefix in the name for all data objects associated with this connection. It will also appear as the display name in the UI and will be used in all API calls made to update or delete the connection.

5. Click Next.

6. Select an authentication method from the dropdown menu. This authentication information will be included in the script populated later on the page.

   1. Username and password: Choose one of the following options.

      1. Select Immuta Generated to have Immuta populate the system account name and password.

      2. Select User Provided to enter your own name and password for the Immuta system account.

   2. Snowflake External OAuth:

      1. Fill out the Token Endpoint, which is where the generated token is sent. It is also known as aud (audience) and iss (issuer).

      2. Fill out the Client ID, which is the subject of the generated token. It is also known as sub (subject).

      3. Opt to fill out the Resource field with a URI of the resource where the requested token will be used.

      4. Enter the x509 Certificate Thumbprint. This identifies the corresponding key to the token and is often abbreviated as x5t or is called kid (key identifier).

      5. Upload the PEM Certificate, which is the client certificate that is used to sign the authorization request.

   3. Key Pair Authentication:

      1. Complete the Username field. This username will be used to connect to the remote database and retrieve records for this data source.

      2. If using a private key, enter the Private Key Password.

      3. Click Select a File, and upload a Snowflake key pair file.

7. The Role is prepopulated from the entry on the previous page.

8. Copy the provided script and run it in Snowflake with the following Snowflake permissions:

   • CREATE DATABASE ON ACCOUNT WITH GRANT OPTION

   • CREATE ROLE ON ACCOUNT WITH GRANT OPTION

   • CREATE USER ON ACCOUNT WITH GRANT OPTION

   • MANAGE GRANTS ON ACCOUNT WITH GRANT OPTION

   • APPLY MASKING POLICY ON ACCOUNT WITH GRANT OPTION

   • APPLY ROW ACCESS POLICY ON ACCOUNT WITH GRANT OPTION

9. Click Test Connection.

10. If the connection is successful, click Next. If there are any errors, check the connection details and credentials to ensure they are correct and try again.

11. Ensure all the details are correct in the summary and click Complete Setup.