2022-07-21 16:23:56 +02:00
---
title: How to create and manage user groups
---
2024-10-03 10:33:22 +02:00
:::note Availability
2022-07-21 16:23:56 +02:00
2024-10-03 10:33:22 +02:00
**Plan**: [Enterprise ](https://www.getunleash.io/pricing ) | **Version** : `4.14+`
2022-07-21 16:23:56 +02:00
:::
refactor: move docs into new structure / fix links for SEO (#2416)
## What
This (admittedly massive) PR updates the "physical" documentation
structure and fixes url inconsistencies and SEO problems reported by
marketing. The main points are:
- remove or move directories : advanced, user_guide, deploy, api
- move the files contained within to the appropriate one of topics,
how-to, tutorials, or reference
- update internal doc links and product links to the content
- create client-side redirects for all the urls that have changed.
A number of the files have been renamed in small ways to better match
their url and to make them easier to find. Additionally, the top-level
api directory has been moved to /reference/api/legacy/unleash (see the
discussion points section for more on this).
## Why
When moving our doc structure to diataxis a while back, we left the
"physical' files lying where they were, because it didn't matter much to
the new structure. However, that did introduce some inconsistencies with
where you place docs and how we organize them.
There's also the discrepancies in whether urls us underscores or hyphens
(which isn't necessarily the same as their file name), which has been
annoying me for a while, but now has also been raised by marketing as an
issue in terms of SEO.
## Discussion points
The old, hand-written API docs have been moved from /api to
/reference/api/legacy/unleash. There _is_ a /reference/api/unleash
directory, but this is being populated by the OpenAPI plugin, and mixing
those could only cause trouble. However, I'm unsure about putting
/legacy/ in the title, because the API isn't legacy, the docs are. Maybe
we could use another path? Like /old-docs/ or something? I'd appreciate
some input on this.
2022-11-22 10:05:30 +01:00
This guide takes you through how to use user groups to manage permissions on your projects. User groups allow you to manage large groups of users more easily than assigning roles directly to those users. Refer to the section on [user groups ](../reference/rbac.md#user-groups ) in the RBAC documentation for more information.
2022-07-21 16:23:56 +02:00
## Creating user groups
1. Navigate to groups by using the admin menu (the gear icon) and selecting the groups option.
2. Navigate to new group.
2023-05-17 08:59:35 +02:00
3. Give the group a name, an optional description, an optional root role, and select the users you'd like to be in the group.
2022-07-21 16:23:56 +02:00
4. Review the details of the group and save them if you're happy.
## Managing users within a group
1. Navigate to groups by using the admin menu (the gear icon) and selecting the groups option.
2. Select the card of the group you want to edit.
3. Remove users by using the remove user button (displayed as a bin).
4. Confirm the remove.
5. Add users by selecting the add button.
2022-08-11 14:01:32 +02:00
6. Find the user you'd like to add to the group and select them.
2022-07-21 16:23:56 +02:00
2022-08-11 14:01:32 +02:00
7. Review the group users and save when you're happy.
2022-07-21 16:23:56 +02:00
2022-08-11 14:01:32 +02:00
2022-07-21 16:23:56 +02:00
## Assigning groups to projects
1. Navigate to projects
2. Select the project you want to manage.
3. Navigate to the access tab and then use the assign user/group button.
4. Find your group in the drop down.
5. Select the role that the group should have in this project. You can review the list of permissions that the group users will gain by having this role before confirming.
