95f4f641b5
https://linear.app/unleash/issue/2-1136/custom-root-roles-documentation - [Adds documentation referencing custom root roles](https://unleash-docs-git-docs-custom-root-roles-unleash-team.vercel.app/reference/rbac); - [Adds a "How to create and assign custom root roles" how-to guide](https://unleash-docs-git-docs-custom-root-roles-unleash-team.vercel.app/how-to/how-to-create-and-assign-custom-root-roles); - Standardizes "global" roles to "root" roles; - Standardizes "standard" roles to "predefined" roles to better reflect their behavior and what is shown in our UI; - Updates predefined role descriptions and makes them consistent; - Updates the side panel description of the user form; - Includes some boy scouting with some tiny fixes of things identified along the way (e.g. the role form was persisting old data when closed and re-opened); Questions: - Is it worth expanding the "Assigning custom root roles" section in the "How to create and assign custom root roles" guide to include the steps for assigning a root role for each entity (user, service account, group)? - Should this PR include an update to the existing "How to create and assign custom project roles" guide? We've since updated the UI; --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
1.8 KiB
| title |
|---|
| How to create and assign custom root roles |
:::info availability
Custom root roles were introduced in Unleash 5.4 and are only available in Unleash Enterprise.
:::
This guide takes you through how to create and assign custom root roles. Custom root roles allow you to fine-tune access rights and permissions to root resources in your Unleash instance.
Creating custom root roles
Step 1: Navigate to the custom root roles page
Navigate to the roles page in the admin UI (available at the URL /admin/roles). Use the settings button in the navigation menu and select "roles".
Step 2: Click the "new root role" button.
Use the "new root role" button to open the "new root role" form.
Step 3: Fill in the root role form
Give the root role a name, a description, and the set of permissions you'd like it to have. For a full overview of all the options, consult the custom root roles reference documentation.
Assigning custom root roles
You can assign custom root roles just like you would assign any other predefined root role. Root roles can be assigned to users, service accounts, and groups.