Viewer Groups

Viewer Group is a set of people allowed to see a deployment on the GMetri Platform. Every Deployment has a Viewer Group and anyone in an organization can create a Viewer Group. Several types of Viewer Groups can be created.

Create Viewer Groups

To create a viewer group (and to access all your viewer groups and their settings):

  • Click on your avatar, then choose Viewer Groups from the menu.

avatar menu

  • This will redirect you to the Viewer Groups page.

viewer groups page

ℹ️ The Viewer Groups viz. Public, Social and Editor are default Viewer Groups and cannot be removed or renamed.

  • Click on + Viewer Group. This will add a new entry to the Viewer Group section.
  • Upon doing so, you can expand this entry to change its settings.

viewer groups expanded

  • You can choose among the three options available for the viewer groups. How to set them and what they do is explained in the Types of Viewer Groups sub-section below.

Types of Viewer Groups

Viewer Groups can be categorized as follows:

  1. Enterprise
  2. Custom Login Form based Viewer Groups
  3. Token based Viewer Groups

SSO

This option allows you select either google or azure based login for viewers.

When you use this, you have three options:

  • Public - all people with valid (google or azure based on your selection) accounts are allowed to access your deployment.)

  • Filter By domain - all people with valid google or azure based accounts on the domain that you have set are allowed to access your deployment.

  • Filter By viewer list - all accounts google or azure based accounts in your viewer list are allowed to access your deployment.

viewer group enterprise

Custom Login Form

Sometimes you may need a custom login form that requires a login identifier other than an email (eg, phone numbers, special usernames, etc). In such cases, you can simply rename the columns to the desired name and it will show up in the login form.

The second column in the csv is treated as the password field (regardless of what you reaname it to). If it is present the csv, we will authenticate all your users against the provided passwords. If you wish to skip password verification, remove this column from the csv.

A sample CSV containing some users with their names and an arbitrary password will look like:

Sample viewerlist with passwords

A sample CSV containing some users with only their names and no password will look like:

Sample viewerlist with passwords

NOTE: Once the csv has been uploaded , you cannot see the passwords again (for security purposes), so if you wish to change the password of some or all your allowed users, upload a new csv with the updated passwords.

Token

This option allows to generate automatic login tokens to login the viewers. A great way to use this feature is to autogenrate the login tokens via an API and create limited time login links.

To generate a token, create a new viewer group and select the token login method. When you select this, you will be shown a signing key, copy this signing key. This will be used to generate the login tokens.

To generate a login token, we create a JWT token. The payload for the JWT is shown below (the optional fields can be set as per requirement):

{ 
  "identifier" (required): "user-1",
  "first_name" (optional): "amy",
  "last_name" (optional): "richards",
  "phone_num" (optional): "+1 000 000 000"
}

identifier is the unique key by which you will identify your viewers. We recommend using unique identifiers for all your viewers.

Now, create a JWT token out of this, and sign it using the sigining key you copied from the step above. A minimal example of generating a JWT token in node.js is

var jwt = require('jsonwebtoken');
var token = jwt.sign({ 'identifier': 'user-1', 'first_name': 'amy' }, '<YOUR SIGNING KEY>');

Now to create a login link with this token, do the following steps:

  • Goto to your deployment and select the viewer group you created above
  • Copy the deployment link
  • Create a login link of the format

<copied_deployment_link>?token=<your_token_here>

you can now forward this link all the viewers with whom you wish to share the experience.

Apply Viewer Group to a Deployment

To apply a viewer group to a particular deployment, head over to the deployment section.


Last update: