Skip to content

You are viewing documentation for Immuta version 2024.1.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

Configure a Snowflake Integration

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
click A "../../getting-started/#authenticate-with-the-api" _blank
click C "../../getting-started/#protect-your-data" _blank
click D "../../getting-started/#register-metadata" _blank

In the Snowflake integration, Immuta manages access to Snowflake tables by administering Snowflake row access policies and column masking policies on those tables, allowing users to query tables directly in Snowflake while dynamic policies are enforced.

Use the /integrations endpoint to

Requirements

  • APPLICATION_ADMIN Immuta permission
  • Snowflake Enterprise account
  • Role used to configure, edit, or remove the integration needs to have the following Snowflake privileges:
    • 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

Configure the integration

You have two options for configuring your Snowflake integration:

  • Automatic setup: Grant Immuta one-time use of credentials to automatically configure your Snowflake environment and the integration. When performing an automated installation, Immuta requires temporary, one-time use of credentials with the Snowflake privileges listed in the requirements section.

    These permissions will be used to create and configure a new Immuta-managed database within the specified Snowflake instance. The credentials are not stored or saved by Immuta, and Immuta doesn’t retain access to them after initial setup is complete.

    You can create a new account for Immuta to use that has these permissions, or you can grant temporary use of a pre-existing account. By default, the pre-existing account with appropriate permissions is ACCOUNTADMIN. If you create a new account, it can be deleted after initial setup is complete.

  • Manual setup: Run the Immuta script in your Snowflake environment yourself to configure your Snowflake environment and the integration. The specified role used to run the bootstrap needs to have the Snowflake privileges listed in the requirements section.

Automatic setup

  1. Select the tab below that matches your authentication method.
  2. 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 for parameter definitions, value types, and additional configuration options.

curl -X 'POST' \
    'https://www.organization.immuta.com/integrations' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": true,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "authenticationType": "userPassword",
      "username": "taylor@snowflake.com",
      "password": "abc1234",
      "role": "ACCOUNTADMIN"
    }
    }'
  1. Replace the Immuta URL and API key with your own.
  2. Change the config values to your own, where

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • username and password are the credentials for the system account that can assume the role to manage the database and administer Snowflake masking and row access policies.
curl -X 'POST' \
    'https://www.organization.immuta.com/integrations' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": true,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "authenticationType": "keyPair",
      "username": "SYSTEM_ACCOUNT",
      "privateKey": "-----BEGIN PRIVATE KEY-----\\n<first line of private key content>\\n<another line of private key content>\\n<another line of private key content>\\n-----END PRIVATE KEY-----"
    }
    }'
  1. Replace the Immuta URL and API key with your own.
  2. Change the config values to your own, where

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • username is the system account user that can assume the role to manage the database and administer Snowflake masking and row access policies.
    • privateKey is your private key. Replace new lines in the private key with double backslashes before the new line character: \\n.

Response

The response returns the status of the Snowflake integration configuration connection. See the response schema reference for details about the response schema.

A successful response includes the validation tests statuses.

{
  "id": "123456789",
  "status": "creating",
  "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"
    }
    ]
  }
}

An unsuccessful request returns the status code and an error message. See the HTTP status codes and error messages for a list of statuses, error messages, and troubleshooting guidance.

{
  "statusCode": 409,
  "error": "Conflict",
  "message": "Snowflake integration already exists on host organization.us-east-1.snowflakecomputing.com (id = 123456789)"
}

Manual setup

Best practices: account creation

The account you create for Immuta should only be used for the integration and should not be used as the credentials for creating data sources in Immuta; doing so will cause issues. Instead, create a separate, dedicated READ-ONLY account for creating and registering data sources within Immuta.

To manually configure the integration, complete the following steps:

  1. Generate the Immuta script and run it in your Snowflake environment.
  2. Configure the integration in Immuta.

Generate the script

  1. Select the tab below that matches your authentication method.
  2. Copy the request example and replace the values with your own as directed to generate the script. The examples provided use JSON format, but the request also accepts YAML.

