gitlab-org--gitlab-foss/doc/permissions/permissions.md

# Permissions

Users have different abilities depending on the access level they have in a particular group or project.

If a user is both in a project group and in the project itself, the highest permission level is used.

If a user is a GitLab administrator they receive all permissions.

On public and internal projects the Guest role is not enforced.
All users will be able to create issues, leave comments, and pull or download the project code.

To add or import a user, you can follow the [project users and members
documentation](../workflow/add-user/add-user.md).

## Project

| Action                                | Guest   | Reporter   | Developer   | Master   | Owner  |
|---------------------------------------|---------|------------|-------------|----------|--------|
| Create new issue                      | ✓       | ✓          | ✓           | ✓        | ✓      |
| Leave comments                        | ✓       | ✓          | ✓           | ✓        | ✓      |
| See a list of builds                  | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
| See a build log                       | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
| Download and browse build artifacts   | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
| Pull project code                     |         | ✓          | ✓           | ✓        | ✓      |
| Download project                      |         | ✓          | ✓           | ✓        | ✓      |
| Create code snippets                  |         | ✓          | ✓           | ✓        | ✓      |
| Manage issue tracker                  |         | ✓          | ✓           | ✓        | ✓      |
| Manage labels                         |         | ✓          | ✓           | ✓        | ✓      |
| See a commit status                   |         | ✓          | ✓           | ✓        | ✓      |
| See a container registry              |         | ✓          | ✓           | ✓        | ✓      |
| See environments                      |         | ✓          | ✓           | ✓        | ✓      |
| Manage merge requests                 |         |            | ✓           | ✓        | ✓      |
| Create new merge request              |         |            | ✓           | ✓        | ✓      |
| Create new branches                   |         |            | ✓           | ✓        | ✓      |
| Push to non-protected branches        |         |            | ✓           | ✓        | ✓      |
| Force push to non-protected branches  |         |            | ✓           | ✓        | ✓      |
| Remove non-protected branches         |         |            | ✓           | ✓        | ✓      |
| Add tags                              |         |            | ✓           | ✓        | ✓      |
| Write a wiki                          |         |            | ✓           | ✓        | ✓      |
| Cancel and retry builds               |         |            | ✓           | ✓        | ✓      |
| Create or update commit status        |         |            | ✓           | ✓        | ✓      |
| Update a container registry           |         |            | ✓           | ✓        | ✓      |
| Remove a container registry image     |         |            | ✓           | ✓        | ✓      |
| Create new environments               |         |            | ✓           | ✓        | ✓      |
| Create new milestones                 |         |            |             | ✓        | ✓      |
| Add new team members                  |         |            |             | ✓        | ✓      |
| Push to protected branches            |         |            |             | ✓        | ✓      |
| Enable/disable branch protection      |         |            |             | ✓        | ✓      |
| Turn on/off prot. branch push for devs|         |            |             | ✓        | ✓      |
| Rewrite/remove git tags               |         |            |             | ✓        | ✓      |
| Edit project                          |         |            |             | ✓        | ✓      |
| Add deploy keys to project            |         |            |             | ✓        | ✓      |
| Configure project hooks               |         |            |             | ✓        | ✓      |
| Manage runners                        |         |            |             | ✓        | ✓      |
| Manage build triggers                 |         |            |             | ✓        | ✓      |
| Manage variables                      |         |            |             | ✓        | ✓      |
| Delete environments                   |         |            |             | ✓        | ✓      |
| Switch visibility level               |         |            |             |          | ✓      |
| Transfer project to another namespace |         |            |             |          | ✓      |
| Remove project                        |         |            |             |          | ✓      |
| Force push to protected branches [^2] |         |            |             |          |        |
| Remove protected branches [^2]        |         |            |             |          |        |

[^1]: If **Allow guest to access builds** is enabled in CI settings
[^2]: Not allowed for Guest, Reporter, Developer, Master, or Owner

