permissions.md 18.8 KB
Newer Older
1 2 3 4
---
description: 'Understand and explore the user permission levels in GitLab, and what features each of them grants you access to.'
---

5 6 7 8 9 10 11
# 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 group's project and the
project itself, the highest permission level is used.

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

14
When a member leaves the team all the assigned [Issues](project/issues/index.md) and [Merge Requests](project/merge_requests/index.md)
15 16
will be unassigned automatically.

17
GitLab [administrators](../README.md#administrator-documentation) receive all permissions.
18

19 20
To add or import a user, you can follow the
[project members documentation](../user/project/members/index.md).
21

22
## Principles behind permissions
23

24
See our [product handbook on permissions](https://about.gitlab.com/handbook/product#permissions-in-gitlab)
25

26
## Project members permissions
27 28 29

The following table depicts the various user permission levels in a project.

Mark Chao's avatar
Mark Chao committed
30
| Action                                | Guest   | Reporter   | Developer   |Maintainer| Owner  |
31
|---------------------------------------|---------|------------|-------------|----------|--------|
32 33
| Create new issue                      | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
| Create confidential issue             | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
34
| View confidential issues              | (✓) [^2] | ✓         | ✓           | ✓        | ✓      |
35
| Leave comments                        | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
36 37
| Lock issue discussions                |         | ✓          | ✓           | ✓        | ✓      |
| Lock merge request discussions        |         |            | ✓           | ✓        | ✓      |
38
| See a list of jobs                    | ✓ [^3]  | ✓          | ✓           | ✓        | ✓      |
39
| See a job log                         | ✓ [^3]  | ✓          | ✓           | ✓        | ✓      |
40 41 42 43
| Download and browse job artifacts     | ✓ [^3]  | ✓          | ✓           | ✓        | ✓      |
| View wiki pages                       | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
| Pull project code                     | [^1]    | ✓          | ✓           | ✓        | ✓      |
| Download project                      | [^1]    | ✓          | ✓           | ✓        | ✓      |
44 45
| Assign issues                         |         | ✓          | ✓           | ✓        | ✓      |
| Assign merge requests                 |         |            | ✓           | ✓        | ✓      |
46
| Label issues and merge requests       |         | ✓          | ✓           | ✓        | ✓      |
47 48 49 50 51 52
| Create code snippets                  |         | ✓          | ✓           | ✓        | ✓      |
| Manage issue tracker                  |         | ✓          | ✓           | ✓        | ✓      |
| Manage labels                         |         | ✓          | ✓           | ✓        | ✓      |
| See a commit status                   |         | ✓          | ✓           | ✓        | ✓      |
| See a container registry              |         | ✓          | ✓           | ✓        | ✓      |
| See environments                      |         | ✓          | ✓           | ✓        | ✓      |
53
| See a list of merge requests          |         | ✓          | ✓           | ✓        | ✓      |
54 55 56
| Manage related issues **[STARTER]**   |         | ✓          | ✓           | ✓        | ✓      |
| Lock issue discussions                |         | ✓          | ✓           | ✓        | ✓      |
| Lock merge request discussions        |         |            | ✓           | ✓        | ✓      |
57
| Create new environments               |         |            | ✓           | ✓        | ✓      |
58
| Stop environments                     |         |            | ✓           | ✓        | ✓      |
59
| Manage/Accept merge requests          |         |            | ✓           | ✓        | ✓      |
60 61 62 63 64 65 66
| 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                          |         |            | ✓           | ✓        | ✓      |
67
| Cancel and retry jobs                 |         |            | ✓           | ✓        | ✓      |
68 69 70
| Create or update commit status        |         |            | ✓           | ✓        | ✓      |
| Update a container registry           |         |            | ✓           | ✓        | ✓      |
| Remove a container registry image     |         |            | ✓           | ✓        | ✓      |
71
| Create/edit/delete project milestones |         |            | ✓           | ✓        | ✓      |
72
| Use environment terminals             |         |            |             | ✓        | ✓      |
73 74 75
| Add new team members                  |         |            |             | ✓        | ✓      |
| Push to protected branches            |         |            |             | ✓        | ✓      |
| Enable/disable branch protection      |         |            |             | ✓        | ✓      |
76
| Turn on/off protected branch push for devs|     |            |             | ✓        | ✓      |
77
| Enable/disable tag protections        |         |            |             | ✓        | ✓      |
78 79 80 81
| Rewrite/remove Git tags               |         |            |             | ✓        | ✓      |
| Edit project                          |         |            |             | ✓        | ✓      |
| Add deploy keys to project            |         |            |             | ✓        | ✓      |
| Configure project hooks               |         |            |             | ✓        | ✓      |
82
| Manage Runners                        |         |            |             | ✓        | ✓      |
83
| Manage job triggers                   |         |            |             | ✓        | ✓      |
84
| Manage variables                      |         |            |             | ✓        | ✓      |
85 86 87
| Manage GitLab Pages                   |         |            |             | ✓        | ✓      |
| Manage GitLab Pages domains and certificates |         |            |             | ✓        | ✓      |
| Remove GitLab Pages                   |         |            |             |          | ✓      |
88 89
| Manage clusters                       |         |            |             | ✓        | ✓      |
| Edit comments (posted by any user)    |         |            |             | ✓        | ✓      |
90 91 92
| Switch visibility level               |         |            |             |          | ✓      |
| Transfer project to another namespace |         |            |             |          | ✓      |
| Remove project                        |         |            |             |          | ✓      |
William Chia's avatar
William Chia committed
93
| Delete issues                         |         |            |             |          | ✓      |
94
| Remove pages                          |         |            |             |          | ✓      |
95 96
| Force push to protected branches [^4] |         |            |             |          |        |
| Remove protected branches [^4]        |         |            |             |          |        |
97
| View project Audit Events   |         |            |             | ✓        | ✓      |
98

99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
## Project features permissions

### Wiki and issues

Project features like wiki and issues can be hidden from users depending on
which visibility level you select on project settings.

- Disabled: disabled for everyone
- Only team members: only team members will see even if your project is public or internal
- Everyone with access: everyone can see depending on your project visibility level

### Protected branches

To prevent people from messing with history or pushing code without
review, we've created protected branches. Read through the documentation on
[protected branches](project/protected_branches.md)
to learn more.

Mark Chao's avatar
Mark Chao committed
117
Additionally, you can allow or forbid users with Maintainer and/or
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
Developer permissions to push to a protected branch. Read through the documentation on
[Allowed to Merge and Allowed to Push settings](project/protected_branches.md#using-the-allowed-to-merge-and-allowed-to-push-settings)
to learn more.

### Cycle Analytics permissions

Find the current permissions on the Cycle Analytics dashboard on
the [documentation on Cycle Analytics permissions](project/cycle_analytics.md#permissions).

### Issue Board permissions

Developers and users with higher permission level can use all
the functionality of the Issue Board, that is create/delete lists
and drag issues around. Read though the
[documentation on Issue Boards permissions](project/issue_board.md#permissions)
to learn more.

135
### File Locking permissions **[PREMIUM]**
136 137 138 139 140 141 142 143 144 145 146 147

The user that locks a file or directory is the only one that can edit and push their changes back to the repository where the locked objects are located.

Read through the documentation on [permissions for File Locking](https://docs.gitlab.com/ee/user/project/file_lock.html#permissions-on-file-locking) to learn more.

### Confidential Issues permissions

Confidential issues can be accessed by reporters and higher permission levels,
as well as by guest users that create a confidential issue. To learn more,
read through the documentation on [permissions and access to confidential issues](project/issues/confidential_issues.md#permissions-and-access-to-confidential-issues).

## Group members permissions
148 149 150 151 152

Any user can remove themselves from a group, unless they are the last Owner of
the group. The following table depicts the various user permission levels in a
group.

Mark Chao's avatar
Mark Chao committed
153
| Action                  | Guest | Reporter | Developer | Maintainer | Owner |
154 155 156
|-------------------------|-------|----------|-----------|--------|-------|
| Browse group            | ✓     | ✓        | ✓         | ✓      | ✓     |
| Edit group              |       |          |           |        | ✓     |
157
| Create subgroup         |       |          |           |        | ✓     |
158 159 160
| Create project in group |       |          |           | ✓      | ✓     |
| Manage group members    |       |          |           |        | ✓     |
| Remove group            |       |          |           |        | ✓     |
161
| Manage group labels     |       | ✓        | ✓         | ✓      | ✓     |
162
| Create/edit/delete group milestones | |    | ✓         | ✓      | ✓     |
163 164 165 166 167 168
| View private group epic **[ULTIMATE]** |         | ✓        | ✓         | ✓      | ✓     |
| View internal group epic **[ULTIMATE]** | ✓       | ✓        | ✓         | ✓      | ✓     |
| View public group epic **[ULTIMATE]**   | ✓       | ✓        | ✓         | ✓      | ✓     |
| Create/edit group epic **[ULTIMATE]**  |         | ✓        | ✓         | ✓      | ✓     |
| Delete group epic **[ULTIMATE]**       |         |          |           |        | ✓     |
| View group Audit Events  |         |          |           |        | ✓     |
169

170 171 172 173 174 175 176 177 178 179
### Subgroup permissions

When you add a member to a subgroup, they inherit the membership and
permission level from the parent group. This model allows access to
nested groups if you have membership in one of its parents.

To learn more, read through the documentation on
[subgroups memberships](group/subgroups/index.md#membership).

## External users permissions
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

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.

By default new users are not set as external users. This behavior can be changed
by an administrator under **Admin > Application Settings**.

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
## Auditor users **[PREMIUM ONLY]**

>[Introduced][ee-998] in [GitLab Premium][eep] 8.17.

Auditor users are given read-only access to all projects, groups, and other
resources on the GitLab instance.

An Auditor user should be able to access all projects and groups of a GitLab instance
with the permissions described on the documentation on [auditor users permissions](https://docs.gitlab.com/ee/administration/auditor_users.html#permissions-and-restrictions-of-an-auditor-user).

[Read more about Auditor users.](https://docs.gitlab.com/ee/administration/auditor_users.html)

## Project features

Project features like wiki and issues can be hidden from users depending on
which visibility level you select on project settings.

- Disabled: disabled for everyone
- Only team members: only team members will see even if your project is public or internal
- Everyone with access: everyone can see depending on your project visibility level

224
## GitLab CI/CD permissions
225

226
GitLab CI/CD permissions rely on the role the user has in GitLab. There are four
227
permission levels in total:
228 229

- admin
Mark Chao's avatar
doc  
Mark Chao committed
230
- maintainer
231 232 233
- developer
- guest/reporter

234
The admin user can perform any action on GitLab CI/CD in scope of the GitLab
235 236 237
instance and project. In addition, all admins can use the admin interface under
`/admin/runners`.

Mark Chao's avatar
Mark Chao committed
238
| Action                                | Guest, Reporter | Developer   |Maintainer| Admin  |
239
|---------------------------------------|-----------------|-------------|----------|--------|
240 241
| See commits and jobs                  | ✓               | ✓           | ✓        | ✓      |
| Retry or cancel job                   |                 | ✓           | ✓        | ✓      |
242
| Erase job artifacts and trace         |                 | ✓ [^5]      | ✓        | ✓      |
243 244 245 246 247 248 249
| Remove project                        |                 |             | ✓        | ✓      |
| Create project                        |                 |             | ✓        | ✓      |
| Change project configuration          |                 |             | ✓        | ✓      |
| Add specific runners                  |                 |             | ✓        | ✓      |
| Add shared runners                    |                 |             |          | ✓      |
| See events in the system              |                 |             |          | ✓      |
| Admin interface                       |                 |             |          | ✓      |
250

251
### Job permissions
252

253
>**Note:**
254
GitLab 8.12 has a completely redesigned job permissions system.
255
Read all about the [new model and its implications][new-mod].
256

257
This table shows granted privileges for jobs triggered by specific types of
258
users:
259

Mark Chao's avatar
Mark Chao committed
260
| Action                                      | Guest, Reporter | Developer   |Maintainer| Admin  |
261
|---------------------------------------------|-----------------|-------------|----------|--------|
262
| Run CI job                                  |                 | ✓           | ✓        | ✓      |
263
| Clone source and LFS from current project   |                 | ✓           | ✓        | ✓      |
Kamil Trzcinski's avatar
Kamil Trzcinski committed
264
| Clone source and LFS from public projects   |                 | ✓           | ✓        | ✓      |
265 266
| Clone source and LFS from internal projects |                 | ✓ [^6]      | ✓ [^6]   | ✓      |
| Clone source and LFS from private projects  |                 | ✓ [^7]      | ✓ [^7]   | ✓ [^7] |
Kamil Trzcinski's avatar
Kamil Trzcinski committed
267
| Push source and LFS                         |                 |             |          |        |
268
| Pull container images from current project  |                 | ✓           | ✓        | ✓      |
Kamil Trzcinski's avatar
Kamil Trzcinski committed
269
| Pull container images from public projects  |                 | ✓           | ✓        | ✓      |
270 271
| Pull container images from internal projects|                 | ✓ [^6]      | ✓ [^6]   | ✓      |
| Pull container images from private projects |                 | ✓ [^7]      | ✓ [^7]   | ✓ [^7] |
272 273 274
| Push container images to current project    |                 | ✓           | ✓        | ✓      |
| Push container images to other projects     |                 |             |          |        |

275 276 277 278 279
### New CI job permissions model

GitLab 8.12 has a completely redesigned job permissions system. To learn more,
read through the documentation on the [new CI/CD permissions model](project/new_ci_build_permissions_model.md#new-ci-job-permissions-model).

280 281 282 283 284 285 286 287
## Running pipelines on protected branches

The permission to merge or push to protected branches is used to define if a user can
run CI/CD pipelines and execute actions on jobs that are related to those branches.

See [Security on protected branches](../ci/pipelines.md#security-on-protected-branches)
for details about the pipelines security model.

288 289 290 291 292
## LDAP users permissions

Since GitLab 8.15, LDAP user permissions can now be manually overridden by an admin user.
Read through the documentation on [LDAP users permissions](https://docs.gitlab.com/ee/articles/how_to_configure_ldap_gitlab_ee/index.html#updating-user-permissions-new-feature) to learn more.

293
[^1]: On public and internal projects, all users are able to perform this action
294
[^2]: Guest users can only view the confidential issues they created themselves
295
[^3]: If **Public pipelines** is enabled in **Project Settings > CI/CD**
Mark Chao's avatar
Mark Chao committed
296
[^4]: Not allowed for Guest, Reporter, Developer, Maintainer, or Owner
297 298 299 300
[^5]: Only if the job was triggered by the user
[^6]: Only if user is not external one
[^7]: Only if user is a member of the project

301 302
[ce-18994]: https://gitlab.com/gitlab-org/gitlab-ce/issues/18994
[new-mod]: project/new_ci_build_permissions_model.md
303 304
[ee-998]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/998
[eep]: https://about.gitlab.com/products/