See the config object description for parameter definitions, value types, and additional configuration options.

curl -X 'POST' \
    'https://www.organization.immuta.com/integrations/scripts/create' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "audit": {
        "enabled": false,
      },
      "workspaces": {
        "enabled": false
      },
      "impersonation": {
        "enabled": false
      },
      "authenticationType": "userPassword",
      "username": "taylor@snowflake.com",
      "password": "abc1234"
    }
    }'
  1. Replace the Immuta URL and API key with your own.
  2. Change the config values to your own, where

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • workspaces represents an Immuta project workspace configured for Snowflake. See the object description for child parameters.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • username and password are the credentials for the system account that can assume the role to manage the database and administer Snowflake masking and row access policies.
  3. Run the script returned in the response in your Snowflake environment.

curl -X 'POST' \
    'https://www.organization.immuta.com/integrations/scripts/create' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "audit": {
        "enabled": false,
      },
      "workspaces": {
        "enabled": false
      },
      "impersonation": {
        "enabled": false
      },
      "authenticationType": "keyPair",
      "username": "SYSTEM_ACCOUNT",
      "privateKey": "-----BEGIN PRIVATE KEY-----\\n<first line of private key content>\\n<another line of private key content>\\n<another line of private key content>\\n-----END PRIVATE KEY-----"
    }
    }'
  1. Replace the Immuta URL and API key with your own.
  2. Change the config values to your own, where

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • workspaces represents an Immuta project workspace configured for Snowflake. See the object description for child parameters.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • username is the system account user that can assume the role to manage the database and administer Snowflake masking and row access policies.
    • privateKey is your private key. Replace new lines in the private key with double backslashes before the new line character: \\n.
  3. Run the script returned in the response in your Snowflake environment.

In this example, Snowflake External OAuth is used to authenticate the system account user, ensuring secure communication between Immuta and Snowflake. To use this authentication method, autoBootstrap must be false.

curl -X 'POST' \
    'https://www.organization.immuta.com/integrations/scripts/create' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "impersonation": {
        "enabled": true,
        "role": "IMMUTA_IMPERSONATION"
      },
      "audit": {
        "enabled": false
      },
      "workspaces": {
        "enabled": true,
        "warehouses": ["SAMPLE_WAREHOUSE"]
      },
      "authenticationType": "oAuth",
      "oAuthClientConfig": {
        "provider": "Okta",
        "clientId": "123456abc",
        "useCertificate": true,
        "clientSecret": "secret",
        "authorityUrl": "example.authority.com",
        "encodedOauthPublicKey": "zGpLw5/XF3NtInwf+6xKsw==",
        "encodedOauthPrivateKey": "bTzWZVPi3ugPOTkegLq/7w=="
      }
    }
    }'
  1. Replace the Immuta URL and API key with your own.
  2. Change the config values to your own, where

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • workspaces.enabled specifies whether Immuta project workspaces are enabled for Snowflake.
    • workspaces.warehouses is a list of warehouses that workspace users have usage privileges on.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • username is the system account user that can act on Snowflake objects and configure the integration.
    • oAuthClientConfig specifies your provider, client ID, client secret, authority URL, and your encoded public and private keys. See the object description for details about child parameters.
  3. Run the script returned in the response in your Snowflake environment.

Response

The response returns the script for you to run in your environment.

Configure the integration in Immuta

  1. Select the tab below that matches your authentication method.
  2. 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 parameters and values you provide in this payload must match those you provided when generating the script.

See the config object description for parameter definitions, value types, and additional configuration options.