## Group

In order for a group to appear as public and be browsable, it must contain at
least one public project.

Any user can remove themselves from a group, unless they are the last Owner of the group.

| Action                  | Guest | Reporter | Developer | Master | Owner |
|-------------------------|-------|----------|-----------|--------|-------|
| Browse group            | ✓     | ✓        | ✓         | ✓      | ✓     |
| Edit group              |       |          |           |        | ✓     |
| Create project in group |       |          |           | ✓      | ✓     |
| Manage group members    |       |          |           |        | ✓     |
| Remove group            |       |          |           |        | ✓     |

## External Users

In cases where it is desired that a user has access only to some internal or
private projects, there is the option of creating **External Users**. This
feature may be useful when for example a contractor is working on a given
project and should only have access to that project.

External users can only access projects to which they are explicitly granted
access, thus hiding all other internal or private ones from them. Access can be
granted by adding the user as member to the project or group.

They will, like usual users, receive a role in the project or group with all
the abilities that are mentioned in the table above. They cannot however create
groups or projects, and they have the same access as logged out users in all
other cases.

An administrator can flag a user as external [through the API](../api/users.md)
or by checking the checkbox on the admin panel. As an administrator, navigate
to **Admin > Users** to create a new user or edit an existing one. There, you
will find the option to flag the user as external.
Add titles to doc pages. 2014-05-27 08:12:15 -04:00			`# Permissions`

Moved all the help files to markdown files: Files moved: * Workflow * help/ssh * help/webhooks * help/system_hooks * help/public_access * help/permissions 2014-02-13 05:55:46 -05:00			`Users have different abilities depending on the access level they have in a particular group or project.`
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00
Moved all the help files to markdown files: Files moved: * Workflow * help/ssh * help/webhooks * help/system_hooks * help/public_access * help/permissions 2014-02-13 05:55:46 -05:00			`If a user is both in a project group and in the project itself, the highest permission level is used.`
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00
Moved all the help files to markdown files: Files moved: * Workflow * help/ssh * help/webhooks * help/system_hooks * help/public_access * help/permissions 2014-02-13 05:55:46 -05:00			`If a user is a GitLab administrator they receive all permissions.`

Adjust documentation of permissions [ci skip] 2016-02-22 13:44:13 -05:00			`On public and internal projects the Guest role is not enforced.`
Fix broken link in permissions page [ci skip] 2015-12-28 16:06:40 -05:00			`All users will be able to create issues, leave comments, and pull or download the project code.`
fixed the documentation of the Guest role in permission.md 2015-12-02 09:21:02 -05:00
text fixed 2015-08-03 18:51:09 -04:00			`To add or import a user, you can follow the [project users and members`
Fix broken link in permissions page [ci skip] 2015-12-28 16:06:40 -05:00			`documentation](../workflow/add-user/add-user.md).`
added new doc about adding users and members 2015-07-30 16:20:10 -04:00
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			`## Project`

			`\| Action \| Guest \| Reporter \| Developer \| Master \| Owner \|`
			`\|---------------------------------------\|---------\|------------\|-------------\|----------\|--------\|`
			`\| Create new issue \| ✓ \| ✓ \| ✓ \| ✓ \| ✓ \|`
			`\| Leave comments \| ✓ \| ✓ \| ✓ \| ✓ \| ✓ \|`
Add CI setting: allow_guest_to_access_builds Add the `read_build` ability if user is anonymous or guest and allow_guest_to_access_builds is enabled. 2016-02-02 11:59:37 -05:00			`\| See a list of builds \| ✓ [^1] \| ✓ \| ✓ \| ✓ \| ✓ \|`
			`\| See a build log \| ✓ [^1] \| ✓ \| ✓ \| ✓ \| ✓ \|`
			`\| Download and browse build artifacts \| ✓ [^1] \| ✓ \| ✓ \| ✓ \| ✓ \|`
