Skip to content

Commit

Permalink
Merge 0b0afa4 into 5f010fc
Browse files Browse the repository at this point in the history
  • Loading branch information
VeljkoMaksimovic committed Apr 9, 2024
2 parents 5f010fc + 0b0afa4 commit 4d24804
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 0 deletions.
Binary file added docs/security/groups/change_role.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/security/groups/create_a_group_btn.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/security/groups/go_to_people_page.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions docs/security/groups/groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# User Groups

!!! plans "Available on: <span class="plans-box">Scaleup</span>"

Instead of managing users (changing their roles and adding them to individual projects) one by one, you can use User Groups. This feature simplifies user management, enhances access control, and streamlines the assignment of roles and permissions across your projects. With User Groups, you can efficiently organize users into groups, assign roles to these groups, and manage access to your projects at the group level. Here's how it works:

### Creating a User Group
<ul>
<li> Navigate to the People page. </li>
![People page](./go_to_people_page.png)
<li> If your organization has access to the Groups feature, you should see a "Create a group" button. When you click on it, a pop-up will show, asking for the group name, description, and its members. </li>
![Create a group](./create_a_group_btn.png)
<li> As the final step, you need to enter the group name and its description, as well as add its members. When you create a new group, by default that group has 'Member' role assigned to it. To read more about our RBAC and roles, [click here](/security/rbac-authorization) </li>
![Add members](./new_group_popup.png)
</ul>

### Adding/Removing Users to a User Group
<ul>
<li> On top of the people page, there is a section listing all the groups that exist within your organization. If you have sufficient permissions, you will see "Modify group" button next to the group name. </li>
![Modify group button](./modify_group.png)
<li> The same popup used to create a new group will appear. Here, you can change add new members, remove existing ones, or change group name and description.</li>
<li> Once you have made all the changes, click on the "Save changes" button. It might take up to a couple of minutes for all the changes to propagate through the system, depending on how many users you have added/removed from the group. </li>
</ul>

### Assigning Roles to a User Group
<ul>
<li> As mentioned above, whenever you create a new group, it is assigned a 'Member' role within the organization, and it has no access to any of the projects. </li>
<li> If you go to the organization people page, you will see all the groups listed, together with a label stating which role the group (and its members) have within the organization. If you have sufficient permissions, you will be able to use 'Change role' button next to the group name. </li>
![Change group's role](./change_role.png)
<li> If you go to the project people page, you will be able to add groups (and all of it's members) to the project. </li>
![Add to project](./project_people.png)
</ul>
Binary file added docs/security/groups/modify_group.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/security/groups/new_group_popup.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/security/groups/project_people.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,7 @@ nav:
- RBAC overview: security/rbac-authorization.md
- Default roles: security/default-roles.md
- Repository-to-role mappings: security/repository-to-role-mappings.md
- User Groups: security/groups/groups.md
- Score:
- Insights: score/project-insights.md
- Custom dashboards: score/custom-dashboards.md
Expand Down

0 comments on commit 4d24804

Please sign in to comment.