Getting Started

The integrations API is a REST API that allows you to integrate your remote data platform with Immuta so that Immuta can manage and enforce access controls on your data.

To configure an integration using the API, you must have the APPLICATION_ADMIN Immuta permission.

Configure your integration

Use the POST /integrations endpoint to configure the integration so that Immuta can enforce access controls on tables registered as Immuta data sources. See a section below for a sample request and details about configuring your integration.

Amazon Redshift Spectrum example

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": "Redshift",
    "autoBootstrap": false,
    "config": {
      "host": "organization.aws.amazon.com",
      "database": "immuta",
      "impersonation": {
        "enabled": false
      },
      "authenticationType": "userPassword",
      "username": "taylor@redshift.com",
      "password": "abc1234"
    }
    }'

Replace the values in the request with your Immuta URL and API key or bearer token, and change the config values to your own, where

• host is the URL of your Redshift account.

• database is the name of the that the Immuta system user will manage and store metadata in.

• authenticationType is the type of authentication to use when connecting to Redshift.

• username and password are the credentials for the system account that can act on Redshift objects and configure the integration.

You must manually returned in the response in your Redshift environment yourself before completing the configuration. See the for instructions on completing the setup or for more examples.

For information about the configuration payload, see the .

1. .

2. Copy the request example.

3. Replace the values in the request with your Immuta URL and .

4. Change the config

Replace the values in the request with your Immuta URL and , and change the config values to your own, where

• host is the URL of your Azure Synapse Analytics account.

• schema is the name of the Immuta-managed schema where all your secure views will be created and stored.

• database is the name of an existing database where the Immuta system user will store all Immuta-generated schemas and views.

The example sets autoBootstrap to true, which grants Immuta one-time access to credentials to configure the resources in your Azure Synapse Analytics environment for you. If you set autoBootstrap to false, you must manually in your Azure Synapse Analytics environment yourself before making the request.

For more configuration examples, see the . For information about the configuration payload, see the .

1. by either using the Google Cloud console or the provided Immuta script.

2. Copy the request example. The example uses JSON format, but the request also accepts YAML.

3. Replace the Immuta URL and with your own.

For more configuration examples, see the Configure a . For information about the configuration payload, see the .

Replace the values in the request with your Immuta URL and , and 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.

The example sets autoBootstrap to true, which grants Immuta one-time access to credentials to configure the resources in your Snowflake environment for you. If you set autoBootstrap to false, you must manually in your Snowflake environment yourself before making the request.

For more configuration examples, see the . For information about the configuration payload, see the .

1. Replace the values in the request with your Immuta URL and .

2. Navigate to the Immuta App Settings page and click the Integrations tab.

3. Click your enabled Starburst (Trino) integration and copy the configuration snippet displayed.

Map usernames and create policies before you register your metadata to ensure that policies are enforced on tables and views immediately.

1. to Immuta to ensure Immuta properly enforces policies and audits user queries.

2. Build global policies in Immuta to enforce access controls:

Register your metadata using the API or Immuta UI:

• API how-to guides

See the following how-to guides for configuration examples and steps for creating, managing, or disabling your integration:

See the following reference guides for information about the integrations API endpoints, payloads, and responses: