Skip to content
Last updated

Configure roles and permissions

Roles are named groupings of permissions that control what actions employees can perform across Peach portals. Assign roles to employees to grant access to features like viewing loan information, processing payments, or managing other employees. Users can have multiple roles, and permissions are additive — if any of a user's roles includes a permission, the user has that permission.

Availability: All clients Required permissions: role:list, role:read (to view); role:create (to add); role:update (to edit permissions); role:delete (to remove). To see the Add role button on the list page, your user must hold all four of role:read, role:create, role:update, and role:delete together.

View roles

From the Admin Portal sidebar, select Roles (beta toggle: under the Workforce group). The roles list displays all roles for your company.

ColumnDescription
IDThe Peach-assigned role identifier (RL-XXXX-XXXX). Select to open the role detail page.
NameThe role alias (display name).

Use the search bar to filter roles by name or ID.

Add a role

  1. From the Roles list, select Add role.
  2. Enter an Alias for the role (the display name employees will see).
  3. Optionally select Employees to assign this role to immediately after creation.
  4. In the permissions list, search for and select the permissions you want to grant. Use Select all to grant all permissions.
  5. Select Add to create the role.

The new role takes effect immediately for any assigned employees.

Clone a role

To create a new role based on an existing one:

  1. From a role's detail page, select Clone.
  2. The add role form opens with all permissions from the source role pre-selected.
  3. Update the alias and adjust permissions as needed.
  4. Select Add to create the cloned role.

Edit a role

  1. From the role's detail page, select Edit.
  2. Use the search bar in the permissions section to find specific permissions.
  3. Select or clear permissions as needed. Use Select all to grant all permissions at once.
  4. Select Save to apply changes.

Warning: Editing a role's permissions takes effect immediately for all employees assigned to that role. Review changes carefully before saving.

Note: You can only grant permissions that your own user account already has. This prevents permission escalation — you can't give others more access than you have.

Note: The role alias can only be set at creation time and cannot be changed afterward.

Delete a role

  1. From a role's detail page, select Delete.
  2. In the confirmation dialog, select Yes to confirm.

Warning: Deleting a role immediately revokes all associated permissions from every employee assigned to that role. Ensure employees have alternative roles before deleting.

Role fields

FieldDescriptionRequiredValues / Format
AliasThe display name for the role, visible when assigning roles to employees.YesText, up to 100 characters
EmployeesEmployees to assign this role to during creation.NoMulti-select (add role form only)
PermissionsThe set of actions this role grants. Permissions use the format resource:action (e.g., team:create, loan:read).NoCheckbox list with search

The following fields are read-only:

FieldDescription
Role IDThe Peach-assigned identifier for the role.
Created atThe date and time the role was created.
Updated atThe date and time the role was last modified.