fixed the documentation of the Guest role in permission.md 2015-12-02 09:21:02 -05:00			`\| Pull project code \| \| ✓ \| ✓ \| ✓ \| ✓ \|`
			`\| Download project \| \| ✓ \| ✓ \| ✓ \| ✓ \|`
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			`\| Create code snippets \| \| ✓ \| ✓ \| ✓ \| ✓ \|`
Reporter role can manage issue tracker now Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> 2015-06-30 07:33:02 -04:00			`\| Manage issue tracker \| \| ✓ \| ✓ \| ✓ \| ✓ \|`
			`\| Manage labels \| \| ✓ \| ✓ \| ✓ \| ✓ \|`
Update commit status permissions [ci skip] 2016-02-23 10:13:12 -05:00			`\| See a commit status \| \| ✓ \| ✓ \| ✓ \| ✓ \|`
Rename `images` to `container_registry` 2016-05-09 13:29:57 -04:00			`\| See a container registry \| \| ✓ \| ✓ \| ✓ \| ✓ \|`
Improve design after review 2016-06-14 12:34:48 -04:00			`\| See environments \| \| ✓ \| ✓ \| ✓ \| ✓ \|`
Add "Manage merge requests" permission to docs 2015-07-24 14:59:02 -04:00			`\| Manage merge requests \| \| \| ✓ \| ✓ \| ✓ \|`
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			`\| Create new merge request \| \| \| ✓ \| ✓ \| ✓ \|`
			`\| Create new branches \| \| \| ✓ \| ✓ \| ✓ \|`
			`\| Push to non-protected branches \| \| \| ✓ \| ✓ \| ✓ \|`
add details on protected branches Add some details from https://about.gitlab.com/2014/11/26/keeping-your-code-protected/: Who can: * Force push to non-protected branches * Force push to protected branches * Remove protected branches 2014-11-26 15:19:19 -05:00			`\| Force push to non-protected branches \| \| \| ✓ \| ✓ \| ✓ \|`
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			`\| Remove non-protected branches \| \| \| ✓ \| ✓ \| ✓ \|`
			`\| Add tags \| \| \| ✓ \| ✓ \| ✓ \|`
			`\| Write a wiki \| \| \| ✓ \| ✓ \| ✓ \|`
Add CI setting: allow_guest_to_access_builds Add the `read_build` ability if user is anonymous or guest and allow_guest_to_access_builds is enabled. 2016-02-02 11:59:37 -05:00			`\| Cancel and retry builds \| \| \| ✓ \| ✓ \| ✓ \|`
Update commit status permissions [ci skip] 2016-02-23 10:13:12 -05:00			`\| Create or update commit status \| \| \| ✓ \| ✓ \| ✓ \|`
Rename `images` to `container_registry` 2016-05-09 13:29:57 -04:00			`\| Update a container registry \| \| \| ✓ \| ✓ \| ✓ \|`
Update permission doc 2016-05-16 17:39:23 -04:00			`\| Remove a container registry image \| \| \| ✓ \| ✓ \| ✓ \|`
Improve design after review 2016-06-14 12:34:48 -04:00			`\| Create new environments \| \| \| ✓ \| ✓ \| ✓ \|`
A Developer cannot manage milestones Signed-off-by: Jeroen van Baarsen <jeroenvanbaarsen@gmail.com> 2014-07-09 14:46:37 -04:00			`\| Create new milestones \| \| \| \| ✓ \| ✓ \|`
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			`\| Add new team members \| \| \| \| ✓ \| ✓ \|`
			`\| Push to protected branches \| \| \| \| ✓ \| ✓ \|`
standardize capitalization 2014-09-19 03:58:22 -04:00			`\| Enable/disable branch protection \| \| \| \| ✓ \| ✓ \|`
Add documentation about protected branches. 2014-12-29 04:44:08 -05:00			`\| Turn on/off prot. branch push for devs\| \| \| \| ✓ \| ✓ \|`
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			`\| Rewrite/remove git tags \| \| \| \| ✓ \| ✓ \|`
			`\| Edit project \| \| \| \| ✓ \| ✓ \|`