curl -X 'POST' \
    'https://www.organization.immuta.com/integrations' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "audit": {
        "enabled": false,
      },
      "workspaces": {
        "enabled": false
      },
      "impersonation": {
        "enabled": false
      },
      "authenticationType": "userPassword",
      "username": "taylor@snowflake.com",
      "password": "abc1234"
    }
    }'
  1. Replace the Immuta URL and API key with your own.
  2. Pass the same payload you sent when generating the script, where

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • workspaces represents an Immuta project workspace configured for Snowflake. See the object description for child parameters.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • username and password are the credentials for the system account that can assume the role to manage the database and administer Snowflake masking and row access policies.
curl -X 'POST' \
    'https://www.organization.immuta.com/integrations' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "audit": {
        "enabled": false,
      },
      "workspaces": {
        "enabled": false
      },
      "impersonation": {
        "enabled": false
      },
      "authenticationType": "keyPair",
      "username": "SYSTEM_ACCOUNT",
      "privateKey": "-----BEGIN PRIVATE KEY-----\\n<first line of private key content>\\n<another line of private key content>\\n<another line of private key content>\\n-----END PRIVATE KEY-----"
    }
    }'
  1. Replace the Immuta URL and API key with your own.
  2. Pass the same payload you sent when generating the script, where

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • workspaces represents an Immuta project workspace configured for Snowflake. See the object description for child parameters.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • username is the system account user that can assume the role to manage the database and administer Snowflake masking and row access policies.
    • privateKey is your private key. Replace new lines in the private key with double backslashes before the new line character: \\n.

In this example, Snowflake External OAuth is used to authenticate the system account user, ensuring secure communication between Immuta and Snowflake. To use this authentication method, autoBootstrap must be false.

curl -X 'POST' \
    'https://www.organization.immuta.com/integrations' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "impersonation": {
        "enabled": true,
        "role": "IMMUTA_IMPERSONATION"
      },
      "workspaces": {
        "enabled": true,
        "warehouses": ["SAMPLE_WAREHOUSE"]
      },
      "authenticationType": "oAuth",
      "oAuthClientConfig": {
        "provider": "Okta",
        "clientId": "123456abc",
        "useCertificate": true,
        "clientSecret": "secret",
        "authorityUrl": "example.authority.com",
        "encodedOauthPublicKey": "zGpLw5/XF3NtInwf+6xKsw==",
        "oauthPrivateKey": "bTzWZVPi3ugPOTkegLq/7w=="
      }
    }
    }'
  1. Replace the Immuta URL and API key with your own.
  2. Pass the same payload you sent when generating the script, where

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • workspaces specifies whether Immuta project workspaces are enabled for Snowflake. See the object description for details about child parameters.
    • oAuthClientConfig specifies your provider, client ID, client secret, authority URL, and your encoded public and private keys. See the object description for details about child parameters.

Response

The response returns the status of the Snowflake integration configuration connection. See the response schema reference for details about the response schema.

A successful response includes the validation tests statuses.

{
  "id": "123456789",
  "status": "creating",
  "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"
    }
    ]
  }
}

An unsuccessful request returns the status code and an error message. See the HTTP status codes and error messages for a list of statuses, error messages, and troubleshooting guidance.

{
  "statusCode": 409,
  "error": "Conflict",
  "message": "Snowflake integration already exists on host organization.us-east-1.snowflakecomputing.com (id = 123456789)"
}

Get an integration

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

Response

The response returns the Snowflake integration configuration. See the response schema reference 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 for a list of statuses, error messages, and troubleshooting guidance.

{
  "id": "123456789",
  "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": "<REDACTED>",
    "password": "<REDACTED>",
    "role": "ACCOUNTADMIN"
  }
}
{
  "id": "123456789",
  "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": false,
  "config": {
    "host": "organization.us-east-1.snowflakecomputing.com",
    "warehouse": "SAMPLE_WAREHOUSE",
    "database": "SNOWFLAKE_SAMPLE_DATA",
    "port": 443,
    "impersonation": {
      "enabled": true,
      "role": "IMMUTA_IMPERSONATION"
    },
    "audit": {
      "enabled": false
    },
    "workspaces": {
      "enabled": true,
      "warehouses": ["SAMPLE_WAREHOUSE"]
    },
    "lineage": {
      "enabled": false
    },
    "authenticationType": "oAuthClientCredentials",
    "oAuthClientConfig": {
      "provider": "Okta",
      "clientId": "123456abc",
      "useCertificate": true,
      "clientSecret": "secret",
      "authorityUrl": "example.authority.com",
      "encodedOauthPublicKey": "zGpLw5/XF3NtInwf+6xKsw==",
      "oauthPrivateKey": "bTzWZVPi3ugPOTkegLq/7w=="
    }
  }
}

