# User Management

## User Role

ObX WebUI component offers several options for grouping users. Each level has different tools for managing user accounts and different tasks that they can perform.

One of the most important user management tasks is assigning roles, which govern what permissions a user has. The correct permissions ensure that users have access to only the resources they need.

* **Admin** - Can Add/Remove permissions and can Add/Edit/Delete a dashboards.
* **Editor** - can Add/Edit/Delete a dashboards.
* **View** - can only view a dashboard.

## Teams

Teams are groups of users within the same organization. Teams allow you to grant permissions for a group of users. They are most often used to manage permissions for folders and dashboards.

## Users

Users are named accounts in ObX WebUI with granted permissions to access resources throughout ObX. All users can manage their own accounts to a limited extent.

### Users can:

* View and Edit Profile
* Change their own Password

## Adding Users

Users could have different access permissions on specific WebUI Dashboards, they can be either:

* Admin - Can Add/Remove permissions and can Add/Edit/Delete a dashboards.
* Editor - can Add/Edit/Delete a dashboards.
* View - can only view a dashboard.

{% hint style="info" %}
When you added new user, the default role of the newly added user is View.
{% endhint %}

There are two (2) ways of creating a User in the ObX WebUI.

### Using the ObX Admin Tool

1. Open the ObX Admin Tool
2. From left bar menu, Go to -> Organizations -> Name of Organization -> Users
3. Right-click on the Users -> Add User. This will open the Add user window.
4.  Fill all required fields (with \*):

    `Name*` - the name of the user\
    `Email` - the email of the user\
    `Username*` - the username of the user (this is the username use to login to WebUI)\
    `Password*` - the password of the user (this is the password use to loging to WebUI)\
    `Confirm*` - for confirming password
5. &#x20;Click `Add` button.

<figure><img src="https://1616126851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk102NjXt3SLqrvAU01VG%2Fuploads%2F8bEfNcy5bYQCxrzGvcN2%2FAdding%20user%20via%20Admin%20tool.gif?alt=media&#x26;token=540b44e8-6eb6-476b-aa27-ef29f189299e" alt=""><figcaption><p>Adding user via Admin Tool</p></figcaption></figure>

### Using WebUI Invite

{% hint style="warning" %}
You should be an Admin user and the computer hosting the WebUI component has an internet connection to invite a user.
{% endhint %}

1. Access the ObX Web UI as discussed [here]().
2. Login your Admin credentials.
3. From the left bar menu, Hover your mouse to `Configuration` :gear: -> `Users`
4. This will open all existing users in the WebUI, click on the `Invite` button.
5.  In Invite window, fill the following:

    `Email or Username` - the email of the user, this is where the invite will be sent.\
    `Name` - the name of the user.\
    `Role` - select what will be the role of this user.\
    `Send invite email` - make sure to toggle this ON.
6. Click `Submit`

{% hint style="success" %}
The steps above will send an email invitation to a person specified in the email address. The user should accept the invitation within 24 hours or it will be revoked.
{% endhint %}

