Integration Configuration Payload
Last updated
Last updated
The parameters for configuring an integration in Immuta are outlined in the table below.
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
The config object configures the S3 integration. The table below outlines its child parameters.
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
The table below outlines the parameters for creating an S3 data source.
The table below outlines the response schema for successful requests.
The config object configures the Azure Synapse Analytics integration. The table below outlines its child parameters.
The impersonation object enables and defines roles for user impersonation for Azure Synapse Analytics. The table below outlines its child parameters.
The credentials you used when configuring your integration are required in the payload when autoBootstrap was set to true
when setting up your integration. For integration configurations with autoBootstrap set to false
, no payload is required when deleting the integration.
The metadataDelimiters object specifies the delimiters that Immuta uses to store profile data in Azure Synapse Analytics. The table below outlines its child parameters.
The config object configures the Databricks Unity Catalog integration. The table below outlines its child parameters.
The additionalWorkspaceConnections array allows you to configure additional workspace connections for your Databricks Unity Catalog integration. The table below outlines its child attributes.
The audit object enables Databricks Unity Catalog query audit. The table below outlines its child parameter.
The groupPattern object excludes the listed group from having data policies applied in the Databricks Unity Catalog integration. This account-level group should be used for privileged users and service accounts that require an unmasked view of data. The table below outlines its child parameters.
The proxyOptions object represents your proxy server configuration in Databricks Unity Catalog. The table below outlines the object's child attributes.
The oAuthClientConfig object represents your OAuth configuration in Databricks Unity Catalog. This object is required if you set oAuthM2M
as your authentication type in the Databricks Unity Catalog integration configuration. The table below outlines the object's child parameters.
The config object configures the Google BigQuery integration. The table below outlines its child parameters.
The config object configures the Redshift integration. The table below outlines its child parameters.
The authentication type and credentials you used when configuring your integration are required in the payload when autoBootstrap was set to true
when setting up your integration. For integration configurations with autoBootstrap set to false
, no payload is required when deleting the integration.
The impersonation object enables and defines roles for user impersonation for Redshift. The table below outlines its child parameters.
The okta object represents your Okta configuration. This object is required if you set okta
as your authentication type in the Redshift integration configuration. The table below outlines its child parameters.
The config object configures the Snowflake integration. The table below outlines its child parameters.
The audit object enables Snowflake query audit. The table below outlines its child parameter.
The authentication type and credentials you used when configuring your integration are required in the payload when autoBootstrap was set to true
when setting up your integration. For integration configurations with autoBootstrap set to false
, no payload is required when deleting the integration.
The impersonation object enables and defines roles for user impersonation for Snowflake. The table below outlines its child parameters.
The lineage object enables Snowflake native lineage ingestion. When this setting is enabled, Immuta automatically applies tags added to a Snowflake table to its descendant data source columns in Immuta so you can build policies using those tags to restrict access to sensitive data. The table below outlines its child parameters.
The oAuthClientConfig object represents your OAuth configuration in Snowflake. This object is required if you set oAuthClientCredentials
as your authentication type in the Snowflake integration configuration, and you must set autoBootstrap to false
. The table below outlines the object's child parameters.
The userRolePattern object excludes roles and users from authorization checks in the Snowflake integration. The table below outlines its child parameter.
The workspaces object represents an Immuta project workspace configured for Snowflake. The table below outlines its child parameters.
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Property | Description |
---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Default values | Accepted values |
---|---|---|---|
Parameter | Description | Required or optional | Accepted values |
---|---|---|---|
Parameter | Description | Default values | Accepted values |
---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Attribute | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Default values | Accepted values |
---|---|---|---|
Parameter | Description | Default values | Accepted values |
---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Required or optional | Accepted values |
---|---|---|---|
Parameter | Description | Default values | Accepted values |
---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Default values | Accepted values |
---|---|---|---|
Parameter | Description | Required or optional | Accepted values |
---|---|---|---|
Parameter | Description | Default values | Accepted values |
---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Default values | Accepted values |
---|---|---|---|
Parameter | Description | Default values | Accepted values |
---|---|---|---|