User Roles¶
New in version 8.0.
User Roles are a flexible way to identify a user’s responsibilities and position in an organization, and help craft policy and automation rules.
Administrators can create roles and assign them to any number of licensed users. These can be used when configuring integrations or writing custom approval hooks. They’ll optionally appear as badges alongside the user throughout the UI.
User Roles requires a Review Board subscription
It’s included in a Review Board Plus or Enterprise subscription, and with a legacy Power Pack license.
Adding User Roles¶
Roles are managed through the Administration UI. To manage roles, click the User Roles entry in the Manage section of the sidebar. This is also accessible through the Database button in the Review Board Power Pack entry in Administration UI -> Extensions.
A role has the following fields:
Role name
The display name of the role as it will appear in the UI.
Slug identifier
A unique identifier for the role used in integrations and approval hooks. This must be in slug format (lowercase letters, digits, and hyphens only).
Show badges
When enabled, a badge displaying the role will appear alongside the user throughout certain parts of the UI. See Displaying Badges for details.
Assigned users
The list of users who belong to this role. Only users assigned to your license may be assigned to a role. A user may have multiple roles.
Once the fields are filled in, click Save to create or update the role.
Displaying Badges¶
When Show badges is enabled for a role, a badge displaying the role’s name will appear next to the user in review discussions and other places throughout the website. This makes it easy to identify the responsibilities of participants at a glance.
If a role is only needed for policy enforcement or integration conditions and you do not want a visible badge, uncheck Show badges when creating or editing the role.
Using Roles in Integrations¶
Once roles are defined, they can be referenced as conditions when setting up integrations. The following conditions are available:
Owner’s user role
Matches based on the role assigned to the user who posted the review request.
Participant’s user role
Matches based on the role assigned to any participant in the review (anyone who has posted a review or is a targeted reviewer).
For example, you can trigger a Slack notification whenever a QA Tester publishes a review.
Using Roles in Approval Hooks¶
Roles can be used for enforcing role-based approval policies, such as requiring a Ship It! from a Team Lead before a change can land. See the approval hook documentation for a full example.