Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Data API reference guide
This section details the /data
v1 API, which allows users to register a to Immuta with a single set of credentials rather than configuring an integration and creating data sources separately.
Required Immuta permission: CREATE_DATA_SOURCE
You can register a connection from the following technologies to Immuta using supported authentication methods:
Username and password
Key pair
Snowflake OAuth
Databricks Unity Catalog
To register a connection, you must follow this process:
Run the /integrations/scripts/create
endpoint to receive a script.
Run the script in your remote technology, either Snowflake or Databricks Unity Catalog.
Run the /data/connection
endpoint to finish registering your connection in Immuta.
This feature is being gradually rolled out to customers and may not be available to your account yet.
The connection API is a REST API which allows users to register a to Immuta with a single set of credentials rather than configuring an integration and creating data sources separately. Then Immuta can manage and enforce access controls on your data through that connection.
These guides provide step-by-step instructions for registering and managing your connection.
Register a connection:
Connection registration payloads: This guide defines body parameters for Snowflake and Databricks Unity Catalog connections.
Data API reference guide
To deregister a connection from Immuta, do the following:
POST
/integrations/{id}/scripts/delete
Creates a script to remove Immuta-managed resources from your data platform.
Required Immuta permission: APPLICATION_ADMIN
id integer
Yes
The response returns the script that you will run in your Databricks Unity Catalog or Snowflake environment. Copy it for later.
DELETE
/data/object/{connectionKey}
Delete the given connection and all its child objects.
Required Immuta permission: Infrastructure Admin on the connection
connectionKey string
The key to uniquely identify the connection. This is the same as the display name of the connection in the Immuta UI.
Yes
connectionKey string
The key to uniquely identify the connection.
childCount integer
The number of child objects of the data object that were deleted.
Using the copied generated cleanup script from earlier, run it in your Snowflake or Databricks Unity Catalog environment as a privileged user.
The script will remove any objects that were initially created during the Register a connection process.
The integration ID. Use the endpoint to list all your integrations and their IDs.