Get all integrations

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 with your own.

Response

The response returns the configuration for all integrations. See the response schema reference 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 for a list of statuses, error messages, and troubleshooting guidance.

[
  {
    "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": "<REDACTED>",
      "password": "<REDACTED>",
      "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",
        "token": "REDACTED",
        "audit": {
          "enabled": false
        },
        "catalog": "immuta"
      }
    }
  }
]

Update an integration configuration

You have two options for updating your integration. Follow the steps that match your initial configuration of autoBootstrap:

Automatic update

  1. Select the tab below that matches your authentication method.
  2. Copy the request example and replace the values with your own as directed to update the integration settings. The examples provided use JSON format, but the request also accepts YAML.

See the config object description for parameter definitions, value types, and additional configuration options.

This request updates the configuration to enable query audit in Snowflake.

curl -X 'PUT' \
    'https://www.organization.immuta.com/integrations/{id}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": true,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "audit": {
        "enabled": true,
      },
      "authenticationType": "userPassword",
      "username": "taylor@snowflake.com",
      "password": "abc1234",
      "role": "ACCOUNTADMIN"
    }
    }'
  1. Replace the Immuta URL and API key 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

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • username and password are the credentials for the system account that can assume the role to manage the database and administer Snowflake masking and row access policies.

This request updates the configuration to enable query audit in Snowflake.

curl -X 'PUT' \
    'https://www.organization.immuta.com/integrations/{id}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": true,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "audit": {
        "enabled": true,
      },
      "authenticationType": "keyPair",
      "username": "SYSTEM_ACCOUNT",
      "privateKey": "-----BEGIN PRIVATE KEY-----\\n<first line of private key content>\\n<another line of private key content>\\n<another line of private key content>\\n-----END PRIVATE KEY-----"
    }
    }'
  1. Replace the Immuta URL and API key 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

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • username is the system account user that can assume the role to manage the database and administer Snowflake masking and row access policies.
    • privateKey is your private key. Replace new lines in the private key with double backslashes before the new line character: \\n.

Response

The response returns the status of the Snowflake integration configuration. See the response schema reference for details about the response schema.

A successful response includes the validation tests statuses.

{
  "id": "123456789",
  "status": "editing",
  "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"
    }
    ]
  }
}

An unsuccessful request returns the status code and an error message. See the HTTP status codes and error messages for a list of statuses, error messages, and troubleshooting guidance.

{
  "statusCode": 409,
  "error": "Conflict",
  "message": "Unable to edit integration with ID 123456789 in current state editing."
}

Manual update

To manually update the integration, complete the following steps:

  1. Generate the updated Immuta script and run it in your Snowflake environment.
  2. Update the integration in Immuta.

Generate the updated script

  1. Select the tab below that matches your authentication method.
  2. Copy the request example and replace the values with your own as directed to generate the script. The examples provided use JSON format, but the request also accepts YAML.

See the config object description for parameter definitions, value types, and additional configuration options.

This request updates the configuration to enable query audit in Snowflake.

curl -X 'POST' \
    'https://www.organization.immuta.com/integrations/{id}/scripts/edit' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "audit": {
        "enabled": true,
      },
      "workspaces": {
        "enabled": false
      },
      "impersonation": {
        "enabled": false
      },
      "authenticationType": "userPassword",
      "username": "taylor@snowflake.com",
      "password": "abc1234"
    }
    }'
  1. Replace the Immuta URL and API key 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

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • workspaces represents an Immuta project workspace configured for Snowflake. See the object description for child parameters.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • username and password are the credentials for the system account that can assume the role to manage the database and administer Snowflake masking and row access policies.
  4. Run the script returned in the response in your Snowflake environment.

This request updates the configuration to enable query audit in Snowflake.

