mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
c6af38b12b
https://linear.app/unleash/issue/2-1130/documentation-about-multiple-project-roles - Adds a section for the feature in the "Role-based Access control" reference doc; - Removes the mention that "Groups that *do* have a root role can't be assigned to a project." which is no longer true; - Adds a reference to multiple project roles in the "How to create and assign custom project roles" guide; - Fixes a wrong sentence in the "Assigning custom project roles" section of the aforementioned guide; --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
55 lines
3.7 KiB
Markdown
55 lines
3.7 KiB
Markdown
---
|
|
title: How to create and assign custom project roles
|
|
---
|
|
|
|
import VideoContent from '@site/src/components/VideoContent.jsx'
|
|
|
|
:::info 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](#creating-custom-project-roles "how to create custom project roles") and [assign](#assigning-custom-project-roles "how to assign custom project roles") [custom project roles](../reference/rbac.md#custom-project-roles). Custom project roles allow you to fine-tune access rights and permissions within your projects.
|
|
|
|
<VideoContent videoUrls={["https://www.youtube.com/embed/2BlckVMHxgE" , "https://www.youtube.com/embed/IqaD8iGxkwk"]}>
|
|
|
|
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 🍿
|
|
|
|
</VideoContent>
|
|
|
|
## 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.
|
|
|
|
2. Navigate to the "Project roles" tab.
|
|
|
|
3. Use the "New project role" button to open the role creation form.
|
|
|
|
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](../reference/rbac.md#custom-project-roles).
|
|
|
|
|
|
## Assigning custom project roles
|
|
|
|
:::info Multiple project roles
|
|
|
|
Multiple project roles were introduced as a beta Enterprise feature in **Unleash 5.5**. See [multiple project roles](../reference/rbac.md#multiple-project-roles) for more info.
|
|
|
|
:::
|
|
|
|
Assigning a custom project role is a pretty straightforward process and requires 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.
|
|
|
|
2. Navigate to the project's _access_ tab.
|
|
|
|
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, click on the edit icon coresponding with its line and from the overlay that will show up select the new role you want to assign it from the dropdown and save the changes.
|
|
|
|
- If the user _hasn't_ been added to the project, add them using the button 'Assing user/group'. From the overlay that will show up select the user, assign it a role and save the changes. Now you should be able to see the new user in the table.
|
|
|