# User Roles

User roles are essential for managing access within our system. They define each user's responsibilities and privileges, ensuring a secure and well-organized environment.

### Accessing User Roles in the Admin Console

To view and manage user roles:

1. Navigate to the Admin Console.
2. Click on **Groups & Permissions** in the left-hand menu.
3. Select the **User Roles** tab.

### Searching for User Roles

To find specific user roles:

1. On the **User Roles** page, view the roles displayed as cards, with each card representing a specific user role.
2. Use the **Search** box located above the role cards.
3. Enter a relevant keyword related to the user role you're looking for.
4. Click the **Search** button to display matching results.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2F9QjWfPL1ti4oRtl8kSzB%2Fuser%201.png?alt=media&#x26;token=3a700c93-5a79-47d6-ade0-021da81abede" alt=""><figcaption></figcaption></figure>

### Create New Roles&#x20;

1. To create a new user role:
   1. Click the **Create New Role** button.
   2. Fill in the required details as described below.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2FmXPX3lsnzZs5O0y9Id5R%2Fuser%202.png?alt=media&#x26;token=61ef4014-fce2-4271-80f0-3c9df589424d" alt=""><figcaption></figcaption></figure>

### <mark style="color:blue;">User Role Details</mark>&#x20;

To create a new user role:

1. ***Key:*** A unique identifier for each user role. Think of it as a distinctive code that differentiates one role from another within the system.
2. ***Name:*** A user-friendly label for the role. This is how users will easily identify the purpose of the role at a glance.
3. ***Description:*** An optional field to provide additional context about the role. Use this to describe its responsibilities and purpose, similar to a job description.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2F64wstOj8fPeesw0Xk4cL%2Fuser%203.png?alt=media&#x26;token=3ee0d880-af5f-48b4-879d-27c8d9f69abc" alt=""><figcaption></figcaption></figure>

4. Saving the New User Role

After filling in the mandatory fields:

* Review the entered details to ensure accuracy.&#x20;
* Click the **Save** button to create the new role.

#### Editing User Roles&#x20;

1. On the User Roles page, locate the role you want to edit.
2. Locate the role you want to edit and click the **Edit** icon.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2FjrOR44pqSVpkFnP5jkm0%2Fuser%204.png?alt=media&#x26;token=d2f1b25a-7105-4450-89a6-6c975fc0b0f0" alt=""><figcaption></figcaption></figure>

3. This will open the **Edit Role** page, where you can modify the following details:
   * **Key**: Update the unique identifier if needed.
   * **Name**: Change the user-friendly label for the role.
   * **Description**: Adjust or add more context about the role's purpose and responsibilities.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2Ft6t84d1ou5f4m6WRp0XD%2Fuser%205.png?alt=media&#x26;token=e1bb3a65-0a37-4c56-8ef0-2b6c1754541c" alt=""><figcaption></figcaption></figure>

4. Ensure all mandatory fields are completed.
5. Click the **Save** button to apply the changes.

### Delete User Role&#x20;

To delete an existing user role:

1. Open the **Edit Role** page for the role you wish to delete.
2. Locate and click the **Delete** button.
3. A confirmation prompt will appear—review the details carefully.
4. Confirm your decision to permanently delete the role.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2FVZZWbLhGniTG5qbwORGF%2Fuser%206.png?alt=media&#x26;token=3309dac8-cd01-46ed-98b6-98efe3a8fedf" alt=""><figcaption></figcaption></figure>
