permissions.md 22.1 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](../administration/index.md) 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 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.

Mark Chao's avatar
Mark Chao committed
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
| View project code                     | [^1]    | ✓          | ✓           | ✓        | ✓      |
48 49
| Pull project code                     | [^1]    | ✓          | ✓           | ✓        | ✓      |
| Download project                      | [^1]    | ✓          | ✓           | ✓        | ✓      |
50 51
| Assign issues                         |         | ✓          | ✓           | ✓        | ✓      |
| Assign merge requests                 |         |            | ✓           | ✓        | ✓      |
52 53
| Label issues                          |         | ✓          | ✓           | ✓        | ✓      |
| Label merge requests                  |         |            | ✓           | ✓        | ✓      |
54 55 56 57 58 59
| Create code snippets                  |         | ✓          | ✓           | ✓        | ✓      |
| Manage issue tracker                  |         | ✓          | ✓           | ✓        | ✓      |
| Manage labels                         |         | ✓          | ✓           | ✓        | ✓      |
| See a commit status                   |         | ✓          | ✓           | ✓        | ✓      |
| See a container registry              |         | ✓          | ✓           | ✓        | ✓      |
| See environments                      |         | ✓          | ✓           | ✓        | ✓      |
60
| See a list of merge requests          |         | ✓          | ✓           | ✓        | ✓      |
61 62
| Manage related issues **[STARTER]**   |         | ✓          | ✓           | ✓        | ✓      |
| Lock issue discussions                |         | ✓          | ✓           | ✓        | ✓      |
63
| Create issue from vulnerability **[ULTIMATE]** |         | ✓          | ✓           | ✓        | ✓      |
64
| View Error Tracking list              |         | ✓          | ✓           | ✓        | ✓      |
65 66
| Pull from [Maven repository](https://docs.gitlab.com/ee/user/project/packages/maven_repository.html) or [NPM registry](https://docs.gitlab.com/ee/user/project/packages/npm_registry.html) **[PREMIUM]** |         | ✓          | ✓           | ✓        | ✓      |
| Publish to [Maven repository](https://docs.gitlab.com/ee/user/project/packages/maven_repository.html) or [NPM registry](https://docs.gitlab.com/ee/user/project/packages/npm_registry.html) **[PREMIUM]** |         |            | ✓           | ✓        | ✓      |
67
| Lock merge request discussions        |         |            | ✓           | ✓        | ✓      |
68
| Create new environments               |         |            | ✓           | ✓        | ✓      |
69
| Stop environments                     |         |            | ✓           | ✓        | ✓      |
70
| Manage/Accept merge requests          |         |            | ✓           | ✓        | ✓      |
71 72 73 74 75 76 77
| 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                          |         |            | ✓           | ✓        | ✓      |
78
| Cancel and retry jobs                 |         |            | ✓           | ✓        | ✓      |
79 80 81
| Create or update commit status        |         |            | ✓           | ✓        | ✓      |
| Update a container registry           |         |            | ✓           | ✓        | ✓      |
| Remove a container registry image     |         |            | ✓           | ✓        | ✓      |
82
| Create/edit/delete project milestones |         |            | ✓           | ✓        | ✓      |
83 84 85
| View approved/blacklisted licenses **[ULTIMATE]** |         |            | ✓           | ✓        | ✓      |
| Use security dashboard **[ULTIMATE]** |         |            | ✓           | ✓        | ✓      |
| Dismiss vulnerability **[ULTIMATE]**  |         |            | ✓           | ✓        | ✓      |
86
| Apply code change suggestions         |         |            | ✓           | ✓        | ✓      |
87
| Use environment terminals             |         |            |             | ✓        | ✓      |
88 89 90
| Add new team members                  |         |            |             | ✓        | ✓      |
| Push to protected branches            |         |            |             | ✓        | ✓      |
| Enable/disable branch protection      |         |            |             | ✓        | ✓      |
91
| Turn on/off protected branch push for devs|     |            |             | ✓        | ✓      |
92
| Enable/disable tag protections        |         |            |             | ✓        | ✓      |
93 94 95 96
| Rewrite/remove Git tags               |         |            |             | ✓        | ✓      |
| Edit project                          |         |            |             | ✓        | ✓      |
| Add deploy keys to project            |         |            |             | ✓        | ✓      |
| Configure project hooks               |         |            |             | ✓        | ✓      |
97
| Manage Runners                        |         |            |             | ✓        | ✓      |
98
| Manage job triggers                   |         |            |             | ✓        | ✓      |
99
| Manage variables                      |         |            |             | ✓        | ✓      |
100 101
| Manage GitLab Pages                   |         |            |             | ✓        | ✓      |
| Manage GitLab Pages domains and certificates |         |            |             | ✓        | ✓      |
102
| Remove GitLab Pages                   |         |            |             | ✓        | ✓      |
103
| View GitLab Pages protected by [access control](project/pages/introduction.md#gitlab-pages-access-control-core-only) | ✓       | ✓          | ✓           | ✓        | ✓      |
104
| Manage clusters                       |         |            |             | ✓        | ✓      |
105
| Manage license policy **[ULTIMATE]**  |         |            |             | ✓        | ✓      |
106
| Edit comments (posted by any user)    |         |            |             | ✓        | ✓      |
107
| Manage Error Tracking                 |         |            |             | ✓        | ✓      |
108 109 110
| Switch visibility level               |         |            |             |          | ✓      |
| Transfer project to another namespace |         |            |             |          | ✓      |
| Remove project                        |         |            |             |          | ✓      |
William Chia's avatar
William Chia committed
111
| Delete issues                         |         |            |             |          | ✓      |
112 113
| Force push to protected branches [^4] |         |            |             |          |        |
| Remove protected branches [^4]        |         |            |             |          |        |
114
| View project Audit Events             |         |            |             | ✓        | ✓      |
115
| View project statistics               |         |            |             | ✓        | ✓      |
116

117 118 119 120 121 122 123 124 125 126
## 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
127
- Everyone: enabled for everyone (only available for GitLab Pages)
128 129 130 131 132 133 134 135

### 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
136
Additionally, you can allow or forbid users with Maintainer and/or
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
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.

154
### File Locking permissions **[PREMIUM]**
155 156 157 158 159 160 161 162 163 164 165

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

166 167 168 169 170 171 172
### Releases permissions

[Project Releases](project/releases/index.md) can be read by all project
members (Reporters, Developers, Maintainers, Owners) **except Guests**.
Releases can be created, updated, or deleted via [Releases APIs](../api/releases/index.md)
by project Developers, Maintainers, and Owners.

173
## Group members permissions
174

175 176 177
NOTE: **Note:**
In GitLab 11.0, the Master role was renamed to Maintainer.

178 179 180 181
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
182
| Action                  | Guest | Reporter | Developer | Maintainer | Owner |
183 184 185
|-------------------------|-------|----------|-----------|--------|-------|
| Browse group            | ✓     | ✓        | ✓         | ✓      | ✓     |
| Edit group              |       |          |           |        | ✓     |
186
| Create subgroup         |       |          |           |        | ✓     |
187
| Create project in group |       |          |  ✓         | ✓      | ✓     |
188 189
| Manage group members    |       |          |           |        | ✓     |
| Remove group            |       |          |           |        | ✓     |
190
| Manage group labels     |       | ✓        | ✓         | ✓      | ✓     |
191
| Create/edit/delete group milestones | |    | ✓         | ✓      | ✓     |
Victor Wu's avatar
Victor Wu committed
192
| View group epic **[ULTIMATE]**   | ✓       | ✓        | ✓         | ✓      | ✓     |
193 194 195
| Create/edit group epic **[ULTIMATE]**  |         | ✓        | ✓         | ✓      | ✓     |
| Delete group epic **[ULTIMATE]**       |         |          |           |        | ✓     |
| View group Audit Events  |         |          |           |        | ✓     |
196

197 198 199 200 201 202 203 204 205 206
### 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
207 208 209 210 211 212 213 214 215 216 217 218 219 220

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

222 223 224 225 226 227 228 229
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**.

230 231
### Default internal users

232
The "Internal users" field allows specifying an e-mail address regex pattern to identify default internal users.
233 234 235 236 237 238 239 240 241 242 243 244

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.

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
## 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
265
- Everyone: enabled for everyone (only available for GitLab Pages)
266

267
## GitLab CI/CD permissions
268

269 270 271
NOTE: **Note:**
In GitLab 11.0, the Master role was renamed to Maintainer.

272
GitLab CI/CD permissions rely on the role the user has in GitLab. There are four
273
permission levels in total:
274 275

- admin
Mark Chao's avatar
Mark Chao committed
276
- maintainer
277 278 279
- developer
- guest/reporter

280
The admin user can perform any action on GitLab CI/CD in scope of the GitLab
281 282 283
instance and project. In addition, all admins can use the admin interface under
`/admin/runners`.

Mark Chao's avatar
Mark Chao committed
284
| Action                                | Guest, Reporter | Developer   |Maintainer| Admin  |
285
|---------------------------------------|-----------------|-------------|----------|--------|
286 287
| See commits and jobs                  | ✓               | ✓           | ✓        | ✓      |
| Retry or cancel job                   |                 | ✓           | ✓        | ✓      |
288
| Erase job artifacts and trace         |                 | ✓ [^5]      | ✓        | ✓      |
289 290 291 292 293 294 295
| Remove project                        |                 |             | ✓        | ✓      |
| Create project                        |                 |             | ✓        | ✓      |
| Change project configuration          |                 |             | ✓        | ✓      |
| Add specific runners                  |                 |             | ✓        | ✓      |
| Add shared runners                    |                 |             |          | ✓      |
| See events in the system              |                 |             |          | ✓      |
| Admin interface                       |                 |             |          | ✓      |
296

297
### Job permissions
298

299 300 301
NOTE: **Note:**
In GitLab 11.0, the Master role was renamed to Maintainer.

302
>**Note:**
303
GitLab 8.12 has a completely redesigned job permissions system.
304
Read all about the [new model and its implications][new-mod].
305

306
This table shows granted privileges for jobs triggered by specific types of
307
users:
308

Mark Chao's avatar
Mark Chao committed
309
| Action                                      | Guest, Reporter | Developer   |Maintainer| Admin  |
310
|---------------------------------------------|-----------------|-------------|----------|--------|
311
| Run CI job                                  |                 | ✓           | ✓        | ✓      |
312
| Clone source and LFS from current project   |                 | ✓           | ✓        | ✓      |
313
| Clone source and LFS from public projects   |                 | ✓           | ✓        | ✓      |
314 315
| Clone source and LFS from internal projects |                 | ✓ [^6]      | ✓ [^6]   | ✓      |
| Clone source and LFS from private projects  |                 | ✓ [^7]      | ✓ [^7]   | ✓ [^7] |
316
| Push source and LFS                         |                 |             |          |        |
317
| Pull container images from current project  |                 | ✓           | ✓        | ✓      |
318
| Pull container images from public projects  |                 | ✓           | ✓        | ✓      |
319 320
| Pull container images from internal projects|                 | ✓ [^6]      | ✓ [^6]   | ✓      |
| Pull container images from private projects |                 | ✓ [^7]      | ✓ [^7]   | ✓ [^7] |
321 322 323
| Push container images to current project    |                 | ✓           | ✓        | ✓      |
| Push container images to other projects     |                 |             |          |        |

324 325 326 327 328
### 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).

329 330 331 332 333 334 335 336
## 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.

337 338 339 340 341
## 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.

342
[^1]: On public and internal projects, all users are able to perform this action
343
[^2]: Guest users can only view the confidential issues they created themselves
344
[^3]: If **Public pipelines** is enabled in **Project Settings > CI/CD**
Mark Chao's avatar
Mark Chao committed
345
[^4]: Not allowed for Guest, Reporter, Developer, Maintainer, or Owner
346 347 348 349
[^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

350 351
[ce-18994]: https://gitlab.com/gitlab-org/gitlab-ce/issues/18994
[new-mod]: project/new_ci_build_permissions_model.md
352
[ee-998]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/998
353
[eep]: https://about.gitlab.com/pricing/