permissions.md 21.2 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
M
Marcia Ramos 已提交
12
be able to create issues, leave comments, and clone or download the project code.
13

M
Marcia Ramos 已提交
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.

M
Marcia Ramos 已提交
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

M
Marcia Ramos 已提交
26
## Project members permissions
27

28 29 30
NOTE: **Note:**
In GitLab 11.0, the Master role was renamed to Maintainer.

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

M
Mark Chao 已提交
33
| Action                                | Guest   | Reporter   | Developer   |Maintainer| Owner  |
34
|---------------------------------------|---------|------------|-------------|----------|--------|
35 36
| Create new issue                      | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
| Create confidential issue             | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
37
| View confidential issues              | (✓) [^2] | ✓         | ✓           | ✓        | ✓      |
38
| Leave comments                        | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
39 40
| Lock issue discussions                |         | ✓          | ✓           | ✓        | ✓      |
| Lock merge request discussions        |         |            | ✓           | ✓        | ✓      |
41
| See a list of jobs                    | ✓ [^3]  | ✓          | ✓           | ✓        | ✓      |
42
| See a job log                         | ✓ [^3]  | ✓          | ✓           | ✓        | ✓      |
43 44
| Download and browse job artifacts     | ✓ [^3]  | ✓          | ✓           | ✓        | ✓      |
| View wiki pages                       | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
45 46
| View license management reports **[ULTIMATE]** | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
| View Security reports **[ULTIMATE]**  | ✓ [^1]  | ✓          | ✓           | ✓        | ✓      |
47 48
| Pull project code                     | [^1]    | ✓          | ✓           | ✓        | ✓      |
| Download project                      | [^1]    | ✓          | ✓           | ✓        | ✓      |
49 50
| Assign issues                         |         | ✓          | ✓           | ✓        | ✓      |
| Assign merge requests                 |         |            | ✓           | ✓        | ✓      |
51 52
| Label issues                          |         | ✓          | ✓           | ✓        | ✓      |
| Label merge requests                  |         |            | ✓           | ✓        | ✓      |
53 54 55 56 57 58
| Create code snippets                  |         | ✓          | ✓           | ✓        | ✓      |
| Manage issue tracker                  |         | ✓          | ✓           | ✓        | ✓      |
| Manage labels                         |         | ✓          | ✓           | ✓        | ✓      |
| See a commit status                   |         | ✓          | ✓           | ✓        | ✓      |
| See a container registry              |         | ✓          | ✓           | ✓        | ✓      |
| See environments                      |         | ✓          | ✓           | ✓        | ✓      |
59
| See a list of merge requests          |         | ✓          | ✓           | ✓        | ✓      |
A
Achilleas Pipinellis 已提交
60 61
| Manage related issues **[STARTER]**   |         | ✓          | ✓           | ✓        | ✓      |
| Lock issue discussions                |         | ✓          | ✓           | ✓        | ✓      |
62
| Create issue from vulnerability **[ULTIMATE]** |         | ✓          | ✓           | ✓        | ✓      |
A
Achilleas Pipinellis 已提交
63
| Lock merge request discussions        |         |            | ✓           | ✓        | ✓      |
A
Achilleas Pipinellis 已提交
64
| Create new environments               |         |            | ✓           | ✓        | ✓      |
65
| Stop environments                     |         |            | ✓           | ✓        | ✓      |
66
| Manage/Accept merge requests          |         |            | ✓           | ✓        | ✓      |
67 68 69 70 71 72 73
| 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                          |         |            | ✓           | ✓        | ✓      |
74
| Cancel and retry jobs                 |         |            | ✓           | ✓        | ✓      |
75 76 77
| Create or update commit status        |         |            | ✓           | ✓        | ✓      |
| Update a container registry           |         |            | ✓           | ✓        | ✓      |
| Remove a container registry image     |         |            | ✓           | ✓        | ✓      |
78
| Create/edit/delete project milestones |         |            | ✓           | ✓        | ✓      |
79 80 81
| View approved/blacklisted licenses **[ULTIMATE]** |         |            | ✓           | ✓        | ✓      |
| Use security dashboard **[ULTIMATE]** |         |            | ✓           | ✓        | ✓      |
| Dismiss vulnerability **[ULTIMATE]**  |         |            | ✓           | ✓        | ✓      |
82
| Apply code change suggestions         |         |            | ✓           | ✓        | ✓      |
83
| Use environment terminals             |         |            |             | ✓        | ✓      |
84 85 86
| Add new team members                  |         |            |             | ✓        | ✓      |
| Push to protected branches            |         |            |             | ✓        | ✓      |
| Enable/disable branch protection      |         |            |             | ✓        | ✓      |
87
| Turn on/off protected branch push for devs|     |            |             | ✓        | ✓      |
88
| Enable/disable tag protections        |         |            |             | ✓        | ✓      |
89 90 91 92
| Rewrite/remove Git tags               |         |            |             | ✓        | ✓      |
| Edit project                          |         |            |             | ✓        | ✓      |
| Add deploy keys to project            |         |            |             | ✓        | ✓      |
| Configure project hooks               |         |            |             | ✓        | ✓      |
A
Achilleas Pipinellis 已提交
93
| Manage Runners                        |         |            |             | ✓        | ✓      |
94
| Manage job triggers                   |         |            |             | ✓        | ✓      |
95
| Manage variables                      |         |            |             | ✓        | ✓      |
A
Achilleas Pipinellis 已提交
96 97 98
| Manage GitLab Pages                   |         |            |             | ✓        | ✓      |
| Manage GitLab Pages domains and certificates |         |            |             | ✓        | ✓      |
| Remove GitLab Pages                   |         |            |             |          | ✓      |
99
| View GitLab Pages protected by [access control](project/pages/introduction.md#gitlab-pages-access-control-core-only) | ✓       | ✓          | ✓           | ✓        | ✓      |
100
| Manage clusters                       |         |            |             | ✓        | ✓      |
101
| Manage license policy **[ULTIMATE]**  |         |            |             | ✓        | ✓      |
102
| Edit comments (posted by any user)    |         |            |             | ✓        | ✓      |
103 104 105
| Switch visibility level               |         |            |             |          | ✓      |
| Transfer project to another namespace |         |            |             |          | ✓      |
| Remove project                        |         |            |             |          | ✓      |
W
William Chia 已提交
106
| Delete issues                         |         |            |             |          | ✓      |
107
| Remove pages                          |         |            |             |          | ✓      |
108 109
| Force push to protected branches [^4] |         |            |             |          |        |
| Remove protected branches [^4]        |         |            |             |          |        |
110
| View project Audit Events             |         |            |             | ✓        | ✓      |
111

M
Marcia Ramos 已提交
112 113 114 115 116 117 118 119 120 121
## 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
122
- Everyone: enabled for everyone (only available for GitLab Pages)
M
Marcia Ramos 已提交
123 124 125 126 127 128 129 130

### 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.

M
Mark Chao 已提交
131
Additionally, you can allow or forbid users with Maintainer and/or
M
Marcia Ramos 已提交
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
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.

A
Achilleas Pipinellis 已提交
149
### File Locking permissions **[PREMIUM]**
M
Marcia Ramos 已提交
150 151 152 153 154 155 156 157 158 159 160 161

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
162

163 164 165
NOTE: **Note:**
In GitLab 11.0, the Master role was renamed to Maintainer.

166 167 168 169
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.

M
Mark Chao 已提交
170
| Action                  | Guest | Reporter | Developer | Maintainer | Owner |
171 172 173
|-------------------------|-------|----------|-----------|--------|-------|
| Browse group            | ✓     | ✓        | ✓         | ✓      | ✓     |
| Edit group              |       |          |           |        | ✓     |
174
| Create subgroup         |       |          |           |        | ✓     |
175 176 177
| Create project in group |       |          |           | ✓      | ✓     |
| Manage group members    |       |          |           |        | ✓     |
| Remove group            |       |          |           |        | ✓     |
V
Victor Wu 已提交
178
| Manage group labels     |       | ✓        | ✓         | ✓      | ✓     |
179
| Create/edit/delete group milestones | |    | ✓         | ✓      | ✓     |
A
Achilleas Pipinellis 已提交
180 181 182 183 184 185
| 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  |         |          |           |        | ✓     |
186

M
Marcia Ramos 已提交
187 188 189 190 191 192 193 194 195 196
### 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
197 198 199 200 201 202 203 204 205 206 207 208 209 210

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.
211

212 213 214 215 216 217 218 219
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**.

220 221
### Default internal users

222
The "Internal users" field allows specifying an e-mail address regex pattern to identify default internal users.
223 224 225 226 227 228 229 230 231 232 233 234

New users whose email address matches the regex pattern will be set to internal by default rather than an external collaborator.

The regex pattern format is Ruby, but it needs to be convertible to JavaScript, and the ignore case flag will be set, e.g. "/regex pattern/i".

Here are some examples:

- Use `\.internal@domain\.com` to mark email addresses containing ".internal@domain.com" internal.
- Use `^(?:(?!\.ext@domain\.com).)*$\r?` to mark users with email addresses NOT including .ext@domain.com internal.

Please be aware that this regex could lead to a DOS attack, [see](https://en.wikipedia.org/wiki/ReDoS?) ReDos on Wikipedia.

A
Achilleas Pipinellis 已提交
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
## 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
255
- Everyone: enabled for everyone (only available for GitLab Pages)
A
Achilleas Pipinellis 已提交
256

M
Marcia Ramos 已提交
257
## GitLab CI/CD permissions
258

259 260 261
NOTE: **Note:**
In GitLab 11.0, the Master role was renamed to Maintainer.

M
Marcia Ramos 已提交
262
GitLab CI/CD permissions rely on the role the user has in GitLab. There are four
263
permission levels in total:
264 265

- admin
M
doc  
Mark Chao 已提交
266
- maintainer
267 268 269
- developer
- guest/reporter

M
Marcia Ramos 已提交
270
The admin user can perform any action on GitLab CI/CD in scope of the GitLab
271 272 273
instance and project. In addition, all admins can use the admin interface under
`/admin/runners`.

M
Mark Chao 已提交
274
| Action                                | Guest, Reporter | Developer   |Maintainer| Admin  |
275
|---------------------------------------|-----------------|-------------|----------|--------|
276 277
| See commits and jobs                  | ✓               | ✓           | ✓        | ✓      |
| Retry or cancel job                   |                 | ✓           | ✓        | ✓      |
278
| Erase job artifacts and trace         |                 | ✓ [^5]      | ✓        | ✓      |
279 280 281 282 283 284 285
| Remove project                        |                 |             | ✓        | ✓      |
| Create project                        |                 |             | ✓        | ✓      |
| Change project configuration          |                 |             | ✓        | ✓      |
| Add specific runners                  |                 |             | ✓        | ✓      |
| Add shared runners                    |                 |             |          | ✓      |
| See events in the system              |                 |             |          | ✓      |
| Admin interface                       |                 |             |          | ✓      |
286

M
Marcia Ramos 已提交
287
### Job permissions
288

289 290 291
NOTE: **Note:**
In GitLab 11.0, the Master role was renamed to Maintainer.

292
>**Note:**
293
GitLab 8.12 has a completely redesigned job permissions system.
294
Read all about the [new model and its implications][new-mod].
295

296
This table shows granted privileges for jobs triggered by specific types of
297
users:
298

M
Mark Chao 已提交
299
| Action                                      | Guest, Reporter | Developer   |Maintainer| Admin  |
300
|---------------------------------------------|-----------------|-------------|----------|--------|
301
| Run CI job                                  |                 | ✓           | ✓        | ✓      |
302
| Clone source and LFS from current project   |                 | ✓           | ✓        | ✓      |
K
Kamil Trzcinski 已提交
303
| Clone source and LFS from public projects   |                 | ✓           | ✓        | ✓      |
304 305
| Clone source and LFS from internal projects |                 | ✓ [^6]      | ✓ [^6]   | ✓      |
| Clone source and LFS from private projects  |                 | ✓ [^7]      | ✓ [^7]   | ✓ [^7] |
K
Kamil Trzcinski 已提交
306
| Push source and LFS                         |                 |             |          |        |
307
| Pull container images from current project  |                 | ✓           | ✓        | ✓      |
K
Kamil Trzcinski 已提交
308
| Pull container images from public projects  |                 | ✓           | ✓        | ✓      |
309 310
| Pull container images from internal projects|                 | ✓ [^6]      | ✓ [^6]   | ✓      |
| Pull container images from private projects |                 | ✓ [^7]      | ✓ [^7]   | ✓ [^7] |
311 312 313
| Push container images to current project    |                 | ✓           | ✓        | ✓      |
| Push container images to other projects     |                 |             |          |        |

M
Marcia Ramos 已提交
314 315 316 317 318
### 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).

319 320 321 322 323 324 325 326
## 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.

M
Marcia Ramos 已提交
327 328 329 330 331
## 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.

332
[^1]: On public and internal projects, all users are able to perform this action
333
[^2]: Guest users can only view the confidential issues they created themselves
334
[^3]: If **Public pipelines** is enabled in **Project Settings > CI/CD**
M
Mark Chao 已提交
335
[^4]: Not allowed for Guest, Reporter, Developer, Maintainer, or Owner
336 337 338 339
[^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

340 341
[ce-18994]: https://gitlab.com/gitlab-org/gitlab-ce/issues/18994
[new-mod]: project/new_ci_build_permissions_model.md
A
Achilleas Pipinellis 已提交
342
[ee-998]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/998
343
[eep]: https://about.gitlab.com/pricing/