Roles

Manage roles and permissions to control access to the application

Page Overview

What the page is for

The Roles page allows you to create and manage roles, which are collections of permissions. Roles control what users can do in the application.

When a user would use it

  • When you want to create a new role
  • When you need to edit an existing role
  • When you want to delete a role
  • When you need to manage permissions for a role
  • When you want to view all available roles

How to Access This Page

  1. Log in to the application
  2. From the main dashboard, use the sidebar navigation to click on "Roles"
  3. Or, directly navigate to /roles in your browser

Permissions or prerequisites

  • You must be logged in to access this page
  • You need administrator, super admin, or role manager permissions to manage roles
  • The "Add Role" button will be disabled if you don't have the required permissions

Page Layout

Header / title

  • Title: "Roles"
  • Subtitle: "Manage your roles"
  • Primary button: "Add Role" (disabled if no permission)

Role Table

Shows a list of roles with details.


Step-by-Step Tasks

Creating a New Role

  1. Click the "Add Role" button
  2. Fill in the role details in the dialog
  3. (Optional) Assign permissions to the role
  4. Save the role
  5. The new role will appear in the table

Editing a Role

  1. Find the role in the table
  2. Click the edit action
  3. Update the role's details
  4. Save your changes

Deleting a Role

  1. Find the role you want to delete
  2. Click the delete action
  3. Confirm the deletion in the dialog
  4. The role will be removed

Managing Role Permissions

  1. Find the role
  2. Click the manage permissions action
  3. Add or remove permissions as needed
  4. Save your changes

Field & Button Reference

Field/ButtonWhat it doesWhen to use it
Add RoleOpens the create role dialogWhen you want to create a new role

Tips & Notes

  • Roles control access: Permissions define what users can do
  • Start with existing roles: Use existing roles as templates before creating new ones
  • Be careful with deletion: Deleting a role may affect users assigned to it
  • Use descriptive names: Give roles clear names that reflect their purpose