Skip to main content
Interania

Admin Guide: Manage user roles

0votes
9updates
41views

This document demonstrates how to create Interana user accounts, assign and manage user roles, and includes the following topics:

Interana user roles

You can create user accounts with the Interana CLI, and then assign user roles. A user role establishes the level of access and permissions allowed for the user. Interana currently supports the following user roles:

  • user — Log in and use Interana.
  • publisher — Perform Interana administrative tasks, along with the ability to publish named expressions.
  • admin — Manage and maintain Interana, including user accounts and data ingest. The majority of CLI commands require admin role.

Creating user accounts with the CLI

When you create a user account, you must specify a username and password. For security purposes, the password used to create the account is visible in the bash history. For this reason, it's important to advise the user to change their password when they first log into their account. This section covers the following topics:

CLI command: ia user create

To create a new user account with login credentials, use the ia user create command. 

ia user create <username> <password> [--no-email] [--base-url <base_url>]

The following table explains the command options.

<username> Defines the username for a new user account.
<password> Sets the initial login password for a new user account.
Optional arguments  
--no-email Specifies that email confirmation is not required from the user to be able to login and use their account.
--base-url <base_url> Specifies the hostname used to construct the link in the confirmation email for the user to click to confirm their account. 

Creating a user with email authorization

You can create user accounts that require the user to click a link in a confirmation email to activate their account. To specify email authorization for a user account, use the --base-url option.

We strongly recommend that you specify a fully qualified domain name (FQDN) with the --base-url option. If the--base-url option is not set, it defaults to the public IP of the first API node, which may not be user-friendly.

For example, --base-url example.interana.com produces a confirmation URL similar to:
 https://example.interana.com/api/con...e=BLAHBLAHBLAH

To create a user account with email authorization, do the following:

  1. Open a Terminal window and log in to the Interana config node.
  2. Enter the following command, substituting the variables with values that apply to the account.
ia user create <username> <password> --base-url <FQDN>

The following example creates user example@interana.com with an initial password of interanaRuleZ, and sets the --base-url to the FQDN example.interana.com

ia user create example@interana.com interanaRuleZ --base-url example.interana.com

User, example@interana.com, successfully created.
  1. Now you can continue with assigning a user role.

Creating a user without email authorization

You can create a user account that does not require email authorization by the user to access their account. To specify that a user account does not need email authorization, use the --no-email option. 

To create a user account without email authorization, do the following:

  1. Open a Terminal window and log in to the Interana config node.
  2. Enter the following command, substituting the variables with values that apply to the account.
ia user create <username> <password> --no-email

The following example creates user example@interana.com with an initial password of interanaRuleZ, and specifies that email confirmation is not required to gain access to the account.

ia user create example@interana.com interanaRuleZ --no-email

User, example@interana.com, successfully created.
  1. Now you can continue with assigning a user role.

Assigning user roles

You can assign and remove user roles for specified accounts with theia user update command.

To add and remove user roles, do the following:

  1. Open a Terminal window and log in to the Interana config node.
  2. To assign a role to a user account use the following command, substituting the variables for the values for the account.
ia user update <username> [--add-role <role>] 

The following example adds the publisher role to user dashboard@interana.com.

ia user update dashboard@interana.com --add-role publisher

Successfully added dashboard@interana.com to publisher role.
  1. To remove a role from a user account use the following command, substituting the variables for the values for the account. 
ia user update <username> [--add-role <role>] [--remove-role <role>]

The following example removes the admin role from user funnel@interana.com.

ia user update funnel@interana.com --remove-role admin

Successfully removed funnel@interana.com from admin role.

What's Next

For more information on managing Interana users with the CLI, see the Interana CLI Reference.

  • Was this article helpful?