standardize capitalization 2014-09-19 03:58:22 -04:00			`\| Add deploy keys to project \| \| \| \| ✓ \| ✓ \|`
			`\| Configure project hooks \| \| \| \| ✓ \| ✓ \|`
Add CI setting: allow_guest_to_access_builds Add the `read_build` ability if user is anonymous or guest and allow_guest_to_access_builds is enabled. 2016-02-02 11:59:37 -05:00			`\| Manage runners \| \| \| \| ✓ \| ✓ \|`
			`\| Manage build triggers \| \| \| \| ✓ \| ✓ \|`
			`\| Manage variables \| \| \| \| ✓ \| ✓ \|`
Improve design after review 2016-06-14 12:34:48 -04:00			`\| Delete environments \| \| \| \| ✓ \| ✓ \|`
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			`\| Switch visibility level \| \| \| \| \| ✓ \|`
			`\| Transfer project to another namespace \| \| \| \| \| ✓ \|`
			`\| Remove project \| \| \| \| \| ✓ \|`
Fix missing entries in permission matrix [ci skip] 2016-04-06 17:49:12 -04:00			`\| Force push to protected branches [^2] \| \| \| \| \| \|`
			`\| Remove protected branches [^2] \| \| \| \| \| \|`
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00
Add CI setting: allow_guest_to_access_builds Add the `read_build` ability if user is anonymous or guest and allow_guest_to_access_builds is enabled. 2016-02-02 11:59:37 -05:00			`[^1]: If Allow guest to access builds is enabled in CI settings`
Fix missing entries in permission matrix [ci skip] 2016-04-06 17:49:12 -04:00			`[^2]: Not allowed for Guest, Reporter, Developer, Master, or Owner`
Add CI setting: allow_guest_to_access_builds Add the `read_build` ability if user is anonymous or guest and allow_guest_to_access_builds is enabled. 2016-02-02 11:59:37 -05:00
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			`## Group`

[doc] Groups can be browsable if they contain at least one public project. 2015-03-25 06:18:44 -04:00			`In order for a group to appear as public and be browsable, it must contain at`
			`least one public project.`

			`Any user can remove themselves from a group, unless they are the last Owner of the group.`

Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			`\| Action \| Guest \| Reporter \| Developer \| Master \| Owner \|`
			`\|-------------------------\|-------\|----------\|-----------\|--------\|-------\|`
			`\| Browse group \| ✓ \| ✓ \| ✓ \| ✓ \| ✓ \|`
			`\| Edit group \| \| \| \| \| ✓ \|`
			`\| Create project in group \| \| \| \| ✓ \| ✓ \|`
			`\| Manage group members \| \| \| \| \| ✓ \|`
			`\| Remove group \| \| \| \| \| ✓ \|`
Doc external users feature 2016-03-14 19:11:20 -04:00
			`## External Users`

Refactor external users docs [ci skip] 2016-03-17 03:24:06 -04:00			`In cases where it is desired that a user has access only to some internal or`
			`private projects, there is the option of creating External Users. This`
			`feature may be useful when for example a contractor is working on a given`
			`project and should only have access to that project.`

			`External users can only access projects to which they are explicitly granted`
			`access, thus hiding all other internal or private ones from them. Access can be`
			`granted by adding the user as member to the project or group.`

			`They will, like usual users, receive a role in the project or group with all`
			`the abilities that are mentioned in the table above. They cannot however create`
			`groups or projects, and they have the same access as logged out users in all`
			`other cases.`

			`An administrator can flag a user as external [through the API](../api/users.md)`
			`or by checking the checkbox on the admin panel. As an administrator, navigate`
			`to Admin > Users to create a new user or edit an existing one. There, you`
			`will find the option to flag the user as external.`