# Roles

<figure><img src="/files/FyzRlze9Yf8mhYm2e5yl" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
Role Management in **Autom Mate** allows administrators to define and control user access by configuring menu visibility in the left navigation pane. This feature ensures that users only see relevant sections based on their assigned roles.

#### **Key Highlights of Initial Release**

* **Graphical Interface Control:** Role Management initially enables **menu visibility management** in the **left navigation pane**.
* **Customizable Menu Visibility:** Administrators can define which menus and menu items are **visible** based on assigned roles.
* **Future Enhancements:** **Role-based content access control** will be introduced in upcoming releases to enhance permission granularity.
* **Role-Based Usage Examples:**\
  ✔ **If View access is granted** to the **Dashboard menu**, all dashboards will be visible.\
  ❌ **If View access is disabled**, the Dashboard menu will be completely hidden.\
  ✔ **If Read access is enabled** for the **Automs menu**, all Automs will be visible.
  {% endhint %}

{% hint style="danger" %}
⚠ **Note:** Currently, Role Management applies only to the left navigation pane. **More advanced role-based access control features** will be introduced in future updates.
{% endhint %}

The **Role Management** page in **Autom Mate** enables administrators to create, manage, and configure user roles. Roles determine access levels, defining which features and data users can access within the platform. Proper role management ensures security and structured access control.

**Key Functionalities:**

* **Role Listing:** View all available roles in a structured table.
* **Role Creation:** Define new roles with specific permission sets.
* **Role Editing:** Modify existing roles, including their name, description, and permissions.
* **Role Deletion:** Remove a role permanently (single or bulk deletion).
* **Search Functionality:** Locate specific roles using the search bar.
* **Bulk Selection & Deletion:** Select multiple roles for mass deletion using checkboxes.

***

## **Role Table and UI Elements**

| Column Name            | Description                                                            |
| ---------------------- | ---------------------------------------------------------------------- |
| **Role Name**          | Displays the name of the role (e.g., Administrator, Operator, Viewer). |
| **Description**        | A short explanation of the role’s purpose.                             |
| **Permissions**        | Displays assigned permissions (View, Create, Delete, etc.).            |
| **Actions**            | Options to **edit** or **delete** the role.                            |
| **Selection Checkbox** | Allows users to select multiple roles for bulk deletion.               |

{% hint style="info" %}
The **Search Bar** helps quickly find a role by filtering results dynamically as you type.

The **"Select All" Checkbox** allows administrators to select all roles at once for bulk deletion.
{% endhint %}

***

### **Creating a New Role**

1. Click the **"Create Role"** button.
2. Enter a **Role Name** (must be unique).
3. Add a **Description** (optional but recommended).
4. Click **"Create"** to save the role.
5. The new role appears in the **Role Table**.
6. Click **"Configure Role"** to set permissions

{% hint style="danger" %}
**Warning**

* Role names must be **unique** and cannot be duplicated.
* Once created, a role **cannot be assigned permissions immediately**—you must configure them separately.
  {% endhint %}

***

### **Editing an Existing Role**

1. Locate the role in the **Role Table**.
2. Click the **"Edit"** button under the **Actions** column.
3. Modify the **Role Name** and **Description** as needed.
4. Click **"Update Role"** to save changes.

{% hint style="info" %}
Editing a role **does not affect current users** with that role unless permission changes are made.
{% endhint %}

***

### **Deleting Roles**

{% tabs %}
{% tab title="Single Role Deletion" %}
{% hint style="danger" %}
Deleting a role is a **permanent** action. Ensure that the role is not assigned to active users before deleting.
{% endhint %}

1. Locate the role in the **Role Table**.
2. Click the **"Delete"** button under the **Actions** column.
3. A confirmation dialog appears, prompting you to confirm.
4. Click **"DELETE"** to permanently remove the role, or **"Cancel"** to abort.
   {% endtab %}

{% tab title="Bulk Role Deletion" %}
{% hint style="info" %}
Ensure that **no users are assigned** to the roles being deleted.
{% endhint %}

1. Select multiple roles by checking the boxes next to each role.
2. To select all roles at once, use the **"Select All"** checkbox.
3. Click the **"Delete Selected"** button.
4. A confirmation dialog appears to prevent accidental deletion.
5. Click **"DELETE"** to confirm bulk deletion, or **"Cancel"** to abort.
   {% endtab %}
   {% endtabs %}

***

## **Configuring Role Permissions**

After creating a role, permissions must be assigned to define what the role can access. The following table outlines available permissions:

### **Dashboard Permissions**

| Feature        | Permission Options           |
| -------------- | ---------------------------- |
| **Alerts**     | View, Delete                 |
| **Archives**   | View                         |
| **Dashboard**  | View, Create, Update, Delete |
| **Monitoring** | View                         |

***

### **Management Permissions**

| Feature              | Sub-feature                    | Permission Options           |
| -------------------- | ------------------------------ | ---------------------------- |
| **Alert Management** |                                | False, True                  |
|                      | **Actioneer Profile**          | View, Create, Update, Delete |
|                      | **Alert Profile**              | View, Create, Update, Delete |
| **Queue Pool**       |                                | View, Create, Update, Delete |
| **User Management**  |                                | False, True                  |
|                      | **Roles**                      | View, Create, Update, Delete |
|                      | **User**                       | View, Create, Update, Delete |
| **Vault**            |                                | True, False                  |
|                      | **Application Credentials**    | View, Create, Update, Delete |
|                      | **Custom Credentials**         | View, Create, Update, Delete |
| **Webhook & API**    |                                | True, False                  |
|                      | **Webhook & API Trigger Rule** | View, Create, Update, Delete |

***

### **My Environment Permissions**

| Feature    | Sub-feature         | Permission Options                                    |
| ---------- | ------------------- | ----------------------------------------------------- |
| **Automs** |                     | False, True                                           |
|            | **Autom Builder**   | View, Create, Update, Delete, Publish, Import, Export |
|            | **Autom Groups**    | View, Create, Update, Delete                          |
|            | **Diagram Builder** | View, Update                                          |
|            | **BI Estimator**    | View, Update                                          |
|            | **Libraries**       | View, Create, Update, Delete, Publish                 |
|            | **My Mates**        | View, Update, Delete, Download                        |

***

### **Settings Permissions**

| Feature                        | Sub-feature | Permission Options |
| ------------------------------ | ----------- | ------------------ |
| **API Key Management**         |             | View, Update       |
| **License Management**         |             | View, Update       |
| **Log Retention Management**   |             | View, Update       |
| **Mail Server Management**     |             | View, Update       |
| **Personalization Management** |             | View, Update       |
| **Port & SSL Management**      |             | True, False        |
|                                | **Port**    | View, Update       |
|                                | **SSL**     | View, Update       |

***

### **Store Permissions**

| Feature           | Permission Options |
| ----------------- | ------------------ |
| **Autom Store**   | View, Download     |
| **Library Store** | View               |

{% hint style="danger" %}

* Users **must have** at least one permission assigned for the role to be useful.
* Removing all permissions from a role **disables** it effectively.
  {% endhint %}

***

### **Important Considerations**

🔹 **Roles must have unique names.**\
🔹 **Permissions define access levels.** Assign them carefully.\
🔹 **Deleted roles cannot be recovered.** Ensure they are no longer in use before deletion.\
🔹 **Role-based access changes take effect immediately.**

{% hint style="info" %}
It is recommended to test new roles with **limited access first** before assigning them to multiple users.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.autommate.com/userguide/product-features/management/user-management/roles.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.