Skip to content

You are viewing documentation for Immuta version 2.8.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

User Profile

Audience: All Immuta users

Content Summary: The User Profile page contains personal information about users, including their contact information, SQL account information, API Keys, and pending requests. This page highlights the features of a user's Profile page in the Immuta UI.

User Profile Link Location

User Details

The SQL Credentials tab and the API Key tab display the following information about the user in a pane on the left of the page. With the exception of the HDFS Principal, this information may be edited by the user at any time.

  • Name: The user's full name.
  • Email: The user's email address.
  • Position: The user's current position.
  • About: A short description about the user.
  • Location: The user's work location.
  • Organization: The organization that a user is associated with.
  • Phone Number: The user's phone number.
  • HDFS Principal: An HDFS principal that is linked to the user's Immuta account. Only an admin may set this field. Your HDFS User Principal is used to provide access to Immuta's HDFS Access Pattern. Although you cannot change or remove your HDFS principal (it must be set by an Administrator), you can associate it with a project purpose to access data in HDFS under that purpose.
  • Receive System Notifications as Emails: The user can opt to receive email notifications.

SQL Credentials Tab

In order to connect to the Query Engine using the SQL Access Pattern, each user must create SQL credentials. SQL credentials can be accessed by clicking the SQL Credentials tab in the center pane.

For more information on SQL credentials, see Managing SQL Accounts.

SQL Credentials

API Key Tab

API keys allow for a secure way to communicate with the Immuta REST API without requiring the username and password. Each key can be revoked at any time and new ones generated. Once a key is revoked it can no longer be used to access the REST API, and users will need to authenticate any tool that they were using with the revoked API key with a new key.

Once in the API keys tab, a user can generate API keys or revoke API keys.

An API key can be linked to a project. By linking an API key to a project, you will be limiting that API key's visibility to only data sources associated with that project.

API Keys

Requests Tab

The Requests tab allows users to view and manage all pending access requests directly from their profile page.

Requests Tab