permissions.md 17.1 KB
Newer Older
1 2 3 4 5 6 7
# 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
8
be able to create issues, leave comments, and clone or download the project code.
9

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

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

15 16
To add or import a user, you can follow the
[project members documentation](../user/project/members/index.md).
17

18
## Principles behind permissions
19

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

22
## Project members permissions
23 24 25 26 27

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

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

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
## 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.

Additionally, you can allow or forbid users with Master and/or
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.

125 126 127
### File Locking permissions

> Available in [GitLab Premium](https://about.gitlab.com/products/).
128 129 130 131 132 133

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.

File Locking is available in
134
[GitLab Premium](https://about.gitlab.com/products/) only.
135 136 137 138 139 140 141 142

### 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
143 144 145 146 147 148 149 150 151

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.

| Action                  | Guest | Reporter | Developer | Master | Owner |
|-------------------------|-------|----------|-----------|--------|-------|
| Browse group            | ✓     | ✓        | ✓         | ✓      | ✓     |
| Edit group              |       |          |           |        | ✓     |
152
| Create subgroup         |       |          |           |        | ✓     |
153 154 155
| Create project in group |       |          |           | ✓      | ✓     |
| Manage group members    |       |          |           |        | ✓     |
| Remove group            |       |          |           |        | ✓     |
156
| Manage group labels     |       | ✓        | ✓         | ✓      | ✓     |
157
| Create/edit/delete group milestones | |    | ✓         | ✓      | ✓     |
158

159 160 161 162 163 164 165 166 167 168
### 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
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191

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

192
## GitLab CI/CD permissions
193

194
GitLab CI/CD permissions rely on the role the user has in GitLab. There are four
195
permission levels in total:
196 197 198 199 200 201

- admin
- master
- developer
- guest/reporter

202
The admin user can perform any action on GitLab CI/CD in scope of the GitLab
203 204 205 206 207
instance and project. In addition, all admins can use the admin interface under
`/admin/runners`.

| Action                                | Guest, Reporter | Developer   | Master   | Admin  |
|---------------------------------------|-----------------|-------------|----------|--------|
208 209
| See commits and jobs                  | ✓               | ✓           | ✓        | ✓      |
| Retry or cancel job                   |                 | ✓           | ✓        | ✓      |
210
| Erase job artifacts and trace         |                 | ✓ [^5]      | ✓        | ✓      |
211 212 213 214 215 216 217
| Remove project                        |                 |             | ✓        | ✓      |
| Create project                        |                 |             | ✓        | ✓      |
| Change project configuration          |                 |             | ✓        | ✓      |
| Add specific runners                  |                 |             | ✓        | ✓      |
| Add shared runners                    |                 |             |          | ✓      |
| See events in the system              |                 |             |          | ✓      |
| Admin interface                       |                 |             |          | ✓      |
218

219
### Job permissions
220

221
>**Note:**
222
GitLab 8.12 has a completely redesigned job permissions system.
223
Read all about the [new model and its implications][new-mod].
224

225
This table shows granted privileges for jobs triggered by specific types of
226
users:
227 228 229

| Action                                      | Guest, Reporter | Developer   | Master   | Admin  |
|---------------------------------------------|-----------------|-------------|----------|--------|
230
| Run CI job                                  |                 | ✓           | ✓        | ✓      |
231
| Clone source and LFS from current project   |                 | ✓           | ✓        | ✓      |
232
| Clone source and LFS from public projects   |                 | ✓           | ✓        | ✓      |
233 234
| Clone source and LFS from internal projects |                 | ✓ [^6]      | ✓ [^6]   | ✓      |
| Clone source and LFS from private projects  |                 | ✓ [^7]      | ✓ [^7]   | ✓ [^7] |
235
| Push source and LFS                         |                 |             |          |        |
236
| Pull container images from current project  |                 | ✓           | ✓        | ✓      |
237
| Pull container images from public projects  |                 | ✓           | ✓        | ✓      |
238 239
| Pull container images from internal projects|                 | ✓ [^6]      | ✓ [^6]   | ✓      |
| Pull container images from private projects |                 | ✓ [^7]      | ✓ [^7]   | ✓ [^7] |
240 241 242
| Push container images to current project    |                 | ✓           | ✓        | ✓      |
| Push container images to other projects     |                 |             |          |        |

243 244 245 246 247
### 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).

248 249 250 251 252 253 254 255
## 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.

256 257 258 259 260
## 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.

261 262 263
## Auditor users permissions

> Available in [GitLab Premium](https://about.gitlab.com/products/).
264 265 266 267

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

268
Auditor users are available in [GitLab Premium](https://about.gitlab.com/products/)
269 270
only.

271
[^1]: On public and internal projects, all users are able to perform this action
272
[^2]: Guest users can only view the confidential issues they created themselves
273
[^3]: If **Public pipelines** is enabled in **Project Settings > CI/CD**
274
[^4]: Not allowed for Guest, Reporter, Developer, Master, or Owner
275 276 277 278
[^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

279 280
[ce-18994]: https://gitlab.com/gitlab-org/gitlab-ce/issues/18994
[new-mod]: project/new_ci_build_permissions_model.md