curl -X 'POST' \
    'https://www.organization.immuta.com/integrations/{id}/scripts/edit' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "audit": {
        "enabled": true,
      },
      "workspaces": {
        "enabled": false
      },
      "impersonation": {
        "enabled": false
      },
      "authenticationType": "keyPair",
      "username": "SYSTEM_ACCOUNT",
      "privateKey": "-----BEGIN PRIVATE KEY-----\\n<first line of private key content>\\n<another line of private key content>\\n<another line of private key content>\\n-----END PRIVATE KEY-----"
    }
    }'
  1. Replace the Immuta URL and API key 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

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • workspaces represents an Immuta project workspace configured for Snowflake. See the object description for child parameters.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • username is the system account user that can assume the role to manage the database and administer Snowflake masking and row access policies.
    • privateKey is your private key. Replace new lines in the private key with double backslashes before the new line character: \\n.
  4. Run the script returned in the response in your Snowflake environment.

This request updates the configuration to disable Snowflake workspaces for the integration.

curl -X 'POST' \
    'https://www.organization.immuta.com/integrations/{id}/scripts/edit' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "impersonation": {
        "enabled": true,
        "role": "IMMUTA_IMPERSONATION"
      },
      "audit": {
        "enabled": true
      },
      "workspaces": {
        "enabled": false
      },
      "authenticationType": "oAuth",
      "oAuthClientConfig": {
        "provider": "Okta",
        "clientId": "123456abc",
        "useCertificate": true,
        "clientSecret": "secret",
        "authorityUrl": "example.authority.com",
        "encodedOauthPublicKey": "zGpLw5/XF3NtInwf+6xKsw==",
        "encodedOauthPrivateKey": "bTzWZVPi3ugPOTkegLq/7w=="
      }
    }
    }'
  1. Replace the Immuta URL and API key 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

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • workspaces represents an Immuta project workspace configured for Snowflake. See the object description for child parameters.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • username is the system account user that can act on Snowflake objects and configure the integration.
    • oAuthClientConfig specifies your provider, client ID, client secret, authority URL, and your encoded public and private keys. See the object description for details about child parameters.
  4. Run the script returned in the response in your Snowflake environment.

Response

The response returns the script for you to run in your environment.

Update the integration in Immuta

  1. Select the tab below that matches your authentication method.
  2. Copy the request example and replace the values with your own as directed to update the integration settings. The examples provided use JSON format, but the request also accepts YAML. The payload you provide must match the one you provided when generating the updated script.

See the config object description for parameter definitions, value types, and additional configuration options.

This request updates the configuration to enable query audit in Snowflake.

curl -X 'PUT' \
    'https://www.organization.immuta.com/integrations/{id}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "audit": {
        "enabled": true,
      },
      "workspaces": {
        "enabled": false
      },
      "impersonation": {
        "enabled": false
      },
      "authenticationType": "userPassword",
      "username": "taylor@snowflake.com",
      "password": "abc1234"
    }
    }'
  1. Replace the Immuta URL and API key with your own.
  2. Replace the {id} request parameter with the unique identifier of the integration you want to update.
  3. Pass the same payload you sent when generating the script, where

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • workspaces represents an Immuta project workspace configured for Snowflake. See the object description for child parameters.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • username and password are the credentials for the system account that can assume the role to manage the database and administer Snowflake masking and row access policies.

This request updates the configuration to enable query audit in Snowflake.

curl -X 'PUT' \
    'https://www.organization.immuta.com/integrations/{id}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "audit": {
        "enabled": true,
      },
      "workspaces": {
        "enabled": false
      },
      "impersonation": {
        "enabled": false
      },
      "authenticationType": "keyPair",
      "username": "SYSTEM_ACCOUNT",
      "privateKey": "-----BEGIN PRIVATE KEY-----\\n<first line of private key content>\\n<another line of private key content>\\n<another line of private key content>\\n-----END PRIVATE KEY-----"
    }
    }'
  1. Replace the Immuta URL and API key with your own.
  2. Replace the {id} request parameter with the unique identifier of the integration you want to update.
  3. Pass the same payload you sent when generating the script, where

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • workspaces represents an Immuta project workspace configured for Snowflake. See the object description for child parameters.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • username is the system account user that can assume the role to manage the database and administer Snowflake masking and row access policies.
    • privateKey is your private key. Replace new lines in the private key with double backslashes before the new line character: \\n.

