debian-mirror-gitlab/doc/user/project/members/index.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

332 lines
14 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
2023-05-27 22:25:52 +05:30
stage: Data Stores
group: Tenant Scale
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2021-01-29 00:20:46 +05:30
---
2021-09-04 01:27:46 +05:30
# Members of a project **(FREE)**
2018-03-17 18:26:18 +05:30
2021-06-08 01:23:25 +05:30
Members are the users and groups who have access to your project.
2018-03-17 18:26:18 +05:30
2021-06-08 01:23:25 +05:30
Each member gets a role, which determines what they can do in the project.
2018-03-17 18:26:18 +05:30
2023-04-23 21:23:45 +05:30
## Membership types
2022-05-07 20:08:51 +05:30
2023-04-23 21:23:45 +05:30
Users can become members of a group or project in different ways, which define their membership type.
| Membership type | Membership process |
| --------------------------------------------- | ------------------ |
| [Direct](#add-users-to-a-project) | The user is added directly to the current group or project. |
| [Inherited](#inherited-membership) | The user is a member of an ancestor group or project that is added to the current group or project. |
| [Direct shared](share_project_with_groups.md) | The user is a member of a group or project that is shared into the current group or project. |
| [Inherited shared](../../group/manage.md#share-a-group-with-another-group) | The user is a member of an ancestor of a group or project that is shared into the current group or project. |
2022-05-07 20:08:51 +05:30
```mermaid
flowchart RL
subgraph Group A
A(Direct member)
B{{Shared member}}
subgraph Project A
H(1. Direct member)
C{{2. Inherited member}}
D{{4. Inherited member}}
E{{3. Shared member}}
end
A-->|Direct membership of Group A\nInherited membership of Project A|C
end
subgraph Group C
G(Direct member)
end
subgraph Group B
F(Direct member)
end
F-->|Group B\nshared with\nGroup A|B
B-->|Inherited membership of Project A|D
G-->|Group C shared with Project A|E
```
2023-04-23 21:23:45 +05:30
### Inherited membership
When your project belongs to a group, project members inherit their role
from the group.
![Project members page](img/project_members_v14_4.png)
In this example:
- Three members have access to the project.
- **User 0** is a Reporter and has inherited their role in the project from the **demo** group,
which contains the project.
- **User 1** belongs directly to the project. In the **Source** column, they are listed
as a **Direct member**.
- **Administrator** is the [Owner](../../permissions.md) and member of all groups.
They have inherited their role in the project from the **demo** group.
If a user is:
- A direct member of a project, the **Expiration** and **Max role** fields can be updated directly on the project.
- An inherited member from a parent group, the **Expiration** and **Max role** fields must be updated on the parent group.
### Membership and visibility rights
Depending on their membership type, members of groups or projects are granted different visibility levels
and rights into the group or project.
| Action | Direct group member | Inherited group member | Direct shared group member | Inherited shared group member |
| --- | ------------------- | ---------------------- | -------------------------- | ----------------------------- |
| Generate boards | ✓ | ✓ | ✓ | ✓ |
| View issues of groups higher in the hierarchy | ✓ | ✓ | ✓ | ✓ |
| View labels of groups higher in the hierarchy | ✓ | ✓ | ✓ | ✓ |
| View milestones of groups higher in the hierarchy | ✓ | ✓ | ✓ | ✓ |
| Be shared into other groups | ✓ | | | |
| Be shared into other projects | ✓ | ✓ | | |
| Share the group with other members | ✓ | | | |
In the following example, `User` is a:
- Direct member of `subgroup`.
- Inherited member of `subsubgroup`.
- Indirect member of `subgroup-2` and `subgroup-3`.
- Indirect inherited member of `subsubgroup-2` and `subsubgroup-3`.
```mermaid
graph TD
classDef user stroke:green,color:green;
root --> subgroup --> subsubgroup
root-2 --> subgroup-2 --> subsubgroup-2
root-3 --> subgroup-3 --> subsubgroup-3
subgroup -. shared .-> subgroup-2 -. shared .-> subgroup-3
User-. member .- subgroup
class User user
```
2021-06-08 01:23:25 +05:30
## Add users to a project
2022-04-04 11:22:00 +05:30
> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/247208) in GitLab 13.11 from a form to a modal window [with a flag](../../feature_flags.md). Disabled by default.
> - Modal window [enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/247208) in GitLab 14.8.
2023-01-13 00:05:48 +05:30
> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/352526) in GitLab 14.9. [Feature flag `invite_members_group_modal`](https://gitlab.com/gitlab-org/gitlab/-/issues/352526) removed.
2022-04-04 11:22:00 +05:30
2023-04-23 21:23:45 +05:30
Add users to a project so they become direct members and have permission
2022-08-27 11:52:29 +05:30
to perform actions.
2021-06-08 01:23:25 +05:30
Prerequisite:
2023-01-13 00:05:48 +05:30
- You must have the Owner or Maintainer role.
2021-06-08 01:23:25 +05:30
To add a user to a project:
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2022-04-04 11:22:00 +05:30
1. On the left sidebar, select **Project information > Members**.
1. Select **Invite members**.
2023-04-23 21:23:45 +05:30
1. If the user:
- Has a GitLab account, enter their username.
- Doesn't have a GitLab account, enter their email address.
1. Select a [role](../../permissions.md).
2022-04-04 11:22:00 +05:30
1. Optional. Select an **Access expiration date**.
2023-03-04 22:38:38 +05:30
From that date onward, the user can no longer access the project.
2023-03-17 16:20:25 +05:30
WARNING:
If you give a member the Maintainer role and select an expiration date, that member
has full permissions for the time they are in the role. This includes the ability
to extend their own time in the Maintainer role.
2021-06-08 01:23:25 +05:30
1. Select **Invite**.
2023-04-23 21:23:45 +05:30
If you invited the user using their:
2021-06-08 01:23:25 +05:30
2023-04-23 21:23:45 +05:30
- GitLab username, they are added to the members list.
- Email address, an invitation is sent to their email address, and they are prompted to create an account.
If the invitation is not accepted, GitLab sends reminder emails two, five, and ten days later.
Unaccepted invites are automatically deleted after 90 days.
2021-09-04 01:27:46 +05:30
2023-01-13 00:05:48 +05:30
### Which roles you can assign
The maximum role you can assign depends on whether you have the Owner or Maintainer
role for the group. For example, the maximum role you can set is:
- Owner (`50`), if you have the Owner role for the project.
- Maintainer (`40`), if you have the Maintainer role on the project.
In GitLab 14.8 and earlier, direct members of a project have a maximum role of Maintainer.
The Owner [role](../../permissions.md#project-members-permissions) can be added for the group only.
2021-06-08 01:23:25 +05:30
## Add groups to a project
2022-04-04 11:22:00 +05:30
> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/247208) in GitLab 13.11 from a form to a modal window [with a flag](../../feature_flags.md). Disabled by default.
> - Modal window [enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/247208) in GitLab 14.8.
2023-01-13 00:05:48 +05:30
> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/352526) in GitLab 14.9. [Feature flag `invite_members_group_modal`](https://gitlab.com/gitlab-org/gitlab/-/issues/352526) removed.
2022-04-04 11:22:00 +05:30
2023-04-23 21:23:45 +05:30
When you add a group to a project, every group member (direct or inherited) gets access to the project.
Each member's access is based on the:
2021-09-04 01:27:46 +05:30
2023-04-23 21:23:45 +05:30
- Role they're assigned in the group.
- Maximum role you choose when you invite the group.
2021-06-08 01:23:25 +05:30
2023-04-23 21:23:45 +05:30
If a group member has a role in the group with fewer permissions than the maximum project role, the member keeps the permissions of their group role.
For example, if you add a member with the Guest role to a project with a maximum role of Maintainer, the member has only the permissions of the Guest role in the project.
2023-03-17 16:20:25 +05:30
2023-01-13 00:05:48 +05:30
Prerequisites:
2021-06-08 01:23:25 +05:30
2022-04-04 11:22:00 +05:30
- You must have the Maintainer or Owner role.
2022-08-27 11:52:29 +05:30
- Sharing the project with other groups must not be [prevented](../../group/access_and_permissions.md#prevent-a-project-from-being-shared-with-groups).
2021-06-08 01:23:25 +05:30
2023-01-13 00:05:48 +05:30
To add a group to a project:
2021-06-08 01:23:25 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2022-01-26 12:08:38 +05:30
1. On the left sidebar, select **Project information > Members**.
2022-04-04 11:22:00 +05:30
1. Select **Invite a group**.
1. Select a group.
1. Select the highest [role](../../permissions.md) for users in the group.
2023-01-13 00:05:48 +05:30
1. Optional. Select an **Access expiration date**.
2023-03-04 22:38:38 +05:30
From that date onward, the group can no longer access the project.
2021-06-08 01:23:25 +05:30
1. Select **Invite**.
The members of the group are not displayed on the **Members** tab.
The **Members** tab shows:
- Members who are directly assigned to the project.
2022-08-27 11:52:29 +05:30
- If the project was created in a group [namespace](../../namespace/index.md), members of that group.
2021-06-08 01:23:25 +05:30
2023-04-23 21:23:45 +05:30
## Import members from another project
2021-06-08 01:23:25 +05:30
2023-04-23 21:23:45 +05:30
You can import another project's members to your own project.
Imported project members retain the same permissions as the project you import them from.
2021-06-08 01:23:25 +05:30
Prerequisite:
2022-04-04 11:22:00 +05:30
- You must have the Maintainer or Owner role.
2021-06-08 01:23:25 +05:30
To import users:
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2022-01-26 12:08:38 +05:30
1. On the left sidebar, select **Project information > Members**.
2022-05-07 20:08:51 +05:30
1. Select **Import from a project**.
2021-06-08 01:23:25 +05:30
1. Select the project. You can view only the projects for which you're a maintainer.
1. Select **Import project members**.
2022-05-07 20:08:51 +05:30
After the success message displays, refresh the page to view the new members.
2018-03-17 18:26:18 +05:30
2021-09-04 01:27:46 +05:30
## Remove a member from a project
2023-04-23 21:23:45 +05:30
If a user is:
- A direct member of a project, you can remove them directly from the project.
- An inherited member from a parent group, you can only remove them from the parent group itself.
2021-09-04 01:27:46 +05:30
2021-10-27 15:23:28 +05:30
Prerequisites:
2021-09-04 01:27:46 +05:30
2023-04-23 21:23:45 +05:30
- To remove direct members that have the:
2023-01-13 00:05:48 +05:30
- Maintainer, Developer, Reporter, or Guest role, you must have the Maintainer role.
- Owner role, you must have the Owner role.
2021-09-04 01:27:46 +05:30
- Optional. Unassign the member from all issues and merge requests that
are assigned to them.
2020-01-01 13:55:28 +05:30
2021-09-04 01:27:46 +05:30
To remove a member from a project:
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2022-01-26 12:08:38 +05:30
1. On the left sidebar, select **Project information > Members**.
2022-05-07 20:08:51 +05:30
1. Next to the project member you want to remove, select **Remove member**.
2021-10-27 15:23:28 +05:30
1. Optional. In the confirmation box, select the
**Also unassign this user from related issues and merge requests** checkbox.
1. To prevent leaks of sensitive information from private projects, verify the
2023-04-23 21:23:45 +05:30
member has not forked the private repository or created webhooks. Existing forks continue to receive
2021-12-11 22:18:48 +05:30
changes from the upstream project, and webhooks continue to receive updates. You may also want to configure your project
2021-10-27 15:23:28 +05:30
to prevent projects in a group
2022-08-27 11:52:29 +05:30
[from being forked outside their group](../../group/access_and_permissions.md#prevent-project-forking-outside-group).
2021-09-04 01:27:46 +05:30
1. Select **Remove member**.
2020-01-01 13:55:28 +05:30
2023-01-13 00:05:48 +05:30
## Ensure removed users cannot invite themselves back
Malicious users with the Maintainer or Owner role could exploit a race condition that allows
them to invite themselves back to a group or project that a GitLab administrator has removed them from.
To avoid this problem, GitLab administrators can:
- Remove the malicious user session from the [GitLab Rails console](../../../administration/operations/rails_console.md).
- Impersonate the malicious user to:
- Remove the user from the project.
- Log the user out of GitLab.
- Block the malicious user account.
- Remove the malicious user account.
- Change the password for the malicious user account.
2021-03-11 19:13:27 +05:30
## Filter and sort members
2020-01-01 13:55:28 +05:30
2021-03-11 19:13:27 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21727) in GitLab 12.6.
> - [Improved](https://gitlab.com/groups/gitlab-org/-/epics/4901) in GitLab 13.9.
2021-04-17 20:07:23 +05:30
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/299954) in GitLab 13.10.
2020-01-01 13:55:28 +05:30
2021-09-04 01:27:46 +05:30
You can filter and sort members in a project.
2021-03-11 19:13:27 +05:30
2021-09-04 01:27:46 +05:30
### Display inherited members
2021-03-11 19:13:27 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2022-01-26 12:08:38 +05:30
1. On the left sidebar, select **Project information > Members**.
2021-09-04 01:27:46 +05:30
1. In the **Filter members** box, select `Membership` `=` `Inherited`.
2022-07-16 23:28:13 +05:30
1. Press <kbd>Enter</kbd>.
2021-03-11 19:13:27 +05:30
2021-11-18 22:05:49 +05:30
![Project members filter inherited](img/project_members_filter_inherited_v14_4.png)
2021-03-11 19:13:27 +05:30
2021-09-04 01:27:46 +05:30
### Display direct members
2021-03-11 19:13:27 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2022-01-26 12:08:38 +05:30
1. On the left sidebar, select **Project information > Members**.
2021-09-04 01:27:46 +05:30
1. In the **Filter members** box, select `Membership` `=` `Direct`.
2022-07-16 23:28:13 +05:30
1. Press <kbd>Enter</kbd>.
2021-03-11 19:13:27 +05:30
2021-11-18 22:05:49 +05:30
![Project members filter direct](img/project_members_filter_direct_v14_4.png)
2021-03-11 19:13:27 +05:30
### Search
You can search for members by name, username, or email.
2021-11-18 22:05:49 +05:30
![Project members search](img/project_members_search_v14_4.png)
2021-03-11 19:13:27 +05:30
### Sort
You can sort members by **Account**, **Access granted**, **Max role**, or **Last sign-in** in ascending or descending order.
2021-11-18 22:05:49 +05:30
![Project members sort](img/project_members_sort_v14_4.png)
2020-01-01 13:55:28 +05:30
2021-09-04 01:27:46 +05:30
## Request access to a project
2021-09-30 23:02:18 +05:30
GitLab users can request to become a member of a project.
2021-09-04 01:27:46 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find the project you want to be a member of.
2021-09-04 01:27:46 +05:30
1. By the project name, select **Request Access**.
![Request access button](img/request_access_button.png)
2018-03-17 18:26:18 +05:30
2022-11-25 23:54:43 +05:30
An email is sent to the most recently active project maintainers or owners.
Up to ten project maintainers or owners are notified.
2022-07-23 23:45:48 +05:30
Any project owner or maintainer can approve or decline the request.
Project maintainers cannot approve Owner role access requests.
2021-04-29 21:17:54 +05:30
2022-07-23 23:45:48 +05:30
If a project does not have any direct owners or maintainers, the notification is sent to the
2021-09-04 01:27:46 +05:30
most recently active owners of the project's group.
2018-03-17 18:26:18 +05:30
2021-09-04 01:27:46 +05:30
If you change your mind before your request is approved, select
**Withdraw Access Request**.
2018-03-17 18:26:18 +05:30
2021-09-04 01:27:46 +05:30
## Prevent users from requesting access to a project
2018-03-17 18:26:18 +05:30
2021-09-04 01:27:46 +05:30
You can prevent users from requesting access to a project.
2018-03-17 18:26:18 +05:30
2021-09-04 01:27:46 +05:30
Prerequisite:
2018-03-17 18:26:18 +05:30
2021-09-04 01:27:46 +05:30
- You must be the project owner.
2018-03-17 18:26:18 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2022-01-26 12:08:38 +05:30
1. On the left sidebar, select **Settings > General**.
1. Expand **Visibility, project features, permissions**.
2021-09-04 01:27:46 +05:30
1. Under **Project visibility**, select **Users can request access**.
1. Select **Save changes**.
2021-02-22 17:27:13 +05:30
2021-09-04 01:27:46 +05:30
## Share a project with a group
2018-03-17 18:26:18 +05:30
2021-09-04 01:27:46 +05:30
Instead of adding users one by one, you can [share a project with an entire group](share_project_with_groups.md).