Host Connection Payloads Reference Guide
Snowflake host payload
Attribute | Description | Accepted values |
---|---|---|
connectionKey | A unique name for the host connection. | |
connection.technology | The technology backing the new host. |
|
connection.hostname | The URL of your Snowflake account. This is the same as | |
connection.port | The port to use when connecting to your Snowflake account host. Defaults to | |
connection.warehouse | The default pool of compute resources the Immuta system user will use to run queries and perform other Snowflake operations. | |
connection.role | The privileged Snowflake role used by the Immuta system account when configuring the Snowflake host. It must be able to see the data that Immuta will govern. | |
connection.authenticationType | The authentication type to connect to the host. Make sure this auth type is the same used when requesting the script. |
|
connection.username | The username of the system account that can act on Snowflake objects and configure the host. Required if using | |
connection.password | The password of the system account that can act on Snowflake objects and configure the host. Required if using | |
connection.privateKeyPassword | The Snowflake private key password. Required if using | |
connection.privateKey.keyName | The Immuta-given name of your private key. Required if using | This must be |
connection.privateKey.userFilename | The name of the private key file on your machine. Required if using | |
connection.privateKey.content | The private key. Replace new lines in the private key with a backslash before the new line character: "\n". If you are using another means of configuration, such as a Python script, the "\n" should not be added. Required if using | |
connection.oAuthClientConfig.useCertificate | Specifies whether or not to use a certificate and private key for authenticating with OAuth. Required if using |
|
connection.oAuthClientConfig.clientId | The client identifier of your registered application. Required if using | |
connection.oAuthClientConfig.authorityUrl | Authority URL of your identity provider. Required if using | |
connection.oAuthClientConfig.scope | The scope limits the operations and roles allowed in Snowflake by the access token. Required if using | This must be |
connection.oAuthClientConfig.resource | An optional resource to pass to the token provider. | |
connection.oAuthClientConfig.publicCertificateThumbprint | Your certificate thumbprint. Required if using | |
connection.oAuthClientConfig.oauthPrivateKey.keyName | The Immuta-given name of your private key. Required if using | This must be |
connection.oAuthClientConfig.oauthPrivateKey.userFilename | The name of your private key file on your machine. Required if using | |
connection.oAuthClientConfig.oauthPrivateKey.content | The private key. Replace new lines in the private key with a backslash before the new line character: "\n". If you are using another means of configuration, such as a Python script, the "\n" should not be added. Required if using | |
connection.oAuthClientConfig.clientSecret | Client secret of the application. Required if using | |
settings.isActive | When | |
options.forceRecursiveCrawl | When | |
nativeIntegration | Configuration attributes that should match the values used when getting the script from the integration endpoint. | |
nativeIntegration.type | The type of technology. |
|
nativeIntegration.autoBootstrap | When | This must be |
nativeIntegration.config.authenticationType | The authentication type to connect to the host. Make sure this auth type is the same used when requesting the script. |
|
nativeIntegration.config.username | The username of the system account that can act on Snowflake objects and configure the host. Required if using | |
nativeIntegration.config.password | The password of the system account that can act on Snowflake objects and configure the host. Required if using | |
nativeIntegration.config.privateKeyPassword | The Snowflake private key password. Required if using | |
nativeIntegration.config.keyName | The Immuta-given name of your private key. Required if using | This must be |
nativeIntegration.config.userFilename | The name of the private key file on your machine. Required if using | |
nativeIntegration.config.content | The private key. Replace new lines in the private key with a backslash before the new line character: "\n". If you are using another means of configuration, such as a Python script, the "\n" should not be added. Required if using | |
nativeIntegration.config.oAuthClientConfig.useCertificate | Specifies whether or not to use a certificate and private key for authenticating with OAuth. Required if using | |
nativeIntegration.config.oAuthClientConfig.clientId | The client identifier of your registered application. Required if using | |
nativeIntegration.config.oAuthClientConfig.authorityUrl | Authority URL of your identity provider. Required if using | |
nativeIntegration.config.oAuthClientConfig.scope | The scope limits the operations and roles allowed in Snowflake by the access token. Required if using | This must be |
nativeIntegration.config.oAuthClientConfig.resource | An optional resource to pass to the token provider. | |
nativeIntegration.config.oAuthClientConfig.oauthPrivateKey.keyName | The Immuta-given name of your private key. Required if using | This must be |
nativeIntegration.config.oAuthClientConfig.oauthPrivateKey.userFiles | The name of your private key file on your machine. Required if using | |
nativeIntegration.config.oAuthClientConfig.oauthPrivateKey.content | The private key. Replace new lines in the private key with a backslash before the new line character: "\n". If you are using another means of configuration, such as a Python script, the "\n" should not be added. Required if using | |
connection.oAuthClientConfig.clientSecret | Client secret of the application. Required if using | |
nativeIntegration.config.host | The URL of your Snowflake account. | |
nativeIntegration.config.port | The port to use when connecting to your Snowflake account host. Defaults to | |
nativeIntegration.config.warehouse | The default pool of compute resources the Immuta system user will use to run queries and perform other Snowflake operations. | |
nativeIntegration.config.database | Name of a new empty database that the Immuta system user will manage and store metadata in. | |
nativeIntegration.config.impersonation | Enables user impersonation. User impersonation is not currently supported with this connection. | This must be |
nativeIntegration.config.audit | This object enables Snowflake query audit. | This must be |
nativeIntegration.config.workspaces | This object represents an Immuta project workspace configured for Snowflake. Project workspaces are not currently supported with this connection. | This must be |
nativeIntegration.config.lineage | Enables Snowflake lineage ingestion so that Immuta can apply tags added to Snowflake tables to their descendant data source columns. Lineage is not currently supported with this connection. | This must be |
nativeIntegration.config.userRolePattern | This object excludes roles and users from authorization checks. Excluded roles and users are not currently supported with this connection. | This must be |
Databricks Unity Catalog host payload
Attribute | Description | Accepted values |
---|---|---|
connectionKey | A unique name for the host connection. | |
connection.technology | The technology backing the new host. |
|
connection.hostname | Your Databricks workspace URL. This is the same as | |
connection.port | The port to use when connecting to your Databricks account host. Defaults to | |
connection.httpPath | The HTTP path of your Databricks cluster or SQL warehouse. | |
connection.authenticationType | The authentication type to connect to the host. Make sure this auth type is the same used when requesting the script. |
|
connection.token | The Databricks personal access token for the service principal created for Immuta. | |
settings.isActive | When | This must be |
options.forceRecursiveCrawl | When | This must be |
nativeIntegration | Configuration attributes that should match the values used when getting the script from the integration endpoint. | |
nativeIntegration.type | The type of technology. |
|
nativeIntegration.autoBootstrap | When | This must be |
nativeIntegration.unityCatalog | When | This must be |
nativeIntegration.config.authenticationType | The authentication type to connect to the host. Make sure this auth type is the same used when requesting the script. |
|
nativeIntegration.config.token | The Databricks personal access token for the service principal created for Immuta. | |
nativeIntegration.config.host | Your Databricks workspace URL. This is the same as | |
nativeIntegration.config.port | The port to use when connecting to your Databricks account host. Defaults to | |
nativeIntegration.config.httpPath | The HTTP path of your Databricks cluster or SQL warehouse. | |
nativeIntegration.config.catalog | 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. | |
nativeIntegration.config.audit | This object enables Snowflake query audit. | This must be |
nativeIntegration.config.enableNativeQueryParsing | If | This must be |
nativeIntegration.config.jobConfig.workspaceDirectoryPath | The file path of the workspace directory. | This must be |
nativeIntegration.config.jobConfig.jobClusterId | The ID of the job cluster. | This must be |
Last updated