Register a Snowflake Connection
Last updated
Was this helpful?
Last updated
Was this helpful?
The connection API is a REST API which allows users to register a Snowflake 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. To manage your connection, see the .
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
Complete the following steps to register a Snowflake connection:
Use the /integrations/scripts/create
endpoint to receive a script.
Run the script in Snowflake.
Use the /data/connection
endpoint to finish registering your connection in Immuta.
POST
/integrations/scripts/create
Using the example request, update the <placeholder_values>
with your connection details.
Copy the config
object to use later in the setup process.
Run the request.
Copy the returned script and use it in the next step.
Payload parameters
config.host string
The URL of your Snowflake account.
Yes
config.warehouse string
The default pool of compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
Yes
config.database string
Name of a new empty database that the Immuta system user will manage and store metadata in.
Yes
config.username string
The new username of the system account that can act on Snowflake objects and register the connection. The system account will be created by the script in step two.
Yes
config.password string
The password of the system account that can act on Snowflake objects and register the connection. The system account will be created by the script in step two.
Yes
config.audit object
This object enables Snowflake query audit.
No
config.audit.enabled boolean
If true
, Snowflake query audit is enabled. Set to true
for the recommended configuration.
No
config.workspaces object
This object represents an Immuta project workspace configured for Snowflake.
No
config.workspaces.enabled boolean
If true
, Snowflake project workspaces are enabled. If you use Snowflake table grants, set to false
because table grants and project workspaces cannot be used together. Set to false
for the recommended configuration.
No
config.impersonation object
This object enables user impersonation.
No
config.impersonation.enabled boolean
If true
, user impersonation is enabled. If you use Snowflake low row access policy mode, set to false
because that mode and impersonation cannot be used together.
No
config.lineage object
This object enables Snowflake lineage ingestion.
No
config.lineage.enabled boolean
If true
, Snowflake lineage is enabled. Set false
for the recommended configuration.
No
config.userRolePattern object
This object excludes roles and users from authorization checks.
No
config.userRolePattern.exclude array
This array is a list of roles and users (both case-sensitive) to exclude from authorization checks. Wildcards are unsupported. The roles and users will not have policies applied to them when querying Immuta protected Snowflake tables.
No
POST
/data/connection
Using the tabs below, copy the request and update the <placeholder_values>
with your connection details. The connection
details here should match the ones used when generating the script, and the payload from the script generation should be pasted exactly into nativeIntegration
. Then submit the request.
Payload parameters
connectionKey string
A unique name for the connection.
Yes
connection object
Configuration attributes that should match the values used when getting the script from the integration endpoint.
Yes
connection.hostname string
The URL of your Snowflake account. This should be the same as nativeIntegration.config.host
.
Yes
connection.port integer
The port to use when registering your Snowflake connection. Defaults to 443
.
Yes
connection.warehouse string
The default pool of compute resources the Immuta system user will use to run queries and perform other Snowflake operations.
Yes
connection.role string
The privileged Snowflake role used by the Immuta system account when registering the Snowflake connection. At minimum, it must be able to see the data that Immuta will govern.
Yes
connection.username string
The username of the system account that can act on Snowflake objects and register the connection.
Yes
connection.password string
The password of the system account that can act on Snowflake objects and register the connection.
Yes
settings array
Specifications of the connection's settings, including status.
No
settings.isActive boolean
When false
, data objects will be inactive (disabled) by default when created in Immuta. Set to false
for the recommended configuration.
No
options.forceRecursiveCrawl boolean
If false
, only active (enabled) objects will be crawled. If true
, both active (enabled) and inactive (disabled) data objects will be crawled; any child objects from inactive (disabled) objects will be set as inactive (disabled). Set to true
for the recommended configuration.
No
nativeIntegration object
Yes
objectPath string
The list of names that uniquely identify the path to a data object in the remote platform's hierarchy. The first element will be the associated connectionKey
.
bulkId string
A bulk ID that can be used to search for the status of background jobs triggered by this request.
Example response
Find descriptions of the editable attributes in the table below and of the full payload in the .
Using your generated script, run it in your Snowflake environment as a user with the permissions listed in .
The script will create an Immuta system user that will authenticate using the credentials you specified in the script generation. This new system user will have the permissions listed . Additionally, the script will create the database you specified in the earlier step.
Find descriptions of the editable attributes in the table below and of the full payload in the . The recommended setting values are included in the example.
Configuration attributes that should match the values used when getting the script from the integration endpoint. See the for descriptions.