{% hint style="warning" %}
Make sure you have properly configured the Domain of the WebUI component as discussed [here](../../installation/installation#setting-domain-for-webui-components) before inviting a user. Failed to do so, the invitation will fail.
{% endhint %}

<figure><img src="https://1616126851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk102NjXt3SLqrvAU01VG%2Fuploads%2FEPgSzHfZCYZ5oaJIMv1f%2FAdding%20user%20via%20Invite.gif?alt=media&#x26;token=0175b254-3192-452a-8b45-60448e848f09" alt=""><figcaption><p>Adding user via WebUI Invite</p></figcaption></figure>

## Changing User Role

Users could have different access permissions on specific WebUI Dashboards, they can be either:

* Admin - Can Add/Remove permissions and can Add/Edit/Delete a dashboards.
* Editor - can Add/Edit/Delete a dashboards.
* View - can only view a dashboard.

There are two(2) ways for changing the user's role:

### Using ObX Admin Tool

1. Open ObX Admin Tool
2. From left bar menu, Go to -> Organizations -> Name of Organization -> Users
3. Select the username you want to change its role.
4. From Info Tab, change the Role based on your preferred role.
5. Click the button Change Role. A successful message confirming the action is completed.

<figure><img src="https://1616126851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk102NjXt3SLqrvAU01VG%2Fuploads%2FfFRakoUSQ41v4i7VfIF9%2FChanging%20role%20via%20Admin%20tool.gif?alt=media&#x26;token=7fd384b8-32ce-408e-ae29-037e39c5d33a" alt=""><figcaption><p>Changing User role via Admin Tool</p></figcaption></figure>

### Using  WebUI

1. Access the ObX Web UI as discussed [here]().
2. Login your Admin credentials.
3. From the left bar menu, Hover your mouse to `Configuration` :gear: -> `Users`
4. This will open all existing users in the WebUI. From the list, under column Role, select the role you want to for the specific user.
5. A confirmation message confirming the action is completed.

<figure><img src="https://1616126851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk102NjXt3SLqrvAU01VG%2Fuploads%2FoK3CfX3phtalddesqF6E%2FChanging%20role%20via%20WebUI.gif?alt=media&#x26;token=2dba22fb-020f-47fd-9e1e-4497d215b60a" alt=""><figcaption><p>Changing User role via WebUI</p></figcaption></figure>

## Deleting User

There are two(2) ways of deleting a user(s):

### Using ObX Admin Tool

1. Open ObX Admin Tool.
2. From left bar menu, Go to -> Organizations -> Name of Organization -> Users.
3. Select the username you want to delete.
4. Right-click and Select -> `Delete User`
5. A confirmation dialog to delete the user. Just clik `OK`.

<figure><img src="https://1616126851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk102NjXt3SLqrvAU01VG%2Fuploads%2FmR6FEWI8hNle6WJVwI0z%2FDeleting%20user%20via%20Admin%20tool.gif?alt=media&#x26;token=294883d8-6055-4cfc-986c-266b4804f114" alt=""><figcaption><p>Deleting User using Admin Tool</p></figcaption></figure>

### Using WebUI

1. Access the ObX Web UI as discussed [here]().
2. Login with your Admin credentials.
3. From the left bar menu, Hover your mouse to `Configuration` :gear: -> `Users`
4. This will open all existing users in the WebUI. From the list, in the outer right corner, Click on :x: button.
5. A confirmation to delete the user will pop-out, click the `Delete` button.

<figure><img src="https://1616126851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk102NjXt3SLqrvAU01VG%2Fuploads%2FJOABtbTA2c0oH395HfaJ%2FDeleting%20user%20via%20WebUI.gif?alt=media&#x26;token=176480c7-6346-4f42-86f7-c6f8b93f699b" alt=""><figcaption><p>Deleting a User via WebUI</p></figcaption></figure>

## Adding Teams

In addition to granting Dashboard permissions on a per-user basis, you can also allocate permissions based on user teams. This means that all users belonging to a particular team will automatically inherit the permissions assigned to that team.

1. Access the ObX Web UI as discussed [here]().
2. Login your Admin credentials.
3. From the left bar menu, Hover your mouse to `Configuration` :gear: -> `Teams`
4. This will open all existing Teams in the WebUI (if there are).&#x20;
5. Click the button `New Team`.
6.  Fill the required fields:

    `Name` - the name of the Team. e.g. _`Maintenance team`_\
    `Email` (optional) - email for the team
7. Click the `Create` button.
8. Once done, it will open you the window for new Team created. From here, you can also add member/user for the team.&#x20;

{% hint style="info" %}
By default, the admin user who created the team will be automatically part/member of the Team created.
{% endhint %}

<figure><img src="https://1616126851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk102NjXt3SLqrvAU01VG%2Fuploads%2F47f0MaKSlJolyfUj4TB7%2FAdding%20Team.gif?alt=media&#x26;token=12c0679a-3904-44e1-9abf-6d7062f587ee" alt=""><figcaption><p>Adding Team</p></figcaption></figure>

### Adding Users / Members to the Team

1. Access the ObX Web UI as discussed [here]().
2. Login your Admin credentials.
3. From the left bar menu, Hover your mouse to `Configuration` :gear: -> `Teams`
4. This will open all existing Teams in the WebUI (if there are). &#x20;
5. From the list, click on the name of Team you want to add some members. This will open the window for that team and the list of members / users of that team.
6. Click on the `Add Member` button.
7. From the selection, choose -> User
8. Search for the user you want to add, and then select it.
9. From the selection, you can set wether this user will be a `Member` or an `Admin`.
10. Click `Save` button.
11. You'll see from the list of members/users the newly added user.

<figure><img src="https://1616126851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk102NjXt3SLqrvAU01VG%2Fuploads%2FAIaPx2VRth3INZiyEYIE%2FAdding%20User%20to%20a%20Team.gif?alt=media&#x26;token=f3dee697-bc47-4db5-ad42-205a57a82c6d" alt=""><figcaption><p>Adding User / Member to a Team</p></figcaption></figure>

### Deleting Users / Members to the Team

1. Access the ObX Web UI as discussed [here]().
2. Login your Admin credentials.
3. From the left bar menu, Hover your mouse to `Configuration` :gear: -> `Teams`
4. This will open all existing Teams in the WebUI (if there are). &#x20;
5. From the list, click on the name of Team you want to delete some members. This will open the window for that team and the list of members / users of that team.
6. From the list of Users / Members, on the outer right Click on :x: button.&#x20;
7. A confirmation message that the user is removed in the Team.

<figure><img src="https://1616126851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk102NjXt3SLqrvAU01VG%2Fuploads%2Fs5coH9X8MPgwPK7a3bPP%2FDeleting%20User%20to%20a%20Team.gif?alt=media&#x26;token=52561f67-ec77-4f8a-83fc-d18eeef7503b" alt=""><figcaption><p>Deleting a User / Member to the Team</p></figcaption></figure>

### Changing Users / Members permission of the Team

1. Access the ObX Web UI as discussed [here]().
2. Login your Admin credentials.
3. From the left bar menu, Hover your mouse to `Configuration` :gear: -> `Teams`
4. This will open all existing Teams in the WebUI (if there are). &#x20;
5. From the list, click on the name of Team you want to edit some members. This will open the window for that team and the list of members / users of that team.
6. From the list of Users / Members, in the column `Permissions`, select appropriate permission for the specific user.
7. A confirmation message that the user is updated in the Team.

<figure><img src="https://1616126851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk102NjXt3SLqrvAU01VG%2Fuploads%2Fk2sLTOdE709OapI6p2Yv%2FChanging%20user%20role%20on%20a%20Team.gif?alt=media&#x26;token=39361ae2-d790-4468-b47b-376a3823e2bf" alt=""><figcaption><p>Changing User's permission on a Team</p></figcaption></figure>

## Deleting a Team

1. Access the ObX Web UI as discussed [here]().
2. Login your Admin credentials.
3. From the left bar menu, Hover your mouse to `Configuration` :gear: -> `Teams`
4. From the list of Team, on the outer right, Click on :x: button.
5. Click on `Delete` button.
6. A confirmation message that team is deleted.

<figure><img src="https://1616126851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk102NjXt3SLqrvAU01VG%2Fuploads%2FoxmID7a16AFUvvAaoNXB%2FDeleting%20a%20Team.gif?alt=media&#x26;token=0c3cb93f-4ce7-4e0a-a24b-ff6485398417" alt=""><figcaption><p>Deleting a Team</p></figcaption></figure>

{% hint style="info" %}
Deleting a Team **doesn't** mean that the users / members under it will also be deleted. All users under a team will be retained and should be deleted individually if needed.
{% endhint %}

