Skip to content

Commit

Permalink
docs: Move user groups section to after permissions section (#2081)
Browse files Browse the repository at this point in the history
The permissions section is a subsection of the CPR section and
shouldn't be separated. This seems to have been an oversight.
  • Loading branch information
thomasheartman committed Sep 23, 2022
1 parent 87a9789 commit a358534
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions website/docs/user_guide/rbac.md
Expand Up @@ -52,26 +52,6 @@ Each custom project role consists of:
- a set of **project permissions** (optional)
- a set of **environment permissions** (optional)

## User Groups

:::info availability

User groups are available to Unleash Enterprise users since **Unleash 4.14**.

:::

User groups allow you to assign roles to a group of users within a project, rather than to a user directly. This allows you to manage your user permissions more easily when there's lots of users in the system. For a guide on how to create and manage user groups see [_how to create and manage user groups_](../how-to/how-to-create-and-manage-user-groups.md).

A user group consists of the following:

- a **name** (required)
- a **description** (optional)
- a list of users (optional)

Groups do nothing on their own. They must be given a role on a project to assign permissions.

While a user can only have one role in a given project, a user may belong to multiple groups, and each of those groups may be given a role on a project. In the case where a given user is given permissions to a project through more than one group, the user will inherit most permissive permissions of all their groups in that project.

### Project permissions

You can assign the following project permissions. The permissions will be valid across all of the project's environments.
Expand Down Expand Up @@ -123,3 +103,23 @@ You can assign the following permissions on a per-environment level within the p
- **enable/disable toggles**

Lets the user enable and disable toggles within the environment.

## User Groups

:::info availability

User groups are available to Unleash Enterprise users since **Unleash 4.14**.

:::

User groups allow you to assign roles to a group of users within a project, rather than to a user directly. This allows you to manage your user permissions more easily when there's lots of users in the system. For a guide on how to create and manage user groups see [_how to create and manage user groups_](../how-to/how-to-create-and-manage-user-groups.md).

A user group consists of the following:

- a **name** (required)
- a **description** (optional)
- a list of users (optional)

Groups do nothing on their own. They must be given a role on a project to assign permissions. You can assign both standard roles and custom project roles to groups.

While a user can only have one role in a given project, a user may belong to multiple groups, and each of those groups may be given a role on a project. In the case where a given user is given permissions to a project through more than one group, the user will inherit most permissive permissions of all their groups in that project.

1 comment on commit a358534

@vercel
Copy link

@vercel vercel bot commented on a358534 Sep 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

unleash – ./website

unleash-unleash-team.vercel.app
unleash-tawny.vercel.app
unleash-git-main-unleash-team.vercel.app

Please sign in to comment.