Skip to content

You are viewing documentation for Immuta version 2023.1.

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

cancel

SQL Account Management

Audience: Data Users

Content Summary: This page outlines how to create your SQL account, view your SQL connection information, update your password, and create SQL connections for projects.

Creating an Immuta User SQL Account

  1. Navigate to your Profile page.
  2. Click on the SQL Credentials tab. Then Create Account.

  3. Fill out the required fields following these guidelines:

    • Usernames must be unique and can only consist of lowercase letters, numbers, and underscores ( _ ).
    • Usernames cannot start with a number and can be no longer than 63 characters.
    • Passwords should not contain braces ( { ).

    Your SQL password will never be displayed in the Immuta console, so be sure to store it in a secure location. 1. Click the Create button at the bottom of the center pane.

Note: Rather than requiring users to enter this user/password for authentication when accessing a data source, System Administrators may force users to use PKI or LDAP authentication.

Viewing SQL Connection Information

  1. Assuming an Immuta SQL Account has already been created, navigate to your Profile page.
  2. Click on the SQL Credentials tab.
  3. Click the dropdown menu button in the top right corner of the page, and then select the Copy to Clipboard button to copy the SQL connection information.

This connection can be used to connect your favorite BI tool to the Immuta database, where all the Immuta Data Sources you’re subscribed to will be available to you as tables.

Updating an Immuta user SQL password

  1. Assuming an Immuta SQL Account has already been created, navigate to your Profile page.
  2. Click on the SQL Credentials tab.
  3. Click the dropdown menu button in the top right corner of the page, and then select the Change Password button.
  4. Change the password and click Save.

Creating Project Based SQL Connections

  1. Navigate to the Project details page.
  2. Click SQL Connection in the right menu under Credentials.
  3. A modal window will display with the requested connection information. Please make sure to store these credentials somewhere secure. If you misplace them, you will have to generate a new account and re-authenticate all services connected to Immuta via this account.
  4. When done, click the Close button.

Project SQL accounts are unique to each project, and only provide access to the data sources in that project. Note that project SQL credentials cannot be retrieved from Immuta if they are lost. Credentials can only be re-generated using the instructions above. When a user generates new SQL credentials for a project, any existing SQL credentials for that project the user may have had are revoked.