> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reveal User/Role Management

## Overview

*Reveal* manages its own application database.  In addition to storing data
about dashboards and slices, it also manages users, roles, and permissions
for accessing those entities specific to *Reveal*.

<Info>
  By default, user accounts created in the database will automatically
  be created in *Reveal*.  Roles and permissions within *Reveal* need to be
  added afterwards.
</Info>

<a id="security-reveal-authentication" />

## Authentication

User accounts will be kept in sync between *Reveal* and the database, so any
user that can log into the database can log into *Reveal* with the same
credentials.

<a id="security-reveal-users" />

## Users

User accounts allow individual access to users in *Reveal*. Each user is
assigned one or more roles, which determines the areas and features of the
application they can access.

### Creating a New User

Since users are automatically created in *Reveal* when they are created in the
database, users should generally not need to be created within *Reveal* using
the following scheme.

To create a new user, while logged into *Reveal*, click
**Security > List Users** from the top menu bar.

<img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_security-picklistusers.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=8a0a4301d1707cd5bb6880eb9b5f9dcc" alt="../images/reveal_security-picklistusers.png" width="620" height="100" data-path="content/security/images/reveal_security-picklistusers.png" />

<br />

Once on the **List Users** page, click on the **+** button to
access the **Add User** page.

<img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_security_listusers-pickadd.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=5c21c4567e786c93f6dac2fc3e7c3a8d" alt="../images/reveal_security_listusers-pickadd.png" width="620" height="160" data-path="content/security/images/reveal_security_listusers-pickadd.png" />

<br />

At minimum, fill in the required fields with user information and click the
**Save** button. Make sure the **Is Active** field is checked if
the user is to be activated immediately.

<img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_security_adduser.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=ce997a8ab53f45a5762622d08e4a918c" alt="../images/reveal_security_adduser.png" width="620" height="380" data-path="content/security/images/reveal_security_adduser.png" />

Successful user creation should be confirmed, and the new user will be
displayed in the list.

### Editing a User

To edit an existing user, while logged into *Reveal*, click
**Security > List Users** from the top menu bar.  Click the
**Edit** icon on the left side of the user record to edit.  Update the
information and click the **Save** button.

<img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_security_listusers-pickedit.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=0c1b651c7b22fb2c93fb03c022d5d254" alt="../images/reveal_security_listusers-pickedit.png" width="620" height="200" data-path="content/security/images/reveal_security_listusers-pickedit.png" />

### Deleting a User

To delete an existing user, while logged into *Reveal*, click
**Security > List Users** from the top menu bar.  Click the
**Delete** icon on the left side of the user record to delete.
Confirm the deletion to continue.

<img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_security_listusers-pickdelete.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=92237b2c5cedc904961073dcfabf0a07" alt="../images/reveal_security_listusers-pickdelete.png" width="620" height="200" data-path="content/security/images/reveal_security_listusers-pickdelete.png" />

<a id="security-reveal-roles" />

## Roles

Roles make it simple to control access and are used to group users with
similar functional requirements. For example, *Reveal* ships with 3 default
roles: `Admin`, `Designer`, and `Dashboard`. *Admins* have full access
to the system. *Designers* are able to create slices and dashboards. *Dashboard*
users have read-only access to view dashboards.

### Creating a New Role

To create a new role, while logged into *Reveal*, click
**Security > List Roles** from the top menu bar.

<img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_security-picklistroles.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=6f2f28195b6cbe95b973818dd8fe902a" alt="../images/reveal_security-picklistroles.png" width="620" height="170" data-path="content/security/images/reveal_security-picklistroles.png" />

<br />

Once on the **List Roles** page, click on the **+** button to
access the **Add Role** page.

<img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_security_listroles-pickadd.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=40be5d2f200b395dad4873aa44037a4f" alt="../images/reveal_security_listroles-pickadd.png" width="620" height="160" data-path="content/security/images/reveal_security_listroles-pickadd.png" />

<br />

Complete the form by providing a name for the new role and also add all the
desired permissions that should be associated with the role. Then, click the
**Save** button.

<img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_security_addrole.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=41f8d76cbe721dc9cb774901c104370d" alt="../images/reveal_security_addrole.png" width="620" height="210" data-path="content/security/images/reveal_security_addrole.png" />

Successful role creation should be confirmed, and the new role will be
displayed in the list.

### Editing a Role

To edit an existing role, while logged into *Reveal*, click
**Security > List Roles** from the top menu bar.  Click the
**Edit** icon on the left side of the role record to edit.  Update the
information and click the **Save** button.

<img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_security_listroles-pickedit.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=00bd6bbd4e80f0a339e20da15246a426" alt="../images/reveal_security_listroles-pickedit.png" width="620" height="180" data-path="content/security/images/reveal_security_listroles-pickedit.png" />

### Deleting a Role

To delete an existing role, while logged into *Reveal*, click
**Security > List Roles** from the top menu bar.  Click the
**Delete** icon on the left side of the role record to delete. Confirm
the deletion to continue.

<img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_security_listroles-pickdelete.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=d52bf19bcf22dbae6e8d49b13c6bdc1b" alt="../images/reveal_security_listroles-pickdelete.png" width="620" height="180" data-path="content/security/images/reveal_security_listroles-pickdelete.png" />

<a id="security-reveal-permissions" />

## Permissions

Permissions in *Reveal* allow for very fine-grained control over user/role
access to certain screens and features. There are many permissions, and it is
easy to get overwhelmed. It's best to review the default roles that ship with
*Reveal* to review what permissions are associated with each role and get an
idea of what each permission does. There is no need or way to add/edit/delete
permissions themselves, as they are tied to specific application code.

<a id="change-password-reveal" />

## Changing the Administrator Password

To change the administrator account password:

1. Log into [Reveal](/content/bi/reveal)

   1. Enter **Username** (default is `admin`)
   2. Enter **Password** (default is `admin`)
   3. Click **Login**

2. Click the down arrow next to the user icon on the right of the
   top  menu bar, and then click **Profile**.

   <img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_dashboards-pickprofile.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=81a903420be38c7a6bd5b68ac8c1e8aa" alt="../images/reveal_dashboards-pickprofile.png" width="620" height="170" data-path="content/security/images/reveal_dashboards-pickprofile.png" />

3. Next, click the **Reset my password** button

   <img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_profile.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=6e53dd9e66b5d3c0d2339fcd84520da1" alt="../images/reveal_profile.png" width="620" height="340" data-path="content/security/images/reveal_profile.png" />

4. Enter and confirm your new password, then click the **Save** button.

   <img src="https://mintcdn.com/kinetica/47teRgjGtbiLXAyb/content/security/images/reveal_profile_resetpass.png?fit=max&auto=format&n=47teRgjGtbiLXAyb&q=85&s=163fb858e87d1dfbf187bb8a5bb867f1" alt="../images/reveal_profile_resetpass.png" width="620" height="200" data-path="content/security/images/reveal_profile_resetpass.png" />
