Skip to content

You are viewing documentation for Immuta version 2021.5.

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

cancel

Immuta SaaS: Using Your Free Trial

Audience: Free trial users

Content Summary: Your free trial instance of Immuta SaaS allows you to connect your own data to Immuta to share with other users in your organization. This page outlines the end-to-end process of signing up for a free trial, connecting and protecting your data, and sharing your data with other users who can then connect their analytic tools to query the data. Each section contains links to tutorials, videos, or troubleshooting tips.

Your Role

Navigate to the section of this tutorial that corresponds to your role:

Prerequisite: Sign Up for a Free Trial

Navigate to this page to request a free trial. After you've received a response from Immuta and received a URL to create an Immuta Account, continue to the next step.

1 - Create Your Instance of Immuta

After you've set a password for your Immuta Account, you will automatically navigate to the Cloud Portal.

An Organization with This Name Already Exists

This error indicates that there is already a company and organization with this name in Immuta Accounts. Choose one of the options below to resolve the issue:

  • Enter a unique name in the Company textbox.
  • Contact your organization's administrator to get added as a user to an existing free trial.

  1. On the Welcome to Immuta page, click Let's Get Started to create your free trial instance of Immuta. Note: Your instance may take up to five minutes to be created.

    Provision Page

    Your Instance Doesn't Provision

    Your instance may take up to five minutes to create. However, submit a support ticket if you are not prompted to log in to your instance of Immuta after 10 minutes.

  2. Click Log In with Immuta Accounts to navigate to your free trial.

2 - Configure Your Instance

2.1 - Configure a Native Access Pattern

Opt to configure a native access pattern:

  • Databricks Note: The default configuration for native Databricks does not include support for R or Scala in the free trial.
  • Redshift
  • Snowflake

Databricks Language Support and Account Requirements

  • The configuration for native Databricks does not include support for R or Scala.
  • A Premium account for Azure and an Enterprise account for AWS is required, as the Cluster Policies feature is not available in the Standard Databricks offering. You must also have table access controls (table ACLs) enabled in your workspaces.
  • Your Databricks username must match the email address you used when you signed up for the free trial. If your usernames don't match, you can manually map the Databricks username from the Admin page.

2.2 - Add New Users

  1. Click the Admin icon in the left sidebar.
  2. Click the New User button at the top of the page. You will automatically navigate to Immuta Accounts, where you can add single or multiple users.
  3. Select your Time Zone.
  4. Complete the First Name, Last Name, and Email fields for your user.

  5. Select one of the following roles

    • Organization Admin: This role allows the user to manage their organization's users.
    • Organization User: This general user role grants access Immuta resources.

  6. Click Save. The user accounts you created will appear in your Immuta SaaS instance.

Immuta Accounts

3 - Connect Your Data

Databases Running in Closed Networks

If your database runs in a closed network, authorize this IP address in your network firewall configuration to allow Immuta to connect: 54.88.42.98.

Select a tutorial for your specific data provider for instructions on connecting your data to Immuta:

Data Source

Additional tutorials can be found in Chapter 4 of Immuta Documentation.

4 - Protect Your Data

4.1 - Create and Apply Tags

Create and apply tags to your data sources, or verify tags that have been applied correctly to your data by Sensitive Data Discovery. These tags can then be used in policies to protect sensitive data.

Tags

4.2 - Create Groups

Create groups that can be used in Data and Subscription policies to restrict what data users based on which groups they have been assigned.

Group

4.3 - Build Policies

Build Global Policies to protect data sources across your organization. Alternatively, you can write Local Policies to enforce restrictions on single data sources.

Policy

4.4 - Preview Policy-Enforced Data

After you've applied policies to data sources, preview your policy-enforced data in the Query Editor.

Query Editor

5 - Share Your Data

5.1 - Opt to Set Default Permissions

Permissions determine the actions users can take in the Immuta console, such as creating data sources and projects, writing Global Policies, or managing users.

Before adding new users to your free trial, opt to set default permissions for these new users on the App Settings page.

Permissions

5.2 - Add Users to Your Free Trial

  1. Click the Admin icon in the left sidebar.

  2. Click the New User button. You will automatically navigate to Immuta Accounts.

    New User

  3. Enter a First Name, Last Name, Email, and Time Zone for this user.

  4. Select Organization User from the Role dropdown menu in the Manage Organizations section.

    • Organization User: This role allows users to access Immuta resources, such as Documentation, Cloud Portal, and Support.
    • Organization Admin: This role allows the user to manage other users within their organization in Immuta Accounts.

    Role

  5. Save your changes.

  6. Return to the Admin page in your free trial and click Sync IAM Users. The new user will be added to your free trial and can log in through Immuta Accounts.

    Sync

5.3 - Add Entitlements to Users

User entitlements are divided into two categories in Immuta: groups and attributes. After entitlements are added to users, they can be used in policies to restrict access to data.

Opt to add groups and attributes to users from the Admin page.

Entitlements

5.4 - Map External User IDs

External IDs for native integrations can be mapped in to Immuta, allowing you to link an external account to the corresponding Immuta account even when usernames do not match between systems. Users can query policy-enforced data when they log in to Databricks or Snowflake.

Manually map the external user ID on the App Settings page.

External User ID

6 - Subscribe to Data Sources

Data sources are created by Data Owners to expose data stored in an external database or warehouse.

To query policy-enforced data, subscribe to a data source.

Subscribe

7 - Query Data

Query data in your native database.