Click the Identities in the navigation menu and select Users.
Click the New User button.
Fill out the Full Name and Email fields in the dialog. Note: The user's email address will be used as the username and must be unique.
Click the Create button.
Click Identities in the navigation menu and select Users.
Select the user you want to edit and select the Settings tab.
Click Add Permissions.
Click the Select Permission dropdown, and select the permission you want to give the user.
Click Identities in the navigation menu and select Users.
Select the user you want to disable, and click the more actions icon.
Select Disable User.
Click Disable in the confirmation dialog.
Requirement: USER_ADMIN permission
Note: This action permanently deletes all data associated with this user from Immuta, including data source subscriptions, and a timestamp of this event will be captured in the audit logs. The ability to create governance reports against this user will no longer be possible. This action cannot be undone.
Click Identities in the navigation menu and select Users.
Select the user you want to disable, and click the more actions icon.
Select Permanently Delete.
Click Permanently Delete User in the confirmation dialog.
Prerequisite:
Click Identities in the navigation menu and select Users.
Click the more actions icon and select Migrate User.
Enter their username in the modal that appears and click Migrate User.
Click Identities in the navigation menu and select Users.
Select the user you want to edit and select the Settings tab.
Click Remove on the permission you want to remove.
Click Identities in the navigation menu and select Users.
Click the Metrics button.
Complete the Number of Days field in the dialog that appears, and then click Download to download the JSON file.
Once an account has been disabled, it will not appear in the list of current Immuta users. To show the disabled accounts,
Click Identities in the navigation menu and select Users.
Use Filters to filter the table to Include Accounts and check the Disabled box.
Type Delete to confirm deleting the user permanently.
Click the Confirm Permanent Delete button.
Immuta can consume user attributes from an external HTTP endpoint in an out-of-band fashion. This feature allows you to retrieve users' groups and authorizations from an additional resource, alongside the user attributes retrieved in the authentication flow. Such an external endpoint can be configured on any of the Identity Provider types that Immuta supports.
The following section instructs how to implement the HTTP service.
The service can authenticate requests with both or either of the following methods:
Basic username and password Authorization header
SSL cert validation
For more information, refer to .
Note: Immuta will expect non 200 error codes when the user info cannot be retrieved.
The user info endpoint will be called each time Immuta needs to synchronize with a remote IAM on user groups and authorizations. Immuta will query the endpoint with the user ID specified in request's query.
Note: The endpoint's path does not necessarily have to be /user-info.
Parameters
Responses
Response Schema
Below is an example value that could be returned by the endpoint:
Click the App Settings icon in the navigation menu.
If you are modifying an existing IAM, click the name of the IAM. If you are creating a new IAM, click Add IAM.
Check the External Groups and Authorizations Endpoint checkbox.
In the External User Info URI field, enter the full path to your customer HTTP endpoint.
Click Identities in the navigation menu and select Groups.
Click the New Group button.
In the modal, enter the new group's name. You can opt to enter a description of and email address for the new group.
Click Save.
Click Identities in the navigation menu and select Groups.
Select the group you want to edit and select the Settings tab.
Click the Add Members button.
Begin typing in the Search by Member Name or Email text box.
Click Identities in the navigation menu and select Groups.
Select the group you want to edit and select the Settings tab.
Click Add Attributes.
Begin typing the attribute name in the Attribute text box.
Click Identities in the navigation menu and select Groups.
Select the group you want to edit and select the Settings tab.
In the members section, click Remove in the Action column for the member you want to remove.
Click Delete
Click Identities in the navigation menu and select Groups.
Select the group you want to edit.
Click the more actions icon, and select Delete.
Click Delete to confirm.
Click Identities in the navigation menu and select Users or Groups.
Select the user or group you want to edit and select the Settings tab.
In the Attributes section, click the more actions icon on the attribute value you want to remove.
Click on the name from the dropdown list to add this user to the group.
If the attribute already exists, select it from the dropdown list.
If the attribute does not exist yet, enter the full name of the attribute, and then select it from the dropdown.
In the Attribute Value text box, enter a value.
If the value already exists, select it from the dropdown list.
If the value does not exist, enter the full name, and then select it from the dropdown.
Click Close.
Optionally, check the Use Authentication checkbox and provide the username and password with which Immuta should authenticate when querying the user info endpoint. Immuta will subsequently send requests to the service with a Basic authorization header.
Optionally, enable SSL by checking the Enable SSL checkbox.
Optionally, if SSL is enabled, check the Require SSL Request Cert if your service requires SSL certificate validation. This step will require that you upload three files:
The SSL key file (*.pem)
The SSL cert file (*.pem)
The SSL CA file (*.pem)
userid
query
The unique user identifier (username in Immuta)
Yes
string
200
successful operation - user info retrieved successfully
groups
[{"name": "<group_name>"}]
authorizations
{"<authorization_name>": ["<value>"]}
{
"groups": [{
"name": "Accountants",
}, {
"name": "Controllers",
}],
"authorizations": {
"EMEA": ["Sales", "Expenses"],
"APAC": ["Sales"]
}
}External IDs for integrations can be mapped in based on attributes from an external IAM system, allowing you to link an external account to the corresponding Immuta account even when usernames do not match between Immuta and the external system.
External IDs for integrations can be mapped in based on attributes from an external IAM system.
Click the App Settings icon in the navigation menu and click
Select your IAM and scroll to the Profile Schema section.
Ensure that usernames in your data platform align with usernames in an external IAM and that those accounts align with an IAM attribute. Then, enter the IAM attribute in the field that corresponds to your data platform:
User's Databricks Username
User's Snowflake Username
User's Trino Username
User's Azure Synapse Analytics Username
User's Redshift Username
User's AWS User. After entering the IAM attribute in the User's AWS User field, click the Select AWS User Type from the dropdown and select one of the types below. This is used by the Amazon S3 Integration to map users in Immuta to the corresponding user type in AWS.
None (fallback to Immuta username): When selecting this option, the AWS username is assumed to be the same as the Immuta username.
: Only a single Immuta user can be mapped to an IAM role. This restriction prohibits enforcing policies on AWS users who could assume that role. Therefore, if using role principals, create a new user in Immuta that represents the role so that the role then has the permissions applied specifically to it.
User's PostgreSQL Username
User's Teradata Username
Click Test Connection, and then click Test User Login.
Click Save.
For IAMs where no mapping has been defined (including Immuta's built-in IAM), the external user ID mappings can be set manually.
Click Identities in the navigation menu and select Users.
Select the user you want to edit.
In the Usernames section, click Edit for the technology username you want to change.
Complete the Username field in the modal that appears and click Save.
For Databricks usernames,
Select Databricks Username to map the Databricks username to the Immuta user and enter the Databricks username in the field. Username mapping for Databricks is case insensitive.
Select Unset (fallback to Immuta username) to use the Immuta username as the assumed Databricks username. Use this option if the user's Databricks username exactly matches the user's Immuta username. Username mapping for Databricks is case insensitive.
For S3 usernames, use the dropdown menu to select the User Type. Then complete the S3 field. User and role names are case-sensitive. See the for details.
: Only a single Immuta user can be mapped to an IAM role. This restriction prohibits enforcing policies on AWS users who could assume that role. Therefore, if using role principals, create a new user in Immuta that represents the role so that the role then has the permissions applied specifically to it.
All external IDs are displayed on the user details page and their user profile.
AWS Identity Center user IDs: You must use the numeric User ID value found in AWS IAM Identity Center, not the user's email address.
User ID value found in AWS IAM Identity Center, not the user's email address.Unset (fallback to Immuta username): When selecting this option, the S3 username is assumed to be the same as the Immuta username.
Impersonation allows users to query data as another Immuta user. If you don't see instructions for enabling impersonation for your integration on this page, the integration does not support it. See the Integrations overview page to view a list of integrations and the Immuta features they support.
Select Enable Impersonation when configuring the Redshift integration on the .
After enabling user impersonation with your Amazon Redshift integration, there are two ways to give a user permission to use the feature: in the Immuta UI or in Amazon Redshift. Use the tabs below to select one method.
As an Immuta user with the permission USER_ADMIN,
Click Identities in the navigation menu and select Users.
Select the user you want to edit and select the Settings tab.
Click Add Permissions.
To impersonate another user in Redshift,
Run the following in Redshift: CALL immuta_procedures.impersonate_user(<Immuta username of the user to impersonate>).
Run queries.
To end user impersonation in Redshift, run CALL immuta_procedures.impersonate_user(<NULL>).
There are two ways to revoke permission to impersonate users: in the Immuta UI or in Amazon Redshift. Use the tabs below to select one method.
As an Immuta user with the permission USER_ADMIN,
Click Identities in the navigation menu and select Users.
Select the user you want to edit and select the Settings tab.
Click Remove for the IMPERSONATE_USER permission.
User impersonation is specific to the script and session in which it was set. Using a new script or running a subset of script queries without setting the context will result in the queries being run as the regular user.
Select Enable Impersonation when configuring the Synapse Analytics integration on the .
After enabling user impersonation with your Azure Synapse Analytics integration, there are two ways to give a user permission to use the feature: in the Immuta UI or in Azure Synapse Analytics. Use the tabs below to select one method.
As an Immuta user with the permission USER_ADMIN,
Click Identities in the navigation menu and select Users.
Select the user you want to edit and select the Settings tab.
Click Add Permissions.
To impersonate another user in Synapse,
Run the following command:
Run queries.
To end user impersonation in Synapse, run EXEC sys.sp_set_session_context @key = N'NULL', @value = '<NULL>'.
There are two ways to revoke permission to impersonate users: in the Immuta UI or in Azure Synapse Analytics. Use the tabs below to select one method.
As an Immuta user with the permission USER_ADMIN,
Click Identities in the navigation menu and select Users.
Select the user you want to edit and select the Settings tab.
Click Remove for the IMPERSONATE_USER permission.
User impersonation is specific to the script and session in which it was set. Opening a new script will revert the user back to themselves.
Databricks user impersonation allows a Databricks user to impersonate an Immuta user. With this feature,
the Immuta user who is being impersonated does not have to have a Databricks account, but they must have an Immuta account.
the Databricks user who is impersonating an Immuta user does not have to be associated with Immuta. For example, this could be a service account.
When acting under impersonation, the Databricks user loses their privileged access, so they can only access the tables the Immuta user has access to and only perform DDL commands when that user is acting under an allowed circumstance (such as workspaces, scratch paths, or non-Immuta reads/writes).
In the , add a comma-separated list of Databricks users who are allowed to impersonate Immuta users for the IMMUTA_SPARK_DATABRICKS_ALLOWED_IMPERSONATION_USERS Spark environment variable.
Once the cluster is configured with a list of Databricks users who are allowed to impersonate Immuta users, run the following SQL command to set the user you want to impersonate:
This command generates an API token for the specified user that queries Immuta for metadata pertinent to that user. When generating the token, the impersonated username is matched with the corresponding IAM user. The IAM used by default is the built-in IAM in Immuta, but can be set using the .
Run queries as the impersonated Immuta user:
Once impersonation is active, any query issued in the session will have the appropriate data and subscription policies applied for the impersonated user.
Audited queries include an impersonationUser field, which identifies the Databricks user impersonating the Immuta user:
To end user impersonation for the session, run
The only way to enable this feature is through cluster configuration. The IMPERSONATE_USER permission in Immuta will not allow a user to perform impersonation in Databricks.
User impersonation is automatically enabled with your Starburst (Trino) integration, but the authenticated user must be given the IMPERSONATE_USER permission in Immuta or match the Starburst (Trino) .
To grant the user IMPERSONATE_USER permission, as an Immuta user with the permission USER_ADMIN,
Click Identities in the navigation menu and select Users.
Select the user you want to edit and select the Settings tab.
Click Add Permissions.
Click the Select Permission dropdown, and select the IMPERSONATE_USER
The Starburst (Trino) integration supports the native Starburst or Trino impersonation approaches:
JDBC method: In your JDBC connection driver properties, set the sessionUser property to the Immuta user you want to impersonate. See the for details.
Trino CLI method: Set the --session-user property to specify the session user as the Immuta user you want to impersonate when invoking the . See the for details.
To view the user you are impersonating, run SHOW SESSION like 'immuta.immuta_user'.
To end user impersonation, run RESET SESSION immuta.immuta_user.
To revoke permission to impersonate users, as an Immuta user with the permission USER_ADMIN,
Click Identities in the navigation menu and select Users.
Select the user you want to edit and select the Settings tab.
Click Remove for the IMPERSONATE_USER permission.
The user's permissions to impersonate users are not checked until the query is run. If the user does not have the IMPERSONATE_USER permission in Immuta, they will be able to run the command to impersonate a role, but will not be able to query as that role.
Select Enable Impersonation when configuring the Snowflake integration on the .
After enabling user impersonation with your Snowflake integration, there are two ways to give a user permission to use the feature: in the Immuta UI or in Snowflake. Use the tabs below to select one method.
As an Immuta user with the permission USER_ADMIN,
Click Identities in the navigation menu and select Users.
Select the user you want to edit and select the Settings tab.
Click Add Permissions.
To impersonate another user in Snowflake,
Open a New Worksheet and set your role to the impersonation role specific to your organization.
Run SET immuta_user = '<<Immuta username of the user to impersonate>>'.
Run queries within that worksheet.
There are two ways to revoke permission to impersonate users: in the Immuta UI or in Snowflake. Use the tabs below to select one method.
As an Immuta user with the permission USER_ADMIN,
Click Identities in the navigation menu and select Users.
Select the user you want to edit and select the Settings tab.
Click Remove for the IMPERSONATE_USER permission.
Impersonation is specific to the workspace and session in which it was set. Opening a new worksheet will revert the user back to themselves.
Snowflake auditing will show the user running the queries as the user logged in to Snowflake not as the user they are impersonating.
Impersonation is not supported in Snowflake if or is enabled.
Click the Select Permission dropdown, and select the IMPERSONATE_USER permission.
As a Redshift superuser,
Navigate to your Redshift instance.
Run ALTER GROUP <Impersonation Group> ADD USER <Redshift User>.
As a Redshift superuser,
Navigate to your Redshift instance.
Run the following in Redshift: ALTER GROUP <Impersonation Group> DROP USER <Redshift User>
Click the Select Permission dropdown, and select the IMPERSONATE_USER permission.
As a Synapse user,
Navigate to your Synapse instance.
Run the following in Synapse: EXEC sp_addrolemember N'<Impersonation Role>', N'<Synapse User>'
As a Synapse user,
Navigate to your Synapse.
Run the following in Synapse: EXEC sp_droprolemember N'<Impersonation Role>', N'<Synapse User>'
Click the Select Permission dropdown, and select the IMPERSONATE_USER permission.
As a Snowflake user with the ACCOUNTADMIN role,
Navigate to your Snowflake instance.
In a worksheet run GRANT ROLE <<Impersonation_Role>> TO USER "<<Snowflake User>>".
In this example, the Impersonation Role is the name entered on the Immuta App Settings page when the feature was enabled. The default is IMMUTA_IMPERSONATION, but the admin may have customized it. The Snowflake User is the username of the Snowflake user that will now have permission to impersonate other users.
As a Snowflake user with the ACCOUNTADMIN role,
Navigate to your Snowflake instance.
In a worksheet run the following: REVOKE ROLE <<Impersonation Role>> FROM USER "<<Snowflake User>>"
In this example, the Impersonation Role is the name entered on the Immuta App Settings page when the feature was enabled. The default is IMMUTA_IMPERSONATION, but the admin may have customized it. The Snowflake User is the username of the Snowflake user that will now have permission to impersonate other users.
EXEC sys.sp_set_session_context @key = N'immuta_user',
@value = '<Synapse username linked to the Immuta user you want to impersonate>';"spark_env_vars.IMMUTA_SPARK_DATABRICKS_ALLOWED_IMPERSONATION_USERS": {
"type": "fixed",
"value": "[email protected],[email protected]"
}%sql
set [email protected]%sql
set [email protected]
select * from demo.hr_data limit 10;{
"id": "query-a20e-493e-id-c1ada0a23a26",
"dateTime": "1639684812845",
"month": 1463,
"profileId": 4,
"userId": "[email protected]",
"dataSourceId": 1,
"dataSourceName": "Hr Data",
"count": 1,
"recordType": "spark",
"success": true,
"component": "dataSource",
"accessType": "query",
"query": "Relation[id#2644,first_name#2645,last_name#2646,email#2647,gender#2648,race#2649,ssn#2650,dept#2651,job#2652,skills#2653,salary#2654,type#2655] parquet\n",
"extra": {
"databricksWorkspaceID": "0",
"maskedColumns": {},
"metastoreTables": [
"demo.hr_data"
],
"clusterName": "your-cluster-name",
"pathUris": [
"dbfs:/user/hive/warehouse/demo.db/hr_data"
],
"queryText": "select * from demo.hr_data limit 10;",
"queryLanguage": "sql",
"clusterID": "your-171358-cluster-id",
"impersonationUser": "[email protected]"
},
"dataSourceTableName": "demo_hr_data",
"createdAt": "2021-12-16T20:00:12.850Z",
"updatedAt": "2021-12-16T20:00:12.850Z"
}%sql
set immuta.impersonate.user=