Invite Users to the App

White Label Data makes sharing your data easy by allowing you to invite users to your application. This feature is a standard flow that works as follows:

  1. As an administrator, you can invite others to the app using the Invite Form.
  2. You choose the Persona (page set and attributes) that you want the user to have when they use the app. For example, you can segment into different groups that each see different pages or data within visualizations. See Personas.
  3. The user receives an automated email with a one-time link to connect to the app.
  4. When the users clicks the link, they are asked to set their password.
  5. The user now has login credentials to your application with the Persona information you selected when you invited them.

Understanding Your Admin Account

A user account will be created for you by Hashpath that has ‘admin’ privileges in White Label Data. This account can be used to invite additional users to the app. Separately, you may be invited to become an administrator for the Auth0 tenant associated with your account.

Note: Your Auth0 tenant account is different from your White Label Data admin account. Your White Label Data admin account is an account that can both login to your White Label Data app instance and invite new users. Your Auth0 tenant account can be used to login to the Auth0 management portal to perform advanced user operations.

Inviting a User

There is a special URL in your app for inviting new users. Navigate to the /invite URL within your app’s domain to see the Invite Form.

The invite form has the following standard options:

Option Description
First Name The first name of the user you are inviting.
Last Name The last name of the user you are inviting.
Email The email address of the user you are inviting. This is the email address that the invitation email and one-time link will be sent to.
Group IDs (optional) A list of Looker group IDs that the embed user should have when making connections to Looker. Used only for Looker iFrame embedding.
Page Set The White Label Data page set to assign to the user. See Personas.

Customizing the Invite Form with Attributes

It is often useful to add additional attributes to further segment your users. These attributes cannot be changed by users and are stored securely in Auth0. Therefore, they can be used to segment data by adding them to WHERE clauses of your SQL queries. For example, you may want to segment users by ‘partner name’.

Attributes are added to the invite form by specifying the following in appconfig.json. Note that invite_parameters is a JSON array that can hold multiple, comma-separated dictionaries of invite parameters:

"invite_parameters": [
        {
            "label": "Customer ID",
            "id" : "customer_id",
            "input_type": "text",
            "max_length" : 100,
            "default_value" : "Enter Customer ID"
        },
        {
            "label": "Partner Name",
            "id" : "partner_name",
            "input_type": "text",
            "max_length" : 100,
            "default_value" : "Enter Partner Name"
        }
    ]
Option Example Description
label "Customer ID" The label of the parameter in the Invite form.
id "customer_id" A unique identifer for the attribute. Must not contain spaces. The id becomes the key that is used to store the custom attribute in Auth0 and is the attribute name that can be referenced in SQL queries (see Personas).
input_type "text" Specifies the type of input. Currently the only option is text.
max_length 100 The length of the input field in the form for this attribute.
default_value "Enter Customer ID" The initial value of the form input.