1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-14 00:19:16 +01:00

docs: Move user groups section to after permissions section (#2081)

The permissions section is a subsection of the CPR section and
shouldn't be separated. This seems to have been an oversight.
This commit is contained in:
Thomas Heartman 2022-09-23 11:15:15 +02:00 committed by GitHub
parent 87a9789300
commit a3585343e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -52,26 +52,6 @@ Each custom project role consists of:
- a set of **project permissions** (optional) - a set of **project permissions** (optional)
- a set of **environment 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 ### Project permissions
You can assign the following project permissions. The permissions will be valid across all of the project's environments. You can assign the following project permissions. The permissions will be valid across all of the project's environments.
@ -123,3 +103,23 @@ You can assign the following permissions on a per-environment level within the p
- **enable/disable toggles** - **enable/disable toggles**
Lets the user enable and disable toggles within the environment. 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.