Role Definitions centralize reusable authorization roles within the current tenant scope. These roles let customers apply consistent permission sets instead of managing permissions individually for each user.
Important Notes
-
Roles are evaluated within company and business unit scope.
-
System roles are baseline platform roles and are read-only in the page.
-
Custom roles are intended for customer-managed setup.
-
Permission changes should be reviewed carefully before they are used in production access assignments.
-
Roles are assigned in the Users page.
View the Existing Roles
Use the roles list to review the current setup before adding or changing roles.
-
In Settings, select Role Definitions.
-
Scroll down to the list of existing roles to review the following:
-
Name: The display name of the role.
-
Key: The internal role key.
-
Type: Whether the role is System or Custom.
-
Status: Whether the role is Active or Inactive.
-
Create a New Custom Role
Create a custom role when your company needs a reusable permission set that is not already provided by a system role.
To create a custom role:
-
In Settings, select Role Definitions.
-
In the Create Role area, complete the following fields.
-
Role Key (Required): Enter the internal key for the role, such as dispatch.manager. The role key is the internal identifier used for the role definition.
-
Role Name (Required): Enter the display name, such as Dispatch Manager.
-
Description (Optional): Enter a short explanation of what the role is intended for.
-
-
Review the normalized role key shown on the page.
-
Select Create role.
Edit a Custom Role
Update a custom role when the role name, description, or active status needs to change.
System roles cannot be edited. If a role is marked Read-only, it is a system role.
To edit a custom role:
-
In Settings, click Role Definitions.
-
Select the custom role from the list.
-
In the Edit Role area, review the saved key.
-
Update the editable fields.
-
Role Name (Required): Keep the display name clear and current.
-
Description (Optional): Update the explanation if the role purpose changes.
-
Active (Optional): Turn the role on or off for future use.
-
-
Click Save.
The role key is displayed for reference and is not edited in the Edit Role section.
Assign Permissions to a Role
Permissions determine what the role grants to users who receive that role.
To assign permissions to a role:
-
Select a custom role from the list.
-
Go to the Permissions area.
-
Review permissions grouped by resource.
-
Select the checkboxes for the permissions the role should grant.
-
Review the selected count.
-
Select Save Permissions.