# Configure a Databricks Unity Catalog Integration {% @mermaid/diagram content="graph LR A(Authenticate) --> B(Configure integration) --> C(Map users and create policies) --> D(Register metadata); style A fill:#fff style B fill:#2F6BA7,color:#fff style C fill:#fff style D fill:#fff" %} Immuta’s integration with Unity Catalog allows you to manage multiple Databricks workspaces through Unity Catalog while protecting your data with Immuta policies. Instead of manually creating UDFs or granting access to each table in Databricks, you can author your policies in Immuta and have Immuta manage and enforce Unity Catalog access-control policies on your data in Databricks clusters or SQL warehouses. Use the `/integrations` endpoint to * [configure a Databricks Unity Catalog integration](#configure-the-integration) * [get a Databricks Unity Catalog integration](#get-an-integration) * [get all integrations](#get-all-integrations) * [update a Databricks Unity Catalog integration](#update-an-integration-configuration) * [delete a Databricks Unity Catalog integration](#delete-an-integration) ## Requirements ### Permissions The following permissions and personas are used in the registration process. * **Immuta user**: An Immuta user with the `APPLICATION_ADMIN` Immuta permission must configure the Databricks Unity Catalog integration. * **Databricks user**: The Databricks user [running the installation script](#user-content-fn-1)[^1] must have the following privileges. * `Account admin` * `CREATE CATALOG` privilege on the Unity Catalog metastore to create an Immuta-owned catalog and tables * [`Metastore admin`](#user-content-fn-2)[^2] (only required if enabling query audit) * [**Databricks service principal**](#user-content-fn-3)[^3]: * `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. * 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](https://docs.databricks.com/en/data-governance/unity-catalog/manage-privileges/index.html). The `system.access` schema must also be [enabled](https://docs.databricks.com/en/admin/system-tables/index.html#enable-a-system-schema) on the metastore before it can be used. See the [Databricks documentation](https://docs.databricks.com/en/data-governance/unity-catalog/manage-privileges/privileges.html) for more details about Unity Catalog privileges and securable objects. ### Authentication * **Access token authentication**: If using this method, generate a personal access token for the service principal that Immuta will use to manage policies in Unity Catalog. This service principal must have the privileges listed above for the metastore associated with the Databricks workspace. * **OAuth machine-to-machine (M2M) authentication**: If using this method, follow [Databricks documentation to create a client secret](https://docs.databricks.com/en/dev-tools/auth/oauth-m2m.html) for the Immuta service principal. This service principal must have the privileges listed above for the metastore associated with the Databricks workspace. ## Prerequisite Enable Databricks Unity Catalog on the Immuta app settings page: 1. Click the **App Settings** icon in the left sidebar. 2. Scroll to the **Global Integrations Settings** section and check the **Enable Databricks Unity Catalog support in Immuta** checkbox. ## Configure the integration You have two options for configuring your Databricks Unity Catalog integration: * [**Automatic setup**](#automatic-setup): When performing an automatic setup, the Databricks personal access token you configure below must be attached to an account with [these Databricks permissions](#requirements) for the metastore associated with the specified Databricks workspace. Immuta creates the catalogs, schemas, tables, and functions using the integration's configured personal access token. * [**Manual setup**](#manual-setup): Run the Immuta script in Databricks yourself to create the catalog. You can also modify the script to customize your storage location for tables, schemas, or catalogs. The user running the script needs to have the `CREATE CATALOG` permission on the workspace metastore. The Databricks personal access token you configure must be attached to an account with the Databricks permissions listed in the [requirements section](#requirements). ### Automatic setup **Required permissions:** When performing an automatic setup, the credentials provided must have the [permissions listed above](#permissions). Copy the request example, and replace the values with your own as directed to configure the integration settings. The examples provided use JSON format, but the request also accepts YAML. See the [**config** object description](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/payload#databricks-unity-catalog-configuration-objects) for parameter definitions, value types, and additional configuration options. {% tabs %} {% tab title="Access token authentication example" %} \`\`\`shell curl -X 'POST' \ '' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \ -d '{ "type": "Databricks", "autoBootstrap": true, "config": { "workspaceUrl": "[www.example-workspace.cloud.databricks.com](http://www.example-workspace.cloud.databricks.com)", "httpPath": "sql/protocolv1/o/0/0000-00000-abc123", "authenticationType": "token", "token": "REDACTED", "catalog": "immuta" } }' \`\`\` 1. Replace the **Immuta URL** and [**API key**](https://documentation.immuta.com/2024.2/developer-guides/api-intro/getting-started#authenticate-with-the-api) with your own. 2. Change the **config** values to your own, where * **workspaceUrl** is your Databricks workspace URL. * **httpPath** is the HTTP path of your Databricks cluster or SQL warehouse. * **token** is the Databricks personal access token. This is the access token for the Immuta service principal. * **catalog** is 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. {% hint style="warning" %} **Create a separate Immuta catalog for each Immuta tenant** If multiple Immuta tenants are connected to your Databricks environment, create a separate **Immuta catalog** for each of those tenants. Having multiple Immuta tenants use the same Immuta catalog causes failures in policy enforcement. {% endhint %} {% endtab %} {% tab title="OAuth machine-to-machine authentication example" %} \`\`\`shell curl -X 'POST' \ '' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \ -d '{ "type": "Databricks", "autoBootstrap": true, "config": { "workspaceUrl": "[www.example-workspace.cloud.databricks.com](http://www.example-workspace.cloud.databricks.com)", "httpPath": "sql/protocolv1/o/0/0000-00000-abc123", "authenticationType": "oAuthM2M", "oAuthClientConfig": { "clientId": "123456abc", "clientSecret": "secret", "authorityUrl": "example.authority.com" }, "catalog": "immuta" } }' \`\`\` 1. Replace the **Immuta URL** and [**API key**](https://documentation.immuta.com/2024.2/developer-guides/api-intro/getting-started#authenticate-with-the-api) with your own. 2. Change the **config** values to your own, where * **workspaceUrl** is your Databricks workspace URL. * **httpPath** is the HTTP path of your Databricks cluster or SQL warehouse. * **oAuthClientConfig** specifies your client ID, client secret, and authority URL. See the [object description](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/payload#databricks-unity-catalog-oauth-configuration-object) for details about child parameters. * **catalog** is 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. {% hint style="warning" %} **Create a separate Immuta catalog for each Immuta tenant** If multiple Immuta tenants are connected to your Databricks environment, create a separate **Immuta catalog** for each of those tenants. Having multiple Immuta tenants use the same Immuta catalog causes failures in policy enforcement. {% endhint %} {% endtab %} {% endtabs %} #### Response The response returns the status of the Databricks Unity Catalog integration configuration connection. See the [response schema reference](https://documentation.immuta.com/2024.2/developer-guides/api-intro/integrations-api/reference-guides/response-schema) for details about the response schema. {% tabs %} {% tab title="200 response" %} A successful response includes the validation tests statuses. ```json { "id": "123456789", "status": "creating", "validationResults": { "status": "passed", "validationTests": [ { "name": "Metastore validation", "status": "passed" }, { "name": "Basic Connection Test", "result": [ { "1": 1 } ], "status": "passed" } ] } } ``` {% endtab %} {% tab title="Unsuccessful request" %} An unsuccessful request returns the status code and an error message. See the [HTTP status codes and error messages](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/status-codes#post-errors) for a list of statuses, error messages, and troubleshooting guidance. ```json { "statusCode": 409, "error": "Conflict", "message": "Databricks Unity Catalog integration already exists on www.example-workspace.cloud.databricks.com (id = 123456789)" } ``` {% endtab %} {% endtabs %} ### Manual setup **Required permissions:** When performing a manual setup, the Databricks user running the script must have the [permissions listed above](#permissions). To manually configure the integration, complete the following steps: 1. [Generate the Immuta script and run it in your Databricks environment.](#generate-the-script) 2. [Configure the integration in Immuta.](#configure-the-integration-in-immuta) #### Generate the script Copy the request example, and replace the values with your own as directed to configure the integration settings. The examples provided use JSON format, but the request also accepts YAML. See the [**config** object description](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/payload#databricks-unity-catalog-configuration-objects) for parameter definitions, value types, and additional configuration options. {% tabs %} {% tab title="Access token authentication example" %} \`\`\`shell curl -X 'POST' \ '' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \ -d '{ "type": "Databricks", "autoBootstrap": false, "config": { "workspaceUrl": "[www.example-workspace.cloud.databricks.com](http://www.example-workspace.cloud.databricks.com)", "httpPath": "sql/protocolv1/o/0/0000-00000-abc123", "authenticationType": "token", "token": "REDACTED", "catalog": "immuta" } }' \`\`\` 1. Replace the **Immuta URL** and [**API key**](https://documentation.immuta.com/2024.2/developer-guides/api-intro/getting-started#authenticate-with-the-api) with your own. 2. Change the **config** values to your own, where * **workspaceUrl** is your Databricks workspace URL. * **httpPath** is the HTTP path of your Databricks cluster or SQL warehouse. * **token** is the Databricks personal access token. This is the access token for the Immuta service principal. * **catalog** is 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. {% hint style="warning" %} **Create a separate Immuta catalog for each Immuta tenant** If multiple Immuta tenants are connected to your Databricks environment, create a separate **Immuta catalog** for each of those tenants. Having multiple Immuta tenants use the same Immuta catalog causes failures in policy enforcement. {% endhint %} 3. Run the script returned in the response in your Databricks environment. {% endtab %} {% tab title="OAuth machine-to-machine authentication example" %} \`\`\`shell curl -X 'POST' \ '' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \ -d '{ "type": "Databricks", "autoBootstrap": false, "config": { "workspaceUrl": "[www.example-workspace.cloud.databricks.com](http://www.example-workspace.cloud.databricks.com)", "httpPath": "sql/protocolv1/o/0/0000-00000-abc123", "authenticationType": "oAuthM2M", "oAuthClientConfig": { "clientId": "123456abc", "clientSecret": "secret", "authorityUrl": "example.authority.com" }, "catalog": "immuta" } }' \`\`\` 1. Replace the **Immuta URL** and [**API key**](https://documentation.immuta.com/2024.2/developer-guides/api-intro/getting-started#authenticate-with-the-api) with your own. 2. Change the **config** values to your own, where * **workspaceUrl** is your Databricks workspace URL. * **httpPath** is the HTTP path of your Databricks cluster or SQL warehouse. * **oAuthClientConfig** specifies your client ID, client secret, and authority URL. See the [object description](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/payload#databricks-unity-catalog-oauth-configuration-object) for details about child parameters. * **catalog** is 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. {% hint style="warning" %} **Create a separate Immuta catalog for each Immuta tenant** If multiple Immuta tenants are connected to your Databricks environment, create a separate **Immuta catalog** for each of those tenants. Having multiple Immuta tenants use the same Immuta catalog causes failures in policy enforcement. {% endhint %} 3. Run the script returned in the response in your Databricks environment. {% endtab %} {% endtabs %} **Response** The response returns the script for you to run in your environment. #### Configure the integration in Immuta Copy the request example, and replace the values with your own as directed to configure the integration settings. The examples provided use JSON format, but the request also accepts YAML. The payload you provide must match the payload sent when [generating the script](#generate-the-script). See the [**config** object description](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/payload#databricks-unity-catalog-configuration-objects) for parameter definitions, value types, and additional configuration options. {% tabs %} {% tab title="Access token authentication example" %} \`\`\`shell curl -X 'POST' \ '' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \ -d '{ "type": "Databricks", "autoBootstrap": false, "config": { "workspaceUrl": "[www.example-workspace.cloud.databricks.com](http://www.example-workspace.cloud.databricks.com)", "httpPath": "sql/protocolv1/o/0/0000-00000-abc123", "authenticationType": "token", "token": "REDACTED", "catalog": "immuta" } }' \`\`\` 1. Replace the **Immuta URL** and [**API key**](https://documentation.immuta.com/2024.2/developer-guides/api-intro/getting-started#authenticate-with-the-api) with your own. 2. Pass the same payload you sent when [generating the script](#generate-the-script), where * **workspaceUrl** is your Databricks workspace URL. * **httpPath** is the HTTP path of your Databricks cluster or SQL warehouse. * **token** is the Databricks personal access token. This is the access token for the Immuta service principal. * **catalog** is 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. {% hint style="warning" %} **Create a separate Immuta catalog for each Immuta tenant** If multiple Immuta tenants are connected to your Databricks environment, create a separate **Immuta catalog** for each of those tenants. Having multiple Immuta tenants use the same Immuta catalog causes failures in policy enforcement. {% endhint %} {% endtab %} {% tab title="OAuth machine-to-machine authentication example" %} \`\`\`shell curl -X 'POST' \ '' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \ -d '{ "type": "Databricks", "autoBootstrap": false, "config": { "workspaceUrl": "[www.example-workspace.cloud.databricks.com](http://www.example-workspace.cloud.databricks.com)", "httpPath": "sql/protocolv1/o/0/0000-00000-abc123", "authenticationType": "oAuthM2M", "oAuthClientConfig": { "clientId": "123456abc", "clientSecret": "secret", "authorityUrl": "example.authority.com" }, "catalog": "immuta" } }' \`\`\` 1. Replace the **Immuta URL** and [**API key**](https://documentation.immuta.com/2024.2/developer-guides/api-intro/getting-started#authenticate-with-the-api) with your own. 2. Pass the same payload you sent when [generating the script](#generate-the-script), where * **workspaceUrl** is your Databricks workspace URL. * **httpPath** is the HTTP path of your Databricks cluster or SQL warehouse. * **oAuthClientConfig** specifies your client ID, client secret, and authority URL. See the [object description](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/payload#databricks-unity-catalog-oauth-configuration-object) for details about child parameters. * **catalog** is 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. {% hint style="warning" %} **Create a separate Immuta catalog for each Immuta tenant** If multiple Immuta tenants are connected to your Databricks environment, create a separate **Immuta catalog** for each of those tenants. Having multiple Immuta tenants use the same Immuta catalog causes failures in policy enforcement. {% endhint %} {% endtab %} {% endtabs %} #### Response The response returns the status of the Databricks Unity Catalog integration configuration connection. See the [response schema reference](https://documentation.immuta.com/2024.2/developer-guides/api-intro/integrations-api/reference-guides/response-schema) for details about the response schema. {% tabs %} {% tab title="200 response" %} A successful response includes the validation tests statuses. ```json { "id": "123456789", "status": "creating", "validationResults": { "status": "passed", "validationTests": [ { "name": "Metastore validation", "status": "passed" }, { "name": "Basic Connection Test", "result": [ { "1": 1 } ], "status": "passed" } ] } } ``` {% endtab %} {% tab title="Unsuccessful response" %} An unsuccessful request returns the status code and an error message. See the [HTTP status codes and error messages](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/status-codes#post-errors) for a list of statuses, error messages, and troubleshooting guidance. ```json { "statusCode": 409, "error": "Conflict", "message": "Databricks Unity Catalog integration already exists on www.example-workspace.cloud.databricks.com (id = 123456789)" } ``` {% endtab %} {% endtabs %} ## Get an integration ```shell curl -X 'GET' \ 'https://www.organization.immuta.com/integrations/{id}' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' ``` 1. Copy the request example. 2. Replace the **Immuta URL** and [**API key**](https://documentation.immuta.com/2024.2/developer-guides/api-intro/getting-started#authenticate-with-the-api) with your own. 3. Replace the **{id}** request parameter with the unique identifier of the integration you want to get. Alternatively, you can get a list of all integrations and their IDs with the [`GET /integrations` endpoint](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/integrations-api#get-integrations). ### Response The response returns a Databricks Unity Catalog integration configuration. See the [response schema reference](https://documentation.immuta.com/2024.2/developer-guides/api-intro/integrations-api/reference-guides/response-schema) for details about the response schema. An unsuccessful request returns the status code and an error message. See the [HTTP status codes and error messages](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/status-codes#get-error) for a list of statuses, error messages, and troubleshooting guidance. ```json { "id": "123456789", "status": "enabled", "validationResults": { "status": "passed", "validationTests": [ { "name": "Metastore validation", "status": "passed" }, { "name": "Basic Connection Test", "result": [ { "1": 1 } ], "status": "passed" } ] }, "type": "Databricks", "autoBootstrap": false, "config": { "port": 443, "workspaceUrl": "www.example-workspace.cloud.databricks.com", "httpPath": "sql/protocolv1/o/0/0000-00000-abc123", "authenticationType": "token", "token": "REDACTED", "audit": { "enabled": false }, "catalog": "immuta" } } ``` ## Get all integrations ```shell curl -X 'GET' \ 'https://www.organization.immuta.com/integrations' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' ``` 1. Copy the request example. 2. Replace the **Immuta URL** and [**API key**](https://documentation.immuta.com/2024.2/developer-guides/api-intro/getting-started#authenticate-with-the-api) with your own. ### Response The response returns the configuration for all integrations. See the [response schema reference](https://documentation.immuta.com/2024.2/developer-guides/api-intro/integrations-api/reference-guides/response-schema) for details about the response schema. An unsuccessful request returns the status code and an error message. See the [HTTP status codes and error messages](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/status-codes#get-error) for a list of statuses, error messages, and troubleshooting guidance. ```json [ { "id": "1", "status": "enabled", "validationResults": { "status": "passed", "validationTests": [ { "name": "Initial Validation: Basic Connection Test", "status": "passed" }, { "name": "Initial Validation: Default Warehouse Access Test", "status": "passed", "result": [] }, { "name": "Initial Validation: Validate access to Privileged Role", "status": "passed", "result": [] }, { "name": "Validate Automatic: Database Does Not Exist", "status": "passed" }, { "name": "Validate Automatic: Impersonation Role Does Not Exist", "status": "skipped" }, { "name": "Validate Automatic Bootstrap User Grants", "status": "passed" } ] }, "type": "Snowflake", "autoBootstrap": true, "config": { "host": "organization.us-east-1.snowflakecomputing.com", "warehouse": "SAMPLE_WAREHOUSE", "database": "SNOWFLAKE_SAMPLE_DATA", "port": 443, "audit": { "enabled": false }, "workspaces": { "enabled": false }, "impersonation": { "enabled": false }, "lineage": { "enabled": false }, "authenticationType": "userPassword", "username": "", "password": "", "role": "ACCOUNTADMIN" } }, { "id": "2", "status": "enabled", "type": "Databricks", "validationResults": { "status": "passed", "validationTests": [ { "name": "Metastore validation", "status": "passed" }, { "name": "Basic Connection Test", "result": [ { "1": 1 } ], "status": "passed" } ] }, "autoBootstrap": true, "config": { "workspaceUrl": "www.example-workspace.cloud.databricks.com", "httpPath": "sql/protocolv1/o/0/0000-00000-abc123", "authenticationType": "token", "token": "REDACTED", "audit": { "enabled": false }, "catalog": "immuta" } } ] ``` ## Update an integration configuration Copy the request example, and replace the values with your own as directed to configure the integration settings. The examples provided use JSON format, but the request also accepts YAML. See the [**config** object description](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/payload#databricks-unity-catalog-configuration-objects) for parameter definitions, value types, and additional configuration options. ```shell curl -X 'PUT' \ 'https://www.organization.immuta.com/integrations/{id}' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \ -d '{ "type": "Databricks", "autoBootstrap": true, "config": { "workspaceUrl": "www.example-workspace.cloud.databricks.com", "httpPath": "sql/protocolv1/o/0/0000-00000-abc123", "authenticationType": "token", "token": "REDACTED", "catalog": "immuta" } }' ``` *This example updates the access token.* 1. Replace the **Immuta URL** and [**API key**](https://documentation.immuta.com/2024.2/developer-guides/api-intro/getting-started#authenticate-with-the-api) with your own. 2. Replace the **{id}** request parameter with the unique identifier of the integration you want to update. 3. Change the **config** values to your own, where * **workspaceUrl** is your Databricks workspace URL. * **httpPath** is the HTTP path of your Databricks cluster or SQL warehouse. * **token** is the Databricks personal access token. This is the access token for the Immuta service principal. * **catalog** is 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. {% hint style="warning" %} **Create a separate Immuta catalog for each Immuta tenant** If multiple Immuta tenants are connected to your Databricks environment, create a separate **Immuta catalog** for each of those tenants. Having multiple Immuta tenants use the same Immuta catalog causes failures in policy enforcement. {% endhint %} ### Response The response returns the status of the Databricks Unity Catalog integration configuration connection. See the [response schema reference](https://documentation.immuta.com/2024.2/developer-guides/api-intro/integrations-api/reference-guides/response-schema) for details about the response schema. {% tabs %} {% tab title="200 response" %} A successful response includes the validation tests statuses. ```json { "id": "123456789", "status": "editing", "validationResults": { "status": "passed", "validationTests": [ { "name": "Metastore validation", "status": "passed" }, { "name": "Basic Connection Test", "result": [ { "1": 1 } ], "status": "passed" } ] } } ``` {% endtab %} {% tab title="Unsuccessful response" %} An unsuccessful request returns the status code and an error message. See the [HTTP status codes and error messages](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/status-codes#put-errors) for a list of statuses, error messages, and troubleshooting guidance. ```json { "statusCode": 409, "error": "Conflict", "message": "Unable to edit integration with ID 123456789 in current state editing." } ``` {% endtab %} {% endtabs %} ## Delete an integration ```shell curl -X 'DELETE' \ 'https://www.organization.immuta.com/integrations/{id}' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' ``` 1. Copy the request example. 2. Replace the **Immuta URL** and [**API key**](https://documentation.immuta.com/2024.2/developer-guides/api-intro/getting-started#authenticate-with-the-api) with your own. 3. Replace the **{id}** request parameter with the unique identifier of the integration you want to delete. ### Response The response returns the status of the Databricks Unity Catalog integration configuration that has been deleted. See the [response schema reference](https://documentation.immuta.com/2024.2/developer-guides/api-intro/integrations-api/reference-guides/response-schema) for details about the response schema. An unsuccessful request returns the status code and an error message. See the [HTTP status codes and error messages](https://documentation.immuta.com/2024.2/developer-guides/api-intro/reference-guides/status-codes#delete-errors) for a list of statuses, error messages, and troubleshooting guidance. ```json { "id": "123456789", "status": "deleting", "validationResults": { "status": "passed", "validationTests": [ { "name": "Metastore validation", "status": "passed" }, { "name": "Basic Connection Test", "result": [ { "1": 1 } ], "status": "passed" } ] } } ``` [^1]: If configuring the integration using the [automatic setup method](#automatic-setup), the credentials provided must have these privileges. [^2]: To enable query audit, this user must be an account admin and metastore admin. See [Manage privileges in Unity Catalog](https://docs.databricks.com/en/data-governance/unity-catalog/manage-privileges/index.html) for details. [^3]: 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.