Skip to main content

How to create and assign custom project roles

availability

Custom project roles were introduced in Unleash 4.6 and are only available in Unleash Enterprise.

This guide takes you through how to create and assign custom project roles. Custom project roles allow you to fine-tune access rights and permissions within your projects.

video content

The guides on this page are also available in video format! Does a minute or two of watching someone walk through the steps sound better to you than following steps with static screenshots? If so, check out these video walkthroughs instead 🍿

Creating custom project roles

It takes about three steps to create custom project roles:

  1. Navigate to the custom project roles page by using the admin menu (the gear symbol) and navigating to users. A visual representation of the current step: the Unleash Admin UI with the steps highlighted.
  2. Navigate to the "project roles" tab. The admin/roles screen, with the project roles tab highlighted. The page shows a table of project roles with their descriptions.
  3. Use the "new project role" button to open the role creation form. The visual position of the 'new project role' button on the page.
  4. Give the role a name, an optional description, and the set of permissions you'd like it to have. For a full overview of all the options, consult the custom project roles reference documentation. The project role creation form filled in with details for a "developer" role. To the left is the equivalent cURL command you could run if you wanted to use the API instead of the form.

Assigning custom project roles

Custom project role creation is a pretty straightforward process and requires around three steps, outlined below.

To assign a custom project role to a user:

  1. Navigate to the project you want to assign the user a role in. The steps to navigate to a project: use the 'projects' navigation item and select your project.
  2. Navigate to the project's access page. A project overview with the 'access' tab highlighted.
  3. This step depends on whether the user has already been added to the project or not:
    • If the user has already been added to the project, select the new role you want to give them from the dropdown menu next to their name. A list of users with access to the current project. To the right of each user is a dropdown input labeled role.
    • If the user hasn't been added to the project, add them via the 'add user' form. Select the role you want to give them from the role field. Adding a user to a project. The add user form is filled out with data for an "Alexis". The Role input is open and the custom "Developer" role is highlighted.