This request updates the configuration to disable Snowflake workspaces and enable Snowflake query audit for the integration.

curl -X 'PUT' \
    'https://www.organization.immuta.com/integrations/{id}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "type": "Snowflake",
    "autoBootstrap": false,
    "config": {
      "host": "organization.us-east-1.snowflakecomputing.com",
      "warehouse": "SAMPLE_WAREHOUSE",
      "database": "SNOWFLAKE_SAMPLE_DATA",
      "impersonation": {
        "enabled": true,
        "role": "IMMUTA_IMPERSONATION"
      },
      "audit": {
        "enabled": true
      },
      "workspaces": {
        "enabled": false
      },
      "authenticationType": "oAuth",
      "oAuthClientConfig": {
        "provider": "Okta",
        "clientId": "123456abc",
        "useCertificate": true,
        "clientSecret": "secret",
        "authorityUrl": "example.authority.com",
        "encodedOauthPublicKey": "zGpLw5/XF3NtInwf+6xKsw==",
        "oauthPrivateKey": "bTzWZVPi3ugPOTkegLq/7w=="
      }
    }
    }'
  1. Replace the Immuta URL and API key with your own.
  2. Replace the {id} request parameter with the unique identifier of the integration you want to update.
  3. Pass the same payload you sent when generating the script, where

    • host is the URL of your Snowflake account.
    • warehouse is the default pool of Snowflake compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
    • database is the name of a new empty database that the Immuta system user will manage and store metadata in.
    • impersonation specifies whether user impersonation is enabled. See the object description for child parameters.
    • audit specifies whether query audit is enabled for Snowflake. See the object description for child parameters.
    • workspaces specifies whether Immuta project workspaces are enabled for Snowflake. See the object description for details about child parameters.
    • oAuthClientConfig specifies your provider, client ID, client secret, authority URL, and your encoded public and private keys. See the object description for details about child parameters.

Response

The response returns the status of the Snowflake integration configuration. See the response schema reference for details about the response schema.

A successful response includes the validation tests statuses.

{
  "id": "123456789",
  "status": "editing",
  "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"
    }
    ]
  }
}

An unsuccessful request returns the status code and an error message. See the HTTP status codes and error messages for a list of statuses, error messages, and troubleshooting guidance.

{
  "statusCode": 409,
  "error": "Conflict",
  "message": "Unable to edit integration with ID 123456789 in current state editing."
}

Delete an integration

curl -X 'DELETE' \
    'https://www.organization.immuta.com/integrations/{id}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "authenticationType": "userPassword",
    "username": "taylor@snowflake.com",
    "password": "abc1234",
    "role": "ACCOUNTADMIN"
    }'
  1. Copy the request example.
  2. Replace the Immuta URL and API key with your own.
  3. Replace the {id} request parameter with the unique identifier of the integration you want to delete.
  4. If you set

    • autoBootstrap to true when enabling the integration, specify the authenticationType and the credentials you used to configure the integration in the payload, as illustrated in the example. See the Integrations API endpoints guide for details.
    • autoBootstrap to false when enabling the integration,

      1. Use the script cleanup endpoint (for integrations that were not successfully created) or the delete endpoint (for integrations that were successfully created) to generate a script that will remove Immuta-managed resources and policies from your environment.

      2. Make the request above without including a payload to remove the integration from Immuta.

      3. Run the generated script in Snowflake.

Response

The response returns the status of the Snowflake integration configuration that has been deleted. See the response schema reference 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 for a list of statuses, error messages, and troubleshooting guidance.

{
  "id": "123456789",
  "status": "deleting",
  "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"
    }
    ]
  }
}