url
stringlengths 24
122
| repo_url
stringlengths 60
156
| date_extracted
stringdate 2025-08-13 00:00:00
2025-08-13 00:00:00
| root
stringlengths 3
85
| breadcrumbs
listlengths 1
6
| filename
stringlengths 6
60
| stage
stringclasses 33
values | group
stringclasses 81
values | info
stringclasses 22
values | title
stringlengths 3
110
⌀ | description
stringlengths 11
359
⌀ | clean_text
stringlengths 47
3.32M
| rich_text
stringlengths 321
3.32M
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|
https://docs.gitlab.com/user/access_and_permissions
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/access_and_permissions.md
|
2025-08-13
|
doc/user/group
|
[
"doc",
"user",
"group"
] |
access_and_permissions.md
|
Tenant Scale
|
Organizations
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Group access and permissions
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Configure your groups to control group permissions and access.
For more information, see also [Sharing projects and groups](../project/members/sharing_projects_groups.md).
## Group push rules
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Moved to Settings/Repository](https://gitlab.com/gitlab-org/gitlab/-/issues/220365) in GitLab 15.4.
{{< /history >}}
Group push rules allow group maintainers to set
[push rules](../project/repository/push_rules.md) for newly created projects in the specific group.
To configure push rules for a group:
1. On the left sidebar, select **Settings > Repository**.
1. Expand the **Pre-defined push rules** section.
1. Select the settings you want.
1. Select **Save push rules**.
The group's new subgroups have push rules set for them based on either:
- The closest parent group with push rules defined.
- Push rules set for the entire instance, if no parent groups have push rules defined.
## Restrict Git access protocols
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/365601) in GitLab 15.1.
- [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/365357) in GitLab 16.0.
{{< /history >}}
You can set the permitted protocols used to access a group's repositories to either SSH, HTTPS, or both. This setting
is disabled when the [instance setting](../../administration/settings/visibility_and_access_controls.md#configure-enabled-git-access-protocols) is
configured by an administrator.
To change the permitted Git access protocols for a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Choose the permitted protocols from **Enabled Git access protocols**.
1. Select **Save changes**.
## Restrict group access by IP address
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To ensure only people from your organization can access particular resources, you can restrict access to groups by IP
address. This top-level group setting applies to:
- The GitLab UI, including subgroups, projects, and issues. It does not apply to GitLab Pages.
- The API.
- On GitLab Self-Managed you can also configure
[globally-allowed IP address ranges](../../administration/settings/visibility_and_access_controls.md#configure-globally-allowed-ip-address-ranges)
for the group.
Administrators can combine restricted access by IP address with
[globally-allowed IP addresses](../../administration/settings/visibility_and_access_controls.md#configure-globally-allowed-ip-address-ranges).
{{< alert type="warning" >}}
IP restriction requires proper configuration of the `X-Forwarded-For` header. To limit the risk
of IP spoofing, you must overwrite, and not append, any `X-Forwarded-For` headers sent by clients.
For deployments without an upstream proxy or load balancer, configure the server that receives direct
requests from users to preserve the original client IP address and overwrite any `X-Forwarded-For` headers.
In NGINX, for example, modify your configuration file to include:
```plaintext
proxy_set_header X-Forwarded-For $remote_addr;
```
For deployments with an upstream proxy or load balancer, configure the proxy or load balancer to
preserve the original client IP address and overwrite any `X-Forwarded-For` headers. This approach ensures that
GitLab receives the full chain of IPs, starting from the original client, and can correctly evaluate
the IP restrictions. In NGINX, for example, modify your configuration file to include:
```plaintext
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
```
{{< /alert >}}
To restrict group access by IP address:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. In the **Restrict access by IP address** text box, enter a list of IPv4 or IPv6
address ranges in CIDR notation. This list:
- Has no limit on the number of IP address ranges.
- Applies to both SSH or HTTP authorized IP address ranges. You cannot split
this list by type of authorization.
1. Select **Save changes**.
### Security implications
Keep in mind that restricting group access by IP address has the following implications:
- Administrators and group Owners can access group settings from any IP address, regardless of IP restriction. However:
- Group Owners can access the subgroups, but not the projects belonging to the group or subgroups, when accessing from a disallowed IP address.
- Administrators can access projects belonging to the group when accessing from a disallowed IP address.
Access to projects includes cloning code from them.
- Users can still see group and project names and hierarchies. Only the following are restricted:
- [Groups](../../api/groups.md), including all [group resources](../../api/api_resources.md#group-resources).
- [Project](../../api/projects.md), including all [project resources](../../api/api_resources.md#project-resources).
- When you register a runner, it is not bound by the IP restrictions. When the runner requests a new job or an update to
a job's state, it is also not bound by the IP restrictions. But when the running CI/CD job sends Git requests from a
restricted IP address, the IP restriction prevents code from being cloned.
- Users might still see some events from the IP-restricted groups and projects on their dashboard. Activity might include
push, merge, issue, or comment events.
- IP access restrictions do not stop users from using the [reply by email feature](../../administration/reply_by_email.md) to create or edit comments on issues or merge requests.
- IP access restrictions for Git operations through SSH are supported on GitLab SaaS.
IP access restrictions applied to GitLab Self-Managed instances are possible with [`gitlab-sshd`](../../administration/operations/gitlab_sshd.md)
with [PROXY protocol](../../administration/operations/gitlab_sshd.md#proxy-protocol-support) enabled.
- IP restriction is not applicable to shared resources belonging to a group. Any shared resource is accessible to a user even if that user is not able to access the group.
- While IP restrictions apply to public projects, they aren't a complete firewall and cached files for a project may still be accessible to users not in the IP block
### GitLab.com access restrictions
IP address-based group access restriction doesn't work with [hosted runners for GitLab.com](../../ci/runners/hosted_runners/_index.md).
These runners operate as ephemeral virtual machines with [dynamic IP addresses](../gitlab_com/_index.md#ip-range) from large
cloud provider pools (AWS, Google Cloud). To allow these broad IP ranges defeat the purpose of IP address-based access restriction.
## Restrict group access by domain
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Support for restricting group memberships to groups with a subset of the allowed email domains [added](https://gitlab.com/gitlab-org/gitlab/-/issues/354791) in GitLab 15.1.1
{{< /history >}}
You can define an email domain allowlist at the top-level namespace to restrict which users can
access a group and its projects. A user's primary email domain must match an entry in the allowlist
to access that group. Subgroups inherit the same allowlist.
To restrict group access by domain:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. In the **Restrict membership by email** field, enter the domain names to allow.
1. Select **Save changes**.
The next time you attempt to add a user to the group, their [primary email](../profile/_index.md#change-your-primary-email)
must match one of the allowed domains.
You cannot restrict the most popular public email domains, such as:
- `aol.com`, `gmail.com`, `hotmail.co.uk`, `hotmail.com`,
- `hotmail.fr`, `icloud.com`, `live.com`, `mail.com`,
- `me.com`, `msn.com`, `outlook.com`,
- `proton.me`, `protonmail.com`, `tutanota.com`,
- `yahoo.com`, `yandex.com`, `zohomail.com`
When you share a group, both the source and target namespaces must allow the domains of the members' email addresses.
{{< alert type="note" >}}
Removing a domain from the **Restrict membership by email** list does not remove existing users with that domain from the group or its projects.
Also, if you share a group or project with another group, the target group can add more email domains to its list that are not in the list of the source group.
Hence, this feature does not ensure that the current members always conform to the **Restrict membership by email** list.
{{< /alert >}}
## Prevent users from requesting access to a group
As a group Owner, you can prevent non-members from requesting access to
your group.
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Clear the **Allow users to request access** checkbox.
1. Select **Save changes**.
## Prevent project forking outside group
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
By default, projects in a group can be forked.
However, you can prevent the projects in a group from being forked outside of the current top-level group.
{{< alert type="note" >}}
Prevent forking outside the top-level group when possible to reduce potential avenues for bad actors.
However, if you expect a lot of external collaboration, allowing forks outside the top-level group might be unavoidable.
{{< /alert >}}
Prerequisites:
- This setting is enabled on the top-level group only.
- All subgroups inherit this setting from the top-level group, and it cannot be
changed at the subgroup level.
To prevent projects from being forked outside the group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Check **Prevent project forking outside current group**.
1. Select **Save changes**.
Existing forks are not removed.
## Prevent members from being added to projects in a group
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
As a group Owner, you can prevent any new project membership for all
projects in a group, allowing tighter control over project membership.
For example, if you want to lock the group for an [audit event](../../administration/compliance/audit_event_reports.md),
you can guarantee that project membership cannot be modified during the audit.
If group membership lock is enabled, the group Owner can still:
- Invite groups or add members to groups to give them access to projects in the **locked** group.
- Change the role of group members.
The setting does not cascade. Projects in subgroups observe the subgroup configuration, ignoring the parent group.
To prevent members from being added to projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Under **Membership**, select **Users cannot be added to projects in this group**.
1. Select **Save changes**.
After you lock the membership for a group:
- All users who previously had permissions can no longer add members to a group.
- API requests to add a new user to a project are not possible.
## Manage group memberships with LDAP
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- Support for custom roles for users synced in groups [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/435229) in GitLab 17.2.
{{< /history >}}
Group syncing allows LDAP groups to be mapped to GitLab groups. This provides more control over per-group user management. To configure group syncing, edit the `group_base` **DN** (`'OU=Global Groups,OU=GitLab INT,DC=GitLab,DC=org'`). This **OU** contains all groups that are associated with GitLab groups.
Group links can be created by using either a CN or a filter. To create these group links, go to the group's **Settings > LDAP Synchronization** page. After configuring the link, it may take more than an hour for the users to sync with the GitLab group. After you have configured the link:
- In GitLab 16.7 and earlier, group Owners cannot add members to or remove members from the group. The LDAP server is considered the single source of truth for group membership for all users who have signed in with LDAP credentials.
- In GitLab 16.8 and later, group Owners can use the [member roles API](../../api/member_roles.md) or [group members API](../../api/members.md#add-a-member-to-a-group-or-project) to add a service account user to or remove a service account user from the group, even when LDAP synchronization is enabled for the group. Group Owners cannot add or remove non-service account users.
When a user belongs to two LDAP groups configured for the same GitLab group, GitLab assigns them the
higher of the two associated roles.
For example:
- User is a member of LDAP groups `Owner` and `Dev`.
- The GitLab Group is configured with these two LDAP groups.
- When group sync is completed, the user is granted the Owner role as this is the higher of the two LDAP group roles.
For more information on the administration of LDAP and group sync, refer to the [main LDAP documentation](../../administration/auth/ldap/ldap_synchronization.md#group-sync).
{{< alert type="note" >}}
When you add LDAP group syncing, if an LDAP user is a group member and they are not part of the LDAP group, they are removed from the group.
{{< /alert >}}
You can use a workaround to [manage project access through LDAP groups](../project/working_with_projects.md#manage-project-access-through-ldap-groups).
### Create group links with a CN
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To create group links with LDAP group CN:
<!-- vale gitlab_base.Spelling = NO -->
1. Select the **LDAP Server** for the link.
1. As the **Sync method**, select `LDAP Group cn`.
1. In the **LDAP Group cn** field, begin typing the CN of the group. There is a dropdown list with matching CNs in the configured `group_base`. Select your CN from this list.
1. In the **LDAP Access** section, choose a [default role](../permissions.md) or [custom role](../custom_roles/_index.md) for users synced in this group.
1. Select **Add Synchronization**.
<!-- vale gitlab_base.Spelling = YES -->
### Create group links with a filter
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To create group links with an LDAP user filter:
1. Select the **LDAP Server** for the link.
1. As the **Sync method**, select `LDAP user filter`.
1. Input your filter in the **LDAP User filter** box. Follow the [documentation on user filters](../../administration/auth/ldap/_index.md#set-up-ldap-user-filter).
1. In the **LDAP Access** section, choose a [default role](../permissions.md) or [custom role](../custom_roles/_index.md) for users synced in this group.
1. Select **Add Synchronization**.
### Override user permissions
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
LDAP user permissions can be manually overridden by an administrator. To override a user's permissions:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Manage > Members**. If LDAP synchronization
has granted a user a role with:
- More permissions than the parent group membership, that user is displayed as having
[direct membership](../project/members/_index.md#display-direct-members) of the group.
- The same or fewer permissions than the parent group membership, that user is displayed as having
[inherited membership](../project/members/_index.md#membership-types) of the group.
1. Optional. If the user you want to edit is displayed as having inherited membership,
[filter the subgroup to show direct members](_index.md#filter-a-group) before
overriding LDAP user permissions.
1. In the row for the user you are editing, select the pencil ({{< icon name="pencil" >}}) icon.
1. Select **Edit permissions** in the dialog.
Now you can edit the user's permissions from the **Members** page.
## Set the default role that can use pipeline variables
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/513117) in GitLab 17.10.
{{< /history >}}
This group setting controls the default value of the [minimum role allowed to run a new pipeline with pipeline variables](../../ci/variables/_index.md#restrict-pipeline-variables)
project setting. New projects created in the group have this value selected by default.
Prerequisites:
- You must have at least the Maintainer role in the group.
- The group must be the top-level group, not a subgroup.
To set the default minimum role:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > CI/CD > Variables**.
1. Under **Default role to use pipeline variables** select a minimum role, or select
**No one allowed** to prevent any user from using pipeline variables.
1. Select **Save changes**.
After a new project is created, project members with at least the Maintainer role
can change the project setting to another value if needed.
## Troubleshooting
### Verify if access is blocked by IP restriction
If a user sees a 404 error when they try to access a specific group,
their access might be blocked by an IP restriction.
Search the `auth.log` rails log for one or more of the following entries:
- `json.message`: `'Attempting to access IP restricted group'`
- `json.allowed`: `false`
In viewing the log entries, compare `remote.ip` with the list of [allowed IP addresses](#restrict-group-access-by-ip-address) for the group.
### Cannot update permissions for a group member
If a group Owner cannot update permissions for a group member, check which memberships
are listed. Group Owners can only update direct memberships.
Members added directly to a subgroup are still considered [inherited members](../project/members/_index.md#membership-types)
if they have the same or a higher role in the parent group.
To view and update direct memberships, [filter the group to show direct members](_index.md#filter-a-group).
[Issue 337539](https://gitlab.com/gitlab-org/gitlab/-/issues/337539#note_1277786161) proposes a redesigned members page that lists both direct and indirect memberships with the ability to filter by type.
### Cannot clone or pull using SSH after enabling IP restrictions
If you have issues with Git SSH operations after adding IP address restrictions,
check if your connection defaults to IPv6.
Some operating systems prioritize IPv6 over IPv4 when both are available,
which might not be obvious from the Git terminal feedback.
If your connection uses IPv6, you can resolve this issue by adding the IPv6 address to the allowlist.
|
---
stage: Tenant Scale
group: Organizations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Group access and permissions
breadcrumbs:
- doc
- user
- group
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Configure your groups to control group permissions and access.
For more information, see also [Sharing projects and groups](../project/members/sharing_projects_groups.md).
## Group push rules
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Moved to Settings/Repository](https://gitlab.com/gitlab-org/gitlab/-/issues/220365) in GitLab 15.4.
{{< /history >}}
Group push rules allow group maintainers to set
[push rules](../project/repository/push_rules.md) for newly created projects in the specific group.
To configure push rules for a group:
1. On the left sidebar, select **Settings > Repository**.
1. Expand the **Pre-defined push rules** section.
1. Select the settings you want.
1. Select **Save push rules**.
The group's new subgroups have push rules set for them based on either:
- The closest parent group with push rules defined.
- Push rules set for the entire instance, if no parent groups have push rules defined.
## Restrict Git access protocols
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/365601) in GitLab 15.1.
- [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/365357) in GitLab 16.0.
{{< /history >}}
You can set the permitted protocols used to access a group's repositories to either SSH, HTTPS, or both. This setting
is disabled when the [instance setting](../../administration/settings/visibility_and_access_controls.md#configure-enabled-git-access-protocols) is
configured by an administrator.
To change the permitted Git access protocols for a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Choose the permitted protocols from **Enabled Git access protocols**.
1. Select **Save changes**.
## Restrict group access by IP address
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To ensure only people from your organization can access particular resources, you can restrict access to groups by IP
address. This top-level group setting applies to:
- The GitLab UI, including subgroups, projects, and issues. It does not apply to GitLab Pages.
- The API.
- On GitLab Self-Managed you can also configure
[globally-allowed IP address ranges](../../administration/settings/visibility_and_access_controls.md#configure-globally-allowed-ip-address-ranges)
for the group.
Administrators can combine restricted access by IP address with
[globally-allowed IP addresses](../../administration/settings/visibility_and_access_controls.md#configure-globally-allowed-ip-address-ranges).
{{< alert type="warning" >}}
IP restriction requires proper configuration of the `X-Forwarded-For` header. To limit the risk
of IP spoofing, you must overwrite, and not append, any `X-Forwarded-For` headers sent by clients.
For deployments without an upstream proxy or load balancer, configure the server that receives direct
requests from users to preserve the original client IP address and overwrite any `X-Forwarded-For` headers.
In NGINX, for example, modify your configuration file to include:
```plaintext
proxy_set_header X-Forwarded-For $remote_addr;
```
For deployments with an upstream proxy or load balancer, configure the proxy or load balancer to
preserve the original client IP address and overwrite any `X-Forwarded-For` headers. This approach ensures that
GitLab receives the full chain of IPs, starting from the original client, and can correctly evaluate
the IP restrictions. In NGINX, for example, modify your configuration file to include:
```plaintext
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
```
{{< /alert >}}
To restrict group access by IP address:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. In the **Restrict access by IP address** text box, enter a list of IPv4 or IPv6
address ranges in CIDR notation. This list:
- Has no limit on the number of IP address ranges.
- Applies to both SSH or HTTP authorized IP address ranges. You cannot split
this list by type of authorization.
1. Select **Save changes**.
### Security implications
Keep in mind that restricting group access by IP address has the following implications:
- Administrators and group Owners can access group settings from any IP address, regardless of IP restriction. However:
- Group Owners can access the subgroups, but not the projects belonging to the group or subgroups, when accessing from a disallowed IP address.
- Administrators can access projects belonging to the group when accessing from a disallowed IP address.
Access to projects includes cloning code from them.
- Users can still see group and project names and hierarchies. Only the following are restricted:
- [Groups](../../api/groups.md), including all [group resources](../../api/api_resources.md#group-resources).
- [Project](../../api/projects.md), including all [project resources](../../api/api_resources.md#project-resources).
- When you register a runner, it is not bound by the IP restrictions. When the runner requests a new job or an update to
a job's state, it is also not bound by the IP restrictions. But when the running CI/CD job sends Git requests from a
restricted IP address, the IP restriction prevents code from being cloned.
- Users might still see some events from the IP-restricted groups and projects on their dashboard. Activity might include
push, merge, issue, or comment events.
- IP access restrictions do not stop users from using the [reply by email feature](../../administration/reply_by_email.md) to create or edit comments on issues or merge requests.
- IP access restrictions for Git operations through SSH are supported on GitLab SaaS.
IP access restrictions applied to GitLab Self-Managed instances are possible with [`gitlab-sshd`](../../administration/operations/gitlab_sshd.md)
with [PROXY protocol](../../administration/operations/gitlab_sshd.md#proxy-protocol-support) enabled.
- IP restriction is not applicable to shared resources belonging to a group. Any shared resource is accessible to a user even if that user is not able to access the group.
- While IP restrictions apply to public projects, they aren't a complete firewall and cached files for a project may still be accessible to users not in the IP block
### GitLab.com access restrictions
IP address-based group access restriction doesn't work with [hosted runners for GitLab.com](../../ci/runners/hosted_runners/_index.md).
These runners operate as ephemeral virtual machines with [dynamic IP addresses](../gitlab_com/_index.md#ip-range) from large
cloud provider pools (AWS, Google Cloud). To allow these broad IP ranges defeat the purpose of IP address-based access restriction.
## Restrict group access by domain
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Support for restricting group memberships to groups with a subset of the allowed email domains [added](https://gitlab.com/gitlab-org/gitlab/-/issues/354791) in GitLab 15.1.1
{{< /history >}}
You can define an email domain allowlist at the top-level namespace to restrict which users can
access a group and its projects. A user's primary email domain must match an entry in the allowlist
to access that group. Subgroups inherit the same allowlist.
To restrict group access by domain:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. In the **Restrict membership by email** field, enter the domain names to allow.
1. Select **Save changes**.
The next time you attempt to add a user to the group, their [primary email](../profile/_index.md#change-your-primary-email)
must match one of the allowed domains.
You cannot restrict the most popular public email domains, such as:
- `aol.com`, `gmail.com`, `hotmail.co.uk`, `hotmail.com`,
- `hotmail.fr`, `icloud.com`, `live.com`, `mail.com`,
- `me.com`, `msn.com`, `outlook.com`,
- `proton.me`, `protonmail.com`, `tutanota.com`,
- `yahoo.com`, `yandex.com`, `zohomail.com`
When you share a group, both the source and target namespaces must allow the domains of the members' email addresses.
{{< alert type="note" >}}
Removing a domain from the **Restrict membership by email** list does not remove existing users with that domain from the group or its projects.
Also, if you share a group or project with another group, the target group can add more email domains to its list that are not in the list of the source group.
Hence, this feature does not ensure that the current members always conform to the **Restrict membership by email** list.
{{< /alert >}}
## Prevent users from requesting access to a group
As a group Owner, you can prevent non-members from requesting access to
your group.
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Clear the **Allow users to request access** checkbox.
1. Select **Save changes**.
## Prevent project forking outside group
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
By default, projects in a group can be forked.
However, you can prevent the projects in a group from being forked outside of the current top-level group.
{{< alert type="note" >}}
Prevent forking outside the top-level group when possible to reduce potential avenues for bad actors.
However, if you expect a lot of external collaboration, allowing forks outside the top-level group might be unavoidable.
{{< /alert >}}
Prerequisites:
- This setting is enabled on the top-level group only.
- All subgroups inherit this setting from the top-level group, and it cannot be
changed at the subgroup level.
To prevent projects from being forked outside the group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Check **Prevent project forking outside current group**.
1. Select **Save changes**.
Existing forks are not removed.
## Prevent members from being added to projects in a group
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
As a group Owner, you can prevent any new project membership for all
projects in a group, allowing tighter control over project membership.
For example, if you want to lock the group for an [audit event](../../administration/compliance/audit_event_reports.md),
you can guarantee that project membership cannot be modified during the audit.
If group membership lock is enabled, the group Owner can still:
- Invite groups or add members to groups to give them access to projects in the **locked** group.
- Change the role of group members.
The setting does not cascade. Projects in subgroups observe the subgroup configuration, ignoring the parent group.
To prevent members from being added to projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Under **Membership**, select **Users cannot be added to projects in this group**.
1. Select **Save changes**.
After you lock the membership for a group:
- All users who previously had permissions can no longer add members to a group.
- API requests to add a new user to a project are not possible.
## Manage group memberships with LDAP
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- Support for custom roles for users synced in groups [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/435229) in GitLab 17.2.
{{< /history >}}
Group syncing allows LDAP groups to be mapped to GitLab groups. This provides more control over per-group user management. To configure group syncing, edit the `group_base` **DN** (`'OU=Global Groups,OU=GitLab INT,DC=GitLab,DC=org'`). This **OU** contains all groups that are associated with GitLab groups.
Group links can be created by using either a CN or a filter. To create these group links, go to the group's **Settings > LDAP Synchronization** page. After configuring the link, it may take more than an hour for the users to sync with the GitLab group. After you have configured the link:
- In GitLab 16.7 and earlier, group Owners cannot add members to or remove members from the group. The LDAP server is considered the single source of truth for group membership for all users who have signed in with LDAP credentials.
- In GitLab 16.8 and later, group Owners can use the [member roles API](../../api/member_roles.md) or [group members API](../../api/members.md#add-a-member-to-a-group-or-project) to add a service account user to or remove a service account user from the group, even when LDAP synchronization is enabled for the group. Group Owners cannot add or remove non-service account users.
When a user belongs to two LDAP groups configured for the same GitLab group, GitLab assigns them the
higher of the two associated roles.
For example:
- User is a member of LDAP groups `Owner` and `Dev`.
- The GitLab Group is configured with these two LDAP groups.
- When group sync is completed, the user is granted the Owner role as this is the higher of the two LDAP group roles.
For more information on the administration of LDAP and group sync, refer to the [main LDAP documentation](../../administration/auth/ldap/ldap_synchronization.md#group-sync).
{{< alert type="note" >}}
When you add LDAP group syncing, if an LDAP user is a group member and they are not part of the LDAP group, they are removed from the group.
{{< /alert >}}
You can use a workaround to [manage project access through LDAP groups](../project/working_with_projects.md#manage-project-access-through-ldap-groups).
### Create group links with a CN
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To create group links with LDAP group CN:
<!-- vale gitlab_base.Spelling = NO -->
1. Select the **LDAP Server** for the link.
1. As the **Sync method**, select `LDAP Group cn`.
1. In the **LDAP Group cn** field, begin typing the CN of the group. There is a dropdown list with matching CNs in the configured `group_base`. Select your CN from this list.
1. In the **LDAP Access** section, choose a [default role](../permissions.md) or [custom role](../custom_roles/_index.md) for users synced in this group.
1. Select **Add Synchronization**.
<!-- vale gitlab_base.Spelling = YES -->
### Create group links with a filter
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To create group links with an LDAP user filter:
1. Select the **LDAP Server** for the link.
1. As the **Sync method**, select `LDAP user filter`.
1. Input your filter in the **LDAP User filter** box. Follow the [documentation on user filters](../../administration/auth/ldap/_index.md#set-up-ldap-user-filter).
1. In the **LDAP Access** section, choose a [default role](../permissions.md) or [custom role](../custom_roles/_index.md) for users synced in this group.
1. Select **Add Synchronization**.
### Override user permissions
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
LDAP user permissions can be manually overridden by an administrator. To override a user's permissions:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Manage > Members**. If LDAP synchronization
has granted a user a role with:
- More permissions than the parent group membership, that user is displayed as having
[direct membership](../project/members/_index.md#display-direct-members) of the group.
- The same or fewer permissions than the parent group membership, that user is displayed as having
[inherited membership](../project/members/_index.md#membership-types) of the group.
1. Optional. If the user you want to edit is displayed as having inherited membership,
[filter the subgroup to show direct members](_index.md#filter-a-group) before
overriding LDAP user permissions.
1. In the row for the user you are editing, select the pencil ({{< icon name="pencil" >}}) icon.
1. Select **Edit permissions** in the dialog.
Now you can edit the user's permissions from the **Members** page.
## Set the default role that can use pipeline variables
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/513117) in GitLab 17.10.
{{< /history >}}
This group setting controls the default value of the [minimum role allowed to run a new pipeline with pipeline variables](../../ci/variables/_index.md#restrict-pipeline-variables)
project setting. New projects created in the group have this value selected by default.
Prerequisites:
- You must have at least the Maintainer role in the group.
- The group must be the top-level group, not a subgroup.
To set the default minimum role:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > CI/CD > Variables**.
1. Under **Default role to use pipeline variables** select a minimum role, or select
**No one allowed** to prevent any user from using pipeline variables.
1. Select **Save changes**.
After a new project is created, project members with at least the Maintainer role
can change the project setting to another value if needed.
## Troubleshooting
### Verify if access is blocked by IP restriction
If a user sees a 404 error when they try to access a specific group,
their access might be blocked by an IP restriction.
Search the `auth.log` rails log for one or more of the following entries:
- `json.message`: `'Attempting to access IP restricted group'`
- `json.allowed`: `false`
In viewing the log entries, compare `remote.ip` with the list of [allowed IP addresses](#restrict-group-access-by-ip-address) for the group.
### Cannot update permissions for a group member
If a group Owner cannot update permissions for a group member, check which memberships
are listed. Group Owners can only update direct memberships.
Members added directly to a subgroup are still considered [inherited members](../project/members/_index.md#membership-types)
if they have the same or a higher role in the parent group.
To view and update direct memberships, [filter the group to show direct members](_index.md#filter-a-group).
[Issue 337539](https://gitlab.com/gitlab-org/gitlab/-/issues/337539#note_1277786161) proposes a redesigned members page that lists both direct and indirect memberships with the ability to filter by type.
### Cannot clone or pull using SSH after enabling IP restrictions
If you have issues with Git SSH operations after adding IP address restrictions,
check if your connection defaults to IPv6.
Some operating systems prioritize IPv6 over IPv4 when both are available,
which might not be obvious from the Git terminal feedback.
If your connection uses IPv6, you can resolve this issue by adding the IPv6 address to the allowlist.
|
https://docs.gitlab.com/user/group/iterations
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/iterations
|
[
"doc",
"user",
"group",
"iterations"
] |
_index.md
|
Plan
|
Project Management
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Iterations
|
Time-boxed workflow, program increments, cadence, and sprints.
|
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
An iteration in GitLab refers to a time-boxed workflow that groups issues to be worked on during
a specific period of time, usually lasting 1-3 weeks.
Teams can use iterations to track velocity and volatility metrics.
For tracking the same item over multiple concurrent periods, you can use iterations with [milestones](../../project/milestones/_index.md).
Create and manage various [iteration cadences](#iteration-cadences) in a group.
For example, you can use:
- Milestones for Program Increments, which span 8-12 weeks.
- Iterations for Sprints, which span 2 weeks.
In GitLab, iterations are similar to milestones, with a few differences:
- Iterations are only available to groups.
- Iterations are grouped into iteration cadences.
- Iterations require both a start and an end date.
- Iteration date ranges cannot overlap within an iteration cadence.
## Planning workflows with iterations
You can use iterations to organize and track work in fixed time periods.
The following examples show how iterations help teams maintain consistent delivery cycles.
### Sprint planning and execution
Use iterations to plan and execute work in fixed time periods, and help teams maintain a
predictable delivery cadence.
When teams work in sprints, each iteration provides a clear timebox for planning,
execution, and delivery of work items.
For more information, see
[Tutorial: Use GitLab to facilitate Scrum](../../../tutorials/scrum_events/_index.md).
For example, when running two-week sprints, teams often need to coordinate multiple workstreams.
The development team tracks implementation in the current sprint, while product managers prepare
backlog items for upcoming sprints.
By using iterations:
- Teams can visualize their entire sprint schedule.
- Work automatically rolls over between sprints.
- Stakeholders can track sprint progress through burndown charts.
- Teams can measure velocity across multiple sprints.
This structure helps teams complete work consistently while maintaining visibility into progress.
When you set up iterations for sprints:
- Each team works in the same iteration cadence.
- Teams can view work status in iteration reports.
- Sprint planning becomes more predictable.
### Rapid development cycles
Use iterations to support shorter development cycles when your team needs frequent releases.
When practicing methodologies like Extreme Programming (XP), teams can use one-week iterations
to maintain fast feedback loops.
For example, when implementing rapid changes, teams might deploy to production multiple times
per iteration.
The team tracks their work in weekly iterations while maintaining the flexibility
to release whenever code is ready.
By using iterations:
- Teams maintain structured timeboxes.
- You can track development velocity.
- Teams can adapt planning based on weekly metrics.
- Stakeholders can see concrete progress each week.
This approach helps teams balance agile practices with organized planning.
When you use iterations for rapid cycles:
- Work is organized into clear weekly boundaries.
- Teams track progress in smaller increments.
- Release planning aligns with iteration boundaries.
## Iteration cadences
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5077) in GitLab 14.1 [with a flag](../../../administration/feature_flags/_index.md), named `iteration_cadences`. Disabled by default.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/354977) in GitLab 15.0: All scheduled iterations must start on the same day of the week as the cadence start day. Start date of cadence cannot be edited after the first iteration starts.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/354878) in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/367493) in GitLab 15.4: A new automation start date can be selected for cadence. Upcoming iterations are scheduled to start on the same day of the week as the changed start date. Iteration cadences can be manually managed by turning off the automatic scheduling feature.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/354878) in GitLab 15.5. Feature flag `iteration_cadences` removed.
{{< /history >}}
Iteration cadences are containers for iterations and can be used to automate iteration scheduling.
You can use them to automate creating iterations every 1, 2, 3, or 4 weeks. You can also
configure iteration cadences to automatically roll over incomplete issues to the next iteration.
### Create an iteration cadence
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for a group.
To create an iteration cadence:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
1. Select **New iteration cadence**.
1. Enter the title and description of the iteration cadence.
To manually manage the iteration cadence, clear the **Enable automatic scheduling** checkbox and skip the next step.
1. Complete the required fields to use automatic scheduling.
- Select the automation start date of the iteration cadence. Iterations are scheduled to
begin on the same day of the week as the day of the week of the start date.
- From the **Duration** dropdown list, select how many weeks each iteration should last.
- From the **Upcoming iterations** dropdown list, select how many upcoming iterations should be
created and maintained by GitLab.
- Optional. To move incomplete issues to the next iteration, select the **Enable roll over** checkbox.
At the end of the current iteration, [Automation Bot](#gitlab-automation-bot-user) moves all open
issues to the next iteration.
Issues are moved at midnight in the instance time zone (UTC by default).
Administrators can change the instance time zone.
1. Select **Create cadence**. The cadence list page opens.
To manually manage the created cadence, see [Create an iteration manually](#create-an-iteration-manually).
### View the iterations list
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
To view all the iterations in a cadence, ordered by descending date, select that iteration cadence.
From there you can create a new iteration or select an iteration to get a more detailed view.
{{< alert type="note" >}}
If a project has issue tracking
[turned off](../../project/settings/_index.md#configure-project-features-and-permissions),
to view the iterations list, enter its URL. To do so, add: `/-/cadences` to your project or group URL.
For example `https://gitlab.com/gitlab-org/sample-data-templates/sample-gitlab-project/-/cadences`.
[Issue 339009](https://gitlab.com/gitlab-org/gitlab/-/issues/339009) tracks improving this.
{{< /alert >}}
### Edit an iteration cadence
Prerequisites:
- You must have at least the Planner role for a group.
To edit an iteration cadence:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
1. To the right of the cadence you want to edit, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) and
then select **Edit cadence**.
1. Edit the fields.
- When you use automatic scheduling and edit the **Automation start date** field,
you must set a new start date that doesn't overlap with the existing
current or past iterations.
- Editing **Upcoming iterations** is a non-destructive action.
For example, if ten upcoming iterations already exist, changing the number under **Upcoming iterations** to `2`
doesn't delete the eight existing upcoming iterations.
1. Select **Save changes**.
#### Turn on and off automatic scheduling for an iteration cadence
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
1. To the right of the cadence for which you want to turn on or off automatic scheduling, select the
vertical ellipsis ({{< icon name="ellipsis_v" >}}) and then select **Edit cadence**.
1. Select or clear the **Enable automatic scheduling** checkbox.
1. If you're turning on automatic scheduling,
complete the required fields **Automation start date**, **Duration**, and **Upcoming iterations**.
- For **Automation start date**, you can select any date that doesn't overlap with the existing open iterations.
If you have upcoming iterations, the automatic scheduling adjusts them appropriately to fit
your chosen duration.
1. Select **Save changes**.
#### Example: Turn on automatic scheduling for a manual iteration cadence
Suppose it's Friday, April 15, and you have three iterations in a manual iteration cadence:
- Monday, April 4 - Friday, April 8 (closed)
- Tuesday, April 12 - Friday, April 15 (ongoing)
- Tuesday, May 3 - Friday, May 6 (upcoming)
The earliest possible **Automation start date** you can choose in this scenario
is Saturday, April 16, because April 15 overlaps with the ongoing iteration.
If you select Monday, April 18 as the automation start date to
automate scheduling iterations every week up to two upcoming iterations,
after the conversion you have the following iterations:
- Monday, April 4 - Friday, April 8 (closed)
- Tuesday, April 12 - Friday, April 15 (ongoing)
- Monday, April 18 - Sunday, April 24 (upcoming)
- Monday, April 25 - Sunday, May 1 (upcoming)
Your existing upcoming iteration "Tuesday, April 12 - Friday, April 15"
is changed to "April 18 - Sunday, April 24".
An additional upcoming iteration "April 25 - Sunday, May 1" is scheduled
to satisfy the requirement that there are at least two upcoming iterations scheduled.
### Delete an iteration cadence
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for a group.
Deleting an iteration cadence also deletes all iterations in that cadence.
To delete an iteration cadence:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
1. To the right of the cadence you want to delete, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) and then select **Delete cadence**.
1. Select **Delete cadence**.
### GitLab Automation Bot user
When iteration roll-over is enabled, at the end of the current iteration, all open issues are moved
to the next iteration.
Iterations are changed by the special GitLab Automation Bot user, which you can see in the issue
[system notes](../../project/system_notes.md).
This user isn't a [billable user](../../../subscriptions/manage_users_and_seats.md#criteria-for-non-billable-users),
so it does not count toward the license limit count.
On GitLab.com, this is the `automation-bot1` user.
## Create an iteration manually
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
When an iteration cadence has automatic scheduling enabled, iterations are created on schedule.
If you disable that option, you can create iterations manually.
Prerequisites:
- You must have at least the Planner role for a group.
- There must be at least one iteration cadence in the group and
[automatic scheduling must be disabled](#turn-on-and-off-automatic-scheduling-for-an-iteration-cadence) for the iteration cadence.
To create an iteration:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
1. To the right of the cadence in which you want create an iteration, select the vertical ellipsis
({{< icon name="ellipsis_v" >}}) and then select **Add iteration**.
1. Complete the fields.
1. Select **Create iteration**. The iteration details page opens.
## Edit an iteration
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for a group.
To edit an iteration:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations** and select an iteration cadence.
1. Select the iteration you want edit. The iteration details page opens.
1. In the upper-right corner, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) and then select **Edit**.
1. Edit the fields:
- You can edit **Title**, **Start date**, and **Due date** only if [automatic scheduling is disabled](#turn-on-and-off-automatic-scheduling-for-an-iteration-cadence) for the iteration cadence.
1. Select **Save changes**.
## Delete an iteration
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for a group.
- [Automatic scheduling must be disabled](#turn-on-and-off-automatic-scheduling-for-an-iteration-cadence) for the iteration cadence.
To delete an iteration:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations** and select an iteration cadence.
1. Select the iteration you want edit. The iteration details page opens.
1. In the upper-right corner, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) and then select **Delete**.
1. Select **Delete**.
## Iteration report
You can track the progress of an iteration by reviewing iteration reports.
An iteration report displays a list of all the issues assigned to an iteration and their status.
The report also shows a breakdown of total issues in an iteration.
Open iteration reports show a summary of completed, unstarted, and in-progress issues.
Closed iteration reports show the total number of issues completed by the due date.
### View an iteration report
To view an iteration report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations** and select an iteration cadence.
1. Select an iteration.
### Iteration burndown and burnup charts
The iteration report includes [burndown and burnup charts](../../project/milestones/burndown_and_burnup_charts.md),
similar to how they appear when viewing a [milestone](../../project/milestones/_index.md):
- Burndown charts help track completion progress of total scope.
- Burnup charts track the daily total count and weight of issues added to and completed in a given timebox.
#### View iteration charts scoped to subgroups or projects
View burndown and burnup charts for iterations created for a group in any of its
subgroups or projects.
When you do this, the charts only count the issues that belong to the subgroup or project.
For example, suppose a group has two projects named `Project 1` and `Project 2`.
Each project has a single issue assigned to the same iteration from the group.
An iteration report generated for the group shows issue counts for all the group's projects:
- Completed: 0 of 2
- Incomplete: 0 of 2
- Unstarted: 2 of 2
- Burndown chart total issues: 2
- Burnup chart total issues: 2
An iteration report generated for `Project 1` shows only issues that belong to this project:
- Completed: 0 of 1
- Incomplete: 0 of 1
- Unstarted: 1 of 1
- Burndown chart total issues: 1
- Burnup chart total issues: 1
### Group issues by label
Group the list of issues by label to view issues that belong to your team, and get a more accurate
understanding of scope attributable to each label.
To group issues by label:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations** and select an iteration cadence.
1. Select an iteration.
1. From the **Group by** dropdown list, select **Label**.
1. From the **Filter by label** dropdown list, select the labels you want to group by.
1. Select any area outside the label dropdown list. The page is now grouped by the selected labels.
## Related topics
- [Add an issue to an iteration](../../project/issues/managing_issues.md#add-an-issue-to-an-iteration)
- [Tutorial: Use GitLab to run an Agile iteration](../../../tutorials/agile_sprint/_index.md)
|
---
stage: Plan
group: Project Management
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Iterations
description: Time-boxed workflow, program increments, cadence, and sprints.
breadcrumbs:
- doc
- user
- group
- iterations
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
An iteration in GitLab refers to a time-boxed workflow that groups issues to be worked on during
a specific period of time, usually lasting 1-3 weeks.
Teams can use iterations to track velocity and volatility metrics.
For tracking the same item over multiple concurrent periods, you can use iterations with [milestones](../../project/milestones/_index.md).
Create and manage various [iteration cadences](#iteration-cadences) in a group.
For example, you can use:
- Milestones for Program Increments, which span 8-12 weeks.
- Iterations for Sprints, which span 2 weeks.
In GitLab, iterations are similar to milestones, with a few differences:
- Iterations are only available to groups.
- Iterations are grouped into iteration cadences.
- Iterations require both a start and an end date.
- Iteration date ranges cannot overlap within an iteration cadence.
## Planning workflows with iterations
You can use iterations to organize and track work in fixed time periods.
The following examples show how iterations help teams maintain consistent delivery cycles.
### Sprint planning and execution
Use iterations to plan and execute work in fixed time periods, and help teams maintain a
predictable delivery cadence.
When teams work in sprints, each iteration provides a clear timebox for planning,
execution, and delivery of work items.
For more information, see
[Tutorial: Use GitLab to facilitate Scrum](../../../tutorials/scrum_events/_index.md).
For example, when running two-week sprints, teams often need to coordinate multiple workstreams.
The development team tracks implementation in the current sprint, while product managers prepare
backlog items for upcoming sprints.
By using iterations:
- Teams can visualize their entire sprint schedule.
- Work automatically rolls over between sprints.
- Stakeholders can track sprint progress through burndown charts.
- Teams can measure velocity across multiple sprints.
This structure helps teams complete work consistently while maintaining visibility into progress.
When you set up iterations for sprints:
- Each team works in the same iteration cadence.
- Teams can view work status in iteration reports.
- Sprint planning becomes more predictable.
### Rapid development cycles
Use iterations to support shorter development cycles when your team needs frequent releases.
When practicing methodologies like Extreme Programming (XP), teams can use one-week iterations
to maintain fast feedback loops.
For example, when implementing rapid changes, teams might deploy to production multiple times
per iteration.
The team tracks their work in weekly iterations while maintaining the flexibility
to release whenever code is ready.
By using iterations:
- Teams maintain structured timeboxes.
- You can track development velocity.
- Teams can adapt planning based on weekly metrics.
- Stakeholders can see concrete progress each week.
This approach helps teams balance agile practices with organized planning.
When you use iterations for rapid cycles:
- Work is organized into clear weekly boundaries.
- Teams track progress in smaller increments.
- Release planning aligns with iteration boundaries.
## Iteration cadences
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5077) in GitLab 14.1 [with a flag](../../../administration/feature_flags/_index.md), named `iteration_cadences`. Disabled by default.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/354977) in GitLab 15.0: All scheduled iterations must start on the same day of the week as the cadence start day. Start date of cadence cannot be edited after the first iteration starts.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/354878) in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/367493) in GitLab 15.4: A new automation start date can be selected for cadence. Upcoming iterations are scheduled to start on the same day of the week as the changed start date. Iteration cadences can be manually managed by turning off the automatic scheduling feature.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/354878) in GitLab 15.5. Feature flag `iteration_cadences` removed.
{{< /history >}}
Iteration cadences are containers for iterations and can be used to automate iteration scheduling.
You can use them to automate creating iterations every 1, 2, 3, or 4 weeks. You can also
configure iteration cadences to automatically roll over incomplete issues to the next iteration.
### Create an iteration cadence
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for a group.
To create an iteration cadence:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
1. Select **New iteration cadence**.
1. Enter the title and description of the iteration cadence.
To manually manage the iteration cadence, clear the **Enable automatic scheduling** checkbox and skip the next step.
1. Complete the required fields to use automatic scheduling.
- Select the automation start date of the iteration cadence. Iterations are scheduled to
begin on the same day of the week as the day of the week of the start date.
- From the **Duration** dropdown list, select how many weeks each iteration should last.
- From the **Upcoming iterations** dropdown list, select how many upcoming iterations should be
created and maintained by GitLab.
- Optional. To move incomplete issues to the next iteration, select the **Enable roll over** checkbox.
At the end of the current iteration, [Automation Bot](#gitlab-automation-bot-user) moves all open
issues to the next iteration.
Issues are moved at midnight in the instance time zone (UTC by default).
Administrators can change the instance time zone.
1. Select **Create cadence**. The cadence list page opens.
To manually manage the created cadence, see [Create an iteration manually](#create-an-iteration-manually).
### View the iterations list
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
To view all the iterations in a cadence, ordered by descending date, select that iteration cadence.
From there you can create a new iteration or select an iteration to get a more detailed view.
{{< alert type="note" >}}
If a project has issue tracking
[turned off](../../project/settings/_index.md#configure-project-features-and-permissions),
to view the iterations list, enter its URL. To do so, add: `/-/cadences` to your project or group URL.
For example `https://gitlab.com/gitlab-org/sample-data-templates/sample-gitlab-project/-/cadences`.
[Issue 339009](https://gitlab.com/gitlab-org/gitlab/-/issues/339009) tracks improving this.
{{< /alert >}}
### Edit an iteration cadence
Prerequisites:
- You must have at least the Planner role for a group.
To edit an iteration cadence:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
1. To the right of the cadence you want to edit, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) and
then select **Edit cadence**.
1. Edit the fields.
- When you use automatic scheduling and edit the **Automation start date** field,
you must set a new start date that doesn't overlap with the existing
current or past iterations.
- Editing **Upcoming iterations** is a non-destructive action.
For example, if ten upcoming iterations already exist, changing the number under **Upcoming iterations** to `2`
doesn't delete the eight existing upcoming iterations.
1. Select **Save changes**.
#### Turn on and off automatic scheduling for an iteration cadence
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
1. To the right of the cadence for which you want to turn on or off automatic scheduling, select the
vertical ellipsis ({{< icon name="ellipsis_v" >}}) and then select **Edit cadence**.
1. Select or clear the **Enable automatic scheduling** checkbox.
1. If you're turning on automatic scheduling,
complete the required fields **Automation start date**, **Duration**, and **Upcoming iterations**.
- For **Automation start date**, you can select any date that doesn't overlap with the existing open iterations.
If you have upcoming iterations, the automatic scheduling adjusts them appropriately to fit
your chosen duration.
1. Select **Save changes**.
#### Example: Turn on automatic scheduling for a manual iteration cadence
Suppose it's Friday, April 15, and you have three iterations in a manual iteration cadence:
- Monday, April 4 - Friday, April 8 (closed)
- Tuesday, April 12 - Friday, April 15 (ongoing)
- Tuesday, May 3 - Friday, May 6 (upcoming)
The earliest possible **Automation start date** you can choose in this scenario
is Saturday, April 16, because April 15 overlaps with the ongoing iteration.
If you select Monday, April 18 as the automation start date to
automate scheduling iterations every week up to two upcoming iterations,
after the conversion you have the following iterations:
- Monday, April 4 - Friday, April 8 (closed)
- Tuesday, April 12 - Friday, April 15 (ongoing)
- Monday, April 18 - Sunday, April 24 (upcoming)
- Monday, April 25 - Sunday, May 1 (upcoming)
Your existing upcoming iteration "Tuesday, April 12 - Friday, April 15"
is changed to "April 18 - Sunday, April 24".
An additional upcoming iteration "April 25 - Sunday, May 1" is scheduled
to satisfy the requirement that there are at least two upcoming iterations scheduled.
### Delete an iteration cadence
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for a group.
Deleting an iteration cadence also deletes all iterations in that cadence.
To delete an iteration cadence:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
1. To the right of the cadence you want to delete, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) and then select **Delete cadence**.
1. Select **Delete cadence**.
### GitLab Automation Bot user
When iteration roll-over is enabled, at the end of the current iteration, all open issues are moved
to the next iteration.
Iterations are changed by the special GitLab Automation Bot user, which you can see in the issue
[system notes](../../project/system_notes.md).
This user isn't a [billable user](../../../subscriptions/manage_users_and_seats.md#criteria-for-non-billable-users),
so it does not count toward the license limit count.
On GitLab.com, this is the `automation-bot1` user.
## Create an iteration manually
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
When an iteration cadence has automatic scheduling enabled, iterations are created on schedule.
If you disable that option, you can create iterations manually.
Prerequisites:
- You must have at least the Planner role for a group.
- There must be at least one iteration cadence in the group and
[automatic scheduling must be disabled](#turn-on-and-off-automatic-scheduling-for-an-iteration-cadence) for the iteration cadence.
To create an iteration:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations**.
1. To the right of the cadence in which you want create an iteration, select the vertical ellipsis
({{< icon name="ellipsis_v" >}}) and then select **Add iteration**.
1. Complete the fields.
1. Select **Create iteration**. The iteration details page opens.
## Edit an iteration
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for a group.
To edit an iteration:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations** and select an iteration cadence.
1. Select the iteration you want edit. The iteration details page opens.
1. In the upper-right corner, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) and then select **Edit**.
1. Edit the fields:
- You can edit **Title**, **Start date**, and **Due date** only if [automatic scheduling is disabled](#turn-on-and-off-automatic-scheduling-for-an-iteration-cadence) for the iteration cadence.
1. Select **Save changes**.
## Delete an iteration
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for a group.
- [Automatic scheduling must be disabled](#turn-on-and-off-automatic-scheduling-for-an-iteration-cadence) for the iteration cadence.
To delete an iteration:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations** and select an iteration cadence.
1. Select the iteration you want edit. The iteration details page opens.
1. In the upper-right corner, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) and then select **Delete**.
1. Select **Delete**.
## Iteration report
You can track the progress of an iteration by reviewing iteration reports.
An iteration report displays a list of all the issues assigned to an iteration and their status.
The report also shows a breakdown of total issues in an iteration.
Open iteration reports show a summary of completed, unstarted, and in-progress issues.
Closed iteration reports show the total number of issues completed by the due date.
### View an iteration report
To view an iteration report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations** and select an iteration cadence.
1. Select an iteration.
### Iteration burndown and burnup charts
The iteration report includes [burndown and burnup charts](../../project/milestones/burndown_and_burnup_charts.md),
similar to how they appear when viewing a [milestone](../../project/milestones/_index.md):
- Burndown charts help track completion progress of total scope.
- Burnup charts track the daily total count and weight of issues added to and completed in a given timebox.
#### View iteration charts scoped to subgroups or projects
View burndown and burnup charts for iterations created for a group in any of its
subgroups or projects.
When you do this, the charts only count the issues that belong to the subgroup or project.
For example, suppose a group has two projects named `Project 1` and `Project 2`.
Each project has a single issue assigned to the same iteration from the group.
An iteration report generated for the group shows issue counts for all the group's projects:
- Completed: 0 of 2
- Incomplete: 0 of 2
- Unstarted: 2 of 2
- Burndown chart total issues: 2
- Burnup chart total issues: 2
An iteration report generated for `Project 1` shows only issues that belong to this project:
- Completed: 0 of 1
- Incomplete: 0 of 1
- Unstarted: 1 of 1
- Burndown chart total issues: 1
- Burnup chart total issues: 1
### Group issues by label
Group the list of issues by label to view issues that belong to your team, and get a more accurate
understanding of scope attributable to each label.
To group issues by label:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Iterations** and select an iteration cadence.
1. Select an iteration.
1. From the **Group by** dropdown list, select **Label**.
1. From the **Filter by label** dropdown list, select the labels you want to group by.
1. Select any area outside the label dropdown list. The page is now grouped by the selected labels.
## Related topics
- [Add an issue to an iteration](../../project/issues/managing_issues.md#add-an-issue-to-an-iteration)
- [Tutorial: Use GitLab to run an Agile iteration](../../../tutorials/agile_sprint/_index.md)
|
https://docs.gitlab.com/user/group/contribution_analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/contribution_analytics
|
[
"doc",
"user",
"group",
"contribution_analytics"
] |
_index.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Contribution analytics
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Contribution analytics provide an overview of the
[contribution events](../../profile/contributions_calendar.md#user-contribution-events)
your group's members made in the last week, month, or three months.
Interactive bar charts and a detailed table show contribution events
(push events, issues, and merge requests) by group member.
Use contribution analytics to get insights into team activity and individual performance, and use this information for:
- Workload balancing: Analyze your group's contributions over a period of time, and identify group members who are high performers or may benefit from additional support.
- Team collaboration: Evaluate the balance of contributions, such as code pushes versus reviews or approvals, to ensure collaborative development practices.
- Training opportunities: Identify areas where team members may benefit from mentorship or training, such as low merge request approval or issue resolution rates.
- Retrospective evaluation: Incorporate contribution analytics into retrospectives to assess how effectively the team met objectives and where adjustments may be needed.
### Tracking
Contribution analytics are based on push events, because they provide a more reliable view of contributions than unique commits.
Counting unique commits may lead to duplication when commits are pushed across multiple branches.
By tracking push events instead, GitLab ensures that every contribution is counted accurately.
For example, a user pushes three commits to branch A in one push.
Later, the user pushes two of those commits from branch A to branch B.
GitLab records five commits, though the user made three unique commits.
## View contribution analytics
To view contribution analytics:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Contribution analytics**.
1. Optional. Filter the results:
- To view contribution analytics for last week, month, or three months, select one of the three tabs.
The selected time period applies to all charts and the table.
- To zoom in on a bar chart to display only a subset of group members,
select the sliders ({{< icon name="status-paused" >}}) below the chart and slide them along the axis.
- To sort the contributions table by a column, select the column header or the chevron
({{< icon name="chevron-lg-down" >}} for descending order, {{< icon name="chevron-lg-up" >}} for ascending order).
1. Optional. To view a group member's contributions, either:
- On the **Contribution analytics** bar charts, hover over the bar with the member's name.
- In the **Contributions per group member** table, select the member's name.
The member's GitLab profile is displayed, and you can explore their [contributions calendar](../../profile/contributions_calendar.md).
To retrieve metrics for user contributions, you can also use the [GraphQL API](../../../api/graphql/reference/_index.md#groupcontributions).
## Contribution analytics with ClickHouse
On GitLab.com, contribution analytics run through the ClickHouse Cloud cluster.
On GitLab Self-Managed, when you configure the ClickHouse integration, the ClickHouse `events` table is automatically populated from the PostgreSQL `events` table. This process might take some time for large installations. After the table is fully synchronized, new events become available in ClickHouse with a delay of about three minutes.
For more information, see:
- [ClickHouse integration guidelines](../../../integration/clickhouse.md)
- [ClickHouse usage at GitLab](https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/clickhouse_usage/)
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Contribution analytics
breadcrumbs:
- doc
- user
- group
- contribution_analytics
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Contribution analytics provide an overview of the
[contribution events](../../profile/contributions_calendar.md#user-contribution-events)
your group's members made in the last week, month, or three months.
Interactive bar charts and a detailed table show contribution events
(push events, issues, and merge requests) by group member.
Use contribution analytics to get insights into team activity and individual performance, and use this information for:
- Workload balancing: Analyze your group's contributions over a period of time, and identify group members who are high performers or may benefit from additional support.
- Team collaboration: Evaluate the balance of contributions, such as code pushes versus reviews or approvals, to ensure collaborative development practices.
- Training opportunities: Identify areas where team members may benefit from mentorship or training, such as low merge request approval or issue resolution rates.
- Retrospective evaluation: Incorporate contribution analytics into retrospectives to assess how effectively the team met objectives and where adjustments may be needed.
### Tracking
Contribution analytics are based on push events, because they provide a more reliable view of contributions than unique commits.
Counting unique commits may lead to duplication when commits are pushed across multiple branches.
By tracking push events instead, GitLab ensures that every contribution is counted accurately.
For example, a user pushes three commits to branch A in one push.
Later, the user pushes two of those commits from branch A to branch B.
GitLab records five commits, though the user made three unique commits.
## View contribution analytics
To view contribution analytics:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Contribution analytics**.
1. Optional. Filter the results:
- To view contribution analytics for last week, month, or three months, select one of the three tabs.
The selected time period applies to all charts and the table.
- To zoom in on a bar chart to display only a subset of group members,
select the sliders ({{< icon name="status-paused" >}}) below the chart and slide them along the axis.
- To sort the contributions table by a column, select the column header or the chevron
({{< icon name="chevron-lg-down" >}} for descending order, {{< icon name="chevron-lg-up" >}} for ascending order).
1. Optional. To view a group member's contributions, either:
- On the **Contribution analytics** bar charts, hover over the bar with the member's name.
- In the **Contributions per group member** table, select the member's name.
The member's GitLab profile is displayed, and you can explore their [contributions calendar](../../profile/contributions_calendar.md).
To retrieve metrics for user contributions, you can also use the [GraphQL API](../../../api/graphql/reference/_index.md#groupcontributions).
## Contribution analytics with ClickHouse
On GitLab.com, contribution analytics run through the ClickHouse Cloud cluster.
On GitLab Self-Managed, when you configure the ClickHouse integration, the ClickHouse `events` table is automatically populated from the PostgreSQL `events` table. This process might take some time for large installations. After the table is fully synchronized, new events become available in ClickHouse with a delay of about three minutes.
For more information, see:
- [ClickHouse integration guidelines](../../../integration/clickhouse.md)
- [ClickHouse usage at GitLab](https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/clickhouse_usage/)
|
https://docs.gitlab.com/user/group/repositories_analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/repositories_analytics
|
[
"doc",
"user",
"group",
"repositories_analytics"
] |
_index.md
|
Verify
|
Pipeline Execution
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Repository analytics for groups
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Repository analytics for groups provides test coverage data for all projects in a group.
You can use group repository analytics to:
- Monitor code coverage trends across all projects in a group.
- Track the total number of projects and jobs that generate coverage reports.
- Download historical coverage data for analysis.
Support for subgroups is proposed in [issue 273527](https://gitlab.com/gitlab-org/gitlab/-/issues/273527).
## View group repository analytics
Prerequisites:
- Projects within the group must be configured to collect test coverage data.
To view repository analytics for a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Repository analytics**.
## Coverage metrics
The group **Repository analytics** page displays:
- **Current group code coverage**:
- Number of projects with coverage reports.
- Average coverage percentage across all projects.
- Total number of pipeline jobs that produce coverage reports.
- **Average test coverage**: A graph that shows the average test coverage across all projects in your group for the last 30 days.
- **Latest test coverage results**: A list of the most recent coverage data for each project in your group. Select projects from the dropdown list to filter the results.
## Download coverage data
You can download a CSV file containing historical coverage data for projects in your group.
The CSV report:
- Contains up to 1000 records.
- Includes data from the default branch of each project.
- Shows one row per day when coverage was reported.
- Uses the last value of the day if multiple coverage reports were generated.
- Contains the following information for each coverage report:
- Date the coverage job ran
- Name of the job that generated the report
- Project name
- Coverage percentage
To download the coverage data:
1. On the group **Repository analytics** page, select **Download historic test coverage data (.csv)**.
1. Select the projects to include:
- From the **Projects** dropdown list, choose specific projects. The projects dropdown list shows up to 100 projects.
- Optional. Select **Select all** to include all projects in your group.
1. From the **Date range** dropdown list, select the time period to include.
1. Select **Download test coverage data (.csv)**.
## Related topics
- [Repository analytics for projects](../../analytics/repository_analytics.md)
- [Code coverage](../../../ci/testing/code_coverage/_index.md)
|
---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Repository analytics for groups
breadcrumbs:
- doc
- user
- group
- repositories_analytics
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Repository analytics for groups provides test coverage data for all projects in a group.
You can use group repository analytics to:
- Monitor code coverage trends across all projects in a group.
- Track the total number of projects and jobs that generate coverage reports.
- Download historical coverage data for analysis.
Support for subgroups is proposed in [issue 273527](https://gitlab.com/gitlab-org/gitlab/-/issues/273527).
## View group repository analytics
Prerequisites:
- Projects within the group must be configured to collect test coverage data.
To view repository analytics for a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Repository analytics**.
## Coverage metrics
The group **Repository analytics** page displays:
- **Current group code coverage**:
- Number of projects with coverage reports.
- Average coverage percentage across all projects.
- Total number of pipeline jobs that produce coverage reports.
- **Average test coverage**: A graph that shows the average test coverage across all projects in your group for the last 30 days.
- **Latest test coverage results**: A list of the most recent coverage data for each project in your group. Select projects from the dropdown list to filter the results.
## Download coverage data
You can download a CSV file containing historical coverage data for projects in your group.
The CSV report:
- Contains up to 1000 records.
- Includes data from the default branch of each project.
- Shows one row per day when coverage was reported.
- Uses the last value of the day if multiple coverage reports were generated.
- Contains the following information for each coverage report:
- Date the coverage job ran
- Name of the job that generated the report
- Project name
- Coverage percentage
To download the coverage data:
1. On the group **Repository analytics** page, select **Download historic test coverage data (.csv)**.
1. Select the projects to include:
- From the **Projects** dropdown list, choose specific projects. The projects dropdown list shows up to 100 projects.
- Optional. Select **Select all** to include all projects in your group.
1. From the **Date range** dropdown list, select the time period to include.
1. Select **Download test coverage data (.csv)**.
## Related topics
- [Repository analytics for projects](../../analytics/repository_analytics.md)
- [Code coverage](../../../ci/testing/code_coverage/_index.md)
|
https://docs.gitlab.com/user/group/migrated_items
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/migrated_items.md
|
2025-08-13
|
doc/user/group/import
|
[
"doc",
"user",
"group",
"import"
] |
migrated_items.md
|
Create
|
Import
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Items migrated when using direct transfer
|
Project and group items included or excluded when using direct transfer.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Many items are migrated when using the direct transfer method, and some are excluded.
## Migrated group items
The group items that are migrated depend on the version of GitLab you use on the destination. To determine if a
specific group item is migrated:
1. Check the [`groups/stage.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/bulk_imports/groups/stage.rb)
file for all editions and the
[`groups/stage.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/ee/bulk_imports/groups/stage.rb) file
for Enterprise Edition for your version on the destination. For example, for version 15.9:
- <https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/lib/bulk_imports/groups/stage.rb> (all editions).
- <https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/ee/lib/ee/bulk_imports/groups/stage.rb> (Enterprise
Edition).
1. Check the
[`group/import_export.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/import_export/group/import_export.yml)
file for groups for your version on the destination. For example, for version 15.9:
<https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/lib/gitlab/import_export/group/import_export.yml>.
Any other group items are **not** migrated.
Group items that are migrated to the destination GitLab instance include:
- Badges
- Boards
- Board lists
- Epics
- Group labels
{{< alert type="note" >}}
Group labels cannot retain any associated label priorities during import.
You must prioritize these labels again manually after you migrate the relevant project to the destination instance.
{{< /alert >}}
- Group milestones
- Iterations
- Iteration cadences
- [Members](direct_transfer_migrations.md#user-contribution-and-membership-mapping)
- Namespace settings
- Release milestones
- Subgroups
- Uploads
- Wikis
### Excluded items
Some group items are excluded from migration because they:
- Might contain sensitive information:
- CI/CD variables
- Deploy tokens
- Webhooks
- Are not supported:
- Custom fields
- Iteration cadence settings
- Pending member invitations
- Push rules
## Migrated project items
{{< history >}}
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.6.
- `bulk_import_projects` feature flag [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.10.
- Project migrations through the API [added](https://gitlab.com/gitlab-org/gitlab/-/issues/390515) in GitLab 15.11.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/461326) in GitLab 18.3.
{{< /history >}}
If you choose to migrate projects when you [select groups to migrate](direct_transfer_migrations.md#select-the-groups-and-projects-to-import),
project items are migrated with the projects.
The project items that are migrated depends on the version of GitLab you use on the destination. To determine if a
specific project item is migrated:
1. Check the [`projects/stage.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/bulk_imports/projects/stage.rb)
file for all editions and the
[`projects/stage.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/ee/bulk_imports/projects/stage.rb)
file for Enterprise Edition for your version on the destination. For example, for version 15.9:
- <https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/lib/bulk_imports/projects/stage.rb> (all editions).
- <https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/ee/lib/ee/bulk_imports/projects/stage.rb> (Enterprise
Edition).
1. Check the
[`project/import_export.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/import_export/project/import_export.yml)
file for projects for your version on the destination. For example, for version 15.9:
<https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/lib/gitlab/import_export/project/import_export.yml>.
Any other project items are **not** migrated.
If you choose not to migrate projects along with groups or if you want to retry a project migration, you can
initiate project-only migrations using the [API](../../../api/bulk_imports.md).
Project items that are migrated to the destination GitLab instance include:
- Auto DevOps
- Badges
- Branches (including protected branches)
{{< alert type="note" >}}
Imported branches respect the [default branch protection settings](../../project/repository/branches/protected.md) of the destination group.
These settings might cause an unprotected branch to be imported as protected.
{{< /alert >}}
- CI pipelines
- Commit comments
- Designs
- External merge requests
- Issues
- Issue boards
- Labels
- LFS objects
- [Members](direct_transfer_migrations.md#user-contribution-and-membership-mapping)
- Merge requests
- Milestones
- Pipeline history
- Pipeline schedules
- Projects
- Project features
- Push rules
- Releases
- Release evidences
- Repositories
- Settings
- Snippets
- Uploads
- Vulnerability reports
{{< alert type="note" >}}
[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/501466) in GitLab 17.7.
Vulnerability reports are migrated without their status.
For more information, see [issue 512859](https://gitlab.com/gitlab-org/gitlab/-/issues/512859).
For the `ActiveRecord::RecordNotUnique` error when migrating vulnerability reports,
see [issue 509904](https://gitlab.com/gitlab-org/gitlab/-/issues/509904).
{{< /alert >}}
- Wikis
### Issue-related items
Issue-related project items that are migrated to the destination GitLab instance include:
- Issue comments
- Issue iterations
- Issue resource iteration events
- Issue resource milestone events
- Issue resource state events
- Merge request URL references
- Time tracking
### Merge request-related items
Merge request-related project items that are migrated to the destination GitLab instance include:
- Issue URL references
- Merge request approvers
- Merge request comments
- Merge request resource milestone events
- Merge request resource state events
- Merge request reviewers
- Multiple merge request assignees
- Time tracking
### Setting-related items
Setting-related project items that are migrated to the destination GitLab instance include:
- Avatar
- Container expiration policy
- Project properties
- Service Desk
### Excluded items
Some project items are excluded from migration because they:
- Might contain sensitive information:
- CI/CD job logs
- CI/CD variables
- Container registry images
- Deploy keys
- Deploy tokens
- Encrypted tokens
- Job artifacts
- Pipeline schedule variables
- Pipeline triggers
- Webhooks
- Are not supported:
- Agents
- Container registry
- Custom fields
- Environments
- Feature flags
- Infrastructure registry
- Instance administrators in branch protection rules when migrating
from GitLab Self-Managed to GitLab.com or GitLab Dedicated
- Linked issues
- Merge request approval rules
- Merge request dependencies
- Package registry
- Pages domains
- Pending member invitations
- Remote mirrors
- Wiki comments
{{< alert type="note" >}}
Approval rules related to project settings are imported.
{{< /alert >}}
- Do not contain recoverable data:
- Merge requests with no diff or source information
(for more information, see [issue 537943](https://gitlab.com/gitlab-org/gitlab/-/issues/537943))
|
---
stage: Create
group: Import
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Items migrated when using direct transfer
description: Project and group items included or excluded when using direct transfer.
breadcrumbs:
- doc
- user
- group
- import
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Many items are migrated when using the direct transfer method, and some are excluded.
## Migrated group items
The group items that are migrated depend on the version of GitLab you use on the destination. To determine if a
specific group item is migrated:
1. Check the [`groups/stage.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/bulk_imports/groups/stage.rb)
file for all editions and the
[`groups/stage.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/ee/bulk_imports/groups/stage.rb) file
for Enterprise Edition for your version on the destination. For example, for version 15.9:
- <https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/lib/bulk_imports/groups/stage.rb> (all editions).
- <https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/ee/lib/ee/bulk_imports/groups/stage.rb> (Enterprise
Edition).
1. Check the
[`group/import_export.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/import_export/group/import_export.yml)
file for groups for your version on the destination. For example, for version 15.9:
<https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/lib/gitlab/import_export/group/import_export.yml>.
Any other group items are **not** migrated.
Group items that are migrated to the destination GitLab instance include:
- Badges
- Boards
- Board lists
- Epics
- Group labels
{{< alert type="note" >}}
Group labels cannot retain any associated label priorities during import.
You must prioritize these labels again manually after you migrate the relevant project to the destination instance.
{{< /alert >}}
- Group milestones
- Iterations
- Iteration cadences
- [Members](direct_transfer_migrations.md#user-contribution-and-membership-mapping)
- Namespace settings
- Release milestones
- Subgroups
- Uploads
- Wikis
### Excluded items
Some group items are excluded from migration because they:
- Might contain sensitive information:
- CI/CD variables
- Deploy tokens
- Webhooks
- Are not supported:
- Custom fields
- Iteration cadence settings
- Pending member invitations
- Push rules
## Migrated project items
{{< history >}}
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.6.
- `bulk_import_projects` feature flag [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.10.
- Project migrations through the API [added](https://gitlab.com/gitlab-org/gitlab/-/issues/390515) in GitLab 15.11.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/461326) in GitLab 18.3.
{{< /history >}}
If you choose to migrate projects when you [select groups to migrate](direct_transfer_migrations.md#select-the-groups-and-projects-to-import),
project items are migrated with the projects.
The project items that are migrated depends on the version of GitLab you use on the destination. To determine if a
specific project item is migrated:
1. Check the [`projects/stage.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/bulk_imports/projects/stage.rb)
file for all editions and the
[`projects/stage.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/ee/bulk_imports/projects/stage.rb)
file for Enterprise Edition for your version on the destination. For example, for version 15.9:
- <https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/lib/bulk_imports/projects/stage.rb> (all editions).
- <https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/ee/lib/ee/bulk_imports/projects/stage.rb> (Enterprise
Edition).
1. Check the
[`project/import_export.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/import_export/project/import_export.yml)
file for projects for your version on the destination. For example, for version 15.9:
<https://gitlab.com/gitlab-org/gitlab/-/blob/15-9-stable-ee/lib/gitlab/import_export/project/import_export.yml>.
Any other project items are **not** migrated.
If you choose not to migrate projects along with groups or if you want to retry a project migration, you can
initiate project-only migrations using the [API](../../../api/bulk_imports.md).
Project items that are migrated to the destination GitLab instance include:
- Auto DevOps
- Badges
- Branches (including protected branches)
{{< alert type="note" >}}
Imported branches respect the [default branch protection settings](../../project/repository/branches/protected.md) of the destination group.
These settings might cause an unprotected branch to be imported as protected.
{{< /alert >}}
- CI pipelines
- Commit comments
- Designs
- External merge requests
- Issues
- Issue boards
- Labels
- LFS objects
- [Members](direct_transfer_migrations.md#user-contribution-and-membership-mapping)
- Merge requests
- Milestones
- Pipeline history
- Pipeline schedules
- Projects
- Project features
- Push rules
- Releases
- Release evidences
- Repositories
- Settings
- Snippets
- Uploads
- Vulnerability reports
{{< alert type="note" >}}
[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/501466) in GitLab 17.7.
Vulnerability reports are migrated without their status.
For more information, see [issue 512859](https://gitlab.com/gitlab-org/gitlab/-/issues/512859).
For the `ActiveRecord::RecordNotUnique` error when migrating vulnerability reports,
see [issue 509904](https://gitlab.com/gitlab-org/gitlab/-/issues/509904).
{{< /alert >}}
- Wikis
### Issue-related items
Issue-related project items that are migrated to the destination GitLab instance include:
- Issue comments
- Issue iterations
- Issue resource iteration events
- Issue resource milestone events
- Issue resource state events
- Merge request URL references
- Time tracking
### Merge request-related items
Merge request-related project items that are migrated to the destination GitLab instance include:
- Issue URL references
- Merge request approvers
- Merge request comments
- Merge request resource milestone events
- Merge request resource state events
- Merge request reviewers
- Multiple merge request assignees
- Time tracking
### Setting-related items
Setting-related project items that are migrated to the destination GitLab instance include:
- Avatar
- Container expiration policy
- Project properties
- Service Desk
### Excluded items
Some project items are excluded from migration because they:
- Might contain sensitive information:
- CI/CD job logs
- CI/CD variables
- Container registry images
- Deploy keys
- Deploy tokens
- Encrypted tokens
- Job artifacts
- Pipeline schedule variables
- Pipeline triggers
- Webhooks
- Are not supported:
- Agents
- Container registry
- Custom fields
- Environments
- Feature flags
- Infrastructure registry
- Instance administrators in branch protection rules when migrating
from GitLab Self-Managed to GitLab.com or GitLab Dedicated
- Linked issues
- Merge request approval rules
- Merge request dependencies
- Package registry
- Pages domains
- Pending member invitations
- Remote mirrors
- Wiki comments
{{< alert type="note" >}}
Approval rules related to project settings are imported.
{{< /alert >}}
- Do not contain recoverable data:
- Merge requests with no diff or source information
(for more information, see [issue 537943](https://gitlab.com/gitlab-org/gitlab/-/issues/537943))
|
https://docs.gitlab.com/user/group/direct_transfer_migrations
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/direct_transfer_migrations.md
|
2025-08-13
|
doc/user/group/import
|
[
"doc",
"user",
"group",
"import"
] |
direct_transfer_migrations.md
|
Create
|
Import
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Migrate groups and projects by using direct transfer
|
Migrate groups and projects between GitLab instances by using direct transfer.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To migrate GitLab groups and projects by using direct transfer:
1. Ensure you meet the [prerequisites](#prerequisites).
1. Review [user contribution and membership mapping](#user-contribution-and-membership-mapping).
1. [Connect the source GitLab instance](#connect-the-source-gitlab-instance).
1. [Select groups and projects to import](#select-the-groups-and-projects-to-import) and begin the migration.
1. [Review the results of the import](#review-results-of-the-import).
If there are any problems, you can:
1. [Cancel](#cancel-a-running-migration) or [retry](#retry-failed-or-partially-successful-migrations) the migration.
1. Check the [troubleshooting information](troubleshooting.md).
## Prerequisites
{{< history >}}
- Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5.
{{< /history >}}
Before migrating by using direct transfer, see the following prerequisites.
### Network and storage space
- The network connection between instances or GitLab.com must support HTTPS.
- Firewalls must not block the connection between the source and destination GitLab instances.
- The source and destination GitLab instances must have enough free space in the `/tmp` directory
to create and extract archives of transferred projects and groups.
### Versions
To maximize the chance of a successful and performant migration:
- Upgrade both the source and destination instances to GitLab 16.8 or later for bulk import and export of relations.
For more information, see [epic 9036](https://gitlab.com/groups/gitlab-org/-/epics/9036).
- Migrate between versions that are as late as possible for bug fixes and other improvements.
If the source and destination instances are not the same version,
the source instance must not be more than two [minor](../../../policy/maintenance.md#versioning)
versions earlier than the destination instance.
This requirement does not apply for migrations from GitLab.com to GitLab Dedicated.
### Configuration
- Ensure [Sidekiq is properly configured](../../project/import/_index.md#sidekiq-configuration).
- Both GitLab instances must have group migration by direct transfer
[enabled in application settings](../../../administration/settings/import_and_export_settings.md#enable-migration-of-groups-and-projects-by-direct-transfer)
by an instance administrator.
- You must have a
[personal access token](../../profile/personal_access_tokens.md) for
the source GitLab instance:
- For GitLab 15.1 and later source instances, the personal access token must
have the `api` scope.
- For GitLab 15.0 and earlier source instances, the personal access token must
have both the `api` and `read_repository` scopes.
- You must have the required permissions on the source and destination instances. For:
- Most users, you need:
- The Owner role on the source group to migrate from.
- A role in the destination namespace that allows you to [create a subgroup](../subgroups/_index.md#create-a-subgroup) in that namespace.
- Administrators of both instances without the required roles, you can instead start the import by using
[the API](../../../api/bulk_imports.md#start-a-new-group-or-project-migration).
- To import project snippets, ensure snippets are
[enabled in the source project](../../snippets.md#change-default-visibility-of-snippets).
- To import items stored in object storage, you must either:
- [Configure `proxy_download`](../../../administration/object_storage.md#configure-the-common-parameters).
- Ensure that the destination GitLab instance has access to the object storage of the source GitLab instance.
- You cannot import groups with projects when the source instance or group has **Default minimum role required to create projects** set
to **No one**. If required, this setting can be changed:
- For [a whole instance](../../../administration/settings/visibility_and_access_controls.md#define-which-roles-can-create-projects).
- For [specific groups](../_index.md#specify-who-can-add-projects-to-a-group).
## User contribution and membership mapping
{{< details >}}
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Mapping of shared and inherited shared members as direct members was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129017) in GitLab 16.3.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148220) in GitLab 16.11, shared and inherited shared members are no longer mapped as direct members if they are already shared or inherited shared members of the imported group or project.
- Full support for mapping inherited membership [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/458834) in GitLab 17.1.
- Removed from direct transfer on GitLab.com in GitLab 17.5 in favor of [the alternative](../../project/import/_index.md#user-contribution-and-membership-mapping).
- Removed as the default direct transfer method on GitLab Self-Managed and GitLab Dedicated in GitLab 17.7 in favor of [the alternative](../../project/import/_index.md#user-contribution-and-membership-mapping).
{{< /history >}}
This method of user contribution and membership mapping is available for
GitLab Self-Managed when `bulk_import_importer_user_mapping` is disabled.
This feature flag is enabled by default.
For information on the default method available for GitLab Self-Managed and GitLab.com,
see [user contribution and membership mapping](../../project/import/_index.md#user-contribution-and-membership-mapping).
Users are never created during a migration. Instead, contributions and membership of users on the source instance are
mapped to users on the destination instance. The type of mapping of a user's membership depends on the
[membership type](../../project/members/_index.md#membership-types) on source instance:
- Direct memberships are mapped as direct memberships on the destination instance.
- Inherited memberships are mapped as inherited memberships on the destination instance.
- Shared memberships are mapped as direct memberships on the destination instance unless the user has an existing shared
membership. Full support for mapping shared memberships is proposed in
[issue 458345](https://gitlab.com/gitlab-org/gitlab/-/issues/458345).
When mapping [inherited and shared](../../project/members/_index.md#membership-types) memberships, if the user
has an existing membership in the destination namespace with a [higher role](../../permissions.md#roles) than
the one being mapped, the membership is mapped as a direct membership instead. This ensures the member does not get
elevated permissions.
{{< alert type="note" >}}
There is a [known issue](_index.md#known-issues) affecting the mapping of shared memberships.
{{< /alert >}}
### Configure users on destination instance
To ensure GitLab maps users and their contributions correctly between the source and destination instances:
1. Create the required users on the destination GitLab instance. You can create users with the API only on GitLab Self-Managed instances because it requires
administrator access. When migrating to GitLab.com or GitLab Self-Managed you can:
- Create users manually.
- Set up or use your existing [SAML SSO provider](../saml_sso/_index.md) and leverage user synchronization of SAML SSO groups supported through
[SCIM](../saml_sso/scim_setup.md). You can
[bypass the GitLab user account verification with verified email domains](../saml_sso/_index.md#bypass-user-email-confirmation-with-verified-domains).
1. Ensure that users have a [public email](../../profile/_index.md#set-your-public-email) on the source GitLab instance that matches any confirmed email address on the destination GitLab instance. Most
users receive an email asking them to confirm their email address.
1. If users already exist on the destination instance and you use [SAML SSO for GitLab.com groups](../saml_sso/_index.md), all users must
[link their SAML identity to their GitLab.com account](../saml_sso/_index.md#link-saml-to-your-existing-gitlabcom-account).
There is no way in the GitLab UI or API to automatically set public email addresses for users. If you need to set
a lot of user accounts to have public email addresses, see
[issue 284495](https://gitlab.com/gitlab-org/gitlab/-/issues/284495#note_1910159855) for a potential workaround.
## Connect the source GitLab instance
On the destination GitLab instance, create the group you want to import to and connect the source GitLab instance:
1. Create either:
- A new group. On the left sidebar, at the top, select **Create new** ({{< icon name="plus" >}}) and **New group**. Then select **Import group**.
- A new subgroup. On existing group's page, either:
- Select **New subgroup**.
- On the left sidebar, at the top, select **Create new** ({{< icon name="plus" >}}) and **New subgroup**. Then select the **import an existing group** link.
1. Enter the base URL of a GitLab instance.
1. Enter the [personal access token](../../profile/personal_access_tokens.md) for your source GitLab instance.
1. Select **Connect instance**.
## Select the groups and projects to import
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385689) in GitLab 15.8, option to import groups with or without projects.
- **Import user memberships** checkbox [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/477734) in GitLab 17.6.
{{< /history >}}
After you have authorized access to the source GitLab instance, you are redirected to the GitLab group importer page. Here you can see a list of the top-level groups on the connected source instance where you have the Owner role.
If you do not want to import all user memberships from the source instance, ensure the **Import user memberships** checkbox is cleared. For example, the source instance might have 200 members, but you might want to import 50 members only. After the import completes, you can add more members to groups and projects.
1. By default, the proposed group namespaces match the names as they exist in source instance, but based on your permissions, you can choose to edit these names before you proceed to import any of them. Group and project paths must conform to [naming rules](../../reserved_names.md#rules-for-usernames-project-and-group-names-and-slugs) and are normalized if necessary to avoid import failures.
1. Next to the groups you want to import, select either:
- **Import with projects**. If this is not available, see [prerequisites](#prerequisites).
- **Import without projects**.
1. The **Status** column shows the import status of each group. If you leave the page open, it updates in real-time.
1. After a group has been imported, select its GitLab path to open its GitLab URL.
## Review results of the import
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/429109) in GitLab 16.6 [with a flag](../../feature_flags.md) named `bulk_import_details_page`. Enabled by default.
- Feature flag `bulk_import_details_page` removed in GitLab 16.8.
- Details for partially completed and completed imports [added](https://gitlab.com/gitlab-org/gitlab/-/issues/437874) in GitLab 16.9.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/443492) in GitLab 17.0, an **Imported** badge to indicate that designs, epics, issues, merge requests, notes (system notes and comments), snippets, and user profile activity were imported.
{{< /history >}}
To review the results of an import:
1. Go to the [Group import history page](#group-import-history).
1. To see the details of a failed import, select the **Show errors** link on any import with a **Failed** or **Partially completed** status.
1. If the import has a **Partially completed** or **Complete** status, to see which items were and were not imported, select **View details**.
You can also see that an item was imported when you see an **Imported** badge on some items in the GitLab UI.
## Group import history
{{< history >}}
- **Partially completed** status [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394727) in GitLab 16.7.
{{< /history >}}
You can view all groups migrated by you by direct transfer listed on the group import history page. This list includes:
- Paths of source groups.
- Paths of destination groups.
- Start date of each import.
- Status of each import.
- Error details if any errors occurred.
To view group import history:
1. Sign in to GitLab.
1. On the left sidebar, at the top, select **Create new** ({{< icon name="plus" >}}) and **New group**.
1. Select **Import group**.
1. In the upper-right corner, select **View import history**.
1. If there are any errors for a particular import, select **Show errors** to see their details.
## Cancel a running migration
If required, you can cancel a running migration by using either the REST API or a Rails console.
### Cancel with the REST API
For information on cancelling a running migration with the REST API, see
[Cancel a migration](../../../api/bulk_imports.md#cancel-a-migration).
### Cancel with a Rails console
To cancel a running migration with a Rails console:
1. Start a [Rails console session](../../../administration/operations/rails_console.md#starting-a-rails-console-session)
on the destination GitLab instance.
1. Find the last import by running the following command. Replace `USER_ID` with the user ID of the user that started the import:
```ruby
bulk_import = BulkImport.where(user_id: USER_ID).last
```
1. Cause the import and all items associated with it to fail by running the following command:
```ruby
bulk_import.entities.each do |entity|
entity.trackers.each do |tracker|
tracker.batches.each(&:fail_op!)
end
entity.trackers.each(&:fail_op!)
entity.fail_op!
end
bulk_import.fail_op!
```
Cancelling a `bulk_import` doesn't stop workers that are exporting the project on the source instance, but prevents the
destination instance from:
- Asking the source instance for more projects to be exported.
- Making other API calls to the source instance for various checks and information.
## Retry failed or partially successful migrations
If your migrations fail, or partially succeed but are missing items, you can retry the migration. To retry a migration
of a:
- Top-level group and all of its subgroups and projects, use either the GitLab UI or the
[GitLab REST API](../../../api/bulk_imports.md).
- Specific subgroups or projects, use the [GitLab REST API](../../../api/bulk_imports.md).
|
---
stage: Create
group: Import
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Migrate groups and projects by using direct transfer
description: Migrate groups and projects between GitLab instances by using direct
transfer.
breadcrumbs:
- doc
- user
- group
- import
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To migrate GitLab groups and projects by using direct transfer:
1. Ensure you meet the [prerequisites](#prerequisites).
1. Review [user contribution and membership mapping](#user-contribution-and-membership-mapping).
1. [Connect the source GitLab instance](#connect-the-source-gitlab-instance).
1. [Select groups and projects to import](#select-the-groups-and-projects-to-import) and begin the migration.
1. [Review the results of the import](#review-results-of-the-import).
If there are any problems, you can:
1. [Cancel](#cancel-a-running-migration) or [retry](#retry-failed-or-partially-successful-migrations) the migration.
1. Check the [troubleshooting information](troubleshooting.md).
## Prerequisites
{{< history >}}
- Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5.
{{< /history >}}
Before migrating by using direct transfer, see the following prerequisites.
### Network and storage space
- The network connection between instances or GitLab.com must support HTTPS.
- Firewalls must not block the connection between the source and destination GitLab instances.
- The source and destination GitLab instances must have enough free space in the `/tmp` directory
to create and extract archives of transferred projects and groups.
### Versions
To maximize the chance of a successful and performant migration:
- Upgrade both the source and destination instances to GitLab 16.8 or later for bulk import and export of relations.
For more information, see [epic 9036](https://gitlab.com/groups/gitlab-org/-/epics/9036).
- Migrate between versions that are as late as possible for bug fixes and other improvements.
If the source and destination instances are not the same version,
the source instance must not be more than two [minor](../../../policy/maintenance.md#versioning)
versions earlier than the destination instance.
This requirement does not apply for migrations from GitLab.com to GitLab Dedicated.
### Configuration
- Ensure [Sidekiq is properly configured](../../project/import/_index.md#sidekiq-configuration).
- Both GitLab instances must have group migration by direct transfer
[enabled in application settings](../../../administration/settings/import_and_export_settings.md#enable-migration-of-groups-and-projects-by-direct-transfer)
by an instance administrator.
- You must have a
[personal access token](../../profile/personal_access_tokens.md) for
the source GitLab instance:
- For GitLab 15.1 and later source instances, the personal access token must
have the `api` scope.
- For GitLab 15.0 and earlier source instances, the personal access token must
have both the `api` and `read_repository` scopes.
- You must have the required permissions on the source and destination instances. For:
- Most users, you need:
- The Owner role on the source group to migrate from.
- A role in the destination namespace that allows you to [create a subgroup](../subgroups/_index.md#create-a-subgroup) in that namespace.
- Administrators of both instances without the required roles, you can instead start the import by using
[the API](../../../api/bulk_imports.md#start-a-new-group-or-project-migration).
- To import project snippets, ensure snippets are
[enabled in the source project](../../snippets.md#change-default-visibility-of-snippets).
- To import items stored in object storage, you must either:
- [Configure `proxy_download`](../../../administration/object_storage.md#configure-the-common-parameters).
- Ensure that the destination GitLab instance has access to the object storage of the source GitLab instance.
- You cannot import groups with projects when the source instance or group has **Default minimum role required to create projects** set
to **No one**. If required, this setting can be changed:
- For [a whole instance](../../../administration/settings/visibility_and_access_controls.md#define-which-roles-can-create-projects).
- For [specific groups](../_index.md#specify-who-can-add-projects-to-a-group).
## User contribution and membership mapping
{{< details >}}
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Mapping of shared and inherited shared members as direct members was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129017) in GitLab 16.3.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148220) in GitLab 16.11, shared and inherited shared members are no longer mapped as direct members if they are already shared or inherited shared members of the imported group or project.
- Full support for mapping inherited membership [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/458834) in GitLab 17.1.
- Removed from direct transfer on GitLab.com in GitLab 17.5 in favor of [the alternative](../../project/import/_index.md#user-contribution-and-membership-mapping).
- Removed as the default direct transfer method on GitLab Self-Managed and GitLab Dedicated in GitLab 17.7 in favor of [the alternative](../../project/import/_index.md#user-contribution-and-membership-mapping).
{{< /history >}}
This method of user contribution and membership mapping is available for
GitLab Self-Managed when `bulk_import_importer_user_mapping` is disabled.
This feature flag is enabled by default.
For information on the default method available for GitLab Self-Managed and GitLab.com,
see [user contribution and membership mapping](../../project/import/_index.md#user-contribution-and-membership-mapping).
Users are never created during a migration. Instead, contributions and membership of users on the source instance are
mapped to users on the destination instance. The type of mapping of a user's membership depends on the
[membership type](../../project/members/_index.md#membership-types) on source instance:
- Direct memberships are mapped as direct memberships on the destination instance.
- Inherited memberships are mapped as inherited memberships on the destination instance.
- Shared memberships are mapped as direct memberships on the destination instance unless the user has an existing shared
membership. Full support for mapping shared memberships is proposed in
[issue 458345](https://gitlab.com/gitlab-org/gitlab/-/issues/458345).
When mapping [inherited and shared](../../project/members/_index.md#membership-types) memberships, if the user
has an existing membership in the destination namespace with a [higher role](../../permissions.md#roles) than
the one being mapped, the membership is mapped as a direct membership instead. This ensures the member does not get
elevated permissions.
{{< alert type="note" >}}
There is a [known issue](_index.md#known-issues) affecting the mapping of shared memberships.
{{< /alert >}}
### Configure users on destination instance
To ensure GitLab maps users and their contributions correctly between the source and destination instances:
1. Create the required users on the destination GitLab instance. You can create users with the API only on GitLab Self-Managed instances because it requires
administrator access. When migrating to GitLab.com or GitLab Self-Managed you can:
- Create users manually.
- Set up or use your existing [SAML SSO provider](../saml_sso/_index.md) and leverage user synchronization of SAML SSO groups supported through
[SCIM](../saml_sso/scim_setup.md). You can
[bypass the GitLab user account verification with verified email domains](../saml_sso/_index.md#bypass-user-email-confirmation-with-verified-domains).
1. Ensure that users have a [public email](../../profile/_index.md#set-your-public-email) on the source GitLab instance that matches any confirmed email address on the destination GitLab instance. Most
users receive an email asking them to confirm their email address.
1. If users already exist on the destination instance and you use [SAML SSO for GitLab.com groups](../saml_sso/_index.md), all users must
[link their SAML identity to their GitLab.com account](../saml_sso/_index.md#link-saml-to-your-existing-gitlabcom-account).
There is no way in the GitLab UI or API to automatically set public email addresses for users. If you need to set
a lot of user accounts to have public email addresses, see
[issue 284495](https://gitlab.com/gitlab-org/gitlab/-/issues/284495#note_1910159855) for a potential workaround.
## Connect the source GitLab instance
On the destination GitLab instance, create the group you want to import to and connect the source GitLab instance:
1. Create either:
- A new group. On the left sidebar, at the top, select **Create new** ({{< icon name="plus" >}}) and **New group**. Then select **Import group**.
- A new subgroup. On existing group's page, either:
- Select **New subgroup**.
- On the left sidebar, at the top, select **Create new** ({{< icon name="plus" >}}) and **New subgroup**. Then select the **import an existing group** link.
1. Enter the base URL of a GitLab instance.
1. Enter the [personal access token](../../profile/personal_access_tokens.md) for your source GitLab instance.
1. Select **Connect instance**.
## Select the groups and projects to import
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385689) in GitLab 15.8, option to import groups with or without projects.
- **Import user memberships** checkbox [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/477734) in GitLab 17.6.
{{< /history >}}
After you have authorized access to the source GitLab instance, you are redirected to the GitLab group importer page. Here you can see a list of the top-level groups on the connected source instance where you have the Owner role.
If you do not want to import all user memberships from the source instance, ensure the **Import user memberships** checkbox is cleared. For example, the source instance might have 200 members, but you might want to import 50 members only. After the import completes, you can add more members to groups and projects.
1. By default, the proposed group namespaces match the names as they exist in source instance, but based on your permissions, you can choose to edit these names before you proceed to import any of them. Group and project paths must conform to [naming rules](../../reserved_names.md#rules-for-usernames-project-and-group-names-and-slugs) and are normalized if necessary to avoid import failures.
1. Next to the groups you want to import, select either:
- **Import with projects**. If this is not available, see [prerequisites](#prerequisites).
- **Import without projects**.
1. The **Status** column shows the import status of each group. If you leave the page open, it updates in real-time.
1. After a group has been imported, select its GitLab path to open its GitLab URL.
## Review results of the import
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/429109) in GitLab 16.6 [with a flag](../../feature_flags.md) named `bulk_import_details_page`. Enabled by default.
- Feature flag `bulk_import_details_page` removed in GitLab 16.8.
- Details for partially completed and completed imports [added](https://gitlab.com/gitlab-org/gitlab/-/issues/437874) in GitLab 16.9.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/443492) in GitLab 17.0, an **Imported** badge to indicate that designs, epics, issues, merge requests, notes (system notes and comments), snippets, and user profile activity were imported.
{{< /history >}}
To review the results of an import:
1. Go to the [Group import history page](#group-import-history).
1. To see the details of a failed import, select the **Show errors** link on any import with a **Failed** or **Partially completed** status.
1. If the import has a **Partially completed** or **Complete** status, to see which items were and were not imported, select **View details**.
You can also see that an item was imported when you see an **Imported** badge on some items in the GitLab UI.
## Group import history
{{< history >}}
- **Partially completed** status [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394727) in GitLab 16.7.
{{< /history >}}
You can view all groups migrated by you by direct transfer listed on the group import history page. This list includes:
- Paths of source groups.
- Paths of destination groups.
- Start date of each import.
- Status of each import.
- Error details if any errors occurred.
To view group import history:
1. Sign in to GitLab.
1. On the left sidebar, at the top, select **Create new** ({{< icon name="plus" >}}) and **New group**.
1. Select **Import group**.
1. In the upper-right corner, select **View import history**.
1. If there are any errors for a particular import, select **Show errors** to see their details.
## Cancel a running migration
If required, you can cancel a running migration by using either the REST API or a Rails console.
### Cancel with the REST API
For information on cancelling a running migration with the REST API, see
[Cancel a migration](../../../api/bulk_imports.md#cancel-a-migration).
### Cancel with a Rails console
To cancel a running migration with a Rails console:
1. Start a [Rails console session](../../../administration/operations/rails_console.md#starting-a-rails-console-session)
on the destination GitLab instance.
1. Find the last import by running the following command. Replace `USER_ID` with the user ID of the user that started the import:
```ruby
bulk_import = BulkImport.where(user_id: USER_ID).last
```
1. Cause the import and all items associated with it to fail by running the following command:
```ruby
bulk_import.entities.each do |entity|
entity.trackers.each do |tracker|
tracker.batches.each(&:fail_op!)
end
entity.trackers.each(&:fail_op!)
entity.fail_op!
end
bulk_import.fail_op!
```
Cancelling a `bulk_import` doesn't stop workers that are exporting the project on the source instance, but prevents the
destination instance from:
- Asking the source instance for more projects to be exported.
- Making other API calls to the source instance for various checks and information.
## Retry failed or partially successful migrations
If your migrations fail, or partially succeed but are missing items, you can retry the migration. To retry a migration
of a:
- Top-level group and all of its subgroups and projects, use either the GitLab UI or the
[GitLab REST API](../../../api/bulk_imports.md).
- Specific subgroups or projects, use the [GitLab REST API](../../../api/bulk_imports.md).
|
https://docs.gitlab.com/user/group/import
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/import
|
[
"doc",
"user",
"group",
"import"
] |
_index.md
|
Create
|
Import
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Migrating GitLab by using direct transfer
|
Direct transfer for data migration between GitLab instances.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.6.
- New application setting `bulk_import_enabled` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383268) in GitLab 15.8. `bulk_import` feature flag removed.
- `bulk_import_projects` feature flag [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.10.
{{< /history >}}
You can migrate GitLab groups:
- From GitLab Self-Managed and GitLab Dedicated to GitLab.com
- From GitLab.com to GitLab Self-Managed and GitLab Dedicated
- From one GitLab Self-Managed or GitLab Dedicated instance to another
- On the same GitLab instance
Migration by direct transfer creates a new copy of the group. If you want to move groups instead of copying groups, you
can [transfer groups](../manage.md#transfer-a-group) if the groups are in the same GitLab instance. Transferring groups
instead of migrating them is a faster and more complete option.
You can migrate groups in two ways:
- By direct transfer (recommended).
- By [uploading an export file](../../project/settings/import_export.md).
If you migrate from GitLab.com to a GitLab Self-Managed or GitLab Dedicated instance, an administrator can create users on the instance.
On GitLab Self-Managed and GitLab Dedicated, by default [migrating group items](migrated_items.md#migrated-group-items) is not available. To show the
feature, an administrator can [enable it in application settings](../../../administration/settings/import_and_export_settings.md#enable-migration-of-groups-and-projects-by-direct-transfer).
Migrating groups by direct transfer copies the groups from one place to another. You can:
- Copy many groups at once.
- In the GitLab UI, copy top-level groups to:
- Another top-level group.
- The subgroup of any existing top-level group.
- Another GitLab instance, including GitLab.com.
- In the [API](../../../api/bulk_imports.md), copy top-level groups and subgroups to these locations.
- Copy groups with or without projects.
Copying groups with projects is available by default on GitLab.com.
Not all group and project resources are copied. See list of copied resources below:
- [Migrated group items](migrated_items.md#migrated-group-items).
- [Migrated project items](migrated_items.md#migrated-project-items).
After you start a migration, you should not make any changes to imported groups or projects
on the source instance because these changes might not be copied to the destination instance.
We invite you to leave your feedback about migrating by direct transfer in
[the feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/284495).
## Migrating specific projects
Migrating groups by using direct transfer in the GitLab UI migrates all projects in the group. If you want to migrate only specific projects in the group by using direct
transfer, you must use the [API](../../../api/bulk_imports.md#start-a-new-group-or-project-migration).
## Known issues
- Because of [issue 406685](https://gitlab.com/gitlab-org/gitlab/-/issues/406685), files with a filename longer than 255 characters are not migrated.
- In GitLab 16.1 and earlier, you should **not** use direct transfer with
[scheduled scan execution policies](../../application_security/policies/scan_execution_policies.md).
- For a list of other known issues, see [epic 6629](https://gitlab.com/groups/gitlab-org/-/epics/6629).
- In GitLab 16.9 and earlier, because of [issue 438422](https://gitlab.com/gitlab-org/gitlab/-/issues/438422), you might see the
`DiffNote::NoteDiffFileCreationError` error. When this error occurs, the diff of a note on a merge request's diff
is missing, but the note and the merge request are still imported.
- When mapped from the source instance, shared members are mapped as direct members on the destination unless those
memberships already exist on the destination. This means that importing a top-level group on the source instance to a
top-level group on the destination instance always maps to direct members in projects, even though the source top-level
group contains the necessary shared membership hierarchy details. Support for full mapping of shared memberships is
proposed in [issue 458345](https://gitlab.com/gitlab-org/gitlab/-/issues/458345).
- In GitLab 17.0, 17.1, and 17.2, imported epics and work items are mapped
to the importing user rather than the original author.
## Estimating migration duration
Estimating the duration of migration by direct transfer is difficult. The following factors affect migration duration:
- Hardware and database resources available on the source and destination GitLab instances. More resources on the source and destination instances can result in
shorter migration duration because:
- The source instance receives API requests, and extracts and serializes the entities to export.
- The destination instance runs the jobs and creates the entities in its database.
- Complexity and size of data to be exported. For example, imagine you want to migrate two different projects with 1000 merge requests each. The two projects can take
very different amounts of time to migrate if one of the projects has a lot more attachments, comments, and other items on the merge requests. Therefore, the number
of merge requests on a project is a poor predictor of how long a project will take to migrate.
There's no exact formula to reliably estimate a migration. However, the average durations of each pipeline worker importing a project relation can help you to get an idea of how long importing your projects might take:
| Project resource type | Average time (in seconds) to import a record |
|:----------------------------|:---------------------------------------------|
| Empty Project | 2.4 |
| Repository | 20 |
| Project Attributes | 1.5 |
| Members | 0.2 |
| Labels | 0.1 |
| Milestones | 0.07 |
| Badges | 0.1 |
| Issues | 0.1 |
| Snippets | 0.05 |
| Snippet Repositories | 0.5 |
| Boards | 0.1 |
| Merge Requests | 1 |
| External Pull Requests | 0.5 |
| Protected Branches | 0.1 |
| Project Feature | 0.3 |
| Container Expiration Policy | 0.3 |
| Service Desk Setting | 0.3 |
| Releases | 0.1 |
| CI Pipelines | 0.2 |
| Commit Notes | 0.05 |
| Wiki | 10 |
| Uploads | 0.5 |
| LFS Objects | 0.5 |
| Design | 0.1 |
| Auto DevOps | 0.1 |
| Pipeline Schedules | 0.5 |
| References | 5 |
| Push rule | 0.1 |
Though it's difficult to predict migration duration, we've seen:
- 100 projects (19.9k issues, 83k merge requests, 100k+ pipelines) migrated in 8 hours.
- 1926 projects (22k issues, 160k merge requests, 1.1 million pipelines) migrated in 34 hours.
If you are migrating large projects and encounter problems with timeouts or duration of the migration, see [Reducing migration duration](#reducing-migration-duration).
## Reducing migration duration
These are some strategies for reducing the duration of migrations that use direct transfer.
### Add Sidekiq workers to the destination instance
A single direct transfer migration runs five entities (groups or projects) per import at a time,
regardless of the number of workers available on the destination instance.
More Sidekiq workers on the destination instance can reduce the time it takes to import each entity,
as long as the instance has enough resources to handle additional concurrent jobs.
In GitLab 16.8 and later, with the introduction of bulk import and export of relations,
the number of available workers on the destination instance has become more critical.
For more information about how to add Sidekiq workers to the destination instance,
see [Sidekiq configuration](../../project/import/_index.md#sidekiq-configuration).
### Redistribute large projects or start separate migrations
The number of workers on the source instance should be enough to export the 5 concurrent entities in parallel (for each running import). Otherwise, there can be
delays and potential timeouts as the destination is waiting for exported data to become available.
Distributing projects in different groups helps to avoid timeouts. If several large projects are in the same group, you can:
1. Move large projects to different groups or subgroups.
1. Start separate migrations each group and subgroup.
The GitLab UI can only migrate top-level groups. Using the API, you can also migrate subgroups.
## Limits
{{< history >}}
- Eight hour time limit on migrations [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/429867) in GitLab 16.7.
{{< /history >}}
Hardcoded limits apply on migration by direct transfer.
| Limit | Description |
|:------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 6 | Maximum number of migrations permitted by a destination GitLab instance per minute per user. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386452) in GitLab 15.9. |
| 210 seconds | Maximum number of seconds to wait for decompressing an archive file. |
| 50 MB | Maximum length an NDJSON row can have. |
| 5 minutes | Maximum number of seconds until an empty export status on source instance is raised. |
[Configurable limits](../../../administration/settings/account_and_limit_settings.md) are also available.
In GitLab 16.3 and later, the following previously hard-coded settings are [configurable](https://gitlab.com/gitlab-org/gitlab/-/issues/384976):
- Maximum relation size that can be downloaded from the source instance (set to 5 GiB).
- Maximum size of a decompressed archive (set to 10 GiB).
You can test the maximum relation size limit using these APIs:
- [Group relations export API](../../../api/group_relations_export.md).
- [Project relations export API](../../../api/project_relations_export.md)
If either API produces files larger than the maximum relation size limit, group migration by direct transfer fails.
## Visibility rules
After migration:
- Private groups and projects stay private.
- Internal groups and projects:
- Stay internal when copied into an internal group unless internal visibility is [restricted](../../../administration/settings/visibility_and_access_controls.md#restrict-visibility-levels). In that case, the groups and projects become private.
- Become private when copied into a private group.
- Public groups and projects:
- Stay public when copied into a public group unless public visibility is [restricted](../../../administration/settings/visibility_and_access_controls.md#restrict-visibility-levels). In that case, the groups and projects become internal.
- Become internal when copied into an internal group unless internal visibility is [restricted](../../../administration/settings/visibility_and_access_controls.md#restrict-visibility-levels). In that case, the groups and projects become private.
- Become private when copied into a private group.
If you used a private network on your source instance to hide content from the general public,
make sure to have a similar setup on the destination instance, or to import into a private group.
## Migration by direct transfer process
See [Migrate groups and projects by using direct transfer](direct_transfer_migrations.md).
|
---
stage: Create
group: Import
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Migrating GitLab by using direct transfer
description: Direct transfer for data migration between GitLab instances.
breadcrumbs:
- doc
- user
- group
- import
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.6.
- New application setting `bulk_import_enabled` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383268) in GitLab 15.8. `bulk_import` feature flag removed.
- `bulk_import_projects` feature flag [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.10.
{{< /history >}}
You can migrate GitLab groups:
- From GitLab Self-Managed and GitLab Dedicated to GitLab.com
- From GitLab.com to GitLab Self-Managed and GitLab Dedicated
- From one GitLab Self-Managed or GitLab Dedicated instance to another
- On the same GitLab instance
Migration by direct transfer creates a new copy of the group. If you want to move groups instead of copying groups, you
can [transfer groups](../manage.md#transfer-a-group) if the groups are in the same GitLab instance. Transferring groups
instead of migrating them is a faster and more complete option.
You can migrate groups in two ways:
- By direct transfer (recommended).
- By [uploading an export file](../../project/settings/import_export.md).
If you migrate from GitLab.com to a GitLab Self-Managed or GitLab Dedicated instance, an administrator can create users on the instance.
On GitLab Self-Managed and GitLab Dedicated, by default [migrating group items](migrated_items.md#migrated-group-items) is not available. To show the
feature, an administrator can [enable it in application settings](../../../administration/settings/import_and_export_settings.md#enable-migration-of-groups-and-projects-by-direct-transfer).
Migrating groups by direct transfer copies the groups from one place to another. You can:
- Copy many groups at once.
- In the GitLab UI, copy top-level groups to:
- Another top-level group.
- The subgroup of any existing top-level group.
- Another GitLab instance, including GitLab.com.
- In the [API](../../../api/bulk_imports.md), copy top-level groups and subgroups to these locations.
- Copy groups with or without projects.
Copying groups with projects is available by default on GitLab.com.
Not all group and project resources are copied. See list of copied resources below:
- [Migrated group items](migrated_items.md#migrated-group-items).
- [Migrated project items](migrated_items.md#migrated-project-items).
After you start a migration, you should not make any changes to imported groups or projects
on the source instance because these changes might not be copied to the destination instance.
We invite you to leave your feedback about migrating by direct transfer in
[the feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/284495).
## Migrating specific projects
Migrating groups by using direct transfer in the GitLab UI migrates all projects in the group. If you want to migrate only specific projects in the group by using direct
transfer, you must use the [API](../../../api/bulk_imports.md#start-a-new-group-or-project-migration).
## Known issues
- Because of [issue 406685](https://gitlab.com/gitlab-org/gitlab/-/issues/406685), files with a filename longer than 255 characters are not migrated.
- In GitLab 16.1 and earlier, you should **not** use direct transfer with
[scheduled scan execution policies](../../application_security/policies/scan_execution_policies.md).
- For a list of other known issues, see [epic 6629](https://gitlab.com/groups/gitlab-org/-/epics/6629).
- In GitLab 16.9 and earlier, because of [issue 438422](https://gitlab.com/gitlab-org/gitlab/-/issues/438422), you might see the
`DiffNote::NoteDiffFileCreationError` error. When this error occurs, the diff of a note on a merge request's diff
is missing, but the note and the merge request are still imported.
- When mapped from the source instance, shared members are mapped as direct members on the destination unless those
memberships already exist on the destination. This means that importing a top-level group on the source instance to a
top-level group on the destination instance always maps to direct members in projects, even though the source top-level
group contains the necessary shared membership hierarchy details. Support for full mapping of shared memberships is
proposed in [issue 458345](https://gitlab.com/gitlab-org/gitlab/-/issues/458345).
- In GitLab 17.0, 17.1, and 17.2, imported epics and work items are mapped
to the importing user rather than the original author.
## Estimating migration duration
Estimating the duration of migration by direct transfer is difficult. The following factors affect migration duration:
- Hardware and database resources available on the source and destination GitLab instances. More resources on the source and destination instances can result in
shorter migration duration because:
- The source instance receives API requests, and extracts and serializes the entities to export.
- The destination instance runs the jobs and creates the entities in its database.
- Complexity and size of data to be exported. For example, imagine you want to migrate two different projects with 1000 merge requests each. The two projects can take
very different amounts of time to migrate if one of the projects has a lot more attachments, comments, and other items on the merge requests. Therefore, the number
of merge requests on a project is a poor predictor of how long a project will take to migrate.
There's no exact formula to reliably estimate a migration. However, the average durations of each pipeline worker importing a project relation can help you to get an idea of how long importing your projects might take:
| Project resource type | Average time (in seconds) to import a record |
|:----------------------------|:---------------------------------------------|
| Empty Project | 2.4 |
| Repository | 20 |
| Project Attributes | 1.5 |
| Members | 0.2 |
| Labels | 0.1 |
| Milestones | 0.07 |
| Badges | 0.1 |
| Issues | 0.1 |
| Snippets | 0.05 |
| Snippet Repositories | 0.5 |
| Boards | 0.1 |
| Merge Requests | 1 |
| External Pull Requests | 0.5 |
| Protected Branches | 0.1 |
| Project Feature | 0.3 |
| Container Expiration Policy | 0.3 |
| Service Desk Setting | 0.3 |
| Releases | 0.1 |
| CI Pipelines | 0.2 |
| Commit Notes | 0.05 |
| Wiki | 10 |
| Uploads | 0.5 |
| LFS Objects | 0.5 |
| Design | 0.1 |
| Auto DevOps | 0.1 |
| Pipeline Schedules | 0.5 |
| References | 5 |
| Push rule | 0.1 |
Though it's difficult to predict migration duration, we've seen:
- 100 projects (19.9k issues, 83k merge requests, 100k+ pipelines) migrated in 8 hours.
- 1926 projects (22k issues, 160k merge requests, 1.1 million pipelines) migrated in 34 hours.
If you are migrating large projects and encounter problems with timeouts or duration of the migration, see [Reducing migration duration](#reducing-migration-duration).
## Reducing migration duration
These are some strategies for reducing the duration of migrations that use direct transfer.
### Add Sidekiq workers to the destination instance
A single direct transfer migration runs five entities (groups or projects) per import at a time,
regardless of the number of workers available on the destination instance.
More Sidekiq workers on the destination instance can reduce the time it takes to import each entity,
as long as the instance has enough resources to handle additional concurrent jobs.
In GitLab 16.8 and later, with the introduction of bulk import and export of relations,
the number of available workers on the destination instance has become more critical.
For more information about how to add Sidekiq workers to the destination instance,
see [Sidekiq configuration](../../project/import/_index.md#sidekiq-configuration).
### Redistribute large projects or start separate migrations
The number of workers on the source instance should be enough to export the 5 concurrent entities in parallel (for each running import). Otherwise, there can be
delays and potential timeouts as the destination is waiting for exported data to become available.
Distributing projects in different groups helps to avoid timeouts. If several large projects are in the same group, you can:
1. Move large projects to different groups or subgroups.
1. Start separate migrations each group and subgroup.
The GitLab UI can only migrate top-level groups. Using the API, you can also migrate subgroups.
## Limits
{{< history >}}
- Eight hour time limit on migrations [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/429867) in GitLab 16.7.
{{< /history >}}
Hardcoded limits apply on migration by direct transfer.
| Limit | Description |
|:------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 6 | Maximum number of migrations permitted by a destination GitLab instance per minute per user. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386452) in GitLab 15.9. |
| 210 seconds | Maximum number of seconds to wait for decompressing an archive file. |
| 50 MB | Maximum length an NDJSON row can have. |
| 5 minutes | Maximum number of seconds until an empty export status on source instance is raised. |
[Configurable limits](../../../administration/settings/account_and_limit_settings.md) are also available.
In GitLab 16.3 and later, the following previously hard-coded settings are [configurable](https://gitlab.com/gitlab-org/gitlab/-/issues/384976):
- Maximum relation size that can be downloaded from the source instance (set to 5 GiB).
- Maximum size of a decompressed archive (set to 10 GiB).
You can test the maximum relation size limit using these APIs:
- [Group relations export API](../../../api/group_relations_export.md).
- [Project relations export API](../../../api/project_relations_export.md)
If either API produces files larger than the maximum relation size limit, group migration by direct transfer fails.
## Visibility rules
After migration:
- Private groups and projects stay private.
- Internal groups and projects:
- Stay internal when copied into an internal group unless internal visibility is [restricted](../../../administration/settings/visibility_and_access_controls.md#restrict-visibility-levels). In that case, the groups and projects become private.
- Become private when copied into a private group.
- Public groups and projects:
- Stay public when copied into a public group unless public visibility is [restricted](../../../administration/settings/visibility_and_access_controls.md#restrict-visibility-levels). In that case, the groups and projects become internal.
- Become internal when copied into an internal group unless internal visibility is [restricted](../../../administration/settings/visibility_and_access_controls.md#restrict-visibility-levels). In that case, the groups and projects become private.
- Become private when copied into a private group.
If you used a private network on your source instance to hide content from the general public,
make sure to have a similar setup on the destination instance, or to import into a private group.
## Migration by direct transfer process
See [Migrate groups and projects by using direct transfer](direct_transfer_migrations.md).
|
https://docs.gitlab.com/user/group/troubleshooting
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/troubleshooting.md
|
2025-08-13
|
doc/user/group/import
|
[
"doc",
"user",
"group",
"import"
] |
troubleshooting.md
|
Create
|
Import
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Troubleshooting direct transfer migrations
|
Troubleshooting GitLab direct transfer migrations with Rails console commands, error solutions, and configuration tips.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
In a [rails console session](../../../administration/operations/rails_console.md#starting-a-rails-console-session),
you can find the failure or error messages for the group import attempt using:
```ruby
# Get relevant import records
import = BulkImports::Entity.where(namespace_id: Group.id).map(&:bulk_import).last
# Alternative lookup by user
import = BulkImport.where(user_id: User.find(...)).last
# Get list of import entities. Each entity represents either a group or a project
entities = import.entities
# Get a list of entity failures
entities.map(&:failures).flatten
# Alternative failure lookup by status
entities.where(status: [-1]).pluck(:destination_name, :destination_namespace, :status)
```
You can also see all migrated entities with any failures related to them using an
[API endpoint](../../../api/bulk_imports.md#list-all-group-or-project-migrations-entities).
## Stale imports
Migrations might stall or finish with a `timeout` status due to issues on the source or destination instance.
To resolve these issues, inspect the logs from both the source and destination instances.
### Source instance
On the source instance, stale imports are often due to excessive memory usage,
which might restart Sidekiq processes and interrupt export jobs.
The destination instance might wait for the export files until the migration eventually times out.
To check if the [group](../../../api/group_relations_export.md#export-status) or [project](../../../api/project_relations_export.md#export-status) relations were successfully exported,
run the following command:
```shell
curl --request GET --location "https://example.gitlab.com/api/v4/projects/:ID/export_relations/status" \
--header "PRIVATE-TOKEN: <your_access_token>"
```
If a relation has a status other than `1`, the relation was not successfully exported
and the issue is on the source instance.
You can also run the following command to search for interrupted export jobs.
Keep in mind that Sidekiq logs might rotate after restarts, so be sure to
check the rotated logs as well.
```shell
grep `BulkImports::RelationBatchExportWorker` sidekiq.log | grep "interrupted_count"
```
If Sidekiq restarts are causing the issue:
- Configure a separate Sidekiq process for export jobs.
For more information, see [Sidekiq configuration](../../project/import/_index.md#sidekiq-configuration).
If the problem persists, reduce Sidekiq concurrency to limit the number of jobs processed simultaneously.
- Increase Sidekiq memory limits:
If your instance has available memory, [increase the maximum RSS limit](../../../administration/sidekiq/sidekiq_memory_killer.md#configuring-the-limits) for Sidekiq processes.
For example, you can increase the limit from 2 GB to 3 GB to prevent frequent restarts.
- Increase maximum interruption count:
To allow more interruptions before a job fails, you can increase the maximum interruption count for
[`BulkImports::RelationBatchExportWorker`](https://gitlab.com/gitlab-org/gitlab/-/blob/b8e11d267cdd4a00807984f98a9d8d8cfa51602e/app/workers/bulk_imports/relation_batch_export_worker.rb#L4):
1. Add the following configuration to increase the limit to `20` (the default value is `3`):
```ruby
sidekiq_options max_retries_after_interruption: 20
```
1. Restart Sidekiq for the changes to take effect.
You can now trigger a new migration or use the
[relations export API](../../../api/project_relations_export.md#schedule-new-export) to manually trigger the export.
Check the [export status](../../../api/project_relations_export.md#export-status) to see if
relations are being exported successfully.
For example, to trigger the export of a specific project, run the following command:
```shell
curl --request POST --location "https://example.gitlab.com/api/v4/projects/:ID/export_relations" \
--header "PRIVATE-TOKEN: <your_access_token>" \
--form 'batched="true"'
```
### Destination instance
In rare cases, the destination instance might fail to migrate a group or project successfully.
For more information, see [issue 498720](https://gitlab.com/gitlab-org/gitlab/-/issues/498720).
To resolve this issue, migrate the groups or projects that failed by using the [import API](../../../api/import.md).
With this API, you can migrate specific groups and projects individually.
## Error: `404 Group Not Found`
If you attempt to import a group that has a path comprised of only numbers (for example, `5000`), GitLab attempts to
find the group by ID instead of the path. This causes a `404 Group Not Found` error in GitLab 15.4 and earlier.
To solve this, you must change the source group path to include a non-numerical character using either:
- The GitLab UI:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand **Advanced**.
1. Under **Change group URL**, change the group URL to include non-numeric characters.
- The [Groups API](../../../api/groups.md#update-group-attributes).
## Other `404` errors
You can receive other `404` errors when importing a group, for example:
```json
"exception_message": "Unsuccessful response 404 from [FILTERED] Bo...",
"exception_class": "BulkImports::NetworkError",
```
This error indicates a problem transferring from the source instance. To solve this, check that you have met the
[prerequisites](direct_transfer_migrations.md#prerequisites) on the source instance.
## Mismatched group or project path names
If a source group or project path doesn't conform to [naming rules](../../reserved_names.md#rules-for-usernames-project-and-group-names-and-slugs), the path is normalized to
ensure it is valid. For example, `Destination-Project-Path` is normalized to `destination-project-path`.
## Error: `command exited with error code 15 and Unable to save [FILTERED] into [FILTERED]`
You might receive the error `command exited with error code 15 and Unable to save [FILTERED] into [FILTERED]` in logs
when migrating projects by using direct transfer. If you receive this error, you can safely ignore it. GitLab retries
the exited command.
## Error: `Batch export [batch_number] from source instance failed`
On the destination instance, you might encounter the following error:
```plaintext
Batch export [batch_number] from source instance failed: [source instance error]
```
This error occurs when the source instance fails to export some records.
The most common reasons are:
- Insufficient disk space
- Multiple interruptions of Sidekiq jobs due to insufficient memory
- Database statement timeout
To resolve this issue:
1. Identify and fix the problem on the source instance.
1. Delete the partially imported project or group from the destination instance and initiate a new import.
For more information about the relations and batches that failed to export,
use the export status API endpoints for [projects](../../../api/project_relations_export.md#export-status)
and [groups](../../../api/group_relations_export.md#export-status) on the source instance.
## Error: `duplicate key value violates unique constraint`
When importing records, you might get the following error:
```plaintext
PG::UniqueViolation: ERROR: duplicate key value violates unique constraint
```
This error might occur when a Sidekiq worker processing the import
restarts due to high memory or CPU usage during import.
To reduce Sidekiq memory or CPU issues during import:
- Optimize [Sidekiq configuration](../../project/import/_index.md#sidekiq-configuration) for imports.
- Limit the number of concurrent jobs in the `bulk_import_concurrent_pipeline_batch_limit` [application setting](../../../api/settings.md).
## Error: `BulkImports::FileDownloadService::ServiceError Invalid content type`
When using direct transfer between GitLab instances, you might encounter the following error:
```plaintext
BulkImports::FileDownloadService::ServiceError Invalid content type
```
This error is related to how network traffic is routed between instances.
If a content type other than `application/gzip` is returned,
your network requests might be bypassing GitLab Workhorse.
To resolve this issue:
- Check that your Ingress is configured to route traffic through
GitLab Workhorse on port `8181` rather than directly to Puma.
- Consider enabling [proxy downloads](../../../administration/object_storage.md#proxy-download) for object storage.
|
---
stage: Create
group: Import
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting direct transfer migrations
description: Troubleshooting GitLab direct transfer migrations with Rails console
commands, error solutions, and configuration tips.
breadcrumbs:
- doc
- user
- group
- import
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
In a [rails console session](../../../administration/operations/rails_console.md#starting-a-rails-console-session),
you can find the failure or error messages for the group import attempt using:
```ruby
# Get relevant import records
import = BulkImports::Entity.where(namespace_id: Group.id).map(&:bulk_import).last
# Alternative lookup by user
import = BulkImport.where(user_id: User.find(...)).last
# Get list of import entities. Each entity represents either a group or a project
entities = import.entities
# Get a list of entity failures
entities.map(&:failures).flatten
# Alternative failure lookup by status
entities.where(status: [-1]).pluck(:destination_name, :destination_namespace, :status)
```
You can also see all migrated entities with any failures related to them using an
[API endpoint](../../../api/bulk_imports.md#list-all-group-or-project-migrations-entities).
## Stale imports
Migrations might stall or finish with a `timeout` status due to issues on the source or destination instance.
To resolve these issues, inspect the logs from both the source and destination instances.
### Source instance
On the source instance, stale imports are often due to excessive memory usage,
which might restart Sidekiq processes and interrupt export jobs.
The destination instance might wait for the export files until the migration eventually times out.
To check if the [group](../../../api/group_relations_export.md#export-status) or [project](../../../api/project_relations_export.md#export-status) relations were successfully exported,
run the following command:
```shell
curl --request GET --location "https://example.gitlab.com/api/v4/projects/:ID/export_relations/status" \
--header "PRIVATE-TOKEN: <your_access_token>"
```
If a relation has a status other than `1`, the relation was not successfully exported
and the issue is on the source instance.
You can also run the following command to search for interrupted export jobs.
Keep in mind that Sidekiq logs might rotate after restarts, so be sure to
check the rotated logs as well.
```shell
grep `BulkImports::RelationBatchExportWorker` sidekiq.log | grep "interrupted_count"
```
If Sidekiq restarts are causing the issue:
- Configure a separate Sidekiq process for export jobs.
For more information, see [Sidekiq configuration](../../project/import/_index.md#sidekiq-configuration).
If the problem persists, reduce Sidekiq concurrency to limit the number of jobs processed simultaneously.
- Increase Sidekiq memory limits:
If your instance has available memory, [increase the maximum RSS limit](../../../administration/sidekiq/sidekiq_memory_killer.md#configuring-the-limits) for Sidekiq processes.
For example, you can increase the limit from 2 GB to 3 GB to prevent frequent restarts.
- Increase maximum interruption count:
To allow more interruptions before a job fails, you can increase the maximum interruption count for
[`BulkImports::RelationBatchExportWorker`](https://gitlab.com/gitlab-org/gitlab/-/blob/b8e11d267cdd4a00807984f98a9d8d8cfa51602e/app/workers/bulk_imports/relation_batch_export_worker.rb#L4):
1. Add the following configuration to increase the limit to `20` (the default value is `3`):
```ruby
sidekiq_options max_retries_after_interruption: 20
```
1. Restart Sidekiq for the changes to take effect.
You can now trigger a new migration or use the
[relations export API](../../../api/project_relations_export.md#schedule-new-export) to manually trigger the export.
Check the [export status](../../../api/project_relations_export.md#export-status) to see if
relations are being exported successfully.
For example, to trigger the export of a specific project, run the following command:
```shell
curl --request POST --location "https://example.gitlab.com/api/v4/projects/:ID/export_relations" \
--header "PRIVATE-TOKEN: <your_access_token>" \
--form 'batched="true"'
```
### Destination instance
In rare cases, the destination instance might fail to migrate a group or project successfully.
For more information, see [issue 498720](https://gitlab.com/gitlab-org/gitlab/-/issues/498720).
To resolve this issue, migrate the groups or projects that failed by using the [import API](../../../api/import.md).
With this API, you can migrate specific groups and projects individually.
## Error: `404 Group Not Found`
If you attempt to import a group that has a path comprised of only numbers (for example, `5000`), GitLab attempts to
find the group by ID instead of the path. This causes a `404 Group Not Found` error in GitLab 15.4 and earlier.
To solve this, you must change the source group path to include a non-numerical character using either:
- The GitLab UI:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand **Advanced**.
1. Under **Change group URL**, change the group URL to include non-numeric characters.
- The [Groups API](../../../api/groups.md#update-group-attributes).
## Other `404` errors
You can receive other `404` errors when importing a group, for example:
```json
"exception_message": "Unsuccessful response 404 from [FILTERED] Bo...",
"exception_class": "BulkImports::NetworkError",
```
This error indicates a problem transferring from the source instance. To solve this, check that you have met the
[prerequisites](direct_transfer_migrations.md#prerequisites) on the source instance.
## Mismatched group or project path names
If a source group or project path doesn't conform to [naming rules](../../reserved_names.md#rules-for-usernames-project-and-group-names-and-slugs), the path is normalized to
ensure it is valid. For example, `Destination-Project-Path` is normalized to `destination-project-path`.
## Error: `command exited with error code 15 and Unable to save [FILTERED] into [FILTERED]`
You might receive the error `command exited with error code 15 and Unable to save [FILTERED] into [FILTERED]` in logs
when migrating projects by using direct transfer. If you receive this error, you can safely ignore it. GitLab retries
the exited command.
## Error: `Batch export [batch_number] from source instance failed`
On the destination instance, you might encounter the following error:
```plaintext
Batch export [batch_number] from source instance failed: [source instance error]
```
This error occurs when the source instance fails to export some records.
The most common reasons are:
- Insufficient disk space
- Multiple interruptions of Sidekiq jobs due to insufficient memory
- Database statement timeout
To resolve this issue:
1. Identify and fix the problem on the source instance.
1. Delete the partially imported project or group from the destination instance and initiate a new import.
For more information about the relations and batches that failed to export,
use the export status API endpoints for [projects](../../../api/project_relations_export.md#export-status)
and [groups](../../../api/group_relations_export.md#export-status) on the source instance.
## Error: `duplicate key value violates unique constraint`
When importing records, you might get the following error:
```plaintext
PG::UniqueViolation: ERROR: duplicate key value violates unique constraint
```
This error might occur when a Sidekiq worker processing the import
restarts due to high memory or CPU usage during import.
To reduce Sidekiq memory or CPU issues during import:
- Optimize [Sidekiq configuration](../../project/import/_index.md#sidekiq-configuration) for imports.
- Limit the number of concurrent jobs in the `bulk_import_concurrent_pipeline_batch_limit` [application setting](../../../api/settings.md).
## Error: `BulkImports::FileDownloadService::ServiceError Invalid content type`
When using direct transfer between GitLab instances, you might encounter the following error:
```plaintext
BulkImports::FileDownloadService::ServiceError Invalid content type
```
This error is related to how network traffic is routed between instances.
If a content type other than `application/gzip` is returned,
your network requests might be bypassing GitLab Workhorse.
To resolve this issue:
- Check that your Ingress is configured to route traffic through
GitLab Workhorse on port `8181` rather than directly to Puma.
- Consider enabling [proxy downloads](../../../administration/object_storage.md#proxy-download) for object storage.
|
https://docs.gitlab.com/user/group/issues_analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/issues_analytics
|
[
"doc",
"user",
"group",
"issues_analytics"
] |
_index.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Issue analytics
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Issue analytics provide insights into the issues created each month in a group or project.
A bar chart illustrates the number of issues opened and closed each month.
A table displays the top 100 issues based on the global page filters, with the following details about each issue:
- Name
- Age
- Status
- Milestone
- Iteration
- Weight
- Due date
- Assignee
- Author
## View issue analytics
To view issue analytics:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Issue analytics**. To view the total number of issues for a month, hover over a bar.
1. Optional. To filter the results, in **Search or filter results** text box, enter your criteria:
- Author
- Assignee
- Milestone
- Label
- My reaction
- Weight
1. Optional. To change the total number of months displayed, append the parameter `months_back=n` to the URL.
For example, `https://gitlab.com/groups/gitlab-org/-/issues_analytics?months_back=15`
displays a chart with data for 15 months for the GitLab.org group.
You can also access issue analytics from the [Value Streams Dashboard](../../analytics/value_streams_dashboard.md) through the **New issues** drill-down report.
### Enhanced issue analytics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/233905/) in GitLab 16.3 [with a flag](../../../administration/feature_flags/_index.md) named `issues_completed_analytics_feature_flag`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/437542) in GitLab 16.8.
- [Feature flag `issues_completed_analytics_feature_flag`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/146766) removed in GitLab 16.10.
{{< /history >}}
Enhanced issue analytics display the additional metric `Issues closed`, which represents the total number of resolved issues in your group over a selected period.
You can use this metric to improve the overall turn-around time and value delivered to your customers.
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Issue analytics
breadcrumbs:
- doc
- user
- group
- issues_analytics
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Issue analytics provide insights into the issues created each month in a group or project.
A bar chart illustrates the number of issues opened and closed each month.
A table displays the top 100 issues based on the global page filters, with the following details about each issue:
- Name
- Age
- Status
- Milestone
- Iteration
- Weight
- Due date
- Assignee
- Author
## View issue analytics
To view issue analytics:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Issue analytics**. To view the total number of issues for a month, hover over a bar.
1. Optional. To filter the results, in **Search or filter results** text box, enter your criteria:
- Author
- Assignee
- Milestone
- Label
- My reaction
- Weight
1. Optional. To change the total number of months displayed, append the parameter `months_back=n` to the URL.
For example, `https://gitlab.com/groups/gitlab-org/-/issues_analytics?months_back=15`
displays a chart with data for 15 months for the GitLab.org group.
You can also access issue analytics from the [Value Streams Dashboard](../../analytics/value_streams_dashboard.md) through the **New issues** drill-down report.
### Enhanced issue analytics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/233905/) in GitLab 16.3 [with a flag](../../../administration/feature_flags/_index.md) named `issues_completed_analytics_feature_flag`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/437542) in GitLab 16.8.
- [Feature flag `issues_completed_analytics_feature_flag`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/146766) removed in GitLab 16.10.
{{< /history >}}
Enhanced issue analytics display the additional metric `Issues closed`, which represents the total number of resolved issues in your group over a selected period.
You can use this metric to improve the overall turn-around time and value delivered to your customers.
|
https://docs.gitlab.com/user/group/roadmap
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/roadmap
|
[
"doc",
"user",
"group",
"roadmap"
] |
_index.md
|
Plan
|
Product Planning
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Roadmap
|
Epic progress, timelines, milestones, and goals.
|
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Epics in a group containing a start date or due date can be visualized in a form
of a timeline.
The roadmap in GitLab provides a high-level overview of the planned work and progress of epics and
milestones in a timeline view (that is, a Gantt chart).
Use the roadmap to visualize and communicate the strategic direction and dependencies of your projects.
The epic roadmap offers the following benefits:
- Aligns the team around a shared vision and goals.
- Assists long-term planning and resource allocation.
- Identifies potential blockers, dependencies, and risks early.
- Provides stakeholders with a clear understanding of the project's timeline and milestones.
- Helps track and update the project's progress.
## View the roadmap
To view the roadmap in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Roadmap**.
The roadmap shows the epics and milestones in a
group, one of its subgroups, or a project in one of the groups.
On the epic bars, you can see each epic's title, progress, and completed weight percentage.
When you hover over an epic bar, a popover appears with the epic's title, start date, due date, and
weight completed.
You can expand epics that contain child epics to show their child epics in the roadmap.
You can select the chevron ({{< icon name="chevron-down" >}}) next to the epic title to expand and collapse the
child epics.
On top of the milestone bars, you can see their title. When you point to a
milestone bar or title, a popover appears with its title, start date, and due
date. You can also select the chevron ({{< icon name="chevron-down" >}}) next to the **Milestones**
heading to toggle the list of the milestone bars.
From an epic, you can also [view the roadmap filtered to this epic's descendants](../epics/_index.md#roadmap-in-epics).
## Sort and filter the roadmap
{{< history >}}
- Filtering by group was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385191) in GitLab 15.9.
- Sorting by title, created date, and last updated date [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/460492) in GitLab 17.0.
{{< /history >}}
{{< alert type="note" >}}
Filtering roadmaps by milestone might not be available to you. Be sure to review this section's history for details.
{{< /alert >}}
When you want to explore a roadmap, there are several ways to make it easier by sorting epics or
filtering them by what's important for you.
In the Roadmap view, you can sort epics by:
- Start date
- Due date
- Title
- Created date
- Last updated date
Each option contains a button that toggles the sort order between **ascending**
and **descending**. The sort option and order persist when browsing epics, including
the [epics list view](../epics/_index.md).
In the Roadmap view, you can also filter by the epics':
- Author
- Label
- Milestone
- [Confidentiality](../epics/manage_epics.md#make-an-epic-confidential)
- Epic
- Your Reaction
- Groups
From an epic, you can also [view the roadmap filtered to this epic's descendants](../epics/_index.md#roadmap-in-epics).
### Improve the performance of the roadmap
If your group contains a lot of epics, using filters can reduce the time your roadmap takes to load.
Filtering the roadmap reduces the amount of data the roadmap contains. Reducing
the data in the roadmap can also make it easier for you to find the information you're looking for.
In particular, filtering based on labels can result in a significant performance improvement.
After you set the filters you want to apply, you can save the URL as bookmark in your
browser.
In the future, you can quickly load the filtered roadmap using the bookmark.
### Roadmap settings
{{< history >}}
- Labels visible on roadmaps [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385231) in GitLab 15.9.
{{< /history >}}
When you enable the roadmap settings sidebar, you can use it to refine epics shown in the roadmap.
You can configure the following:
- Select date range.
- Turn milestones on or off, and select whether to show all, group, subgroup, or
project milestones.
- Show all, open, or closed epics.
- Turn progress tracking for child issues on or off and select whether
to use issue weights or counts to calculate progress.
- Turn labels on or off.
The roadmap configuration settings aren't saved in user preferences, but are saved or
shared using URL parameters.
## Timeline duration
{{< history >}}
- [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/198062) from GitLab Ultimate to GitLab Premium in 12.9.
{{< /history >}}
### Date range presets
Roadmap provides these date range options, each with a predetermined timeline duration:
- **This quarter**: Includes the weeks present in the current quarter.
- **This year**: Includes the weeks or months present in the current year.
- **Within 3 years**: Includes the weeks, months, or quarters present both in
the previous 18 months and the upcoming 18 months (three years in total).
### Layout presets
Depending on selected [date range preset](#date-range-presets), the roadmap supports
these layout presets:
- **Quarters**: Available only when the **Within 3 years** date range is selected.
- **Months**: Available when either **This year** or **Within 3 years** date range is selected.
- **Weeks** (default): Available for all the date range presets.
### Quarters
In the **Quarters** preset, roadmap shows epics and milestones which have start or due dates
**falling within** currently selected date range preset,
where **today**
is shown by the vertical red line in the timeline. The sub-headers underneath the quarter name on
the timeline header represent the month of the quarter.
### Months
In the **Months** preset, roadmap shows epics and milestones which have start or
due dates **falling within** or **going through** currently selected date range
preset, where **today** is shown by the vertical red line in the timeline. The
sub-headers underneath the month name on the timeline header represent the date
on the start day (Sunday) of the week. This preset is selected by default.
### Weeks
In the **Weeks** preset, roadmap shows epics and milestones which have start or due dates **falling
within** or **going through** currently selected date range preset, where **today**
is shown by the vertical red line in the timeline. The sub-headers underneath the week name on
the timeline header represent the days of the week.
## Roadmap timeline bar
The timeline bar indicates the approximate position of an epic or milestone based on its start and
due dates.
## Blocked epics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33587) in GitLab 15.5: View blocking epics when hovering over the "blocked" icon.
{{< /history >}}
If an epic is [blocked by another epic](../epics/linked_epics.md#blocking-epics), an icon appears next to its title to indicate its blocked status.
When you hover over the blocked icon ({{< icon name="entity-blocked" >}}), a detailed information popover is displayed.
|
---
stage: Plan
group: Product Planning
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Roadmap
description: Epic progress, timelines, milestones, and goals.
breadcrumbs:
- doc
- user
- group
- roadmap
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Epics in a group containing a start date or due date can be visualized in a form
of a timeline.
The roadmap in GitLab provides a high-level overview of the planned work and progress of epics and
milestones in a timeline view (that is, a Gantt chart).
Use the roadmap to visualize and communicate the strategic direction and dependencies of your projects.
The epic roadmap offers the following benefits:
- Aligns the team around a shared vision and goals.
- Assists long-term planning and resource allocation.
- Identifies potential blockers, dependencies, and risks early.
- Provides stakeholders with a clear understanding of the project's timeline and milestones.
- Helps track and update the project's progress.
## View the roadmap
To view the roadmap in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Roadmap**.
The roadmap shows the epics and milestones in a
group, one of its subgroups, or a project in one of the groups.
On the epic bars, you can see each epic's title, progress, and completed weight percentage.
When you hover over an epic bar, a popover appears with the epic's title, start date, due date, and
weight completed.
You can expand epics that contain child epics to show their child epics in the roadmap.
You can select the chevron ({{< icon name="chevron-down" >}}) next to the epic title to expand and collapse the
child epics.
On top of the milestone bars, you can see their title. When you point to a
milestone bar or title, a popover appears with its title, start date, and due
date. You can also select the chevron ({{< icon name="chevron-down" >}}) next to the **Milestones**
heading to toggle the list of the milestone bars.
From an epic, you can also [view the roadmap filtered to this epic's descendants](../epics/_index.md#roadmap-in-epics).
## Sort and filter the roadmap
{{< history >}}
- Filtering by group was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385191) in GitLab 15.9.
- Sorting by title, created date, and last updated date [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/460492) in GitLab 17.0.
{{< /history >}}
{{< alert type="note" >}}
Filtering roadmaps by milestone might not be available to you. Be sure to review this section's history for details.
{{< /alert >}}
When you want to explore a roadmap, there are several ways to make it easier by sorting epics or
filtering them by what's important for you.
In the Roadmap view, you can sort epics by:
- Start date
- Due date
- Title
- Created date
- Last updated date
Each option contains a button that toggles the sort order between **ascending**
and **descending**. The sort option and order persist when browsing epics, including
the [epics list view](../epics/_index.md).
In the Roadmap view, you can also filter by the epics':
- Author
- Label
- Milestone
- [Confidentiality](../epics/manage_epics.md#make-an-epic-confidential)
- Epic
- Your Reaction
- Groups
From an epic, you can also [view the roadmap filtered to this epic's descendants](../epics/_index.md#roadmap-in-epics).
### Improve the performance of the roadmap
If your group contains a lot of epics, using filters can reduce the time your roadmap takes to load.
Filtering the roadmap reduces the amount of data the roadmap contains. Reducing
the data in the roadmap can also make it easier for you to find the information you're looking for.
In particular, filtering based on labels can result in a significant performance improvement.
After you set the filters you want to apply, you can save the URL as bookmark in your
browser.
In the future, you can quickly load the filtered roadmap using the bookmark.
### Roadmap settings
{{< history >}}
- Labels visible on roadmaps [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385231) in GitLab 15.9.
{{< /history >}}
When you enable the roadmap settings sidebar, you can use it to refine epics shown in the roadmap.
You can configure the following:
- Select date range.
- Turn milestones on or off, and select whether to show all, group, subgroup, or
project milestones.
- Show all, open, or closed epics.
- Turn progress tracking for child issues on or off and select whether
to use issue weights or counts to calculate progress.
- Turn labels on or off.
The roadmap configuration settings aren't saved in user preferences, but are saved or
shared using URL parameters.
## Timeline duration
{{< history >}}
- [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/198062) from GitLab Ultimate to GitLab Premium in 12.9.
{{< /history >}}
### Date range presets
Roadmap provides these date range options, each with a predetermined timeline duration:
- **This quarter**: Includes the weeks present in the current quarter.
- **This year**: Includes the weeks or months present in the current year.
- **Within 3 years**: Includes the weeks, months, or quarters present both in
the previous 18 months and the upcoming 18 months (three years in total).
### Layout presets
Depending on selected [date range preset](#date-range-presets), the roadmap supports
these layout presets:
- **Quarters**: Available only when the **Within 3 years** date range is selected.
- **Months**: Available when either **This year** or **Within 3 years** date range is selected.
- **Weeks** (default): Available for all the date range presets.
### Quarters
In the **Quarters** preset, roadmap shows epics and milestones which have start or due dates
**falling within** currently selected date range preset,
where **today**
is shown by the vertical red line in the timeline. The sub-headers underneath the quarter name on
the timeline header represent the month of the quarter.
### Months
In the **Months** preset, roadmap shows epics and milestones which have start or
due dates **falling within** or **going through** currently selected date range
preset, where **today** is shown by the vertical red line in the timeline. The
sub-headers underneath the month name on the timeline header represent the date
on the start day (Sunday) of the week. This preset is selected by default.
### Weeks
In the **Weeks** preset, roadmap shows epics and milestones which have start or due dates **falling
within** or **going through** currently selected date range preset, where **today**
is shown by the vertical red line in the timeline. The sub-headers underneath the week name on
the timeline header represent the days of the week.
## Roadmap timeline bar
The timeline bar indicates the approximate position of an epic or milestone based on its start and
due dates.
## Blocked epics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33587) in GitLab 15.5: View blocking epics when hovering over the "blocked" icon.
{{< /history >}}
If an epic is [blocked by another epic](../epics/linked_epics.md#blocking-epics), an icon appears next to its title to indicate its blocked status.
When you hover over the blocked icon ({{< icon name="entity-blocked" >}}), a detailed information popover is displayed.
|
https://docs.gitlab.com/user/group/group_access_tokens
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/group_access_tokens.md
|
2025-08-13
|
doc/user/group/settings
|
[
"doc",
"user",
"group",
"settings"
] |
group_access_tokens.md
|
Software Supply Chain Security
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Group access tokens
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
With group access tokens, you can use a single token to:
- Perform actions for groups.
- Manage the projects within the group.
You can use a group access token to authenticate:
- With the [GitLab API](../../../api/rest/authentication.md#personalprojectgroup-access-tokens).
- Authenticate with Git over HTTPS. Use:
- Any non-blank value as a username.
- The group access token as the password.
Group access tokens are similar to [project access tokens](../../project/settings/project_access_tokens.md)
and [personal access tokens](../../profile/personal_access_tokens.md), except they are
associated with a group rather than a project or user.
You cannot use group access tokens to create other group, project, or personal access tokens.
Group access tokens inherit the [default prefix setting](../../../administration/settings/account_and_limit_settings.md#personal-access-token-prefix)
configured for personal access tokens.
## Availability
- On GitLab.com, you can use group access tokens if you have the Premium or Ultimate license tier,
but not with a [trial license](https://about.gitlab.com/free-trial/).
- On GitLab Dedicated and GitLab Self-Managed instances:
- You can use group access tokens with any license tier. If you have the Free tier:
- Review your security and compliance policies around [user self-enrollment](../../../administration/settings/sign_up_restrictions.md#disable-new-sign-ups).
- Consider [restricting the creation of group access tokens](#restrict-the-creation-of-group-access-tokens) to lower potential abuse.
- Group access tokens are subject to the same [maximum lifetime limits](../../../administration/settings/account_and_limit_settings.md#limit-the-lifetime-of-access-tokens)
as personal access tokens if the limit is set.
## Create a group access token
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/348660) in GitLab 15.3, default expiration of 30 days and default role of Guest is populated in the UI.
- Ability to create non-expiring group access tokens [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/392855) in GitLab 16.0.
- Maximum allowable lifetime limit [extended to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901) in GitLab 17.6 [with a flag](../../../administration/feature_flags/_index.md) named `buffered_token_expiration_limit`. Disabled by default.
- Group access token description [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/443819) in GitLab 17.7.
{{< /history >}}
{{< alert type="flag" >}}
The availability of the extended maximum allowable lifetime limit is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
{{< alert type="warning" >}}
The ability to create group access tokens without an expiry date was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/369122) in GitLab 15.4 and [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/392855) in GitLab 16.0. For more information on expiry dates added to existing tokens, see the documentation on [access token expiration](#access-token-expiration).
{{< /alert >}}
### With the UI
To create a group access token:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > Access tokens**.
1. Select **Add new token**.
1. In **Token name**, enter a name. The token name is visible to any user with permissions to view the group.
1. Optional. In **Token description**, enter a description for the token.
1. In **Expiration date**, enter an expiry date for the token:
- The token expires on that date at midnight UTC. A token with the expiration date of 2024-01-01 expires at 00:00:00 UTC on 2024-01-01.
- If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
- By default, this date can be a maximum of 365 days later than the current date. In GitLab 17.6 or later, you can [extend this limit to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901).
- An instance-wide [maximum lifetime](../../../administration/settings/account_and_limit_settings.md#limit-the-lifetime-of-access-tokens) setting can limit the maximum allowable lifetime in GitLab Self-Managed instances.
1. Select a role for the token.
1. Select the [desired scopes](#scopes-for-a-group-access-token).
1. Select **Create group access token**.
A group access token is displayed. Save the group access token somewhere safe. After you leave or refresh the page, you can't view it again.
{{< alert type="warning" >}}
Group access tokens are treated as [internal users](../../../administration/internal_users.md).
If an internal user creates a group access token, that token is able to access
all projects that have visibility level set to [Internal](../../public_access.md).
{{< /alert >}}
### With the Rails console
If you are an administrator, you can create group access tokens in the Rails console:
1. Run the following commands in a [Rails console](../../../administration/operations/rails_console.md):
```ruby
# Set the GitLab administration user to use. If user ID 1 is not available or is not an administrator, use 'admin = User.admins.first' instead to select an administrator.
admin = User.find(1)
# Set the group you want to create a token for. For example, group with ID 109.
group = Group.find(109)
# Create the group bot user. For further group access tokens, the username should be `group_{group_id}_bot_{random_string}` and email address `group_{group_id}_bot_{random_string}@noreply.{Gitlab.config.gitlab.host}`.
random_string = SecureRandom.hex(16)
service_response = Users::CreateService.new(admin, { name: 'group_token', username: "group_#{group.id}_bot_#{random_string}", email: "group_#{group.id}_bot_#{random_string}@noreply.#{Gitlab.config.gitlab.host}", user_type: :project_bot }).execute
bot = service_response.payload[:user] if service_response.success?
# Confirm the group bot.
bot.confirm
# Add the bot to the group with the required role.
group.add_member(bot, :maintainer)
# Give the bot a personal access token.
token = bot.personal_access_tokens.create(scopes:[:api, :write_repository], name: 'group_token')
# Get the token value.
gtoken = token.token
```
1. Test if the generated group access token works:
1. Use the group access token in the `PRIVATE-TOKEN` header with GitLab REST APIs. For example:
- [Create an epic](../../../api/epics.md#new-epic) in the group.
- [Create a project pipeline](../../../api/pipelines.md#create-a-new-pipeline) in one of the group's projects.
- [Create an issue](../../../api/issues.md#new-issue) in one of the group's projects.
1. Use the group token to [clone a group's project](../../../topics/git/clone.md#clone-with-https)
using HTTPS.
## Revoke or rotate a group access token
{{< history >}}
- Ability to view expired and revoked tokens [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/462217) in GitLab 17.3 [with a flag](../../../administration/feature_flags/_index.md) named `retain_resource_access_token_user_after_revoke`. Disabled by default.
- Ability to view expired and revoked tokens until they are automatically deleted and [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/471683) in GitLab 17.9. Feature flag `retain_resource_access_token_user_after_revoke` removed.
{{< /history >}}
In GitLab 17.9 and later, you can view both active and inactive group
access tokens on the access tokens page.
The inactive group access tokens table displays revoked and expired tokens until they are [automatically deleted](../../project/settings/project_access_tokens.md#inactive-token-retention).
To revoke or rotate a group access token:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > Access tokens**.
1. For the relevant token, select **Revoke** ({{< icon name="remove" >}}) or **Rotate** ({{< icon name="retry" >}}).
1. On the confirmation dialog, select **Revoke** or **Rotate**.
## Scopes for a group access token
{{< history >}}
- `k8s_proxy` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/422408) in GitLab 16.4 [with a flag](../../../administration/feature_flags/_index.md) named `k8s_proxy_pat`. Enabled by default.
- Feature flag `k8s_proxy_pat` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131518) in GitLab 16.5.
- `self_rotate` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/178111) in GitLab 17.9. Enabled by default.
{{< /history >}}
The scope determines the actions you can perform when you authenticate with a group access token.
| Scope | Description |
|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `api` | Grants complete read and write access to the scoped group and related project API, including the [container registry](../../packages/container_registry/_index.md), the [dependency proxy](../../packages/dependency_proxy/_index.md), and the [package registry](../../packages/package_registry/_index.md). |
| `read_api` | Grants read access to the scoped group and related project API, including the [package registry](../../packages/package_registry/_index.md). |
| `read_registry` | Grants read access (pull) to the [container registry](../../packages/container_registry/_index.md) images if any project within a group is private and authorization is required. |
| `write_registry` | Grants write access (push) to the [container registry](../../packages/container_registry/_index.md). You need both read and write access to push images. |
| `read_virtual_registry` | If a project is private and authorization is required, grants read-only (pull) access to container images through the [dependency proxy](../../packages/dependency_proxy/_index.md). Available only when the dependency proxy is enabled. |
| `write_virtual_registry` | If a project is private and authorization is required, grants read (pull), write (push), and delete access to container images through the [dependency proxy](../../packages/dependency_proxy/_index.md). Available only when the dependency proxy is enabled. |
| `read_repository` | Grants read access (pull) to all repositories within a group. |
| `write_repository` | Grants read and write access (pull and push) to all repositories within a group. |
| `create_runner` | Grants permission to create runners in a group. |
| `manage_runner` | Grants permission to manage runners in a group. |
| `ai_features` | Grants permission to perform API actions for GitLab Duo. This scope is designed to work with the GitLab Duo Plugin for JetBrains. For all other extensions, see scope requirements. |
| `k8s_proxy` | Grants permission to perform Kubernetes API calls using the agent for Kubernetes in a group. |
| `self_rotate` | Grants permission to rotate this token using the [personal access token API](../../../api/personal_access_tokens.md#rotate-a-personal-access-token). Does not allow rotation of other tokens. |
## Restrict the creation of group access tokens
To limit potential abuse, you can restrict users from creating tokens for a group hierarchy. This setting is only configurable for a top-level group and applies to every downstream subgroup and project. Any existing group access tokens remain valid until their expiration date or until manually revoked.
To restrict the creation of group access tokens:
1. On the left sidebar, select **Search or go to** and find your group.
This group must be at the top level.
1. Select **Settings > General**.
1. Expand **Permissions and group features**.
1. Under **Permissions**, clear the **Users can create project access tokens and group access tokens in this group** checkbox.
1. Select **Save changes**.
## Access token expiration
Whether your existing group access tokens have expiry dates automatically applied
depends on what GitLab offering you have, and when you upgraded to GitLab 16.0 or later:
- On GitLab.com, during the 16.0 milestone, existing group access tokens without
an expiry date were automatically given an expiry date of 365 days later than the current date.
- On GitLab Self-Managed, if you upgraded from GitLab 15.11 or earlier to GitLab 16.0 or later:
- On or before July 23, 2024, existing group access tokens without an expiry
date were automatically given an expiry date of 365 days later than the current date.
This change is a breaking change.
- On or after July 24, 2024, existing group access tokens without an expiry
date did not have an expiry date set.
On GitLab Self-Managed, if you do a new install of one of the following GitLab
versions, your existing group access tokens do not have expiry dates
automatically applied:
- 16.0.9
- 16.1.7
- 16.2.10
- 16.3.8
- 16.4.6
- 16.5.9
- 16.6.9
- 16.7.9
- 16.8.9
- 16.9.10
- 16.10.9
- 16.11.7
- 17.0.5
- 17.1.3
- 17.2.1
### Group access token expiry emails
{{< history >}}
- 60 and 30 day expiry notifications [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/464040) in GitLab 17.6 [with a flag](../../../administration/feature_flags/_index.md) named `expiring_pats_30d_60d_notifications`. Disabled by default.
- 60 and 30 day notifications [generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173792) in GitLab 17.7. Feature flag `expiring_pats_30d_60d_notifications` removed.
- Notifications to inherited group members [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/463016) in GitLab 17.7 [with a flag](../../../administration/feature_flags/_index.md) named `pat_expiry_inherited_members_notification`. Disabled by default.
- Feature flag `pat_expiry_inherited_members_notification` [enabled by default in GitLab 17.10](https://gitlab.com/gitlab-org/gitlab/-/issues/393772).
- Feature flag `pat_expiry_inherited_members_notification` removed in GitLab `17.11`
{{< /history >}}
GitLab runs a check every day at 1:00 AM UTC to identify group access tokens that are expiring in the near future. Members of the group with the Owner role are notified by email when these tokens expire in a certain number of days. The number of days differs depending on the version of GitLab:
- In GitLab 17.6 and later, group Owners are notified by email when the check identifies their group access tokens as expiring in the next 60 days. An additional email is sent when the check identifies their group access tokens as expiring in the next 30 days.
- Group Owners are notified by email when the check identifies their group access tokens as expiring in the next seven days.
- In GitLab 17.7 and later, members with the inherited role of Owner in the group can also receive notification emails. You can configure this by changing:
- The [group setting](../manage.md#expiry-emails-for-group-and-project-access-tokens) for the group or any parent group.
- On GitLab Self-Managed, the [instance setting](../../../administration/settings/email.md#group-and-project-access-token-expiry-emails-to-inherited-members).
Your expired access tokens are listed in the [inactive group access tokens table](#revoke-or-rotate-a-group-access-token) until they are [automatically deleted](../../project/settings/project_access_tokens.md#inactive-token-retention).
## Bot users for groups
Bot users for groups are [GitLab-created non-billable users](../../../subscriptions/manage_users_and_seats.md#criteria-for-non-billable-users).
Each time you create a group access token, a bot user is created and added to the group.
These bot users are similar to
[bot users for projects](../../project/settings/project_access_tokens.md#bot-users-for-projects), except they are added
to groups instead of projects. Bot users for groups:
- Is not a billable user, so it does not count toward the license limit.
- Can have a maximum role of Owner for a group. For more information, see
[Create a group access token](../../../api/group_access_tokens.md#create-a-group-access-token).
- Have a username set to `group_{group_id}_bot_{random_string}`. For example, `group_123_bot_4ffca233d8298ea1`.
- Have an email set to `group_{group_id}_bot_{random_string}@noreply.{Gitlab.config.gitlab.host}`. For example, `group_123_bot_4ffca233d8298ea1@noreply.example.com`.
All other properties are similar to [bot users for projects](../../project/settings/project_access_tokens.md#bot-users-for-projects).
## Token availability
Group access tokens are only available in paid subscriptions, and not available in trial subscriptions. For more information, see the ["What is included" section of the GitLab Trial FAQ](https://about.gitlab.com/free-trial/#what-is-included-in-my-free-trial-what-is-excluded).
## Related topics
- [Group access tokens API](../../../api/group_access_tokens.md)
|
---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Group access tokens
breadcrumbs:
- doc
- user
- group
- settings
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
With group access tokens, you can use a single token to:
- Perform actions for groups.
- Manage the projects within the group.
You can use a group access token to authenticate:
- With the [GitLab API](../../../api/rest/authentication.md#personalprojectgroup-access-tokens).
- Authenticate with Git over HTTPS. Use:
- Any non-blank value as a username.
- The group access token as the password.
Group access tokens are similar to [project access tokens](../../project/settings/project_access_tokens.md)
and [personal access tokens](../../profile/personal_access_tokens.md), except they are
associated with a group rather than a project or user.
You cannot use group access tokens to create other group, project, or personal access tokens.
Group access tokens inherit the [default prefix setting](../../../administration/settings/account_and_limit_settings.md#personal-access-token-prefix)
configured for personal access tokens.
## Availability
- On GitLab.com, you can use group access tokens if you have the Premium or Ultimate license tier,
but not with a [trial license](https://about.gitlab.com/free-trial/).
- On GitLab Dedicated and GitLab Self-Managed instances:
- You can use group access tokens with any license tier. If you have the Free tier:
- Review your security and compliance policies around [user self-enrollment](../../../administration/settings/sign_up_restrictions.md#disable-new-sign-ups).
- Consider [restricting the creation of group access tokens](#restrict-the-creation-of-group-access-tokens) to lower potential abuse.
- Group access tokens are subject to the same [maximum lifetime limits](../../../administration/settings/account_and_limit_settings.md#limit-the-lifetime-of-access-tokens)
as personal access tokens if the limit is set.
## Create a group access token
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/348660) in GitLab 15.3, default expiration of 30 days and default role of Guest is populated in the UI.
- Ability to create non-expiring group access tokens [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/392855) in GitLab 16.0.
- Maximum allowable lifetime limit [extended to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901) in GitLab 17.6 [with a flag](../../../administration/feature_flags/_index.md) named `buffered_token_expiration_limit`. Disabled by default.
- Group access token description [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/443819) in GitLab 17.7.
{{< /history >}}
{{< alert type="flag" >}}
The availability of the extended maximum allowable lifetime limit is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
{{< alert type="warning" >}}
The ability to create group access tokens without an expiry date was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/369122) in GitLab 15.4 and [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/392855) in GitLab 16.0. For more information on expiry dates added to existing tokens, see the documentation on [access token expiration](#access-token-expiration).
{{< /alert >}}
### With the UI
To create a group access token:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > Access tokens**.
1. Select **Add new token**.
1. In **Token name**, enter a name. The token name is visible to any user with permissions to view the group.
1. Optional. In **Token description**, enter a description for the token.
1. In **Expiration date**, enter an expiry date for the token:
- The token expires on that date at midnight UTC. A token with the expiration date of 2024-01-01 expires at 00:00:00 UTC on 2024-01-01.
- If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
- By default, this date can be a maximum of 365 days later than the current date. In GitLab 17.6 or later, you can [extend this limit to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901).
- An instance-wide [maximum lifetime](../../../administration/settings/account_and_limit_settings.md#limit-the-lifetime-of-access-tokens) setting can limit the maximum allowable lifetime in GitLab Self-Managed instances.
1. Select a role for the token.
1. Select the [desired scopes](#scopes-for-a-group-access-token).
1. Select **Create group access token**.
A group access token is displayed. Save the group access token somewhere safe. After you leave or refresh the page, you can't view it again.
{{< alert type="warning" >}}
Group access tokens are treated as [internal users](../../../administration/internal_users.md).
If an internal user creates a group access token, that token is able to access
all projects that have visibility level set to [Internal](../../public_access.md).
{{< /alert >}}
### With the Rails console
If you are an administrator, you can create group access tokens in the Rails console:
1. Run the following commands in a [Rails console](../../../administration/operations/rails_console.md):
```ruby
# Set the GitLab administration user to use. If user ID 1 is not available or is not an administrator, use 'admin = User.admins.first' instead to select an administrator.
admin = User.find(1)
# Set the group you want to create a token for. For example, group with ID 109.
group = Group.find(109)
# Create the group bot user. For further group access tokens, the username should be `group_{group_id}_bot_{random_string}` and email address `group_{group_id}_bot_{random_string}@noreply.{Gitlab.config.gitlab.host}`.
random_string = SecureRandom.hex(16)
service_response = Users::CreateService.new(admin, { name: 'group_token', username: "group_#{group.id}_bot_#{random_string}", email: "group_#{group.id}_bot_#{random_string}@noreply.#{Gitlab.config.gitlab.host}", user_type: :project_bot }).execute
bot = service_response.payload[:user] if service_response.success?
# Confirm the group bot.
bot.confirm
# Add the bot to the group with the required role.
group.add_member(bot, :maintainer)
# Give the bot a personal access token.
token = bot.personal_access_tokens.create(scopes:[:api, :write_repository], name: 'group_token')
# Get the token value.
gtoken = token.token
```
1. Test if the generated group access token works:
1. Use the group access token in the `PRIVATE-TOKEN` header with GitLab REST APIs. For example:
- [Create an epic](../../../api/epics.md#new-epic) in the group.
- [Create a project pipeline](../../../api/pipelines.md#create-a-new-pipeline) in one of the group's projects.
- [Create an issue](../../../api/issues.md#new-issue) in one of the group's projects.
1. Use the group token to [clone a group's project](../../../topics/git/clone.md#clone-with-https)
using HTTPS.
## Revoke or rotate a group access token
{{< history >}}
- Ability to view expired and revoked tokens [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/462217) in GitLab 17.3 [with a flag](../../../administration/feature_flags/_index.md) named `retain_resource_access_token_user_after_revoke`. Disabled by default.
- Ability to view expired and revoked tokens until they are automatically deleted and [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/471683) in GitLab 17.9. Feature flag `retain_resource_access_token_user_after_revoke` removed.
{{< /history >}}
In GitLab 17.9 and later, you can view both active and inactive group
access tokens on the access tokens page.
The inactive group access tokens table displays revoked and expired tokens until they are [automatically deleted](../../project/settings/project_access_tokens.md#inactive-token-retention).
To revoke or rotate a group access token:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > Access tokens**.
1. For the relevant token, select **Revoke** ({{< icon name="remove" >}}) or **Rotate** ({{< icon name="retry" >}}).
1. On the confirmation dialog, select **Revoke** or **Rotate**.
## Scopes for a group access token
{{< history >}}
- `k8s_proxy` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/422408) in GitLab 16.4 [with a flag](../../../administration/feature_flags/_index.md) named `k8s_proxy_pat`. Enabled by default.
- Feature flag `k8s_proxy_pat` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131518) in GitLab 16.5.
- `self_rotate` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/178111) in GitLab 17.9. Enabled by default.
{{< /history >}}
The scope determines the actions you can perform when you authenticate with a group access token.
| Scope | Description |
|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `api` | Grants complete read and write access to the scoped group and related project API, including the [container registry](../../packages/container_registry/_index.md), the [dependency proxy](../../packages/dependency_proxy/_index.md), and the [package registry](../../packages/package_registry/_index.md). |
| `read_api` | Grants read access to the scoped group and related project API, including the [package registry](../../packages/package_registry/_index.md). |
| `read_registry` | Grants read access (pull) to the [container registry](../../packages/container_registry/_index.md) images if any project within a group is private and authorization is required. |
| `write_registry` | Grants write access (push) to the [container registry](../../packages/container_registry/_index.md). You need both read and write access to push images. |
| `read_virtual_registry` | If a project is private and authorization is required, grants read-only (pull) access to container images through the [dependency proxy](../../packages/dependency_proxy/_index.md). Available only when the dependency proxy is enabled. |
| `write_virtual_registry` | If a project is private and authorization is required, grants read (pull), write (push), and delete access to container images through the [dependency proxy](../../packages/dependency_proxy/_index.md). Available only when the dependency proxy is enabled. |
| `read_repository` | Grants read access (pull) to all repositories within a group. |
| `write_repository` | Grants read and write access (pull and push) to all repositories within a group. |
| `create_runner` | Grants permission to create runners in a group. |
| `manage_runner` | Grants permission to manage runners in a group. |
| `ai_features` | Grants permission to perform API actions for GitLab Duo. This scope is designed to work with the GitLab Duo Plugin for JetBrains. For all other extensions, see scope requirements. |
| `k8s_proxy` | Grants permission to perform Kubernetes API calls using the agent for Kubernetes in a group. |
| `self_rotate` | Grants permission to rotate this token using the [personal access token API](../../../api/personal_access_tokens.md#rotate-a-personal-access-token). Does not allow rotation of other tokens. |
## Restrict the creation of group access tokens
To limit potential abuse, you can restrict users from creating tokens for a group hierarchy. This setting is only configurable for a top-level group and applies to every downstream subgroup and project. Any existing group access tokens remain valid until their expiration date or until manually revoked.
To restrict the creation of group access tokens:
1. On the left sidebar, select **Search or go to** and find your group.
This group must be at the top level.
1. Select **Settings > General**.
1. Expand **Permissions and group features**.
1. Under **Permissions**, clear the **Users can create project access tokens and group access tokens in this group** checkbox.
1. Select **Save changes**.
## Access token expiration
Whether your existing group access tokens have expiry dates automatically applied
depends on what GitLab offering you have, and when you upgraded to GitLab 16.0 or later:
- On GitLab.com, during the 16.0 milestone, existing group access tokens without
an expiry date were automatically given an expiry date of 365 days later than the current date.
- On GitLab Self-Managed, if you upgraded from GitLab 15.11 or earlier to GitLab 16.0 or later:
- On or before July 23, 2024, existing group access tokens without an expiry
date were automatically given an expiry date of 365 days later than the current date.
This change is a breaking change.
- On or after July 24, 2024, existing group access tokens without an expiry
date did not have an expiry date set.
On GitLab Self-Managed, if you do a new install of one of the following GitLab
versions, your existing group access tokens do not have expiry dates
automatically applied:
- 16.0.9
- 16.1.7
- 16.2.10
- 16.3.8
- 16.4.6
- 16.5.9
- 16.6.9
- 16.7.9
- 16.8.9
- 16.9.10
- 16.10.9
- 16.11.7
- 17.0.5
- 17.1.3
- 17.2.1
### Group access token expiry emails
{{< history >}}
- 60 and 30 day expiry notifications [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/464040) in GitLab 17.6 [with a flag](../../../administration/feature_flags/_index.md) named `expiring_pats_30d_60d_notifications`. Disabled by default.
- 60 and 30 day notifications [generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173792) in GitLab 17.7. Feature flag `expiring_pats_30d_60d_notifications` removed.
- Notifications to inherited group members [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/463016) in GitLab 17.7 [with a flag](../../../administration/feature_flags/_index.md) named `pat_expiry_inherited_members_notification`. Disabled by default.
- Feature flag `pat_expiry_inherited_members_notification` [enabled by default in GitLab 17.10](https://gitlab.com/gitlab-org/gitlab/-/issues/393772).
- Feature flag `pat_expiry_inherited_members_notification` removed in GitLab `17.11`
{{< /history >}}
GitLab runs a check every day at 1:00 AM UTC to identify group access tokens that are expiring in the near future. Members of the group with the Owner role are notified by email when these tokens expire in a certain number of days. The number of days differs depending on the version of GitLab:
- In GitLab 17.6 and later, group Owners are notified by email when the check identifies their group access tokens as expiring in the next 60 days. An additional email is sent when the check identifies their group access tokens as expiring in the next 30 days.
- Group Owners are notified by email when the check identifies their group access tokens as expiring in the next seven days.
- In GitLab 17.7 and later, members with the inherited role of Owner in the group can also receive notification emails. You can configure this by changing:
- The [group setting](../manage.md#expiry-emails-for-group-and-project-access-tokens) for the group or any parent group.
- On GitLab Self-Managed, the [instance setting](../../../administration/settings/email.md#group-and-project-access-token-expiry-emails-to-inherited-members).
Your expired access tokens are listed in the [inactive group access tokens table](#revoke-or-rotate-a-group-access-token) until they are [automatically deleted](../../project/settings/project_access_tokens.md#inactive-token-retention).
## Bot users for groups
Bot users for groups are [GitLab-created non-billable users](../../../subscriptions/manage_users_and_seats.md#criteria-for-non-billable-users).
Each time you create a group access token, a bot user is created and added to the group.
These bot users are similar to
[bot users for projects](../../project/settings/project_access_tokens.md#bot-users-for-projects), except they are added
to groups instead of projects. Bot users for groups:
- Is not a billable user, so it does not count toward the license limit.
- Can have a maximum role of Owner for a group. For more information, see
[Create a group access token](../../../api/group_access_tokens.md#create-a-group-access-token).
- Have a username set to `group_{group_id}_bot_{random_string}`. For example, `group_123_bot_4ffca233d8298ea1`.
- Have an email set to `group_{group_id}_bot_{random_string}@noreply.{Gitlab.config.gitlab.host}`. For example, `group_123_bot_4ffca233d8298ea1@noreply.example.com`.
All other properties are similar to [bot users for projects](../../project/settings/project_access_tokens.md#bot-users-for-projects).
## Token availability
Group access tokens are only available in paid subscriptions, and not available in trial subscriptions. For more information, see the ["What is included" section of the GitLab Trial FAQ](https://about.gitlab.com/free-trial/#what-is-included-in-my-free-trial-what-is-excluded).
## Related topics
- [Group access tokens API](../../../api/group_access_tokens.md)
|
https://docs.gitlab.com/user/group/subgroups
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/subgroups
|
[
"doc",
"user",
"group",
"subgroups"
] |
_index.md
|
Tenant Scale
|
Organizations
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Subgroups
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can organize GitLab [groups](../_index.md) into subgroups. You can use subgroups to:
- Separate internal and external content. Because every subgroup can have its own
[visibility level](../../public_access.md), you can host groups for different
purposes under the same parent group.
- Organize large projects. You can use subgroups to manage who can access parts of
the source code.
- Manage permissions. Give a user a different
[role](../../permissions.md#group-members-permissions) for each group they're [a member of](#subgroup-membership).
Subgroups can:
- Belong to one immediate parent group.
- Have many subgroups.
- Be nested up to 20 levels.
- Use [runners](../../../ci/runners/_index.md) registered to parent groups:
- Secrets configured for the parent group are available to subgroup jobs.
- Users with at least the Maintainer role in projects that belong to subgroups can see the details of runners registered to
parent groups.
For example:
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
accTitle: Parent and subgroup nesting
accDescr: How parent groups, subgroups, and projects nest.
subgraph "Parent group"
subgraph "Subgroup A"
subgraph "Subgroup A1"
G["Project E"]
end
C["Project A"]
D["Project B"]
E["Project C"]
end
subgraph "Subgroup B"
F["Project D"]
end
end
```
## View subgroups of a group
Prerequisites:
- To view private nested subgroups, you must be a direct or inherited member of
the private subgroup.
To view the subgroups of a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select the **Subgroups and projects** tab.
1. Select the subgroup you want to view.
To view nested subgroups, expand ({{< icon name="chevron-down" >}}) a subgroup.
### Private subgroups in public parent groups
In the hierarchy list, public groups with private subgroups have an expand option ({{< icon name="chevron-down" >}}),
which indicates the group has nested subgroups. All users can view the expand option ({{< icon name="chevron-down" >}}), but only direct or inherited members of the private subgroup can view the private group.
If you prefer to keep information about the presence of nested subgroups private,
you should add private subgroups only to private parent groups.
## Create a subgroup
Prerequisites:
- You must have either:
- At least the Maintainer role for a group.
- The [role determined by a setting](#change-who-can-create-subgroups). These users can create
subgroups even if group creation is
[disabled by an Administrator](../../../administration/admin_area.md#prevent-a-user-from-creating-top-level-groups) in the user's settings.
{{< alert type="note" >}}
You cannot host a GitLab Pages subgroup website with a top-level domain name. For example, `subgroupname.example.io`.
{{< /alert >}}
To create a subgroup:
1. On the left sidebar, select **Search or go to** and find the group you want to create the subgroup in.
1. On the parent group's overview page, in the upper-right corner, select **New subgroup**.
1. Fill in the fields. View a list of [reserved names](../../reserved_names.md) that cannot be used as group names.
1. Select **Create subgroup**.
### Change who can create subgroups
Prerequisites:
- You must have at least the Maintainer role on the group, depending on the group's setting.
To change who can create subgroups on a group:
- As a user with the Owner role on the group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand **Permissions and group features**.
1. From **Roles allowed to create subgroups**, select an option.
1. Select **Save changes**.
- As an administrator:
1. On the left sidebar, at the bottom, select **Admin**.
1. On the left sidebar, select **Overview > Groups** and find your group.
1. In the group's row, select **Edit**.
1. From the **Allowed to create subgroups** dropdown list, select an option.
1. Select **Save changes**.
For more information, view the [permissions table](../../permissions.md#group-members-permissions).
## Subgroup membership
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/219230) to display invited group members on the Members tab of the Members page in GitLab 16.10 [with a flag](../../../administration/feature_flags/_index.md) named `webui_members_inherited_users`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/219230) in GitLab 17.0.
- Feature flag `webui_members_inherited_users` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/163627) in GitLab 17.4. Members of invited groups displayed by default.
{{< /history >}}
When you add a member to a group, that member is also added to all subgroups of that group.
The member's permissions are inherited from the group into all subgroups.
Subgroup members can be:
1. [Direct members](../../project/members/_index.md#add-users-to-a-project) of the subgroup.
1. [Inherited members](../../project/members/_index.md) of the subgroup from the subgroup's parent group.
1. Members of a group that was [shared with the subgroup's top-level group](../../project/members/sharing_projects_groups.md#invite-a-group-to-a-group).
1. [Indirect members](../../project/members/_index.md) include inherited members and members of a group that was [invited to the subgroup or its ancestors](../../project/members/sharing_projects_groups.md#invite-a-group-to-a-group).
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
flowchart RL
accTitle: Subgroup membership
accDescr: How users become members of a subgroup - through direct, indirect, or inherited membership.
subgraph Group A
A(Direct member)
B{{Shared member}}
subgraph Subgroup A
H(1#46; Direct member)
C{{2#46; Inherited member}}
D{{Inherited member}}
E{{3#46; Shared member}}
end
A-->|Direct membership of Group A\nInherited membership of Subgroup A|C
end
subgraph Group C
G(Direct member)
end
subgraph Group B
F(Direct member)
end
F-->|Group B\nshared with\nGroup A|B
B-->|Inherited membership of Subgroup A|D
G-->|Group C shared with Subgroup A|E
```
Group permissions for a member can be changed only by:
- Users with the Owner role on the group.
- Changing the configuration of the group the member was added to.
### Determine membership inheritance
To see if a member has inherited the permissions from a parent group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Manage > Members**.
The member's inheritance is displayed in the **Source** column.
Members list for an example subgroup **Four**:
In the previous screenshot:
- Five members have access to group **Four**.
- User 0 has the Reporter role on group **Four**, and has inherited their permissions from group **One**:
- User 0 is a direct member of group **One**.
- Group **One** is above group **Four** in the hierarchy.
- User 1 has the Developer role on group **Four** and inherited their permissions from group **Two**:
- User 0 is a direct member of group **Two**, which is a subgroup of group **One**.
- Groups **One** / **Two** are above group **Four** in the hierarchy.
- User 2 has the Developer role on group **Four** and has inherited their permissions from group **Three**:
- User 0 is a direct member of group **Three**, which is a subgroup of group **Two**. Group **Two** is a subgroup of group
**One**.
- Groups **One** / **Two** / **Three** are above group **Four** the hierarchy.
- User 3 is a direct member of group **Four**. This means they get their Maintainer role directly from group **Four**.
- Administrator has the Owner role on group **Four** and is a member of all subgroups. For that reason, as with User 3,
the **Source** column indicates they are a direct member.
Members can be [filtered by inherited or direct membership](../_index.md#filter-a-group).
### Override ancestor group membership
Users with the Owner role in a subgroup can add members to it.
You can't give a user a role in a subgroup that is lower than the roles the user has in parent groups.
To override a user's role in a parent group, add the user to the subgroup again with a higher role.
For example:
- If User 1 is added to group **Two** with the Developer role, User 1 inherits that role in every subgroup of group **Two**.
- To give User 1 the Maintainer role in group **Four** (under **One / Two / Three**), add User 1 again to group **Four** with
the Maintainer role.
- If User 1 is removed from group **Four**, the user's role falls back to their role in group **Two**. User 1 has the Developer
role in group **Four** again.
## Mention subgroups
Mentioning subgroups ([`@<subgroup_name>`](../../discussions/_index.md#mentions)) in epics, issues, commits, and merge requests
notifies all direct members of that group. Inherited members of a subgroup are not notified by mentions.
Mentioning works the same as for projects and groups, and you can choose the group of members to be notified.
|
---
stage: Tenant Scale
group: Organizations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Subgroups
breadcrumbs:
- doc
- user
- group
- subgroups
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can organize GitLab [groups](../_index.md) into subgroups. You can use subgroups to:
- Separate internal and external content. Because every subgroup can have its own
[visibility level](../../public_access.md), you can host groups for different
purposes under the same parent group.
- Organize large projects. You can use subgroups to manage who can access parts of
the source code.
- Manage permissions. Give a user a different
[role](../../permissions.md#group-members-permissions) for each group they're [a member of](#subgroup-membership).
Subgroups can:
- Belong to one immediate parent group.
- Have many subgroups.
- Be nested up to 20 levels.
- Use [runners](../../../ci/runners/_index.md) registered to parent groups:
- Secrets configured for the parent group are available to subgroup jobs.
- Users with at least the Maintainer role in projects that belong to subgroups can see the details of runners registered to
parent groups.
For example:
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
accTitle: Parent and subgroup nesting
accDescr: How parent groups, subgroups, and projects nest.
subgraph "Parent group"
subgraph "Subgroup A"
subgraph "Subgroup A1"
G["Project E"]
end
C["Project A"]
D["Project B"]
E["Project C"]
end
subgraph "Subgroup B"
F["Project D"]
end
end
```
## View subgroups of a group
Prerequisites:
- To view private nested subgroups, you must be a direct or inherited member of
the private subgroup.
To view the subgroups of a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select the **Subgroups and projects** tab.
1. Select the subgroup you want to view.
To view nested subgroups, expand ({{< icon name="chevron-down" >}}) a subgroup.
### Private subgroups in public parent groups
In the hierarchy list, public groups with private subgroups have an expand option ({{< icon name="chevron-down" >}}),
which indicates the group has nested subgroups. All users can view the expand option ({{< icon name="chevron-down" >}}), but only direct or inherited members of the private subgroup can view the private group.
If you prefer to keep information about the presence of nested subgroups private,
you should add private subgroups only to private parent groups.
## Create a subgroup
Prerequisites:
- You must have either:
- At least the Maintainer role for a group.
- The [role determined by a setting](#change-who-can-create-subgroups). These users can create
subgroups even if group creation is
[disabled by an Administrator](../../../administration/admin_area.md#prevent-a-user-from-creating-top-level-groups) in the user's settings.
{{< alert type="note" >}}
You cannot host a GitLab Pages subgroup website with a top-level domain name. For example, `subgroupname.example.io`.
{{< /alert >}}
To create a subgroup:
1. On the left sidebar, select **Search or go to** and find the group you want to create the subgroup in.
1. On the parent group's overview page, in the upper-right corner, select **New subgroup**.
1. Fill in the fields. View a list of [reserved names](../../reserved_names.md) that cannot be used as group names.
1. Select **Create subgroup**.
### Change who can create subgroups
Prerequisites:
- You must have at least the Maintainer role on the group, depending on the group's setting.
To change who can create subgroups on a group:
- As a user with the Owner role on the group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand **Permissions and group features**.
1. From **Roles allowed to create subgroups**, select an option.
1. Select **Save changes**.
- As an administrator:
1. On the left sidebar, at the bottom, select **Admin**.
1. On the left sidebar, select **Overview > Groups** and find your group.
1. In the group's row, select **Edit**.
1. From the **Allowed to create subgroups** dropdown list, select an option.
1. Select **Save changes**.
For more information, view the [permissions table](../../permissions.md#group-members-permissions).
## Subgroup membership
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/219230) to display invited group members on the Members tab of the Members page in GitLab 16.10 [with a flag](../../../administration/feature_flags/_index.md) named `webui_members_inherited_users`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/219230) in GitLab 17.0.
- Feature flag `webui_members_inherited_users` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/163627) in GitLab 17.4. Members of invited groups displayed by default.
{{< /history >}}
When you add a member to a group, that member is also added to all subgroups of that group.
The member's permissions are inherited from the group into all subgroups.
Subgroup members can be:
1. [Direct members](../../project/members/_index.md#add-users-to-a-project) of the subgroup.
1. [Inherited members](../../project/members/_index.md) of the subgroup from the subgroup's parent group.
1. Members of a group that was [shared with the subgroup's top-level group](../../project/members/sharing_projects_groups.md#invite-a-group-to-a-group).
1. [Indirect members](../../project/members/_index.md) include inherited members and members of a group that was [invited to the subgroup or its ancestors](../../project/members/sharing_projects_groups.md#invite-a-group-to-a-group).
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
flowchart RL
accTitle: Subgroup membership
accDescr: How users become members of a subgroup - through direct, indirect, or inherited membership.
subgraph Group A
A(Direct member)
B{{Shared member}}
subgraph Subgroup A
H(1#46; Direct member)
C{{2#46; Inherited member}}
D{{Inherited member}}
E{{3#46; Shared member}}
end
A-->|Direct membership of Group A\nInherited membership of Subgroup A|C
end
subgraph Group C
G(Direct member)
end
subgraph Group B
F(Direct member)
end
F-->|Group B\nshared with\nGroup A|B
B-->|Inherited membership of Subgroup A|D
G-->|Group C shared with Subgroup A|E
```
Group permissions for a member can be changed only by:
- Users with the Owner role on the group.
- Changing the configuration of the group the member was added to.
### Determine membership inheritance
To see if a member has inherited the permissions from a parent group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Manage > Members**.
The member's inheritance is displayed in the **Source** column.
Members list for an example subgroup **Four**:
In the previous screenshot:
- Five members have access to group **Four**.
- User 0 has the Reporter role on group **Four**, and has inherited their permissions from group **One**:
- User 0 is a direct member of group **One**.
- Group **One** is above group **Four** in the hierarchy.
- User 1 has the Developer role on group **Four** and inherited their permissions from group **Two**:
- User 0 is a direct member of group **Two**, which is a subgroup of group **One**.
- Groups **One** / **Two** are above group **Four** in the hierarchy.
- User 2 has the Developer role on group **Four** and has inherited their permissions from group **Three**:
- User 0 is a direct member of group **Three**, which is a subgroup of group **Two**. Group **Two** is a subgroup of group
**One**.
- Groups **One** / **Two** / **Three** are above group **Four** the hierarchy.
- User 3 is a direct member of group **Four**. This means they get their Maintainer role directly from group **Four**.
- Administrator has the Owner role on group **Four** and is a member of all subgroups. For that reason, as with User 3,
the **Source** column indicates they are a direct member.
Members can be [filtered by inherited or direct membership](../_index.md#filter-a-group).
### Override ancestor group membership
Users with the Owner role in a subgroup can add members to it.
You can't give a user a role in a subgroup that is lower than the roles the user has in parent groups.
To override a user's role in a parent group, add the user to the subgroup again with a higher role.
For example:
- If User 1 is added to group **Two** with the Developer role, User 1 inherits that role in every subgroup of group **Two**.
- To give User 1 the Maintainer role in group **Four** (under **One / Two / Three**), add User 1 again to group **Four** with
the Maintainer role.
- If User 1 is removed from group **Four**, the user's role falls back to their role in group **Two**. User 1 has the Developer
role in group **Four** again.
## Mention subgroups
Mentioning subgroups ([`@<subgroup_name>`](../../discussions/_index.md#mentions)) in epics, issues, commits, and merge requests
notifies all direct members of that group. Inherited members of a subgroup are not notified by mentions.
Mentioning works the same as for projects and groups, and you can choose the group of members to be notified.
|
https://docs.gitlab.com/user/group/clusters
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/clusters
|
[
"doc",
"user",
"group",
"clusters"
] |
_index.md
|
Deploy
|
Environments
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Group-level Kubernetes clusters (certificate-based) (deprecated)
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. To connect clusters to GitLab,
use the [GitLab agent for Kubernetes](../../clusters/agent/_index.md).
{{< /alert >}}
Similar to [project-level](../../project/clusters/_index.md) and
[instance-level](../../instance/clusters/_index.md) Kubernetes clusters,
group-level Kubernetes clusters allow you to connect a Kubernetes cluster to
your group, enabling you to use the same cluster across multiple projects.
To view your group-level Kubernetes clusters:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Operate > Kubernetes**.
## Cluster management project
Attach a [cluster management project](../../clusters/management_project.md)
to your cluster to manage shared resources requiring `cluster-admin` privileges for
installation, such as an Ingress controller.
## RBAC compatibility
For each project under a group with a Kubernetes cluster, GitLab creates a restricted
service account with [`edit` privileges](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles)
in the project namespace.
## Cluster precedence
If the project's cluster is available and not disabled, GitLab uses the
project's cluster before using any cluster belonging to the group containing
the project.
In the case of subgroups, GitLab uses the cluster of the closest ancestor group
to the project, provided the cluster is not disabled.
## Multiple Kubernetes clusters
You can associate more than one Kubernetes cluster to your group, and maintain different clusters
for different environments, such as development, staging, and production.
When adding another cluster,
[set an environment scope](#environment-scopes) to help
differentiate the new cluster from your other clusters.
## GitLab-managed clusters
You can choose to allow GitLab to manage your cluster for you. If GitLab manages
your cluster, resources for your projects are automatically created. See the
[Access controls](../../project/clusters/cluster_access.md)
section for details on which resources GitLab creates for you.
For clusters not managed by GitLab, project-specific resources aren't created
automatically. If you're using [Auto DevOps](../../../topics/autodevops/_index.md)
for deployments with a cluster not managed by GitLab, you must ensure:
- The project's deployment service account has permissions to deploy to
[`KUBE_NAMESPACE`](../../project/clusters/deploy_to_cluster.md#deployment-variables).
- `KUBECONFIG` correctly reflects any changes to `KUBE_NAMESPACE`
(this is [not automatic](https://gitlab.com/gitlab-org/gitlab/-/issues/31519)). Editing
`KUBE_NAMESPACE` directly is discouraged.
### Clearing the cluster cache
If you choose to allow GitLab to manage your cluster for you, GitLab stores a cached
version of the namespaces and service accounts it creates for your projects. If you
modify these resources in your cluster manually, this cache can fall out of sync with
your cluster, which can cause deployment jobs to fail.
To clear the cache:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Operate > Kubernetes**.
1. Select your cluster.
1. Expand **Advanced settings**.
1. Select **Clear cluster cache**.
## Base domain
Domains at the cluster level permit support for multiple domains
per [multiple Kubernetes clusters](#multiple-kubernetes-clusters) When specifying a domain,
this is automatically set as an environment variable (`KUBE_INGRESS_BASE_DOMAIN`) during
the [Auto DevOps](../../../topics/autodevops/_index.md) stages.
The domain should have a wildcard DNS configured to the Ingress IP address. [More details](../../project/clusters/gitlab_managed_clusters.md#base-domain).
## Environment scopes
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
When adding more than one Kubernetes cluster to your project, you need to differentiate
them with an environment scope. The environment scope associates clusters with
[environments](../../../ci/environments/_index.md) similar to how the
[environment-specific CI/CD variables](../../../ci/environments/_index.md#limit-the-environment-scope-of-a-cicd-variable)
work.
While evaluating which environment matches the environment scope of a
cluster, [cluster precedence](#cluster-precedence) takes
effect. The cluster at the project level takes precedence, followed
by the closest ancestor group, followed by that groups' parent and so
on.
For example, if your project has the following Kubernetes clusters:
| Cluster | Environment scope | Where |
| ---------- | ------------------- | ----------|
| Project | `*` | Project |
| Staging | `staging/*` | Project |
| Production | `production/*` | Project |
| Test | `test` | Group |
| Development| `*` | Group |
And the following environments are set in the `.gitlab-ci.yml` file:
```yaml
stages:
- test
- deploy
test:
stage: test
script: sh test
deploy to staging:
stage: deploy
script: make deploy
environment:
name: staging/$CI_COMMIT_REF_NAME
url: https://staging.example.com/
deploy to production:
stage: deploy
script: make deploy
environment:
name: production/$CI_COMMIT_REF_NAME
url: https://example.com/
```
The result is:
- The Project cluster is used for the `test` job.
- The Staging cluster is used for the `deploy to staging` job.
- The Production cluster is used for the `deploy to production` job.
## Cluster environments
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
For a consolidated view of which CI [environments](../../../ci/environments/_index.md)
are deployed to the Kubernetes cluster, see the documentation for
[cluster environments](../../clusters/environments.md).
## Security of runners
For important information about securely configuring runners, see
[Security of runners](../../project/clusters/cluster_access.md#security-of-runners)
documentation for project-level clusters.
## More information
For information on integrating GitLab and Kubernetes, see
[Kubernetes clusters](../../infrastructure/clusters/_index.md).
|
---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Group-level Kubernetes clusters (certificate-based) (deprecated)
breadcrumbs:
- doc
- user
- group
- clusters
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. To connect clusters to GitLab,
use the [GitLab agent for Kubernetes](../../clusters/agent/_index.md).
{{< /alert >}}
Similar to [project-level](../../project/clusters/_index.md) and
[instance-level](../../instance/clusters/_index.md) Kubernetes clusters,
group-level Kubernetes clusters allow you to connect a Kubernetes cluster to
your group, enabling you to use the same cluster across multiple projects.
To view your group-level Kubernetes clusters:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Operate > Kubernetes**.
## Cluster management project
Attach a [cluster management project](../../clusters/management_project.md)
to your cluster to manage shared resources requiring `cluster-admin` privileges for
installation, such as an Ingress controller.
## RBAC compatibility
For each project under a group with a Kubernetes cluster, GitLab creates a restricted
service account with [`edit` privileges](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles)
in the project namespace.
## Cluster precedence
If the project's cluster is available and not disabled, GitLab uses the
project's cluster before using any cluster belonging to the group containing
the project.
In the case of subgroups, GitLab uses the cluster of the closest ancestor group
to the project, provided the cluster is not disabled.
## Multiple Kubernetes clusters
You can associate more than one Kubernetes cluster to your group, and maintain different clusters
for different environments, such as development, staging, and production.
When adding another cluster,
[set an environment scope](#environment-scopes) to help
differentiate the new cluster from your other clusters.
## GitLab-managed clusters
You can choose to allow GitLab to manage your cluster for you. If GitLab manages
your cluster, resources for your projects are automatically created. See the
[Access controls](../../project/clusters/cluster_access.md)
section for details on which resources GitLab creates for you.
For clusters not managed by GitLab, project-specific resources aren't created
automatically. If you're using [Auto DevOps](../../../topics/autodevops/_index.md)
for deployments with a cluster not managed by GitLab, you must ensure:
- The project's deployment service account has permissions to deploy to
[`KUBE_NAMESPACE`](../../project/clusters/deploy_to_cluster.md#deployment-variables).
- `KUBECONFIG` correctly reflects any changes to `KUBE_NAMESPACE`
(this is [not automatic](https://gitlab.com/gitlab-org/gitlab/-/issues/31519)). Editing
`KUBE_NAMESPACE` directly is discouraged.
### Clearing the cluster cache
If you choose to allow GitLab to manage your cluster for you, GitLab stores a cached
version of the namespaces and service accounts it creates for your projects. If you
modify these resources in your cluster manually, this cache can fall out of sync with
your cluster, which can cause deployment jobs to fail.
To clear the cache:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Operate > Kubernetes**.
1. Select your cluster.
1. Expand **Advanced settings**.
1. Select **Clear cluster cache**.
## Base domain
Domains at the cluster level permit support for multiple domains
per [multiple Kubernetes clusters](#multiple-kubernetes-clusters) When specifying a domain,
this is automatically set as an environment variable (`KUBE_INGRESS_BASE_DOMAIN`) during
the [Auto DevOps](../../../topics/autodevops/_index.md) stages.
The domain should have a wildcard DNS configured to the Ingress IP address. [More details](../../project/clusters/gitlab_managed_clusters.md#base-domain).
## Environment scopes
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
When adding more than one Kubernetes cluster to your project, you need to differentiate
them with an environment scope. The environment scope associates clusters with
[environments](../../../ci/environments/_index.md) similar to how the
[environment-specific CI/CD variables](../../../ci/environments/_index.md#limit-the-environment-scope-of-a-cicd-variable)
work.
While evaluating which environment matches the environment scope of a
cluster, [cluster precedence](#cluster-precedence) takes
effect. The cluster at the project level takes precedence, followed
by the closest ancestor group, followed by that groups' parent and so
on.
For example, if your project has the following Kubernetes clusters:
| Cluster | Environment scope | Where |
| ---------- | ------------------- | ----------|
| Project | `*` | Project |
| Staging | `staging/*` | Project |
| Production | `production/*` | Project |
| Test | `test` | Group |
| Development| `*` | Group |
And the following environments are set in the `.gitlab-ci.yml` file:
```yaml
stages:
- test
- deploy
test:
stage: test
script: sh test
deploy to staging:
stage: deploy
script: make deploy
environment:
name: staging/$CI_COMMIT_REF_NAME
url: https://staging.example.com/
deploy to production:
stage: deploy
script: make deploy
environment:
name: production/$CI_COMMIT_REF_NAME
url: https://example.com/
```
The result is:
- The Project cluster is used for the `test` job.
- The Staging cluster is used for the `deploy to staging` job.
- The Production cluster is used for the `deploy to production` job.
## Cluster environments
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
For a consolidated view of which CI [environments](../../../ci/environments/_index.md)
are deployed to the Kubernetes cluster, see the documentation for
[cluster environments](../../clusters/environments.md).
## Security of runners
For important information about securely configuring runners, see
[Security of runners](../../project/clusters/cluster_access.md#security-of-runners)
documentation for project-level clusters.
## More information
For information on integrating GitLab and Kubernetes, see
[Kubernetes clusters](../../infrastructure/clusters/_index.md).
|
https://docs.gitlab.com/user/group/git_abuse_rate_limit
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/git_abuse_rate_limit.md
|
2025-08-13
|
doc/user/group/reporting
|
[
"doc",
"user",
"group",
"reporting"
] |
git_abuse_rate_limit.md
|
Software Supply Chain Security
|
Authorization
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Git abuse rate limit
| null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8066) in GitLab 15.2 [with a flag](../../../administration/feature_flags/_index.md) named `limit_unique_project_downloads_per_namespace_user`. Disabled by default.
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/365724) in GitLab 15.6.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/183101) in GitLab 18.0. Feature flag `limit_unique_project_downloads_per_namespace_user` removed.
{{< /history >}}
This is the group-level documentation. For GitLab Self-Managed instances, see the [administration documentation](../../../administration/reporting/git_abuse_rate_limit.md).
Git abuse rate limiting is a feature to automatically ban users who download, clone, pull, fetch, or fork more than a specified number of repositories of a group in a given time frame. Banned users cannot access the top-level group or any of its non-public subgroups through HTTP or SSH. The rate limit also applies to users who authenticate with [personal](../../profile/personal_access_tokens.md) or [group access tokens](../settings/group_access_tokens.md), as well as [CI/CD job tokens](../../../ci/jobs/ci_job_token.md). Access to unrelated groups is unaffected.
Git abuse rate limiting does not apply to top-level group owners, [deploy tokens](../../project/deploy_tokens/_index.md), or [deploy keys](../../project/deploy_keys/_index.md).
How GitLab determines a user's rate limit is under development.
GitLab team members can view more information in this confidential epic:
`https://gitlab.com/groups/gitlab-org/modelops/anti-abuse/-/epics/14`.
## Automatic ban notifications
Selected users receive an email notification when a user is banned.
If automatic banning is disabled, a user is not banned automatically when they exceed the limit. However, notifications are still sent. You can use this setup to determine the correct values of the rate limit settings before enabling automatic banning.
If automatic banning is enabled, an email notification is sent when a user is about to be banned, and the user is automatically banned from the group and its subgroups.
## Configure Git abuse rate limiting
1. On the left sidebar, select **Settings > Reporting**.
1. Update the Git abuse rate limit settings:
1. Enter a number in the **Number of repositories** field, greater than or equal to `0` and less than or equal to `10,000`. This number specifies the maximum amount of unique repositories a user can download in the specified time period before they're banned. When set to `0`, Git abuse rate limiting is disabled.
1. Enter a number in the **Reporting time period (seconds)** field, greater than or equal to `0` and less than or equal to `86,400` (10 days). This number specifies the time in seconds a user can download the maximum amount of repositories before they're banned. When set to `0`, Git abuse rate limiting is disabled.
1. Optional. Exclude up to `100` users by adding them to the **Excluded users** field. Excluded users are not automatically banned.
1. Add up to `100` users to the **Send notifications to** field. You must select at least one user. All users with the Owner role for the main group are selected by default.
1. Optional. Turn on the **Automatically ban users from this namespace when they exceed the specified limits** toggle to enable automatic banning.
1. Select **Save changes**.
## Related topics
- [Ban and unban users](../moderate_users.md).
|
---
stage: Software Supply Chain Security
group: Authorization
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Git abuse rate limit
breadcrumbs:
- doc
- user
- group
- reporting
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8066) in GitLab 15.2 [with a flag](../../../administration/feature_flags/_index.md) named `limit_unique_project_downloads_per_namespace_user`. Disabled by default.
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/365724) in GitLab 15.6.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/183101) in GitLab 18.0. Feature flag `limit_unique_project_downloads_per_namespace_user` removed.
{{< /history >}}
This is the group-level documentation. For GitLab Self-Managed instances, see the [administration documentation](../../../administration/reporting/git_abuse_rate_limit.md).
Git abuse rate limiting is a feature to automatically ban users who download, clone, pull, fetch, or fork more than a specified number of repositories of a group in a given time frame. Banned users cannot access the top-level group or any of its non-public subgroups through HTTP or SSH. The rate limit also applies to users who authenticate with [personal](../../profile/personal_access_tokens.md) or [group access tokens](../settings/group_access_tokens.md), as well as [CI/CD job tokens](../../../ci/jobs/ci_job_token.md). Access to unrelated groups is unaffected.
Git abuse rate limiting does not apply to top-level group owners, [deploy tokens](../../project/deploy_tokens/_index.md), or [deploy keys](../../project/deploy_keys/_index.md).
How GitLab determines a user's rate limit is under development.
GitLab team members can view more information in this confidential epic:
`https://gitlab.com/groups/gitlab-org/modelops/anti-abuse/-/epics/14`.
## Automatic ban notifications
Selected users receive an email notification when a user is banned.
If automatic banning is disabled, a user is not banned automatically when they exceed the limit. However, notifications are still sent. You can use this setup to determine the correct values of the rate limit settings before enabling automatic banning.
If automatic banning is enabled, an email notification is sent when a user is about to be banned, and the user is automatically banned from the group and its subgroups.
## Configure Git abuse rate limiting
1. On the left sidebar, select **Settings > Reporting**.
1. Update the Git abuse rate limit settings:
1. Enter a number in the **Number of repositories** field, greater than or equal to `0` and less than or equal to `10,000`. This number specifies the maximum amount of unique repositories a user can download in the specified time period before they're banned. When set to `0`, Git abuse rate limiting is disabled.
1. Enter a number in the **Reporting time period (seconds)** field, greater than or equal to `0` and less than or equal to `86,400` (10 days). This number specifies the time in seconds a user can download the maximum amount of repositories before they're banned. When set to `0`, Git abuse rate limiting is disabled.
1. Optional. Exclude up to `100` users by adding them to the **Excluded users** field. Excluded users are not automatically banned.
1. Add up to `100` users to the **Send notifications to** field. You must select at least one user. All users with the Owner role for the main group are selected by default.
1. Optional. Turn on the **Automatically ban users from this namespace when they exceed the specified limits** toggle to enable automatic banning.
1. Select **Save changes**.
## Related topics
- [Ban and unban users](../moderate_users.md).
|
https://docs.gitlab.com/user/group/epic_work_items
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/epic_work_items.md
|
2025-08-13
|
doc/user/group/epics
|
[
"doc",
"user",
"group",
"epics"
] |
epic_work_items.md
| null | null | null | null | null |
<!-- markdownlint-disable -->
This document was moved to [another location](_index.md#epics-as-work-items).
<!-- This redirect file can be deleted after <2025-09-13>. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. -->
<!-- Before deletion, see: https://docs.gitlab.com/development/documentation/redirects -->
---
|
---
redirect_to: _index.md#epics-as-work-items
remove_date: '2025-09-13'
breadcrumbs:
- doc
- user
- group
- epics
---
<!-- markdownlint-disable -->
This document was moved to [another location](_index.md#epics-as-work-items).
<!-- This redirect file can be deleted after <2025-09-13>. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. -->
<!-- Before deletion, see: https://docs.gitlab.com/development/documentation/redirects -->
---
|
https://docs.gitlab.com/user/group/linked_epics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/linked_epics.md
|
2025-08-13
|
doc/user/group/epics
|
[
"doc",
"user",
"group",
"epics"
] |
linked_epics.md
|
Plan
|
Product Planning
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Linked epics
| null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Linked epics are a bi-directional relationship between any two epics and appear in a block below
the epic description. You can link epics in different groups.
The relationship only shows up in the UI if the user can see both epics.
When you try to close an epic that has open blockers, a warning is displayed.
To manage linked epics through our API, see [Linked epics API](../../../api/linked_epics.md).
## Ways to use linked epics
You can use linked epics to solve several planning and coordination challenges.
The following examples show how linked epics help teams work together more effectively.
### Cross-functional initiatives
Use linked epics to coordinate work between multiple teams and track interdependent deliverables.
When teams work together on a large initiative, each team can manage their own epic while maintaining
visibility into related work.
For example, when launching a new feature, development and marketing teams often work in parallel.
The development team tracks technical implementation in their epic, while the marketing team plans
promotional activities in a separate epic.
By linking these epics:
- Teams can track dependencies between technical and promotional work.
- Each team maintains autonomy while staying aligned on the broader initiative.
- Stakeholders get visibility into the full scope of the launch.
- Teams can identify and resolve blockers across organizational boundaries.
This coordination helps break down silos and ensures all aspects of the initiative stay in sync.
When you link epics across groups:
- Each team keeps their work in their own group.
- Teams can see related work without switching between groups.
- Status updates automatically flow between linked epics.
### Dependency management
Use linked epics to manage and track work dependencies.
When development can't begin until infrastructure changes are complete, linked epics help teams
manage these dependencies.
For example, when building a new feature, teams often need infrastructure updates
before development can start. The infrastructure team tracks their database migration work
in one epic, while the development team plans feature implementation in another epic.
By linking these epics:
- Teams can track when infrastructure work is ready for development.
- Development teams can better plan their sprint capacity.
- Product managers can identify potential workflow delays.
- Teams stay informed of progress without constant meetings.
This visibility helps teams complete work in the right sequence and avoid blocked tasks.
When you link epics to show dependencies:
- Infrastructure and development work stays connected.
- Teams know when they can start their work.
- Status updates flow automatically between epics.
### Higher-level planning
Use linked epics to connect short-term execution with long-term planning.
When managing a series of releases, you can organize high-level goals and track individual feature
deliverables.
For example, when planning multiple releases over several quarters, you can create separate epics
for each release.
Then link these release epics to a central roadmap epic that tracks the overall project.
By linking these epics:
- Teams can understand how their work fits into the larger strategy.
- Product managers can track progress across multiple releases.
- Teams stay focused on current work while seeing future plans.
- Stakeholders can monitor both granular and high-level progress.
This structure helps teams progress on current work while maintaining broader goals.
When you link epics for planning:
- Each release's progress is visible in the roadmap.
- Teams can see upcoming work early.
- Status updates roll up to the higher-level view.
## Add a linked item
{{< history >}}
- Ability to link issues, tasks, objectives, and key results [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/468310) in GitLab 18.1.
{{< /history >}}
Link an epic and another:
- Epic
- Issue
- Task
- Objective
- Key Result
Prerequisites:
- You must have at least the Guest role for both groups or group and project.
- For GitLab SaaS: the epic that you're editing must be in a group on GitLab Ultimate.
The epics you're linking can be in a group on a lower tier.
To link one epic to another item:
1. In the **Linked items** section of an epic, select **Add**.
1. Select the relationship between the two items. Either:
- **relates to**
- **blocks**
- **is blocked by**
1. To enter the linked item, either:
- Enter `#`, followed by the item's number. For example, `#123`.
- Enter `#`, followed by a word from the item's title. For example, `#Deliver`.
- Paste in the item's full URL.
Items of the same group can be specified just by the reference number.
Items from a different group require additional information like the
group name. For example:
- The same group: `#44`
- Different group: `group#44`
Valid references are added to a temporary list that you can review.
1. Select **Add**.
The linked items are then displayed on the epic grouped by relationship.
The relationship only shows in the UI if the user can see both items.
Alternatively, you can add linked items using [quick actions](../../project/quick_actions.md):
- `/relate`
- `/blocks`
- `/blocked_by`
## Remove a linked item
Prerequisites:
- You must have at least the Guest role for the epic's group.
To remove a linked item:
1. At the bottom of the description, find the **Linked items** section of the work item.
1. For each linked item, select **Remove** ({{< icon name="close" >}}).
The relationship is removed from both epics.
## Blocking epics
When you [add a linked item](#add-a-linked-item), you can show that it **blocks** or
**is blocked by** another epic.
If you try to close a blocked epic using the **Close epic** button, a confirmation message appears.
|
---
stage: Plan
group: Product Planning
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Linked epics
breadcrumbs:
- doc
- user
- group
- epics
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Linked epics are a bi-directional relationship between any two epics and appear in a block below
the epic description. You can link epics in different groups.
The relationship only shows up in the UI if the user can see both epics.
When you try to close an epic that has open blockers, a warning is displayed.
To manage linked epics through our API, see [Linked epics API](../../../api/linked_epics.md).
## Ways to use linked epics
You can use linked epics to solve several planning and coordination challenges.
The following examples show how linked epics help teams work together more effectively.
### Cross-functional initiatives
Use linked epics to coordinate work between multiple teams and track interdependent deliverables.
When teams work together on a large initiative, each team can manage their own epic while maintaining
visibility into related work.
For example, when launching a new feature, development and marketing teams often work in parallel.
The development team tracks technical implementation in their epic, while the marketing team plans
promotional activities in a separate epic.
By linking these epics:
- Teams can track dependencies between technical and promotional work.
- Each team maintains autonomy while staying aligned on the broader initiative.
- Stakeholders get visibility into the full scope of the launch.
- Teams can identify and resolve blockers across organizational boundaries.
This coordination helps break down silos and ensures all aspects of the initiative stay in sync.
When you link epics across groups:
- Each team keeps their work in their own group.
- Teams can see related work without switching between groups.
- Status updates automatically flow between linked epics.
### Dependency management
Use linked epics to manage and track work dependencies.
When development can't begin until infrastructure changes are complete, linked epics help teams
manage these dependencies.
For example, when building a new feature, teams often need infrastructure updates
before development can start. The infrastructure team tracks their database migration work
in one epic, while the development team plans feature implementation in another epic.
By linking these epics:
- Teams can track when infrastructure work is ready for development.
- Development teams can better plan their sprint capacity.
- Product managers can identify potential workflow delays.
- Teams stay informed of progress without constant meetings.
This visibility helps teams complete work in the right sequence and avoid blocked tasks.
When you link epics to show dependencies:
- Infrastructure and development work stays connected.
- Teams know when they can start their work.
- Status updates flow automatically between epics.
### Higher-level planning
Use linked epics to connect short-term execution with long-term planning.
When managing a series of releases, you can organize high-level goals and track individual feature
deliverables.
For example, when planning multiple releases over several quarters, you can create separate epics
for each release.
Then link these release epics to a central roadmap epic that tracks the overall project.
By linking these epics:
- Teams can understand how their work fits into the larger strategy.
- Product managers can track progress across multiple releases.
- Teams stay focused on current work while seeing future plans.
- Stakeholders can monitor both granular and high-level progress.
This structure helps teams progress on current work while maintaining broader goals.
When you link epics for planning:
- Each release's progress is visible in the roadmap.
- Teams can see upcoming work early.
- Status updates roll up to the higher-level view.
## Add a linked item
{{< history >}}
- Ability to link issues, tasks, objectives, and key results [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/468310) in GitLab 18.1.
{{< /history >}}
Link an epic and another:
- Epic
- Issue
- Task
- Objective
- Key Result
Prerequisites:
- You must have at least the Guest role for both groups or group and project.
- For GitLab SaaS: the epic that you're editing must be in a group on GitLab Ultimate.
The epics you're linking can be in a group on a lower tier.
To link one epic to another item:
1. In the **Linked items** section of an epic, select **Add**.
1. Select the relationship between the two items. Either:
- **relates to**
- **blocks**
- **is blocked by**
1. To enter the linked item, either:
- Enter `#`, followed by the item's number. For example, `#123`.
- Enter `#`, followed by a word from the item's title. For example, `#Deliver`.
- Paste in the item's full URL.
Items of the same group can be specified just by the reference number.
Items from a different group require additional information like the
group name. For example:
- The same group: `#44`
- Different group: `group#44`
Valid references are added to a temporary list that you can review.
1. Select **Add**.
The linked items are then displayed on the epic grouped by relationship.
The relationship only shows in the UI if the user can see both items.
Alternatively, you can add linked items using [quick actions](../../project/quick_actions.md):
- `/relate`
- `/blocks`
- `/blocked_by`
## Remove a linked item
Prerequisites:
- You must have at least the Guest role for the epic's group.
To remove a linked item:
1. At the bottom of the description, find the **Linked items** section of the work item.
1. For each linked item, select **Remove** ({{< icon name="close" >}}).
The relationship is removed from both epics.
## Blocking epics
When you [add a linked item](#add-a-linked-item), you can show that it **blocks** or
**is blocked by** another epic.
If you try to close a blocked epic using the **Close epic** button, a confirmation message appears.
|
https://docs.gitlab.com/user/group/manage_epics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/manage_epics.md
|
2025-08-13
|
doc/user/group/epics
|
[
"doc",
"user",
"group",
"epics"
] |
manage_epics.md
|
Plan
|
Product Planning
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Manage epics
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This page collects instructions for all the things you can do with [epics](_index.md) or in relation
to them.
## Create an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
- Ability to assign milestones to epics [introduced](https://gitlab.com/groups/gitlab-org/-/epics/329) in GitLab 18.2.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the epic's group.
To create an epic in the group you're in:
1. Get to the New Epic form:
- Go to your group and from the left sidebar select **Epics**. Then select **New epic**.
- From an epic in your group, select **Epic actions** ({{< icon name="ellipsis_v" >}}). Then select **New epic**.
- From anywhere, in the top menu, select **New** ({{< icon name="plus-square" >}}). Then select **New epic**.
- In an empty [roadmap](../roadmap/_index.md), select **New epic**.
1. Enter a title.
1. Complete the fields.
- Enter a description.
- To [make the epic confidential](#make-an-epic-confidential), select the checkbox under **Confidentiality**.
- Choose labels.
- Select a start and due date, or [inherit](#start-and-due-date-inheritance) them.
- Select a [color](#epic-color).
1. Select **Create epic**.
The newly created epic opens.
### Start and due date inheritance
If you select **Inherited**:
- For the **start date**: GitLab scans all child epics and issues assigned to the epic,
and sets the start date to match the earliest start date found in the child epics or the milestone
assigned to the child items.
- For the **due date**: GitLab scans all child epics and issues assigned to the epic,
and sets the due date to match the latest due date found in the child epics or the milestone
assigned to the child items.
These dates are dynamic and recalculated if any of the following occur:
- A child epic's dates change.
- Milestones are reassigned to an issue.
- A milestone's dates change.
- Issues are added to, or removed from, the epic.
Because the epic's dates can inherit dates from its children, the start date and due date propagate from the bottom to the top.
If the start date of a child epic on the lowest level changes, that becomes the earliest possible start date for its parent epic.
The parent epic's start date then reflects this change and propagates upwards to the top epic.
## Edit an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
After you create an epic, you can edit the following details:
- Title
- Description
- Start date
- Due date
- Labels
- Milestone
- [Color](#epic-color)
Prerequisites:
- You must have at least the Planner role for the epic's group.
To edit an epic's title or description:
1. Select **Edit**.
1. Make your changes.
1. Select **Save changes**.
To edit an epic's start date, due date, milestone, or labels:
1. Next to each section in the right sidebar, select **Edit**.
1. Select the dates, milestone, or labels for your epic.
### Reorder list items in the epic description
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15260) in GitLab 15.1.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
When you view an epic that has a list in the description, you can also reorder the list items.
Prerequisites:
- You must have at least the Planner role for the project, be the author of the epic, or be
assigned to the epic.
- The epic's description must have an [ordered, unordered](../../markdown.md#lists), or
[task](../../markdown.md#task-lists) list.
To reorder list items, when viewing an epic:
1. Hover over the list item row to make the grip icon ({{< icon name="grip" >}}) visible.
1. Select and hold the grip icon.
1. Drag the row to the new position in the list.
1. Release the grip icon.
### Bulk edit epics
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
- [Added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/200186) more bulk editing attributes in GitLab 18.3.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the parent epic's group.
To update multiple epics at the same time:
1. In a group, go to **Epics > List**.
1. Select **Bulk edit**. A sidebar on the right appears with editable fields.
1. Select the checkboxes next to each epic you want to edit.
1. Select the appropriate fields and their values from the sidebar.
1. Select **Update selected**.
When bulk editing epics in a group, you can edit the following attributes:
- State (open or closed)
- [Assignees](#assignees)
- [Milestone](../../project/milestones/_index.md)
- [Labels](../../project/labels.md)
- [Health status](#health-status)
- [Notification](../../profile/notifications.md) subscription
- [Confidentiality](#make-an-epic-confidential)
## Prevent truncating descriptions with "Read more"
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/181184) in GitLab 17.10.
{{< /history >}}
If an epic description is long, GitLab displays only part of it.
To see the whole description, you must select **Read more**.
This truncation makes it easier to find other elements on the page without scrolling through lengthy text.
To change whether descriptions are truncated:
1. On an epic, in the upper-right corner, select **More actions** ({{< icon name="ellipsis_v" >}}).
1. Toggle **Truncate descriptions** according to your preference.
This setting is remembered and affects all issues, tasks, epics, objectives, and key results.
## Hide the right sidebar
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/181184) in GitLab 17.10.
{{< /history >}}
Epic attributes are shown in a sidebar to the right of the description when space allows.
To hide the sidebar and increase space for the description:
1. On an epic, in the upper-right corner, select **More actions** ({{< icon name="ellipsis_v" >}}).
1. Select **Hide sidebar**.
This setting is remembered and affects all issues, tasks, epics, objectives, and key results.
To show the sidebar again:
- Repeat the previous steps and select **Show sidebar**.
## Assignees
{{< details >}}
- Status: Beta
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4231) in GitLab 17.4 [with a flag](../../../administration/feature_flags/_index.md) named `work_items_beta`. Disabled by default. This feature is in [beta](../../../policy/development_stages_support.md#beta).
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/551805) in GitLab 18.2.
{{< /history >}}
An epic can be assigned to one or more users.
The assignees can be changed as often as needed.
The idea is that the assignees are people responsible for the epic.
If a user is not a member of a group, an epic can only be assigned to them if another group member
assigns them.
### Change assignee on an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the group.
To change the assignee on an epic:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**, then select your epic to view it.
1. On the right sidebar, in the **Assignees** section, select **Edit**.
1. From the dropdown list, select the users to add as an assignee.
1. Select any area outside the dropdown list.
The assignee is changed without having to refresh the page.
## Epic color
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/79940) in GitLab 14.9 [with a flag](../../../administration/feature_flags/_index.md) named `epic_color_highlight`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/365336) in GitLab 16.11. Feature flag `epic_color_highlight` removed.
- Customizable color [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394864) in GitLab 17.5.
{{< /history >}}
You can set a color for an epic to categorize and prioritize tasks visually.
Use colors to:
- Associate epics with teams or company initiatives.
- Indicate levels in the epic hierarchy.
- Group related epics together.
Epic colors are visible in [roadmaps](../roadmap/_index.md) and [epic boards](epic_boards.md).
On roadmaps, the timeline bars match the epic's color:
On epic boards, the color shows on the epic's card accent:
### Change an epic's color
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the epic's group.
To change an epic's color:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
1. Select **New epic** or select an existing epic.
1. On the right sidebar, in the **Color** section, select **Edit**.
1. Select an existing color or enter an RGB or hex value.
1. Select any area outside the dialog.
The epic's color is updated.
## Delete an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/452189) in GitLab 16.11. In GitLab 16.10 and earlier, if you delete an epic, all its child epics and their descendants are deleted as well. If needed, you can [remove child epics](#remove-a-child-epic-from-a-parent-epic) from the parent epic before you delete it.
- [Allowed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) Planner role to delete an epic in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have the Planner or Owner role for the epic's group.
To delete an epic:
1. Select **Epic actions** ({{< icon name="ellipsis_v" >}}), then **Delete epic**.
1. Select **Delete**. On the confirmation dialog, select **Delete epic**.
Deleting an epic releases all existing issues from their associated epic in the system.
## Close an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the epic's group.
To close an epic:
- In the upper-right corner, select **Epic actions** ({{< icon name="ellipsis_v" >}}), then **Close epic**.
You can also use the `/close` [quick action](../../project/quick_actions.md).
## Reopen a closed epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
You can reopen an epic that was closed.
Prerequisites:
- You must have at least the Planner role for the epic's group.
To do so, either:
- In the upper-right corner, select **Epic actions** ({{< icon name="ellipsis_v" >}}) and then **Reopen epic**.
- Use the `/reopen` [quick action](../../project/quick_actions.md).
You can also create an epic by
[promoting an issue](../../project/issues/managing_issues.md#promote-an-issue-to-an-epic).
## Go to an epic from an issue
If an issue belongs to an epic, you can go to the parent epic with the
link in the right sidebar.
## View epics list
In a group, the left sidebar displays the total count of open epics.
This number indicates all epics associated with the group and its subgroups, including epics you
might not have permission to view.
Prerequisites:
- You must be a member of either:
- The group
- A project in the group
- A project in one of the group's subgroups
To view epics in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
### Who can view an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Whether you can view an epic depends on the [group visibility level](../../public_access.md) and
the epic's [confidentiality status](#make-an-epic-confidential):
- Public group and a non-confidential epic: Anyone can view the epic.
- Private group and non-confidential epic: You must have at least the Guest role for the group.
- Confidential epic (regardless of group visibility): You must have at least the Planner
role for the group.
### Configure epic display preferences
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393559) in GitLab 18.2.
{{< /history >}}
You can customize how epics are displayed in the epic list by showing or hiding specific metadata
fields and configuring view preferences.
GitLab saves your display preferences at different levels:
- **Fields**: Saved per namespace. You can have different field visibility settings for different
groups and projects based on your workflow needs. For example, you can show assignee and labels
in one group, but hide them in another group.
- **Your preferences**: Saved globally across all projects and groups. This ensures consistent
behavior for how you prefer to view work items.
To configure epic display preferences:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan** > **Epics**.
1. In the top right corner, select **Display options** ({{< icon name="preferences" >}}).
1. Under **Fields**, turn on or turn off the metadata you want to display:
- **Assignee**: Who the epic is assigned to.
- **Labels**: Epic labels.
- **Milestone**: Milestone information.
- **Dates**: Due dates and date ranges.
- **Health**: Health status indicators.
- **Blocked/Blocking**: Blocking relationship indicators.
- **Comments**: Comment counts.
- **Popularity**: Popularity metrics.
1. Under **Your preferences**, turn on or turn off **Open items in side panel** to choose how
epics open when you select them:
- On (default): Epics open in a drawer on the right side of the screen.
- Off: Epics open in a full page view.
### Open epics in a drawer
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/464698) in GitLab 17.4 [with a flag](../../../administration/feature_flags/_index.md) named `work_item_view_for_issues`. Enabled by default.
- Ability to toggle between drawer and full page view [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/536620) in GitLab 18.2.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
When you select an epic from the Epics page or an epic board, it opens in a drawer.
You can then view and edit its details without losing context of the epic list or board.
When using the drawer:
- Select an epic from the list to open it in the drawer.
- The drawer appears on the right side of the screen.
- You can edit the epic directly in the drawer.
- To close the drawer, select the close icon ({{< icon name="close" >}}) or press **Escape**.
#### Open an epic in full page view
To open an epic in the full page view:
- Open the epic in a new tab. From the list of epics, either:
- Right-click the epic and open it in a new browser tab.
- Hold <kbd>Cmd</kbd> or <kbd>Ctrl</kbd> and select the epic.
- Select an epic, and from the drawer, in the top-left corner, select **Open in full page** ({{< icon name="maximize" >}}).
#### Set preference whether to open epics in a drawer
To configure how epics open on the Epics page:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
1. In the top right corner, select **Display options** ({{< icon name="preferences" >}}).
1. Toggle **Open items in side panel**:
- **On** (default): Epics open in a drawer overlay.
- **Off**: Epics open in a full page view.
Your preference is saved and remembered across all your sessions and devices.
### Cached epic count
The total count of open epics displayed in the sidebar is cached if higher
than 1000. The cached value is rounded to thousands or millions and updated every 24 hours.
## Filter the list of epics
{{< history >}}
- Filtering by group was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385191) in GitLab 15.9.
- Filtering by custom fields was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/525462) in GitLab 17.11.
{{< /history >}}
You can filter the list of epics by:
- Title or description
- Author name / username
- Labels
- Milestones
- Confidentiality
- Reaction emoji
- Groups
- [Custom fields](../../../user/work_items/custom_fields.md) enabled for epics
To filter:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
1. Select the field **Search or filter results**.
1. From the dropdown list, select the scope or enter plain text to search by epic title or description.
1. Press <kbd>Enter</kbd> on your keyboard. The list is filtered.
### Filter with the OR operator
{{< history >}}
- OR filtering for labels and authors was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/382969) in GitLab 15.9 [with a flag](../../../administration/feature_flags/_index.md) named `or_issuable_queries`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/104292) in GitLab 15.9.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/296031) in GitLab 17.0. Feature flag `or_issuable_queries` removed.
{{< /history >}}
You can use the OR operator (**is one of: `||`**) when you [filter the list of epics](#filter-the-list-of-epics) by:
- Authors
- Labels
`is one of` represents an inclusive OR. For example, if you filter by `Label is one of Deliverable` and
`Label is one of UX`, GitLab shows epics with either `Deliverable`, `UX`, or both labels.
## Sort the list of epics
You can sort the epics list by:
- Start date
- Due date
- Title
Each option contains a button that can toggle the order between **Ascending** and **Descending**.
The sort option and order is saved and used wherever you browse epics, including the
[Roadmap](../roadmap/_index.md).
## Change activity sort order
You can reverse the default order and interact with the activity feed sorted by most recent items
at the top. Your preference is saved in local storage and automatically applied to every epic and issue
you view.
To change the activity sort order, select the **Oldest first** dropdown list and select either oldest
or newest items to be shown first.
## Make an epic confidential
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
If you're working on items that contain private information, you can make an epic confidential.
{{< alert type="note" >}}
A confidential epic can only contain [confidential issues](../../project/issues/confidential_issues.md)
and confidential child epics. However, merge requests are public, if created in a public project.
Read [Merge requests for confidential issues](../../project/merge_requests/confidential.md)
to learn how to create a confidential merge request.
{{< /alert >}}
Prerequisites:
- You must have at least the Planner role for the epic's group.
To make an epic confidential:
- **When creating an epic**: select the checkbox under **Confidentiality**.
- **In an existing epic**: on the right sidebar, select **Edit** next to **Confidentiality**, and then
select **Turn on**.
In GitLab 15.6 and later, you can also use the `/confidential` [quick action](../../project/quick_actions.md).
## Manage issues assigned to an epic
This section collects instructions for all the things you can do with [issues](../../project/issues/_index.md)
in relation to epics.
### View issues assigned to an epic
In the **Child items** section, you can see epics, issues, and tasks assigned to this epic.
You can also see any epics, issues, and tasks inherited by descendant items.
Only epics, issues, and tasks that you can access show on the list.
You can always view the issues assigned to the epic if they are in the group's child project.
It's possible because the visibility setting of a project must be the same as or less restrictive than
of its parent group.
### View count and weight of issues in an epic
In the **Child items** section header, the number of descendant epics and issues and their total
weight is displayed. Tasks are not included in these counts.
To see the number of open and closed epics and issues:
- In the section header or under each epic name, hover over the total counts.
The numbers reflect all child issues and epics associated with the epic, including those you might
not have permission to view.
### View epic progress
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5163) in GitLab 17.1.
{{< /history >}}
In the **Child items** section header, the epic progress percentage is displayed.
Tasks are not included in this calculation.
To see the completed and total weight of child issues:
- In the section header, hover over the percentage.
The weights and progress reflect all issues associated with the epic, including issues you might
not have permission to view.
### Health status
{{< details >}}
- Tier: Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9002) in GitLab 17.5.
{{< /history >}}
Use health status on epics to gain quick insight into project progress.
Health status helps you communicate and manage potential issues proactively.
You can view an epic's health status in the epic view and in the **Child items** and **Linked items** sections.
You can set the health status to:
- On track (green)
- Needs attention (amber)
- At risk (red)
To address risks to timely delivery of your planned work, incorporate a review of epic health status into your:
- Daily stand-up meetings
- Project status reports
- Weekly meetings
#### Change health status of an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the group.
To change the health status of an epic:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
1. Select an epic.
1. In the right sidebar, in the **Health status** section, select **Edit**.
1. From the dropdown list, select a status.
The epic's health status is updated.
You can also set and clear health statuses using the `/health_status` and `/clear_health_status` [quick actions](../../project/quick_actions.md#issues-merge-requests-and-epics).
### Add an issue to an epic
{{< history >}}
- Maximum number of child issues and epics [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/452111) to 5000 in GitLab 17.1.
{{< /history >}}
Add an existing issue to an epic, or create a new issue that's automatically
added to the epic.
The maximum number of direct child issues and epics is 5000.
#### Add an existing issue to an epic
{{< history >}}
- Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8.
{{< /history >}}
You can add existing issues to an epic, including issues in a project from a [different group hierarchy](_index.md#child-issues-from-different-group-hierarchies).
Newly added issues appear at the top of the list of issues in the **Child items** section.
An epic contains a list of issues and an issue can be set as a child item of at most one epic.
When you add a new issue that's already linked to an epic, the issue is automatically unlinked from its
current parent.
Prerequisites:
- You must have at least the Guest role for the issue's project and the epic's group.
To add an existing issue to an epic:
1. On the epic's page, under **Child items**, select **Add**.
1. Select **Add an existing issue**.
1. Identify the issue to be added, using either of the following methods:
- Paste the link of the issue.
- Search for the desired issue by entering part of the issue's title, then selecting the desired
match. Issues from different group hierarchies do not appear in search results.
To add such an issue, enter its full URL.
If there are multiple issues to be added, press <kbd>Space</kbd> and repeat this step.
1. Select **Add**.
#### Create an issue from an epic
{{< history >}}
- Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8.
{{< /history >}}
Creating an issue from an epic enables you to maintain focus on the broader context of the epic
while dividing work into smaller parts.
You can create a new issue from an epic only in projects that are in the epic's group or one of its
descendant subgroups.
To create a new issue in a [project that was shared with the epic's group](../../project/members/sharing_projects_groups.md),
first [create the issue directly in the project](../../project/issues/create_issues.md#from-a-project), and
then [add an existing issue to an epic](#add-an-existing-issue-to-an-epic).
Prerequisites:
- You must have at least the Guest role for the issue's project and the epic's group.
To create an issue from an epic:
1. On the epic's page, under **Child items**, select **Add**.
1. Select **Add a new issue**.
1. Under **Title**, enter the title for the new issue.
1. From the **Project** dropdown list, select the project in which the issue should be created.
1. Select **Create issue**.
The new issue is assigned to the epic.
### Remove an issue from an epic
{{< history >}}
- Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8.
{{< /history >}}
You can remove issues from an epic when you're on the epic's details page.
After you remove an issue from an epic, the issue is no longer associated with this epic.
Prerequisites:
- You must have at least the Guest role for the issue's project and the epic's group.
To remove an issue from an epic:
1. Next to the issue you want to remove, select **Remove** ({{< icon name="close" >}}).
The **Remove issue** warning appears.
1. Select **Remove**.
### Reorder issues assigned to an epic
{{< history >}}
- Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8.
{{< /history >}}
New issues show at the top of the list in the **Child items** section.
You can reorder the list of issues by dragging them.
Prerequisites:
- You must have at least the Guest role for the issue's project and the epic's group.
To reorder issues assigned to an epic:
1. Go to the **Child items** section.
1. Drag issues into the desired order.
### Move issues between epics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8.
{{< /history >}}
New issues appear at the top of the list in the **Child items**
tab. You can move issues from one epic to another.
Prerequisites:
- You must have at least the Guest role for the issue's project and the epic's group.
To move an issue to another epic:
1. Go to the **Child items** section.
1. Drag issues into the desired parent epic in the visible hierarchy.
## Multi-level child epics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can add any epic that belongs to a group or subgroup of the parent epic's group.
New child epics appear at the top of the list of epics in the **Child items** section.
When you add an epic that's already linked to a parent epic, the link to its current parent is removed.
Epics can contain multiple nested child epics, up to a total of 7 levels deep.
### Add a parent epic to an epic
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11198) in GitLab 17.5.
{{< /history >}}
To create a hierarchy of epics, add a parent epic to an existing epic.
This helps organize and track related work across multiple epics.
Prerequisites:
- You must have at least the Guest role for either the parent epic's group or the child epic's group.
To add a parent epic:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
1. Select an epic.
1. In the right sidebar, in the **Parent** section, select **Edit**.
1. In the search box, enter part of the parent epic's title.
You can only search for epics in the same group hierarchy.
1. From the search results, select the epic you want to add as the parent.
The parent epic is added.
### Child epics from other groups
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8502) in GitLab 15.6 [with a flag](../../../administration/feature_flags/_index.md) named `child_epics_from_different_hierarchies`. Disabled by default.
- Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7.
- Cross-group child epics [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/375622) in GitLab 15.9. Enabled by default.
- [Feature flag `child_epics_from_different_hierarchies`](https://gitlab.com/gitlab-org/gitlab/-/issues/382719) removed in GitLab 15.10.
{{< /history >}}
Add a child epic that belongs to a group that is different from the parent epic's group.
Prerequisites:
- You must have at least the Guest role for both the child and parent epics' groups.
- Multi-level child epics must be available for both the child and parent epics' groups.
To add a child epic from another group, paste the epic's URL when [adding an existing epic](#add-a-child-epic-to-an-epic).
### View child epics on a roadmap
From an epic, view its child epics and related milestones on the [roadmap](../roadmap/_index.md).
Prerequisites:
- You must have at least the Guest role for the parent epic's group.
To view child epics from the parent:
- In an epic, in the **Child items** section, select **Roadmap view**.
### Add a child epic to an epic
{{< history >}}
- Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7.
{{< /history >}}
Prerequisites:
- You must have at least the Guest role for the parent epic's group.
#### New epic
To add a new epic as child epic:
1. In an epic, in the **Child items** section, select **Add > Add a new epic**.
1. Select a group from the dropdown list. The epic's group is selected by default.
1. Enter a title for the new epic.
1. Select **Create epic**.
#### Existing epic
To add an existing epic as child epic:
1. In an epic, in the **Child items** section, select **Add > Add an existing epic**.
1. Identify the epic to be added, using either of the following methods:
- Paste the link of the epic.
- Search for the desired issue by entering part of the epic's title, then selecting the desired match. This search is only available for epics in the same group hierarchy.
If there are multiple epics to be added, press <kbd>Space</kbd> and repeat this step.
1. Select **Add**.
### Move child epics between epics
{{< history >}}
- Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7.
{{< /history >}}
New child epics appear at the top of the list in the **Child items** section.
You can move child epics from one epic to another.
When you add a new epic that's already linked to a parent epic, the link to its current parent is removed.
Issues and child epics cannot be intermingled.
Prerequisites:
- You must have at least the Guest role for the parent epic's group.
To move child epics to another epic:
1. Go to the **Child items** section.
1. Drag epics into the desired parent epic.
### Reorder child epics assigned to an epic
{{< history >}}
- Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7.
{{< /history >}}
New child epics appear at the top of the list in the **Child items** section.
You can reorder the list of child epics.
Prerequisites:
- You must have at least the Guest role for the parent epic's group.
To reorder child epics assigned to an epic:
1. Go to the **Child items** section.
1. Drag epics into the desired order.
### Remove a child epic from a parent epic
{{< history >}}
- Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7.
{{< /history >}}
Prerequisites:
- You must have at least the Guest role for the parent epic's group.
To remove a child epic from a parent epic:
1. Select **Remove** ({{< icon name="close" >}}) in the parent epic's list of epics.
The **Remove epic** warning appears.
1. Select **Remove**.
|
---
stage: Plan
group: Product Planning
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Manage epics
breadcrumbs:
- doc
- user
- group
- epics
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This page collects instructions for all the things you can do with [epics](_index.md) or in relation
to them.
## Create an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
- Ability to assign milestones to epics [introduced](https://gitlab.com/groups/gitlab-org/-/epics/329) in GitLab 18.2.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the epic's group.
To create an epic in the group you're in:
1. Get to the New Epic form:
- Go to your group and from the left sidebar select **Epics**. Then select **New epic**.
- From an epic in your group, select **Epic actions** ({{< icon name="ellipsis_v" >}}). Then select **New epic**.
- From anywhere, in the top menu, select **New** ({{< icon name="plus-square" >}}). Then select **New epic**.
- In an empty [roadmap](../roadmap/_index.md), select **New epic**.
1. Enter a title.
1. Complete the fields.
- Enter a description.
- To [make the epic confidential](#make-an-epic-confidential), select the checkbox under **Confidentiality**.
- Choose labels.
- Select a start and due date, or [inherit](#start-and-due-date-inheritance) them.
- Select a [color](#epic-color).
1. Select **Create epic**.
The newly created epic opens.
### Start and due date inheritance
If you select **Inherited**:
- For the **start date**: GitLab scans all child epics and issues assigned to the epic,
and sets the start date to match the earliest start date found in the child epics or the milestone
assigned to the child items.
- For the **due date**: GitLab scans all child epics and issues assigned to the epic,
and sets the due date to match the latest due date found in the child epics or the milestone
assigned to the child items.
These dates are dynamic and recalculated if any of the following occur:
- A child epic's dates change.
- Milestones are reassigned to an issue.
- A milestone's dates change.
- Issues are added to, or removed from, the epic.
Because the epic's dates can inherit dates from its children, the start date and due date propagate from the bottom to the top.
If the start date of a child epic on the lowest level changes, that becomes the earliest possible start date for its parent epic.
The parent epic's start date then reflects this change and propagates upwards to the top epic.
## Edit an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
After you create an epic, you can edit the following details:
- Title
- Description
- Start date
- Due date
- Labels
- Milestone
- [Color](#epic-color)
Prerequisites:
- You must have at least the Planner role for the epic's group.
To edit an epic's title or description:
1. Select **Edit**.
1. Make your changes.
1. Select **Save changes**.
To edit an epic's start date, due date, milestone, or labels:
1. Next to each section in the right sidebar, select **Edit**.
1. Select the dates, milestone, or labels for your epic.
### Reorder list items in the epic description
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15260) in GitLab 15.1.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
When you view an epic that has a list in the description, you can also reorder the list items.
Prerequisites:
- You must have at least the Planner role for the project, be the author of the epic, or be
assigned to the epic.
- The epic's description must have an [ordered, unordered](../../markdown.md#lists), or
[task](../../markdown.md#task-lists) list.
To reorder list items, when viewing an epic:
1. Hover over the list item row to make the grip icon ({{< icon name="grip" >}}) visible.
1. Select and hold the grip icon.
1. Drag the row to the new position in the list.
1. Release the grip icon.
### Bulk edit epics
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
- [Added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/200186) more bulk editing attributes in GitLab 18.3.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the parent epic's group.
To update multiple epics at the same time:
1. In a group, go to **Epics > List**.
1. Select **Bulk edit**. A sidebar on the right appears with editable fields.
1. Select the checkboxes next to each epic you want to edit.
1. Select the appropriate fields and their values from the sidebar.
1. Select **Update selected**.
When bulk editing epics in a group, you can edit the following attributes:
- State (open or closed)
- [Assignees](#assignees)
- [Milestone](../../project/milestones/_index.md)
- [Labels](../../project/labels.md)
- [Health status](#health-status)
- [Notification](../../profile/notifications.md) subscription
- [Confidentiality](#make-an-epic-confidential)
## Prevent truncating descriptions with "Read more"
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/181184) in GitLab 17.10.
{{< /history >}}
If an epic description is long, GitLab displays only part of it.
To see the whole description, you must select **Read more**.
This truncation makes it easier to find other elements on the page without scrolling through lengthy text.
To change whether descriptions are truncated:
1. On an epic, in the upper-right corner, select **More actions** ({{< icon name="ellipsis_v" >}}).
1. Toggle **Truncate descriptions** according to your preference.
This setting is remembered and affects all issues, tasks, epics, objectives, and key results.
## Hide the right sidebar
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/181184) in GitLab 17.10.
{{< /history >}}
Epic attributes are shown in a sidebar to the right of the description when space allows.
To hide the sidebar and increase space for the description:
1. On an epic, in the upper-right corner, select **More actions** ({{< icon name="ellipsis_v" >}}).
1. Select **Hide sidebar**.
This setting is remembered and affects all issues, tasks, epics, objectives, and key results.
To show the sidebar again:
- Repeat the previous steps and select **Show sidebar**.
## Assignees
{{< details >}}
- Status: Beta
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4231) in GitLab 17.4 [with a flag](../../../administration/feature_flags/_index.md) named `work_items_beta`. Disabled by default. This feature is in [beta](../../../policy/development_stages_support.md#beta).
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/551805) in GitLab 18.2.
{{< /history >}}
An epic can be assigned to one or more users.
The assignees can be changed as often as needed.
The idea is that the assignees are people responsible for the epic.
If a user is not a member of a group, an epic can only be assigned to them if another group member
assigns them.
### Change assignee on an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the group.
To change the assignee on an epic:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**, then select your epic to view it.
1. On the right sidebar, in the **Assignees** section, select **Edit**.
1. From the dropdown list, select the users to add as an assignee.
1. Select any area outside the dropdown list.
The assignee is changed without having to refresh the page.
## Epic color
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/79940) in GitLab 14.9 [with a flag](../../../administration/feature_flags/_index.md) named `epic_color_highlight`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/365336) in GitLab 16.11. Feature flag `epic_color_highlight` removed.
- Customizable color [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394864) in GitLab 17.5.
{{< /history >}}
You can set a color for an epic to categorize and prioritize tasks visually.
Use colors to:
- Associate epics with teams or company initiatives.
- Indicate levels in the epic hierarchy.
- Group related epics together.
Epic colors are visible in [roadmaps](../roadmap/_index.md) and [epic boards](epic_boards.md).
On roadmaps, the timeline bars match the epic's color:
On epic boards, the color shows on the epic's card accent:
### Change an epic's color
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the epic's group.
To change an epic's color:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
1. Select **New epic** or select an existing epic.
1. On the right sidebar, in the **Color** section, select **Edit**.
1. Select an existing color or enter an RGB or hex value.
1. Select any area outside the dialog.
The epic's color is updated.
## Delete an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/452189) in GitLab 16.11. In GitLab 16.10 and earlier, if you delete an epic, all its child epics and their descendants are deleted as well. If needed, you can [remove child epics](#remove-a-child-epic-from-a-parent-epic) from the parent epic before you delete it.
- [Allowed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) Planner role to delete an epic in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have the Planner or Owner role for the epic's group.
To delete an epic:
1. Select **Epic actions** ({{< icon name="ellipsis_v" >}}), then **Delete epic**.
1. Select **Delete**. On the confirmation dialog, select **Delete epic**.
Deleting an epic releases all existing issues from their associated epic in the system.
## Close an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the epic's group.
To close an epic:
- In the upper-right corner, select **Epic actions** ({{< icon name="ellipsis_v" >}}), then **Close epic**.
You can also use the `/close` [quick action](../../project/quick_actions.md).
## Reopen a closed epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
You can reopen an epic that was closed.
Prerequisites:
- You must have at least the Planner role for the epic's group.
To do so, either:
- In the upper-right corner, select **Epic actions** ({{< icon name="ellipsis_v" >}}) and then **Reopen epic**.
- Use the `/reopen` [quick action](../../project/quick_actions.md).
You can also create an epic by
[promoting an issue](../../project/issues/managing_issues.md#promote-an-issue-to-an-epic).
## Go to an epic from an issue
If an issue belongs to an epic, you can go to the parent epic with the
link in the right sidebar.
## View epics list
In a group, the left sidebar displays the total count of open epics.
This number indicates all epics associated with the group and its subgroups, including epics you
might not have permission to view.
Prerequisites:
- You must be a member of either:
- The group
- A project in the group
- A project in one of the group's subgroups
To view epics in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
### Who can view an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Whether you can view an epic depends on the [group visibility level](../../public_access.md) and
the epic's [confidentiality status](#make-an-epic-confidential):
- Public group and a non-confidential epic: Anyone can view the epic.
- Private group and non-confidential epic: You must have at least the Guest role for the group.
- Confidential epic (regardless of group visibility): You must have at least the Planner
role for the group.
### Configure epic display preferences
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393559) in GitLab 18.2.
{{< /history >}}
You can customize how epics are displayed in the epic list by showing or hiding specific metadata
fields and configuring view preferences.
GitLab saves your display preferences at different levels:
- **Fields**: Saved per namespace. You can have different field visibility settings for different
groups and projects based on your workflow needs. For example, you can show assignee and labels
in one group, but hide them in another group.
- **Your preferences**: Saved globally across all projects and groups. This ensures consistent
behavior for how you prefer to view work items.
To configure epic display preferences:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan** > **Epics**.
1. In the top right corner, select **Display options** ({{< icon name="preferences" >}}).
1. Under **Fields**, turn on or turn off the metadata you want to display:
- **Assignee**: Who the epic is assigned to.
- **Labels**: Epic labels.
- **Milestone**: Milestone information.
- **Dates**: Due dates and date ranges.
- **Health**: Health status indicators.
- **Blocked/Blocking**: Blocking relationship indicators.
- **Comments**: Comment counts.
- **Popularity**: Popularity metrics.
1. Under **Your preferences**, turn on or turn off **Open items in side panel** to choose how
epics open when you select them:
- On (default): Epics open in a drawer on the right side of the screen.
- Off: Epics open in a full page view.
### Open epics in a drawer
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/464698) in GitLab 17.4 [with a flag](../../../administration/feature_flags/_index.md) named `work_item_view_for_issues`. Enabled by default.
- Ability to toggle between drawer and full page view [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/536620) in GitLab 18.2.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
When you select an epic from the Epics page or an epic board, it opens in a drawer.
You can then view and edit its details without losing context of the epic list or board.
When using the drawer:
- Select an epic from the list to open it in the drawer.
- The drawer appears on the right side of the screen.
- You can edit the epic directly in the drawer.
- To close the drawer, select the close icon ({{< icon name="close" >}}) or press **Escape**.
#### Open an epic in full page view
To open an epic in the full page view:
- Open the epic in a new tab. From the list of epics, either:
- Right-click the epic and open it in a new browser tab.
- Hold <kbd>Cmd</kbd> or <kbd>Ctrl</kbd> and select the epic.
- Select an epic, and from the drawer, in the top-left corner, select **Open in full page** ({{< icon name="maximize" >}}).
#### Set preference whether to open epics in a drawer
To configure how epics open on the Epics page:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
1. In the top right corner, select **Display options** ({{< icon name="preferences" >}}).
1. Toggle **Open items in side panel**:
- **On** (default): Epics open in a drawer overlay.
- **Off**: Epics open in a full page view.
Your preference is saved and remembered across all your sessions and devices.
### Cached epic count
The total count of open epics displayed in the sidebar is cached if higher
than 1000. The cached value is rounded to thousands or millions and updated every 24 hours.
## Filter the list of epics
{{< history >}}
- Filtering by group was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385191) in GitLab 15.9.
- Filtering by custom fields was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/525462) in GitLab 17.11.
{{< /history >}}
You can filter the list of epics by:
- Title or description
- Author name / username
- Labels
- Milestones
- Confidentiality
- Reaction emoji
- Groups
- [Custom fields](../../../user/work_items/custom_fields.md) enabled for epics
To filter:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
1. Select the field **Search or filter results**.
1. From the dropdown list, select the scope or enter plain text to search by epic title or description.
1. Press <kbd>Enter</kbd> on your keyboard. The list is filtered.
### Filter with the OR operator
{{< history >}}
- OR filtering for labels and authors was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/382969) in GitLab 15.9 [with a flag](../../../administration/feature_flags/_index.md) named `or_issuable_queries`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/104292) in GitLab 15.9.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/296031) in GitLab 17.0. Feature flag `or_issuable_queries` removed.
{{< /history >}}
You can use the OR operator (**is one of: `||`**) when you [filter the list of epics](#filter-the-list-of-epics) by:
- Authors
- Labels
`is one of` represents an inclusive OR. For example, if you filter by `Label is one of Deliverable` and
`Label is one of UX`, GitLab shows epics with either `Deliverable`, `UX`, or both labels.
## Sort the list of epics
You can sort the epics list by:
- Start date
- Due date
- Title
Each option contains a button that can toggle the order between **Ascending** and **Descending**.
The sort option and order is saved and used wherever you browse epics, including the
[Roadmap](../roadmap/_index.md).
## Change activity sort order
You can reverse the default order and interact with the activity feed sorted by most recent items
at the top. Your preference is saved in local storage and automatically applied to every epic and issue
you view.
To change the activity sort order, select the **Oldest first** dropdown list and select either oldest
or newest items to be shown first.
## Make an epic confidential
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
If you're working on items that contain private information, you can make an epic confidential.
{{< alert type="note" >}}
A confidential epic can only contain [confidential issues](../../project/issues/confidential_issues.md)
and confidential child epics. However, merge requests are public, if created in a public project.
Read [Merge requests for confidential issues](../../project/merge_requests/confidential.md)
to learn how to create a confidential merge request.
{{< /alert >}}
Prerequisites:
- You must have at least the Planner role for the epic's group.
To make an epic confidential:
- **When creating an epic**: select the checkbox under **Confidentiality**.
- **In an existing epic**: on the right sidebar, select **Edit** next to **Confidentiality**, and then
select **Turn on**.
In GitLab 15.6 and later, you can also use the `/confidential` [quick action](../../project/quick_actions.md).
## Manage issues assigned to an epic
This section collects instructions for all the things you can do with [issues](../../project/issues/_index.md)
in relation to epics.
### View issues assigned to an epic
In the **Child items** section, you can see epics, issues, and tasks assigned to this epic.
You can also see any epics, issues, and tasks inherited by descendant items.
Only epics, issues, and tasks that you can access show on the list.
You can always view the issues assigned to the epic if they are in the group's child project.
It's possible because the visibility setting of a project must be the same as or less restrictive than
of its parent group.
### View count and weight of issues in an epic
In the **Child items** section header, the number of descendant epics and issues and their total
weight is displayed. Tasks are not included in these counts.
To see the number of open and closed epics and issues:
- In the section header or under each epic name, hover over the total counts.
The numbers reflect all child issues and epics associated with the epic, including those you might
not have permission to view.
### View epic progress
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5163) in GitLab 17.1.
{{< /history >}}
In the **Child items** section header, the epic progress percentage is displayed.
Tasks are not included in this calculation.
To see the completed and total weight of child issues:
- In the section header, hover over the percentage.
The weights and progress reflect all issues associated with the epic, including issues you might
not have permission to view.
### Health status
{{< details >}}
- Tier: Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9002) in GitLab 17.5.
{{< /history >}}
Use health status on epics to gain quick insight into project progress.
Health status helps you communicate and manage potential issues proactively.
You can view an epic's health status in the epic view and in the **Child items** and **Linked items** sections.
You can set the health status to:
- On track (green)
- Needs attention (amber)
- At risk (red)
To address risks to timely delivery of your planned work, incorporate a review of epic health status into your:
- Daily stand-up meetings
- Project status reports
- Weekly meetings
#### Change health status of an epic
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for the group.
To change the health status of an epic:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
1. Select an epic.
1. In the right sidebar, in the **Health status** section, select **Edit**.
1. From the dropdown list, select a status.
The epic's health status is updated.
You can also set and clear health statuses using the `/health_status` and `/clear_health_status` [quick actions](../../project/quick_actions.md#issues-merge-requests-and-epics).
### Add an issue to an epic
{{< history >}}
- Maximum number of child issues and epics [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/452111) to 5000 in GitLab 17.1.
{{< /history >}}
Add an existing issue to an epic, or create a new issue that's automatically
added to the epic.
The maximum number of direct child issues and epics is 5000.
#### Add an existing issue to an epic
{{< history >}}
- Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8.
{{< /history >}}
You can add existing issues to an epic, including issues in a project from a [different group hierarchy](_index.md#child-issues-from-different-group-hierarchies).
Newly added issues appear at the top of the list of issues in the **Child items** section.
An epic contains a list of issues and an issue can be set as a child item of at most one epic.
When you add a new issue that's already linked to an epic, the issue is automatically unlinked from its
current parent.
Prerequisites:
- You must have at least the Guest role for the issue's project and the epic's group.
To add an existing issue to an epic:
1. On the epic's page, under **Child items**, select **Add**.
1. Select **Add an existing issue**.
1. Identify the issue to be added, using either of the following methods:
- Paste the link of the issue.
- Search for the desired issue by entering part of the issue's title, then selecting the desired
match. Issues from different group hierarchies do not appear in search results.
To add such an issue, enter its full URL.
If there are multiple issues to be added, press <kbd>Space</kbd> and repeat this step.
1. Select **Add**.
#### Create an issue from an epic
{{< history >}}
- Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8.
{{< /history >}}
Creating an issue from an epic enables you to maintain focus on the broader context of the epic
while dividing work into smaller parts.
You can create a new issue from an epic only in projects that are in the epic's group or one of its
descendant subgroups.
To create a new issue in a [project that was shared with the epic's group](../../project/members/sharing_projects_groups.md),
first [create the issue directly in the project](../../project/issues/create_issues.md#from-a-project), and
then [add an existing issue to an epic](#add-an-existing-issue-to-an-epic).
Prerequisites:
- You must have at least the Guest role for the issue's project and the epic's group.
To create an issue from an epic:
1. On the epic's page, under **Child items**, select **Add**.
1. Select **Add a new issue**.
1. Under **Title**, enter the title for the new issue.
1. From the **Project** dropdown list, select the project in which the issue should be created.
1. Select **Create issue**.
The new issue is assigned to the epic.
### Remove an issue from an epic
{{< history >}}
- Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8.
{{< /history >}}
You can remove issues from an epic when you're on the epic's details page.
After you remove an issue from an epic, the issue is no longer associated with this epic.
Prerequisites:
- You must have at least the Guest role for the issue's project and the epic's group.
To remove an issue from an epic:
1. Next to the issue you want to remove, select **Remove** ({{< icon name="close" >}}).
The **Remove issue** warning appears.
1. Select **Remove**.
### Reorder issues assigned to an epic
{{< history >}}
- Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8.
{{< /history >}}
New issues show at the top of the list in the **Child items** section.
You can reorder the list of issues by dragging them.
Prerequisites:
- You must have at least the Guest role for the issue's project and the epic's group.
To reorder issues assigned to an epic:
1. Go to the **Child items** section.
1. Drag issues into the desired order.
### Move issues between epics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8.
{{< /history >}}
New issues appear at the top of the list in the **Child items**
tab. You can move issues from one epic to another.
Prerequisites:
- You must have at least the Guest role for the issue's project and the epic's group.
To move an issue to another epic:
1. Go to the **Child items** section.
1. Drag issues into the desired parent epic in the visible hierarchy.
## Multi-level child epics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can add any epic that belongs to a group or subgroup of the parent epic's group.
New child epics appear at the top of the list of epics in the **Child items** section.
When you add an epic that's already linked to a parent epic, the link to its current parent is removed.
Epics can contain multiple nested child epics, up to a total of 7 levels deep.
### Add a parent epic to an epic
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11198) in GitLab 17.5.
{{< /history >}}
To create a hierarchy of epics, add a parent epic to an existing epic.
This helps organize and track related work across multiple epics.
Prerequisites:
- You must have at least the Guest role for either the parent epic's group or the child epic's group.
To add a parent epic:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epics**.
1. Select an epic.
1. In the right sidebar, in the **Parent** section, select **Edit**.
1. In the search box, enter part of the parent epic's title.
You can only search for epics in the same group hierarchy.
1. From the search results, select the epic you want to add as the parent.
The parent epic is added.
### Child epics from other groups
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8502) in GitLab 15.6 [with a flag](../../../administration/feature_flags/_index.md) named `child_epics_from_different_hierarchies`. Disabled by default.
- Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7.
- Cross-group child epics [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/375622) in GitLab 15.9. Enabled by default.
- [Feature flag `child_epics_from_different_hierarchies`](https://gitlab.com/gitlab-org/gitlab/-/issues/382719) removed in GitLab 15.10.
{{< /history >}}
Add a child epic that belongs to a group that is different from the parent epic's group.
Prerequisites:
- You must have at least the Guest role for both the child and parent epics' groups.
- Multi-level child epics must be available for both the child and parent epics' groups.
To add a child epic from another group, paste the epic's URL when [adding an existing epic](#add-a-child-epic-to-an-epic).
### View child epics on a roadmap
From an epic, view its child epics and related milestones on the [roadmap](../roadmap/_index.md).
Prerequisites:
- You must have at least the Guest role for the parent epic's group.
To view child epics from the parent:
- In an epic, in the **Child items** section, select **Roadmap view**.
### Add a child epic to an epic
{{< history >}}
- Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7.
{{< /history >}}
Prerequisites:
- You must have at least the Guest role for the parent epic's group.
#### New epic
To add a new epic as child epic:
1. In an epic, in the **Child items** section, select **Add > Add a new epic**.
1. Select a group from the dropdown list. The epic's group is selected by default.
1. Enter a title for the new epic.
1. Select **Create epic**.
#### Existing epic
To add an existing epic as child epic:
1. In an epic, in the **Child items** section, select **Add > Add an existing epic**.
1. Identify the epic to be added, using either of the following methods:
- Paste the link of the epic.
- Search for the desired issue by entering part of the epic's title, then selecting the desired match. This search is only available for epics in the same group hierarchy.
If there are multiple epics to be added, press <kbd>Space</kbd> and repeat this step.
1. Select **Add**.
### Move child epics between epics
{{< history >}}
- Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7.
{{< /history >}}
New child epics appear at the top of the list in the **Child items** section.
You can move child epics from one epic to another.
When you add a new epic that's already linked to a parent epic, the link to its current parent is removed.
Issues and child epics cannot be intermingled.
Prerequisites:
- You must have at least the Guest role for the parent epic's group.
To move child epics to another epic:
1. Go to the **Child items** section.
1. Drag epics into the desired parent epic.
### Reorder child epics assigned to an epic
{{< history >}}
- Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7.
{{< /history >}}
New child epics appear at the top of the list in the **Child items** section.
You can reorder the list of child epics.
Prerequisites:
- You must have at least the Guest role for the parent epic's group.
To reorder child epics assigned to an epic:
1. Go to the **Child items** section.
1. Drag epics into the desired order.
### Remove a child epic from a parent epic
{{< history >}}
- Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7.
{{< /history >}}
Prerequisites:
- You must have at least the Guest role for the parent epic's group.
To remove a child epic from a parent epic:
1. Select **Remove** ({{< icon name="close" >}}) in the parent epic's list of epics.
The **Remove epic** warning appears.
1. Select **Remove**.
|
https://docs.gitlab.com/user/group/epics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/epics
|
[
"doc",
"user",
"group",
"epics"
] |
_index.md
|
Plan
|
Product Planning
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Epics
|
Roadmaps, hierarchies, planning, and issue progress.
|
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Epics in GitLab coordinate and track large initiatives by organizing work items into a work hierarchy.
Epics make complex projects manageable. They:
- Break down large features into smaller deliverables that add incremental value.
- Track the progress of related work items with scheduled start and end dates.
- Organize discussions and decisions about feature scope and requirements.
- Create hierarchical structures that connect tasks to strategic goals.
- Build visual roadmaps to monitor progress toward objectives.
Teams use epics to coordinate across multiple iterations and track progress toward long-term goals.
In the Ultimate tier, [nested epics](manage_epics.md#multi-level-child-epics) provide additional
structure through work hierarchies that align with agile frameworks.
Break down complex projects into more manageable child epics, which can further contain their own
sets of issues and tasks.
This nested structure helps maintain clarity and ensures all aspects of a project are covered without
losing sight of the overarching goals.
<div class="video-fallback">
See the video: <a href="https://www.youtube.com/watch?v=c0EwYYUZppw">GitLab Epics - Setting up your Organization with GitLab</a>.
</div>
<figure class="video-container">
<iframe src="https://www.youtube-nocookie.com/embed/c0EwYYUZppw" frameborder="0" allowfullscreen> </iframe>
</figure>
<!-- Video published on 2023-10-30 -->
## Relationships between epics and other items
The possible relationships between epics and other items are:
- An epic is the parent of one or more issues.
- An epic is the parent of one or more [child epics](manage_epics.md#multi-level-child-epics). Ultimate only.
- An epic is [linked](linked_epics.md) to one or more task, objective, or key result.
Example set of relationships:
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
accTitle: Epics and issues
accDescr: How issues and child epics relate to parent epics and lateral relationships to work items
%% Main structure %%
Parent_epic -->|contains| Issue1
Parent_epic -->|contains| Child_epic
Child_epic -->|contains| Issue2
%% Additional work items and lateral relationships %%
Issue1 -- contains --> Task1["Task"]
Issue2 -- "blocked by" --> Objective1["Objective"]
Task1 -- blocking --> KeyResult1["Key Result"]
%% Work items linked to epics and issues %%
Parent_epic -. related .- Objective1
Child_epic -. "blocked by" .- KeyResult1
```
### Child issues from different group hierarchies
You can add issues from a different group hierarchy to an epic.
To do it, paste the issue URL when
[adding an existing issue](manage_epics.md#add-an-existing-issue-to-an-epic).
## Roadmap in epics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
On the **Child items** section header, select **More actions** ({{< icon name="ellipsis_v" >}}) **> View on a roadmap**.
A roadmap filtered for the parent epic opens.
## Epics as work items
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9290) in GitLab 17.2 [with a flag](../../../administration/feature_flags/_index.md) named `work_item_epics`. Disabled by default. Introduced in [beta](../../../policy/development_stages_support.md#beta).
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/470685) in GitLab 17.6.
- [Enabled by default on GitLab Self-Managed and GitLab Dedicated](https://gitlab.com/gitlab-org/gitlab/-/issues/468310) in GitLab 17.7.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/468310) in GitLab 18.1. Feature flag `work_item_epics` removed.
{{< /history >}}
We have changed how epics look by migrating them to a unified framework for work items to better
meet the product needs of our Agile Planning offering.
For more information, see [epic 9290](https://gitlab.com/groups/gitlab-org/-/epics/9290) and the
following blog posts:
- [First look: The new Agile planning experience in GitLab](https://about.gitlab.com/blog/2024/06/18/first-look-the-new-agile-planning-experience-in-gitlab/) (June 2024)
- [Unveiling a new epic experience for improved Agile planning](https://about.gitlab.com/blog/2024/07/03/unveiling-a-new-epic-experience-for-improved-agile-planning/) (July 2024)
If you run into any issues while trying out this change, you can use the
[feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/494462) to provide more details.
## Work item Markdown reference
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352861) in GitLab 18.1 [with a flag](../../../administration/feature_flags/_index.md) named `extensible_reference_filters`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197052) in GitLab 18.2. Feature flag `extensible_reference_filters` removed.
{{< /history >}}
You can reference work items in GitLab Flavored Markdown fields with `[work_item:123]`.
For more information, see [GitLab-specific references](../../markdown.md#gitlab-specific-references).
## Related topics
- [Manage epics](manage_epics.md) and multi-level child epics.
- Link [related epics](linked_epics.md) based on a type of relationship.
- Create workflows with [epic boards](epic_boards.md).
- [Turn on notifications](../../profile/notifications.md) for about epic events.
- [Add an emoji reaction](../../emoji_reactions.md) to an epic or its comments.
- Collaborate on an epic by posting comments in a [thread](../../discussions/_index.md).
- Use [health status](manage_epics.md#health-status) to track your progress.
- [Create epic templates](../../project/description_templates.md#create-a-description-template) to standardize epic descriptions.
|
---
stage: Plan
group: Product Planning
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Epics
description: Roadmaps, hierarchies, planning, and issue progress.
breadcrumbs:
- doc
- user
- group
- epics
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Epics in GitLab coordinate and track large initiatives by organizing work items into a work hierarchy.
Epics make complex projects manageable. They:
- Break down large features into smaller deliverables that add incremental value.
- Track the progress of related work items with scheduled start and end dates.
- Organize discussions and decisions about feature scope and requirements.
- Create hierarchical structures that connect tasks to strategic goals.
- Build visual roadmaps to monitor progress toward objectives.
Teams use epics to coordinate across multiple iterations and track progress toward long-term goals.
In the Ultimate tier, [nested epics](manage_epics.md#multi-level-child-epics) provide additional
structure through work hierarchies that align with agile frameworks.
Break down complex projects into more manageable child epics, which can further contain their own
sets of issues and tasks.
This nested structure helps maintain clarity and ensures all aspects of a project are covered without
losing sight of the overarching goals.
<div class="video-fallback">
See the video: <a href="https://www.youtube.com/watch?v=c0EwYYUZppw">GitLab Epics - Setting up your Organization with GitLab</a>.
</div>
<figure class="video-container">
<iframe src="https://www.youtube-nocookie.com/embed/c0EwYYUZppw" frameborder="0" allowfullscreen> </iframe>
</figure>
<!-- Video published on 2023-10-30 -->
## Relationships between epics and other items
The possible relationships between epics and other items are:
- An epic is the parent of one or more issues.
- An epic is the parent of one or more [child epics](manage_epics.md#multi-level-child-epics). Ultimate only.
- An epic is [linked](linked_epics.md) to one or more task, objective, or key result.
Example set of relationships:
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
accTitle: Epics and issues
accDescr: How issues and child epics relate to parent epics and lateral relationships to work items
%% Main structure %%
Parent_epic -->|contains| Issue1
Parent_epic -->|contains| Child_epic
Child_epic -->|contains| Issue2
%% Additional work items and lateral relationships %%
Issue1 -- contains --> Task1["Task"]
Issue2 -- "blocked by" --> Objective1["Objective"]
Task1 -- blocking --> KeyResult1["Key Result"]
%% Work items linked to epics and issues %%
Parent_epic -. related .- Objective1
Child_epic -. "blocked by" .- KeyResult1
```
### Child issues from different group hierarchies
You can add issues from a different group hierarchy to an epic.
To do it, paste the issue URL when
[adding an existing issue](manage_epics.md#add-an-existing-issue-to-an-epic).
## Roadmap in epics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
On the **Child items** section header, select **More actions** ({{< icon name="ellipsis_v" >}}) **> View on a roadmap**.
A roadmap filtered for the parent epic opens.
## Epics as work items
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9290) in GitLab 17.2 [with a flag](../../../administration/feature_flags/_index.md) named `work_item_epics`. Disabled by default. Introduced in [beta](../../../policy/development_stages_support.md#beta).
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/470685) in GitLab 17.6.
- [Enabled by default on GitLab Self-Managed and GitLab Dedicated](https://gitlab.com/gitlab-org/gitlab/-/issues/468310) in GitLab 17.7.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/468310) in GitLab 18.1. Feature flag `work_item_epics` removed.
{{< /history >}}
We have changed how epics look by migrating them to a unified framework for work items to better
meet the product needs of our Agile Planning offering.
For more information, see [epic 9290](https://gitlab.com/groups/gitlab-org/-/epics/9290) and the
following blog posts:
- [First look: The new Agile planning experience in GitLab](https://about.gitlab.com/blog/2024/06/18/first-look-the-new-agile-planning-experience-in-gitlab/) (June 2024)
- [Unveiling a new epic experience for improved Agile planning](https://about.gitlab.com/blog/2024/07/03/unveiling-a-new-epic-experience-for-improved-agile-planning/) (July 2024)
If you run into any issues while trying out this change, you can use the
[feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/494462) to provide more details.
## Work item Markdown reference
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352861) in GitLab 18.1 [with a flag](../../../administration/feature_flags/_index.md) named `extensible_reference_filters`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197052) in GitLab 18.2. Feature flag `extensible_reference_filters` removed.
{{< /history >}}
You can reference work items in GitLab Flavored Markdown fields with `[work_item:123]`.
For more information, see [GitLab-specific references](../../markdown.md#gitlab-specific-references).
## Related topics
- [Manage epics](manage_epics.md) and multi-level child epics.
- Link [related epics](linked_epics.md) based on a type of relationship.
- Create workflows with [epic boards](epic_boards.md).
- [Turn on notifications](../../profile/notifications.md) for about epic events.
- [Add an emoji reaction](../../emoji_reactions.md) to an epic or its comments.
- Collaborate on an epic by posting comments in a [thread](../../discussions/_index.md).
- Use [health status](manage_epics.md#health-status) to track your progress.
- [Create epic templates](../../project/description_templates.md#create-a-description-template) to standardize epic descriptions.
|
https://docs.gitlab.com/user/group/epic_boards
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/epic_boards.md
|
2025-08-13
|
doc/user/group/epics
|
[
"doc",
"user",
"group",
"epics"
] |
epic_boards.md
|
Plan
|
Product Planning
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Epic boards
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Displaying total weight on the top of lists [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/364503) in GitLab 15.11.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Epic boards build on the existing [epic tracking functionality](_index.md) and
[labels](../../project/labels.md). Your epics appear as cards in vertical lists, organized by their assigned
labels.
On the top of each list, you can see the number of epics in the list ({{< icon name="epic" >}}) and the total weight of all its epics ({{< icon name="weight" >}}).
<div class="video-fallback">
See the video: <a href="https://www.youtube.com/watch?v=eQUnHwbKEkY">Epics and Issue Boards - Project Management</a>.
</div>
<figure class="video-container">
<iframe src="https://www.youtube-nocookie.com/embed/eQUnHwbKEkY" frameborder="0" allowfullscreen> </iframe>
</figure>
To view an epic board:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epic boards**.
## Create an epic board
Prerequisites:
- You must have at least the Planner role for a group.
To create a new epic board:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epic boards**.
1. In the upper-left corner, select the dropdown list with the current board name.
1. Select **Create new board**.
1. Enter the new board's title.
1. Optional. To hide the Open or Closed lists, clear the **Show the Open list** and
**Show the Closed list** checkboxes.
1. Optional. Set board scope:
1. Next to **Scope**, select **Expand**.
1. Next to **Labels**, select **Edit** and select the labels to use as board scope.
1. Select **Create board**.
Now you can [add some lists](#create-a-new-list).
To change these options later, [edit the board](#edit-the-scope-of-an-epic-board).
## Delete an epic board
Prerequisites:
- You must have at least the Planner role for a group.
- A minimum of two boards present in a group.
To delete the active epic board:
1. In the upper-left corner of the epic board page, select the dropdown list.
1. Select **Delete board**.
1. Select **Delete**.
## Actions you can take on an epic board
- [Create a new list](#create-a-new-list).
- [Remove an existing list](#remove-a-list).
- [Filter epics](#filter-epics).
- Create workflows, like when using [issue boards](../../../tutorials/plan_and_track.md).
- [Move epics and lists](#move-epics-and-lists).
- Change epic labels (by dragging an epic between lists).
- Close an epic (by dragging it to the **Closed** list).
- [Edit the scope of a board](#edit-the-scope-of-an-epic-board).
### Create a new list
{{< history >}}
- Creating a list between existing lists [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/462515) in GitLab 17.5.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for a group.
To create a new list:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epic boards**.
1. In the upper-right corner, select **New list**.
1. Hover or move keyboard focus between two lists.
1. Select **New list**.
The new list panel opens.
1. In the **New list** column expand the **Select a label** dropdown list and select the label to use as
list scope.
1. Select **Add to board**.
The new list is inserted in the same position on the board as the new list panel.
To move and reorder lists, drag them around.
Alternatively, you can select the **New list** at the right end of the board.
The new list is inserted at the right end of the lists, before **Closed**.
### Remove a list
Removing a list doesn't have any effect on epics and labels, as it's just the
list view that's removed. You can always create it again later if you need.
Prerequisites:
- You must have at least the Planner role for a group.
To remove a list from an epic board:
1. On the top of the list you want to remove, select the **List settings** icon ({{< icon name="settings" >}}).
The list settings sidebar opens on the right.
1. Select **Remove list**.
1. On the confirmation dialog, select **OK**.
### Create an epic from an epic board
Prerequisites:
- You must have at least the Planner role for a group.
- You must have [created a list](#create-a-new-list) first.
To create an epic from a list in epic board:
1. On the top of a list, select the **New epic** ({{< icon name="plus" >}}) icon.
1. Enter the new epic's title.
1. Select **Create epic**.
### Edit an epic
<!-- When epics_list_drawer feature flag is removed, change the info below into a proper task topic -->
If your administrator enabled the [epic drawer](manage_epics.md#open-epics-in-a-drawer),
when you select an epic card from the epic board, the epic opens in a drawer.
There, you can edit all the fields, including the description, comments, or related items.
### Filter epics
Use the filters on top of your epic board to show only
the results you want. It's similar to the filtering used in the epic list,
as the metadata from the epics and labels is re-used in the epic board.
You can filter by the following:
- Author
- Label
### View count of issues, weight, and progress of an epic
Epics on an epic board show a summary of their issues, weight, and progress.
To see the number of open and closed issues and the completed and incomplete
weight, hover over the issues icon {{< icon name="issues" >}}, weight icon {{< icon name="weight" >}}, or
progress icon {{< icon name="progress" >}}.
### Move epics and lists
You can move epics and lists by dragging them.
Prerequisites:
- You must have at least the Planner role for a group.
To move an epic, select the epic card and drag it to another position in its current list or
into another list. Learn about possible effects in [Dragging epics between lists](#dragging-epics-between-lists).
To move a list, select its top bar, and drag it horizontally.
You can't move the **Open** and **Closed** lists, but you can hide them when editing an epic board.
#### Move an epic to the start of the list
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4.
{{< /history >}}
When you have many epics, it's inconvenient to manually drag an epic from the bottom of a board list all
the way to the top. You can move epics to the top of the list with a menu shortcut.
Your epic is moved to the top of the list even if other epics are hidden by a filter.
Prerequisites:
- You must at least have the Planner role for a group.
To move an epic to the start of the list:
1. In an epic board, hover over the card of the epic you want to move.
1. Select **Card options** ({{< icon name="ellipsis_v" >}}), then **Move to start of list**.
#### Move an epic to the end of the list
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4.
{{< /history >}}
When you have many epics, it's inconvenient to manually drag an epic from the top of a board list all
the way to the bottom. You can move epics to the bottom of the list with a menu shortcut.
Your epic is moved to the bottom of the list even if other epics are hidden by a filter.
Prerequisites:
- You must at least have the Planner role for a group.
To move an epic to the end of the list:
1. In an epic board, hover over the card of the epic you want to move.
1. Select **Card options** ({{< icon name="ellipsis_v" >}}), then **Move to end of list**.
#### Dragging epics between lists
When you drag epics between lists, the result is different depending on the source list
and the target list.
| | To Open | To Closed | To label B list |
| --------------------- | -------------- | ---------- | ------------------------------ |
| **From Open** | - | Close epic | Add label B |
| **From Closed** | Reopen epic | - | Reopen epic and add label B |
| **From label A list** | Remove label A | Close epic | Remove label A and add label B |
### Edit the scope of an epic board
Prerequisites:
- You must have at least the Planner role for a group.
To edit the scope of an epic board:
1. In the upper-right corner, select **Configure board** ({{< icon name="settings" >}}).
1. Optional:
- Edit the board's title.
- Show or hide the Open and Closed columns.
- Select other labels as the board's scope.
1. Select **Save changes**.
|
---
stage: Plan
group: Product Planning
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Epic boards
breadcrumbs:
- doc
- user
- group
- epics
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Displaying total weight on the top of lists [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/364503) in GitLab 15.11.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
Epic boards build on the existing [epic tracking functionality](_index.md) and
[labels](../../project/labels.md). Your epics appear as cards in vertical lists, organized by their assigned
labels.
On the top of each list, you can see the number of epics in the list ({{< icon name="epic" >}}) and the total weight of all its epics ({{< icon name="weight" >}}).
<div class="video-fallback">
See the video: <a href="https://www.youtube.com/watch?v=eQUnHwbKEkY">Epics and Issue Boards - Project Management</a>.
</div>
<figure class="video-container">
<iframe src="https://www.youtube-nocookie.com/embed/eQUnHwbKEkY" frameborder="0" allowfullscreen> </iframe>
</figure>
To view an epic board:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epic boards**.
## Create an epic board
Prerequisites:
- You must have at least the Planner role for a group.
To create a new epic board:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epic boards**.
1. In the upper-left corner, select the dropdown list with the current board name.
1. Select **Create new board**.
1. Enter the new board's title.
1. Optional. To hide the Open or Closed lists, clear the **Show the Open list** and
**Show the Closed list** checkboxes.
1. Optional. Set board scope:
1. Next to **Scope**, select **Expand**.
1. Next to **Labels**, select **Edit** and select the labels to use as board scope.
1. Select **Create board**.
Now you can [add some lists](#create-a-new-list).
To change these options later, [edit the board](#edit-the-scope-of-an-epic-board).
## Delete an epic board
Prerequisites:
- You must have at least the Planner role for a group.
- A minimum of two boards present in a group.
To delete the active epic board:
1. In the upper-left corner of the epic board page, select the dropdown list.
1. Select **Delete board**.
1. Select **Delete**.
## Actions you can take on an epic board
- [Create a new list](#create-a-new-list).
- [Remove an existing list](#remove-a-list).
- [Filter epics](#filter-epics).
- Create workflows, like when using [issue boards](../../../tutorials/plan_and_track.md).
- [Move epics and lists](#move-epics-and-lists).
- Change epic labels (by dragging an epic between lists).
- Close an epic (by dragging it to the **Closed** list).
- [Edit the scope of a board](#edit-the-scope-of-an-epic-board).
### Create a new list
{{< history >}}
- Creating a list between existing lists [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/462515) in GitLab 17.5.
{{< /history >}}
Prerequisites:
- You must have at least the Planner role for a group.
To create a new list:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Epic boards**.
1. In the upper-right corner, select **New list**.
1. Hover or move keyboard focus between two lists.
1. Select **New list**.
The new list panel opens.
1. In the **New list** column expand the **Select a label** dropdown list and select the label to use as
list scope.
1. Select **Add to board**.
The new list is inserted in the same position on the board as the new list panel.
To move and reorder lists, drag them around.
Alternatively, you can select the **New list** at the right end of the board.
The new list is inserted at the right end of the lists, before **Closed**.
### Remove a list
Removing a list doesn't have any effect on epics and labels, as it's just the
list view that's removed. You can always create it again later if you need.
Prerequisites:
- You must have at least the Planner role for a group.
To remove a list from an epic board:
1. On the top of the list you want to remove, select the **List settings** icon ({{< icon name="settings" >}}).
The list settings sidebar opens on the right.
1. Select **Remove list**.
1. On the confirmation dialog, select **OK**.
### Create an epic from an epic board
Prerequisites:
- You must have at least the Planner role for a group.
- You must have [created a list](#create-a-new-list) first.
To create an epic from a list in epic board:
1. On the top of a list, select the **New epic** ({{< icon name="plus" >}}) icon.
1. Enter the new epic's title.
1. Select **Create epic**.
### Edit an epic
<!-- When epics_list_drawer feature flag is removed, change the info below into a proper task topic -->
If your administrator enabled the [epic drawer](manage_epics.md#open-epics-in-a-drawer),
when you select an epic card from the epic board, the epic opens in a drawer.
There, you can edit all the fields, including the description, comments, or related items.
### Filter epics
Use the filters on top of your epic board to show only
the results you want. It's similar to the filtering used in the epic list,
as the metadata from the epics and labels is re-used in the epic board.
You can filter by the following:
- Author
- Label
### View count of issues, weight, and progress of an epic
Epics on an epic board show a summary of their issues, weight, and progress.
To see the number of open and closed issues and the completed and incomplete
weight, hover over the issues icon {{< icon name="issues" >}}, weight icon {{< icon name="weight" >}}, or
progress icon {{< icon name="progress" >}}.
### Move epics and lists
You can move epics and lists by dragging them.
Prerequisites:
- You must have at least the Planner role for a group.
To move an epic, select the epic card and drag it to another position in its current list or
into another list. Learn about possible effects in [Dragging epics between lists](#dragging-epics-between-lists).
To move a list, select its top bar, and drag it horizontally.
You can't move the **Open** and **Closed** lists, but you can hide them when editing an epic board.
#### Move an epic to the start of the list
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4.
{{< /history >}}
When you have many epics, it's inconvenient to manually drag an epic from the bottom of a board list all
the way to the top. You can move epics to the top of the list with a menu shortcut.
Your epic is moved to the top of the list even if other epics are hidden by a filter.
Prerequisites:
- You must at least have the Planner role for a group.
To move an epic to the start of the list:
1. In an epic board, hover over the card of the epic you want to move.
1. Select **Card options** ({{< icon name="ellipsis_v" >}}), then **Move to start of list**.
#### Move an epic to the end of the list
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4.
{{< /history >}}
When you have many epics, it's inconvenient to manually drag an epic from the top of a board list all
the way to the bottom. You can move epics to the bottom of the list with a menu shortcut.
Your epic is moved to the bottom of the list even if other epics are hidden by a filter.
Prerequisites:
- You must at least have the Planner role for a group.
To move an epic to the end of the list:
1. In an epic board, hover over the card of the epic you want to move.
1. Select **Card options** ({{< icon name="ellipsis_v" >}}), then **Move to end of list**.
#### Dragging epics between lists
When you drag epics between lists, the result is different depending on the source list
and the target list.
| | To Open | To Closed | To label B list |
| --------------------- | -------------- | ---------- | ------------------------------ |
| **From Open** | - | Close epic | Add label B |
| **From Closed** | Reopen epic | - | Reopen epic and add label B |
| **From label A list** | Remove label A | Close epic | Remove label A and add label B |
### Edit the scope of an epic board
Prerequisites:
- You must have at least the Planner role for a group.
To edit the scope of an epic board:
1. In the upper-right corner, select **Configure board** ({{< icon name="settings" >}}).
1. Optional:
- Edit the board's title.
- Show or hide the Open and Closed columns.
- Select other labels as the board's scope.
1. Select **Save changes**.
|
https://docs.gitlab.com/user/group/devops_adoption
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/devops_adoption
|
[
"doc",
"user",
"group",
"devops_adoption"
] |
_index.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
DevOps adoption by group
| null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Added](https://gitlab.com/gitlab-org/gitlab/-/issues/367093) to the [Registration Features Program](../../../administration/settings/usage_statistics.md#registration-features-program) in GitLab 16.6.
{{< /history >}}
DevOps adoption shows you how groups in your organization adopt and use GitLab features.
This information is available for groups and [instances](../../../administration/analytics/devops_adoption.md).
Use DevOps adoption for groups to:
- Identify subgroups that are lagging in their adoption of GitLab features, so you can guide them on
their DevOps journey.
- Find subgroups that have adopted certain features, and provide guidance to other subgroups on
how to use those features.
- Verify if you are getting the return on investment that you expected from GitLab.
## Feature adoption
DevOps adoption shows feature adoption for development, security, and operations.
| Category | Feature |
|-------------|---------|
| Development | Approvals<br>Code owners<br>Issues<br>Merge requests |
| Security | DAST<br>Dependency Scanning<br>Fuzz Testing<br>SAST |
| Operations | Deployments<br>Pipelines<br>Runners |
A feature shows as **adopted** when a group or subgroup has used the feature in a project in the last full calendar month.
For example, if an issue was created in a project in a group, the group has adopted issues in that time.
The **Overview** tab illustrates the:
- Total number of features adopted.
- Features adopted in each category.
- Number of features adopted in each category by month in the **Adoption over time** bar chart.
The chart shows only data from the date you enabled DevOps adoption for the group.
- Number of features adopted in each category by subgroup in the **Adoption by subgroup** table.
The **Dev**, **Sec**, and **Ops** tabs illustrate the features adopted in development, security, and operations by subgroup.
The DevOps adoption report excludes:
- Dormant projects. The number of projects that use a feature is not considered. Having many dormant projects doesn't lower the adoption.
- New GitLab features. Adoption is the total number of features adopted, not the percent of features.
## Data processing
A weekly task processes data for DevOps adoption.
This task is disabled until you access DevOps adoption for a group for the first time.
The data processing task updates the data on the first day of each month.
If the monthly update fails, the task tries daily until it succeeds.
DevOps adoption data may take up to a minute to appear while GitLab processes the group's data.
## View DevOps adoption for groups
Prerequisites:
- You must have at least the Reporter role for the group.
To view DevOps adoption:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > DevOps adoption**.
1. To view the features adopted by category in a month, hover over a bar.
## Add a subgroup to DevOps adoption
Prerequisites:
- You must have at least the Reporter role for the group.
To add a subgroup to the DevOps adoption report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > DevOps adoption**.
1. From the **Add or remove subgroups** dropdown list, select the subgroup you want to add.
## Remove a subgroup from DevOps adoption
Prerequisites:
- You must have at least the Reporter role for the group.
To remove a subgroup from the DevOps adoption report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > DevOps adoption**.
1. Either:
- From the **Add or remove subgroups** dropdown list, clear the subgroup you want to remove.
- From the **Adoption by subgroup** table, in the row of the group you want to remove, select
**Remove Group from the table** ({{< icon name="remove" >}}).
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: DevOps adoption by group
breadcrumbs:
- doc
- user
- group
- devops_adoption
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Added](https://gitlab.com/gitlab-org/gitlab/-/issues/367093) to the [Registration Features Program](../../../administration/settings/usage_statistics.md#registration-features-program) in GitLab 16.6.
{{< /history >}}
DevOps adoption shows you how groups in your organization adopt and use GitLab features.
This information is available for groups and [instances](../../../administration/analytics/devops_adoption.md).
Use DevOps adoption for groups to:
- Identify subgroups that are lagging in their adoption of GitLab features, so you can guide them on
their DevOps journey.
- Find subgroups that have adopted certain features, and provide guidance to other subgroups on
how to use those features.
- Verify if you are getting the return on investment that you expected from GitLab.
## Feature adoption
DevOps adoption shows feature adoption for development, security, and operations.
| Category | Feature |
|-------------|---------|
| Development | Approvals<br>Code owners<br>Issues<br>Merge requests |
| Security | DAST<br>Dependency Scanning<br>Fuzz Testing<br>SAST |
| Operations | Deployments<br>Pipelines<br>Runners |
A feature shows as **adopted** when a group or subgroup has used the feature in a project in the last full calendar month.
For example, if an issue was created in a project in a group, the group has adopted issues in that time.
The **Overview** tab illustrates the:
- Total number of features adopted.
- Features adopted in each category.
- Number of features adopted in each category by month in the **Adoption over time** bar chart.
The chart shows only data from the date you enabled DevOps adoption for the group.
- Number of features adopted in each category by subgroup in the **Adoption by subgroup** table.
The **Dev**, **Sec**, and **Ops** tabs illustrate the features adopted in development, security, and operations by subgroup.
The DevOps adoption report excludes:
- Dormant projects. The number of projects that use a feature is not considered. Having many dormant projects doesn't lower the adoption.
- New GitLab features. Adoption is the total number of features adopted, not the percent of features.
## Data processing
A weekly task processes data for DevOps adoption.
This task is disabled until you access DevOps adoption for a group for the first time.
The data processing task updates the data on the first day of each month.
If the monthly update fails, the task tries daily until it succeeds.
DevOps adoption data may take up to a minute to appear while GitLab processes the group's data.
## View DevOps adoption for groups
Prerequisites:
- You must have at least the Reporter role for the group.
To view DevOps adoption:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > DevOps adoption**.
1. To view the features adopted by category in a month, hover over a bar.
## Add a subgroup to DevOps adoption
Prerequisites:
- You must have at least the Reporter role for the group.
To add a subgroup to the DevOps adoption report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > DevOps adoption**.
1. From the **Add or remove subgroups** dropdown list, select the subgroup you want to add.
## Remove a subgroup from DevOps adoption
Prerequisites:
- You must have at least the Reporter role for the group.
To remove a subgroup from the DevOps adoption report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > DevOps adoption**.
1. Either:
- From the **Add or remove subgroups** dropdown list, clear the subgroup you want to remove.
- From the **Adoption by subgroup** table, in the row of the group you want to remove, select
**Remove Group from the table** ({{< icon name="remove" >}}).
|
https://docs.gitlab.com/user/group/value_stream_analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/value_stream_analytics
|
[
"doc",
"user",
"group",
"value_stream_analytics"
] |
_index.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Value stream analytics
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Value stream analytics calculates the duration of every stage of your software development process.
You can measure how much time it takes to go from an idea to production by tracking merge request or issue events.
Use value stream analytics to identify:
- The amount of time it takes to go from an idea to production.
- The velocity of a given project.
- Bottlenecks in the development process.
- Long-running issues or merge requests.
- Factors that cause your software development lifecycle to slow down.
Value stream analytics helps businesses:
- Visualize their end-to-end DevSecOps workstreams.
- Identify and solve inefficiencies.
- Optimize their workstreams to deliver more value, faster (for example, [reducing merge request review time](https://about.gitlab.com/blog/2025/02/20/how-we-reduced-mr-review-time-with-value-stream-management/)).
For a click-through demo, see [the Value Stream Management product tour](https://gitlab.navattic.com/vsm).
Value stream analytics has a hierarchical structure:
- A **value stream** contains a value stream stage list.
- Each value stream stage list contains one or more **stages**.
- Each stage is defined by two **events**: start and end.
## Value streams
A value stream is the entire work process that delivers value to customers.
Value streams are container objects for stages.
You can have multiple value streams per group, to focus on different aspects of the DevOps lifecycle.
## Value stream stages
A stage represents an event pair (start and end events) with additional metadata, such as the name of the stage.
You can use value stream analytics with the built-in default stages, which you can reorder and hide.
You can also create and add custom stages that align with your specific development workflows.
## Value stream stage events
{{< history >}}
- Merge request first reviewer assigned event [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/466383) in GitLab 17.2. Reviewer assignment events in merge requests created or updated prior to GitLab 17.2 are not available for reporting.
{{< /history >}}
Events are the building blocks that define when stages start and end.
Each event has a start and end time:
- Start event time marks when work begins in a stage (for example, when an issue is created).
- End event time marks when work completes in a stage (for example, when an issue is closed).
GitLab calculates stage duration based on the start and end event times, using this formula:
Stage duration = End event time - Start event time
Value stream analytics supports the following events:
- Issue closed
- Issue created
- Issue first added to a board
- Issue first added to iteration
- Issue first assigned
- Issue first associated with a milestone
- Issue first mentioned in a commit
- Issue label added
- Issue label removed
- Merge request closed
- Merge request created
- Merge request first assigned
- Merge request first committed
- Merge request first deployed to production
- Merge request label added
- Merge request label removed
- Merge request last approved
- Merge request last build finished
- Merge request last build started
- Merge request merged
- Merge request reviewer first assigned
You can share your ideas or feedback about stage events in
[issue 520962](https://gitlab.com/gitlab-org/gitlab/-/issues/520962).
## Data aggregation
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Enable filtering by stop date [added](https://gitlab.com/gitlab-org/gitlab/-/issues/355000) in GitLab 15.0
{{< /history >}}
Value stream analytics uses a backend process to collect and aggregate stage-level data, which
ensures it can scale for large groups with a high number of issues and merge requests. Due to this process,
there may be a slight delay between when an action is taken (for example, closing an issue) and when the data
displays on the value stream analytics page.
It may take up to 10 minutes to process the data and display results. Data collection may take
longer than 10 minutes in the following cases:
- If this is the first time you are viewing value stream analytics and have not yet created a value stream.
- If the group hierarchy has been re-arranged.
- If there have been bulk updates on issues and merge requests.
To view when the data was most recently updated, in the right corner next to **Edit**, hover over the **Last updated** badge.
## Stage measurement
Value stream analytics measures each stage from its start event to its end event.
Only items that have reached their end event are included in the stage time calculation.
By default, blocked issues are not included in the lifecycle overview.
However, you can use custom labels (for example `workflow::blocked`) to track them.
You can customize stages in value stream analytics based on pre-defined events.
To help you with the configuration, GitLab provides a pre-defined list of stages that you can use as a template.
For example, you can define a stage that starts when you add a label to an issue,
and ends when you add another label.
The following table gives an overview of the pre-defined stages in value stream analytics.
| Stage | Measurement method |
| ------- | -------------------- |
| Issue | The median time between creating an issue and taking action to solve it, by either labeling it or adding it to a milestone, whichever comes first. The label is tracked only if it already has an [issue board list](../../project/issue_board.md) created for it. |
| Plan | The median time between the action you took for the previous stage, and pushing the first commit to the branch. The first commit on the branch triggers the separation between **Plan** and **Code**. At least one of the commits in the branch must contain the related issue number (for example, `#42`). If none of the commits in the branch mention the related issue number, it is not considered in the measurement time of the stage. |
| Code | The median time between pushing a first commit (previous stage) and creating a merge request (MR) related to that commit. The key to keep the process tracked is to include the [issue closing pattern](../../project/issues/managing_issues.md#default-closing-pattern) in the description of the merge request. For example, `Closes #xxx`, where `xxx` is the number of the issue related to this merge request. If the closing pattern is not present, then the calculation uses the creation time of the first commit in the merge request as the start time. |
| Test | The median time to run the entire pipeline for that project. It's related to the time GitLab CI/CD takes to run every job for the commits pushed to that merge request. It is basically the start->finish time for all pipelines. |
| Review | The median time taken to review a merge request that has a closing issue pattern, between its creation and until it's merged. |
| Staging | The median time between merging a merge request that has a closing issue pattern until the very first deployment to a [production environment](#production-environment). If there isn't a production environment, this is not tracked. |
{{< alert type="note" >}}
Value stream analytics works on timestamp data and aggregates only the final start and stop events of the stage. For items that move back and forth between stages multiple times, the stage time is calculated solely from the final events' timestamps.
{{< /alert >}}
### Example workflow
This example shows a workflow through all seven stages in one day.
If a stage does not include a start and a stop time, its data is not included in the median time.
In this example, milestones have been created and CI/CD for testing and setting environments is configured.
- 09:00: Create issue. **Issue** stage starts.
- 11:00: Add issue to a milestone (or backlog), start work on the issue, and create a branch locally.
**Issue** stage stops and **Plan** stage starts.
- 12:00: Make the first commit.
- 12:30: Make the second commit to the branch that mentions the issue number.
**Plan** stage stops and **Code** stage starts.
- 14:00: Push branch and create a merge request that contains the
[issue closing pattern](../../project/issues/managing_issues.md#closing-issues-automatically).
**Code** stage stops and **Test** and **Review** stages start.
- GitLab CI/CD takes 5 minutes to run scripts defined in the [`.gitlab-ci.yml` file](../../../ci/yaml/_index.md).
- 19:00: Merge the merge request. **Review** stage stops and **Staging** stage starts.
- 19:30: Deployment to the `production` environment finishes. **Staging** stops.
Value stream analytics records the following times for each stage:
- **Issue**: 09:00 to 11:00: 2 hrs
- **Plan**: 11:00 to 12:00: 1 hr
- **Code**: 12:00 to 14:00: 2 hrs
- **Test**: 5 minutes
- **Review**: 14:00 to 19:00: 5 hrs
- **Staging**: 19:00 to 19:30: 30 minutes
Keep in mind the following observations related to this example:
- This example demonstrates that it doesn't matter if your first
commit doesn't mention the issue number, you can do this later in any commit
on the branch you are working on.
- The **Test** stage is used in the calculation for the overall time of
the cycle. It is included in the **Review** process, as every MR should be
tested.
- This example illustrates only **one cycle** of the seven stages. The value stream analytics dashboard
shows the median time for multiple cycles.
### Cumulative label event duration
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/432576) in GitLab 16.9 [with flags](../../../administration/feature_flags/_index.md) named `enable_vsa_cumulative_label_duration_calculation` and `vsa_duration_from_db`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-com/gl-infra/production/-/issues/17476) in GitLab 16.10. Feature flag `vsa_duration_from_db` removed.
- Feature flag `enable_vsa_cumulative_label_duration_calculation` [removed](https://gitlab.com/gitlab-com/gl-infra/production/-/issues/17478) in GitLab 17.0.
{{< /history >}}
With this feature, value stream analytics measures the duration of repetitive events for label-based stages. You should configure label removal or addition events for both start and end events.
For example, a stage tracks when the `in progress` label is added and removed, with the following times:
- 9:00: label added.
- 10:00: label removed.
- 12:00: label added.
- 14:00 label removed.
With the original calculation method, the duration is five hours (from 9:00 to 14:00).
With cumulative label event duration calculation enabled, the duration is three hours (9:00 to 10:00 and 12:00 to 14:00).
{{< alert type="note" >}}
When you upgrade your GitLab version to 16.10 (or to a higher version), existing label-based value stream analytics stages are automatically reaggregated using the background aggregation process.
{{< /alert >}}
#### Reaggregate data after upgrade
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
On large instances, when you upgrade the GitLab version and especially if several minor versions are skipped, the background aggregation processes might last longer. This delay can result in outdated data on the Value Stream Analytics page.
To speed up the aggregation process and avoid outdated data, in the [rails console](../../../administration/operations/rails_console.md#starting-a-rails-console-session) you can invoke the synchronous aggregation snippet for a given group:
```ruby
group = Group.find(-1) # put your group id here
group_to_aggregate = group.root_ancestor
loop do
cursor = {}
context = Analytics::CycleAnalytics::AggregationContext.new(cursor: cursor)
service_response = Analytics::CycleAnalytics::DataLoaderService.new(group: group_to_aggregate, model: Issue, context: context).execute
if service_response.success? && service_response.payload[:reason] == :limit_reached
cursor = service_response.payload[:context].cursor
elsif service_response.success?
puts "finished"
break
else
puts "failed"
break
end
end
loop do
cursor = {}
context = Analytics::CycleAnalytics::AggregationContext.new(cursor: cursor)
service_response = Analytics::CycleAnalytics::DataLoaderService.new(group: group_to_aggregate, model: MergeRequest, context: context).execute
if service_response.success? && service_response.payload[:reason] == :limit_reached
cursor = service_response.payload[:context].cursor
elsif service_response.success?
puts "finished"
break
else
puts "failed"
break
end
end
```
## Production environment
Value stream analytics identifies [production environments](../../../ci/environments/_index.md#deployment-tier-of-environments) by looking for project
[environments](../../../ci/yaml/_index.md#environment) with a name matching any of these patterns:
- `prod` or `prod/*`
- `production` or `production/*`
These patterns are not case-sensitive.
You can change the name of a project environment in your GitLab CI/CD configuration.
## View value stream analytics
{{< history >}}
- Predefined date ranges dropdown list [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/408656/) in GitLab 16.5 [with a flag](../../../administration/feature_flags/_index.md) named `vsa_predefined_date_ranges`. Disabled by default.
- Predefined date ranges dropdown list [enabled on GitLab Self-Managed and GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/433149) in GitLab 16.7.
- Predefined date ranges dropdown list [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/438051) in GitLab 16.9. Feature flag `vsa_predefined_date_ranges` removed.
{{< /history >}}
Prerequisites:
- You must have at least the Reporter role.
- You must create a custom value stream. Value stream analytics only shows custom value streams created for your group or project.
To view value stream analytics for your group or project:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. To view metrics for a particular stage, select a stage below the **Filter results** text box.
1. Optional. Filter the results:
1. Select the **Filter results** text box.
1. Select a parameter.
1. Select a value or enter text to refine the results.
1. To view metrics in a particular date range, from the dropdown list select a predefined date range or the **Custom** option. With the **Custom** option selected:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
The charts and list display workflow items created during the date range.
1. Optional. Sort results by ascending or descending:
- To sort by most recent or oldest workflow item, select the **Last event** header.
- To sort by most or least amount of time spent in each stage, select the **Duration** header.
A badge next to the workflow items table header shows the number of workflow items that
completed during the selected stage.
The table shows a list of related workflow items for the selected stage. Based on the stage you select, this can be:
- Issues
- Merge requests
{{< alert type="note" >}}
The end date for each predefined date range is the current day, and is included in the number of days selected. For example, the start date for `Last 30 days` is 29 days prior to the current day for a total of 30 days.
{{< /alert >}}
### Data filters
You can filter value stream analytics to view data that matches specific criteria. The following filters are supported:
- Date range
- Project
- Assignee
- Author
- Milestone
- Label
## Value stream analytics metrics
The **Overview** page in value stream analytics displays key metrics of the DevSecOps lifecycle performance for projects and groups.
### Lifecycle metrics
Value stream analytics includes the following lifecycle metrics:
- **Lead time**: Median time from when the issue was created to when it was closed.
- **Cycle time**: Median time between when an issue is first [referenced in the commit message](../../project/issues/crosslinking_issues.md#from-commit-messages) of a merge request and when that referenced issue is closed. You must include `#` followed by the issue number (for example, `#123`) in the commit message, otherwise no data is displayed. Cycle time is typically shorter than lead time because the merge request is created after the first commit.
- **New issues**: Number of new issues created.
- **Deploys**: Total number of deployments to production.
### DORA metrics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/355304) time to restore service tile in GitLab 15.0.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357071) change failure rate tile in GitLab 15.0.
{{< /history >}}
Value stream analytics includes the following [DORA](../../analytics/dora_metrics.md) metrics:
- Deployment frequency
- Lead time for changes
- Time to restore service
- Change failure rate
DORA metrics are calculated based on data from the
[DORA API](../../../api/dora/metrics.md).
If you have a GitLab Premium or Ultimate subscription:
- The number of successful deployments is calculated with DORA data.
- The data is filtered based on environment and environment tier.
## View lifecycle and DORA metrics
Prerequisites:
- To view deployment metrics, you must have a
[production environment configured](#production-environment).
To view lifecycle metrics:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
Lifecycle metrics display below the **Filter results** text box.
1. Optional. Filter the results:
1. Select the **Filter results** text box.
Based on the filter you select, the dashboard automatically aggregates lifecycle metrics and displays the status of the value stream.
1. Select a parameter.
1. Select a value or enter text to refine the results.
1. To adjust the date range:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
To view the [Value Streams Dashboard](../../analytics/value_streams_dashboard.md) and [DORA metrics](../../analytics/dora_metrics.md):
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. Below the **Filter results** text box, in the **Lifecycle metrics** row, select **Value Streams Dashboard / DORA**.
1. Optional. To open the new page, append this path `/analytics/dashboards/value_streams_dashboard` to the group URL
(for example, `https://gitlab.com/groups/gitlab-org/-/analytics/dashboards/value_streams_dashboard`).
## View metrics for each development stage
Value stream analytics shows the median time spent by issues or merge requests in each development stage.
To view the median time spent in each stage by a group:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. Optional. Filter the results:
1. Select the **Filter results** text box.
1. Select a parameter.
1. Select a value or enter text to refine the results.
1. To adjust the date range:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
1. To view the metrics for each stage, above the **Filter results** text box, hover over a stage.
{{< alert type="note" >}}
The date range selector filters items by the event time. The event time is when the
selected stage finished for the given item.
{{< /alert >}}
## View tasks by type
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The **Tasks by type** chart displays the cumulative number of completed tasks (closed issues and merged merge requests) per day for your group.
The chart uses the global page filters to display data based on the selected group and time frame.
To view tasks by type:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Value stream analytics**.
1. Below the **Filter results** text box, select **Overview**. The **Tasks by type** chart displays below the **Total time** chart.
1. Optional. To filter the tasks by type, select **Settings** ({{< icon name="settings" >}}), then **Issues** or **Merge Requests**.
1. Optional. To filter the tasks by label, select **Settings** ({{< icon name="settings" >}}), then one or more labels. By default the top group labels (maximum 10) are selected. You can select a maximum of 15 labels.
## Create a value stream
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- **New value stream** [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/381002) from a dialog to a page in GitLab 16.10 [with a flag](../../../administration/feature_flags/_index.md) named `vsa_standalone_settings_page`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/171856) in GitLab 17.7. Feature flag `vsa_standalone_settings_page` removed.
{{< /history >}}
### With default stages
To create a value stream with default stages:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value Stream analytics**.
1. Select **New Value Stream**.
1. Enter a name for the value stream.
1. Select **Create from default template**.
1. Customize the default stages:
- To re-order stages, select the up or down arrows.
- To hide a stage, select **Hide** ({{< icon name="eye-slash" >}}).
1. To add a custom stage, select **Add a stage**.
- Enter a name for the stage.
- Select a **Start event** and a **Stop event**.
1. Select **New value stream**.
{{< alert type="note" >}}
If you have recently upgraded to GitLab Premium, it can take up to 30 minutes for data to collect and display.
{{< /alert >}}
### With custom stages
To create a value stream with custom stages:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value Stream analytics**.
1. Select **New value stream**.
1. For each stage:
- Enter a name for the stage.
- Select a **Start event** and a **Stop event**.
1. To add another stage, select **Add a stage**.
1. To re-order the stages, select the up or down arrows.
1. Select **New value stream**.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For a video explanation, see [Optimizing merge request review process with Value Stream Analytics](https://www.youtube.com/watch?v=kblpge6xeL8).
<!-- Video published on 2024-07-29 -->
## Label-based stages for custom value streams
To measure complex workflows, you can use [scoped labels](../../project/labels.md#scoped-labels). For example, to measure deployment
time from a staging environment to production, you could use the following labels:
- When the code is deployed to staging, the `workflow::staging` label is added to the merge request.
- When the code is deployed to production, the `workflow::production` label is added to the merge request.
### Automatic data labeling with webhooks
You can automatically add labels by using [GitLab webhook events](../../project/integrations/webhook_events.md),
so that a label is applied to merge requests or issues when a specific event occurs.
Then, you can add label-based stages to track your workflow.
To learn more about the implementation, see the blog post [Applying GitLab Labels Automatically](https://about.gitlab.com/blog/2016/08/19/applying-gitlab-labels-automatically/).
### Example configuration
In the previous example, two independent value streams are set up for two teams that are using different development workflows in the **Test Group** (top-level namespace).
The first value stream uses standard timestamp-based events for defining the stages. The second value stream uses label events.
## Edit a value stream
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- **Edit value stream** [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/381002) from a dialog to a page in GitLab 16.10 [with a flag](../../../administration/feature_flags/_index.md) named `vsa_standalone_settings_page`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/171856) in GitLab 17.7. Feature flag `vsa_standalone_settings_page` removed.
{{< /history >}}
After you create a value stream, you can customize it to suit your purposes. To edit a value stream:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. From the value stream dropdown list, select the value stream you want to edit.
1. Next to the value stream dropdown list, select **Edit**.
1. Optional:
- Rename the value stream.
- Hide or re-order default stages.
- Remove existing custom stages.
- To add new stages, select **Add a stage**.
- Select the start and end events for the stage.
1. Optional. To undo any modifications, select **Restore value stream defaults**.
1. Select **Save Value Stream**.
## Delete a value stream
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To delete a custom value stream:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. From the value stream dropdown list, select the value stream you want to delete, then **Delete (name of value stream)**.
1. To confirm, select **Delete**.
## View number of days for a cycle to complete
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The **Total time chart** shows the average number of days it takes for development cycles to complete.
The chart shows data for the last 500 workflow items.
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. Above the **Filter results** box, select a stage:
- To view a summary of the cycle time for all stages, select **Overview**.
- To view the cycle time for specific stage, select a stage.
1. Optional. Filter the results:
1. Select the **Filter results** text box.
1. Select a parameter.
1. Select a value or enter text to refine the results.
1. To adjust the date range:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
## Access permissions
Access permissions for value stream analytics depend on the project type.
| Project type | Permissions |
|--------------|---------------------------------------------------|
| Public | Anyone can access. |
| Internal | Any authenticated user can access. |
| Private | Any user with at least the Guest role can access. |
## Value Stream Analytics GraphQL API
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Loading stage metrics through GraphQL [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/410327) in GitLab 17.0.
{{< /history >}}
With the VSA GraphQL API, you can request metrics from your configured value streams and value stream stages. This can be useful if you want to export VSA data to an external system or for a report.
The following metrics are available:
- Number of completed items in the stage. The count is limited to a maximum of 10,000 items.
- Median duration for the completed items in the stage.
- Average duration for the completed items in the stage.
### Request the metrics
Prerequisites:
- You must have at least the Reporter role.
First, you must determine which value stream you want to use in the reporting.
To request the configured value streams for a group, run:
```graphql
group(fullPath: "your-group-path") {
valueStreams {
nodes {
id
name
}
}
}
```
Similarly, to request metrics for a project, run:
```graphl
project(fullPath: "your-project-path") {
valueStreams {
nodes {
id
name
}
}
}
```
To request metrics for stages of a value stream, run:
```graphql
group(fullPath: "your-group-path") {
valueStreams(id: "your-value-stream-id") {
nodes {
stages {
id
name
}
}
}
}
```
Depending how you want to consume the data, you can request metrics for one specific stage or all stages in your value stream.
{{< alert type="note" >}}
Requesting metrics for all stages might be too slow for some installations.
The recommended approach is to request metrics stage by stage.
{{< /alert >}}
Requesting metrics for the stage:
```graphql
group(fullPath: "your-group-path") {
valueStreams(id: "your-value-stream-id") {
nodes {
stages(id: "your-stage-id") {
id
name
metrics(timeframe: { start: "2024-03-01", end: "2024-03-31" }) {
average {
value
unit
}
median {
value
unit
}
count {
value
unit
}
}
}
}
}
}
```
{{< alert type="note" >}}
You should always request metrics with a given time frame.
The longest supported time frame is 180 days.
{{< /alert >}}
The `metrics` node supports additional filtering options:
- Assignee usernames
- Author username
- Label names
- Milestone title
Example request with filters:
```graphql
group(fullPath: "your-group-path") {
valueStreams(id: "your-value-stream-id") {
nodes {
stages(id: "your-stage-id") {
id
name
metrics(
labelNames: ["backend"],
milestoneTitle: "17.0",
timeframe: { start: "2024-03-01", end: "2024-03-31" }
) {
average {
value
unit
}
median {
value
unit
}
count {
value
unit
}
}
}
}
}
}
```
### Best practices
- To get an accurate view of the current status, request metrics as close to the end of the time frame as possible.
- For periodic reporting, you can create a script and use the [scheduled pipelines](../../../ci/pipelines/schedules.md) feature to export the data in a timely manner.
- When invoking the API, you get the current data from the database. Over time, the same metrics might change due to changes in the underlying data in the database. For example, moving or removing a project from the group might affect group-level metrics.
- Re-requesting the metrics for previous periods and comparing them to the previously collected metrics can show skews in the data, which can help in discovering and explaining changing trends.
## Forecast deployment frequency
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Experiment
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10228) in GitLab 16.2 as an [experiment](../../../policy/development_stages_support.md#experiment).
{{< /history >}}
Improve your planning and decision-making by predicting productivity metrics and
identifying anomalies across your software development lifecycle.
Prerequisites:
- You must belong to at least one group with the [experiment and beta features setting](../../gitlab_duo/turn_on_off.md#turn-on-beta-and-experimental-features) enabled.
- You must have permission to view the CI/CD analytics.
To view a forecast of deployment frequency in CI/CD Analytics:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > CI/CD analytics**.
1. Select the **Deployment frequency** tab.
1. Turn on the **Show forecast** toggle.
1. On the confirmation dialog, select **Accept testing terms**.
The forecast is displayed as a dotted line on the chart. Data is forecasted for
a duration that is half of the selected date range.
For example, if you select a 30-day range, a forecast for the following 15 days
is displayed.
Provide feedback on this experimental feature in [issue 416833](https://gitlab.com/gitlab-org/gitlab/-/issues/416833).
## Feature availability
Value stream analytics offers different features at the project and group level for FOSS and licensed versions.
- On GitLab Free, value stream analytics does not aggregate data. It queries the database directly where the date range filter is applied to the creation date of issues and merge request. You can view value stream analytics with pre-defined default stages.
- On GitLab Premium, value stream analytics aggregates data and applies the date range filter on the end event. You can also create, edit, and delete value streams.
| Feature | Group level (licensed) | Project level (licensed) | Project level (FOSS) |
|------------------------------------------------------|-----------------------------------------------------------------------------------------------|---------------------------------|----------------------|
| Create custom value streams | Yes | Yes | No, only one value stream (default) is present with the default stages |
| Create custom stages | Yes | Yes | No |
| Filtering (for example, by author, label, milestone) | Yes | Yes | Yes |
| Stage time chart | Yes | Yes | No |
| Total time chart | Yes | Yes | No |
| Task by type chart | Yes | No | No |
| DORA Metrics | Yes | Yes | No |
| Cycle time and lead time summary (Lifecycle metrics) | Yes | Yes | No |
| New issues, commits, and deploys (Lifecycle metrics) | Yes, excluding commits | Yes | Yes |
| Uses aggregated backend | Yes | Yes | No |
| Date filter behavior | Filters items [finished in the date range](https://gitlab.com/groups/gitlab-org/-/epics/6046) | Filters items by creation date. | Filters items by creation date. |
| Authorization | At least reporter | At least reporter | Can be public |
## Troubleshooting
### 100% CPU utilization by Sidekiq `cronjob:analytics_cycle_analytics`
It is possible that value stream analytics background jobs
strongly impact performance by monopolizing CPU resources.
To recover from this situation:
1. Disable the feature for all projects in [the Rails console](../../../administration/operations/rails_console.md),
and remove existing jobs:
```ruby
Project.find_each do |p|
p.analytics_access_level='disabled';
p.save!
end
Analytics::CycleAnalytics::GroupStage.delete_all
Analytics::CycleAnalytics::Aggregation.delete_all
```
1. Configure a [Sidekiq routing](../../../administration/sidekiq/processing_specific_job_classes.md)
with for example a single `feature_category=value_stream_management`
and multiple `feature_category!=value_stream_management` entries.
Find other relevant queue metadata in the
[Enterprise Edition list](../../../administration/sidekiq/processing_specific_job_classes.md#list-of-available-job-classes).
1. Enable value stream analytics for one project after another.
You might need to tweak the Sidekiq routing further according to your performance requirements.
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Value stream analytics
breadcrumbs:
- doc
- user
- group
- value_stream_analytics
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Value stream analytics calculates the duration of every stage of your software development process.
You can measure how much time it takes to go from an idea to production by tracking merge request or issue events.
Use value stream analytics to identify:
- The amount of time it takes to go from an idea to production.
- The velocity of a given project.
- Bottlenecks in the development process.
- Long-running issues or merge requests.
- Factors that cause your software development lifecycle to slow down.
Value stream analytics helps businesses:
- Visualize their end-to-end DevSecOps workstreams.
- Identify and solve inefficiencies.
- Optimize their workstreams to deliver more value, faster (for example, [reducing merge request review time](https://about.gitlab.com/blog/2025/02/20/how-we-reduced-mr-review-time-with-value-stream-management/)).
For a click-through demo, see [the Value Stream Management product tour](https://gitlab.navattic.com/vsm).
Value stream analytics has a hierarchical structure:
- A **value stream** contains a value stream stage list.
- Each value stream stage list contains one or more **stages**.
- Each stage is defined by two **events**: start and end.
## Value streams
A value stream is the entire work process that delivers value to customers.
Value streams are container objects for stages.
You can have multiple value streams per group, to focus on different aspects of the DevOps lifecycle.
## Value stream stages
A stage represents an event pair (start and end events) with additional metadata, such as the name of the stage.
You can use value stream analytics with the built-in default stages, which you can reorder and hide.
You can also create and add custom stages that align with your specific development workflows.
## Value stream stage events
{{< history >}}
- Merge request first reviewer assigned event [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/466383) in GitLab 17.2. Reviewer assignment events in merge requests created or updated prior to GitLab 17.2 are not available for reporting.
{{< /history >}}
Events are the building blocks that define when stages start and end.
Each event has a start and end time:
- Start event time marks when work begins in a stage (for example, when an issue is created).
- End event time marks when work completes in a stage (for example, when an issue is closed).
GitLab calculates stage duration based on the start and end event times, using this formula:
Stage duration = End event time - Start event time
Value stream analytics supports the following events:
- Issue closed
- Issue created
- Issue first added to a board
- Issue first added to iteration
- Issue first assigned
- Issue first associated with a milestone
- Issue first mentioned in a commit
- Issue label added
- Issue label removed
- Merge request closed
- Merge request created
- Merge request first assigned
- Merge request first committed
- Merge request first deployed to production
- Merge request label added
- Merge request label removed
- Merge request last approved
- Merge request last build finished
- Merge request last build started
- Merge request merged
- Merge request reviewer first assigned
You can share your ideas or feedback about stage events in
[issue 520962](https://gitlab.com/gitlab-org/gitlab/-/issues/520962).
## Data aggregation
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Enable filtering by stop date [added](https://gitlab.com/gitlab-org/gitlab/-/issues/355000) in GitLab 15.0
{{< /history >}}
Value stream analytics uses a backend process to collect and aggregate stage-level data, which
ensures it can scale for large groups with a high number of issues and merge requests. Due to this process,
there may be a slight delay between when an action is taken (for example, closing an issue) and when the data
displays on the value stream analytics page.
It may take up to 10 minutes to process the data and display results. Data collection may take
longer than 10 minutes in the following cases:
- If this is the first time you are viewing value stream analytics and have not yet created a value stream.
- If the group hierarchy has been re-arranged.
- If there have been bulk updates on issues and merge requests.
To view when the data was most recently updated, in the right corner next to **Edit**, hover over the **Last updated** badge.
## Stage measurement
Value stream analytics measures each stage from its start event to its end event.
Only items that have reached their end event are included in the stage time calculation.
By default, blocked issues are not included in the lifecycle overview.
However, you can use custom labels (for example `workflow::blocked`) to track them.
You can customize stages in value stream analytics based on pre-defined events.
To help you with the configuration, GitLab provides a pre-defined list of stages that you can use as a template.
For example, you can define a stage that starts when you add a label to an issue,
and ends when you add another label.
The following table gives an overview of the pre-defined stages in value stream analytics.
| Stage | Measurement method |
| ------- | -------------------- |
| Issue | The median time between creating an issue and taking action to solve it, by either labeling it or adding it to a milestone, whichever comes first. The label is tracked only if it already has an [issue board list](../../project/issue_board.md) created for it. |
| Plan | The median time between the action you took for the previous stage, and pushing the first commit to the branch. The first commit on the branch triggers the separation between **Plan** and **Code**. At least one of the commits in the branch must contain the related issue number (for example, `#42`). If none of the commits in the branch mention the related issue number, it is not considered in the measurement time of the stage. |
| Code | The median time between pushing a first commit (previous stage) and creating a merge request (MR) related to that commit. The key to keep the process tracked is to include the [issue closing pattern](../../project/issues/managing_issues.md#default-closing-pattern) in the description of the merge request. For example, `Closes #xxx`, where `xxx` is the number of the issue related to this merge request. If the closing pattern is not present, then the calculation uses the creation time of the first commit in the merge request as the start time. |
| Test | The median time to run the entire pipeline for that project. It's related to the time GitLab CI/CD takes to run every job for the commits pushed to that merge request. It is basically the start->finish time for all pipelines. |
| Review | The median time taken to review a merge request that has a closing issue pattern, between its creation and until it's merged. |
| Staging | The median time between merging a merge request that has a closing issue pattern until the very first deployment to a [production environment](#production-environment). If there isn't a production environment, this is not tracked. |
{{< alert type="note" >}}
Value stream analytics works on timestamp data and aggregates only the final start and stop events of the stage. For items that move back and forth between stages multiple times, the stage time is calculated solely from the final events' timestamps.
{{< /alert >}}
### Example workflow
This example shows a workflow through all seven stages in one day.
If a stage does not include a start and a stop time, its data is not included in the median time.
In this example, milestones have been created and CI/CD for testing and setting environments is configured.
- 09:00: Create issue. **Issue** stage starts.
- 11:00: Add issue to a milestone (or backlog), start work on the issue, and create a branch locally.
**Issue** stage stops and **Plan** stage starts.
- 12:00: Make the first commit.
- 12:30: Make the second commit to the branch that mentions the issue number.
**Plan** stage stops and **Code** stage starts.
- 14:00: Push branch and create a merge request that contains the
[issue closing pattern](../../project/issues/managing_issues.md#closing-issues-automatically).
**Code** stage stops and **Test** and **Review** stages start.
- GitLab CI/CD takes 5 minutes to run scripts defined in the [`.gitlab-ci.yml` file](../../../ci/yaml/_index.md).
- 19:00: Merge the merge request. **Review** stage stops and **Staging** stage starts.
- 19:30: Deployment to the `production` environment finishes. **Staging** stops.
Value stream analytics records the following times for each stage:
- **Issue**: 09:00 to 11:00: 2 hrs
- **Plan**: 11:00 to 12:00: 1 hr
- **Code**: 12:00 to 14:00: 2 hrs
- **Test**: 5 minutes
- **Review**: 14:00 to 19:00: 5 hrs
- **Staging**: 19:00 to 19:30: 30 minutes
Keep in mind the following observations related to this example:
- This example demonstrates that it doesn't matter if your first
commit doesn't mention the issue number, you can do this later in any commit
on the branch you are working on.
- The **Test** stage is used in the calculation for the overall time of
the cycle. It is included in the **Review** process, as every MR should be
tested.
- This example illustrates only **one cycle** of the seven stages. The value stream analytics dashboard
shows the median time for multiple cycles.
### Cumulative label event duration
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/432576) in GitLab 16.9 [with flags](../../../administration/feature_flags/_index.md) named `enable_vsa_cumulative_label_duration_calculation` and `vsa_duration_from_db`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-com/gl-infra/production/-/issues/17476) in GitLab 16.10. Feature flag `vsa_duration_from_db` removed.
- Feature flag `enable_vsa_cumulative_label_duration_calculation` [removed](https://gitlab.com/gitlab-com/gl-infra/production/-/issues/17478) in GitLab 17.0.
{{< /history >}}
With this feature, value stream analytics measures the duration of repetitive events for label-based stages. You should configure label removal or addition events for both start and end events.
For example, a stage tracks when the `in progress` label is added and removed, with the following times:
- 9:00: label added.
- 10:00: label removed.
- 12:00: label added.
- 14:00 label removed.
With the original calculation method, the duration is five hours (from 9:00 to 14:00).
With cumulative label event duration calculation enabled, the duration is three hours (9:00 to 10:00 and 12:00 to 14:00).
{{< alert type="note" >}}
When you upgrade your GitLab version to 16.10 (or to a higher version), existing label-based value stream analytics stages are automatically reaggregated using the background aggregation process.
{{< /alert >}}
#### Reaggregate data after upgrade
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
On large instances, when you upgrade the GitLab version and especially if several minor versions are skipped, the background aggregation processes might last longer. This delay can result in outdated data on the Value Stream Analytics page.
To speed up the aggregation process and avoid outdated data, in the [rails console](../../../administration/operations/rails_console.md#starting-a-rails-console-session) you can invoke the synchronous aggregation snippet for a given group:
```ruby
group = Group.find(-1) # put your group id here
group_to_aggregate = group.root_ancestor
loop do
cursor = {}
context = Analytics::CycleAnalytics::AggregationContext.new(cursor: cursor)
service_response = Analytics::CycleAnalytics::DataLoaderService.new(group: group_to_aggregate, model: Issue, context: context).execute
if service_response.success? && service_response.payload[:reason] == :limit_reached
cursor = service_response.payload[:context].cursor
elsif service_response.success?
puts "finished"
break
else
puts "failed"
break
end
end
loop do
cursor = {}
context = Analytics::CycleAnalytics::AggregationContext.new(cursor: cursor)
service_response = Analytics::CycleAnalytics::DataLoaderService.new(group: group_to_aggregate, model: MergeRequest, context: context).execute
if service_response.success? && service_response.payload[:reason] == :limit_reached
cursor = service_response.payload[:context].cursor
elsif service_response.success?
puts "finished"
break
else
puts "failed"
break
end
end
```
## Production environment
Value stream analytics identifies [production environments](../../../ci/environments/_index.md#deployment-tier-of-environments) by looking for project
[environments](../../../ci/yaml/_index.md#environment) with a name matching any of these patterns:
- `prod` or `prod/*`
- `production` or `production/*`
These patterns are not case-sensitive.
You can change the name of a project environment in your GitLab CI/CD configuration.
## View value stream analytics
{{< history >}}
- Predefined date ranges dropdown list [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/408656/) in GitLab 16.5 [with a flag](../../../administration/feature_flags/_index.md) named `vsa_predefined_date_ranges`. Disabled by default.
- Predefined date ranges dropdown list [enabled on GitLab Self-Managed and GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/433149) in GitLab 16.7.
- Predefined date ranges dropdown list [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/438051) in GitLab 16.9. Feature flag `vsa_predefined_date_ranges` removed.
{{< /history >}}
Prerequisites:
- You must have at least the Reporter role.
- You must create a custom value stream. Value stream analytics only shows custom value streams created for your group or project.
To view value stream analytics for your group or project:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. To view metrics for a particular stage, select a stage below the **Filter results** text box.
1. Optional. Filter the results:
1. Select the **Filter results** text box.
1. Select a parameter.
1. Select a value or enter text to refine the results.
1. To view metrics in a particular date range, from the dropdown list select a predefined date range or the **Custom** option. With the **Custom** option selected:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
The charts and list display workflow items created during the date range.
1. Optional. Sort results by ascending or descending:
- To sort by most recent or oldest workflow item, select the **Last event** header.
- To sort by most or least amount of time spent in each stage, select the **Duration** header.
A badge next to the workflow items table header shows the number of workflow items that
completed during the selected stage.
The table shows a list of related workflow items for the selected stage. Based on the stage you select, this can be:
- Issues
- Merge requests
{{< alert type="note" >}}
The end date for each predefined date range is the current day, and is included in the number of days selected. For example, the start date for `Last 30 days` is 29 days prior to the current day for a total of 30 days.
{{< /alert >}}
### Data filters
You can filter value stream analytics to view data that matches specific criteria. The following filters are supported:
- Date range
- Project
- Assignee
- Author
- Milestone
- Label
## Value stream analytics metrics
The **Overview** page in value stream analytics displays key metrics of the DevSecOps lifecycle performance for projects and groups.
### Lifecycle metrics
Value stream analytics includes the following lifecycle metrics:
- **Lead time**: Median time from when the issue was created to when it was closed.
- **Cycle time**: Median time between when an issue is first [referenced in the commit message](../../project/issues/crosslinking_issues.md#from-commit-messages) of a merge request and when that referenced issue is closed. You must include `#` followed by the issue number (for example, `#123`) in the commit message, otherwise no data is displayed. Cycle time is typically shorter than lead time because the merge request is created after the first commit.
- **New issues**: Number of new issues created.
- **Deploys**: Total number of deployments to production.
### DORA metrics
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/355304) time to restore service tile in GitLab 15.0.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357071) change failure rate tile in GitLab 15.0.
{{< /history >}}
Value stream analytics includes the following [DORA](../../analytics/dora_metrics.md) metrics:
- Deployment frequency
- Lead time for changes
- Time to restore service
- Change failure rate
DORA metrics are calculated based on data from the
[DORA API](../../../api/dora/metrics.md).
If you have a GitLab Premium or Ultimate subscription:
- The number of successful deployments is calculated with DORA data.
- The data is filtered based on environment and environment tier.
## View lifecycle and DORA metrics
Prerequisites:
- To view deployment metrics, you must have a
[production environment configured](#production-environment).
To view lifecycle metrics:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
Lifecycle metrics display below the **Filter results** text box.
1. Optional. Filter the results:
1. Select the **Filter results** text box.
Based on the filter you select, the dashboard automatically aggregates lifecycle metrics and displays the status of the value stream.
1. Select a parameter.
1. Select a value or enter text to refine the results.
1. To adjust the date range:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
To view the [Value Streams Dashboard](../../analytics/value_streams_dashboard.md) and [DORA metrics](../../analytics/dora_metrics.md):
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. Below the **Filter results** text box, in the **Lifecycle metrics** row, select **Value Streams Dashboard / DORA**.
1. Optional. To open the new page, append this path `/analytics/dashboards/value_streams_dashboard` to the group URL
(for example, `https://gitlab.com/groups/gitlab-org/-/analytics/dashboards/value_streams_dashboard`).
## View metrics for each development stage
Value stream analytics shows the median time spent by issues or merge requests in each development stage.
To view the median time spent in each stage by a group:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. Optional. Filter the results:
1. Select the **Filter results** text box.
1. Select a parameter.
1. Select a value or enter text to refine the results.
1. To adjust the date range:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
1. To view the metrics for each stage, above the **Filter results** text box, hover over a stage.
{{< alert type="note" >}}
The date range selector filters items by the event time. The event time is when the
selected stage finished for the given item.
{{< /alert >}}
## View tasks by type
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The **Tasks by type** chart displays the cumulative number of completed tasks (closed issues and merged merge requests) per day for your group.
The chart uses the global page filters to display data based on the selected group and time frame.
To view tasks by type:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Value stream analytics**.
1. Below the **Filter results** text box, select **Overview**. The **Tasks by type** chart displays below the **Total time** chart.
1. Optional. To filter the tasks by type, select **Settings** ({{< icon name="settings" >}}), then **Issues** or **Merge Requests**.
1. Optional. To filter the tasks by label, select **Settings** ({{< icon name="settings" >}}), then one or more labels. By default the top group labels (maximum 10) are selected. You can select a maximum of 15 labels.
## Create a value stream
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- **New value stream** [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/381002) from a dialog to a page in GitLab 16.10 [with a flag](../../../administration/feature_flags/_index.md) named `vsa_standalone_settings_page`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/171856) in GitLab 17.7. Feature flag `vsa_standalone_settings_page` removed.
{{< /history >}}
### With default stages
To create a value stream with default stages:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value Stream analytics**.
1. Select **New Value Stream**.
1. Enter a name for the value stream.
1. Select **Create from default template**.
1. Customize the default stages:
- To re-order stages, select the up or down arrows.
- To hide a stage, select **Hide** ({{< icon name="eye-slash" >}}).
1. To add a custom stage, select **Add a stage**.
- Enter a name for the stage.
- Select a **Start event** and a **Stop event**.
1. Select **New value stream**.
{{< alert type="note" >}}
If you have recently upgraded to GitLab Premium, it can take up to 30 minutes for data to collect and display.
{{< /alert >}}
### With custom stages
To create a value stream with custom stages:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value Stream analytics**.
1. Select **New value stream**.
1. For each stage:
- Enter a name for the stage.
- Select a **Start event** and a **Stop event**.
1. To add another stage, select **Add a stage**.
1. To re-order the stages, select the up or down arrows.
1. Select **New value stream**.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For a video explanation, see [Optimizing merge request review process with Value Stream Analytics](https://www.youtube.com/watch?v=kblpge6xeL8).
<!-- Video published on 2024-07-29 -->
## Label-based stages for custom value streams
To measure complex workflows, you can use [scoped labels](../../project/labels.md#scoped-labels). For example, to measure deployment
time from a staging environment to production, you could use the following labels:
- When the code is deployed to staging, the `workflow::staging` label is added to the merge request.
- When the code is deployed to production, the `workflow::production` label is added to the merge request.
### Automatic data labeling with webhooks
You can automatically add labels by using [GitLab webhook events](../../project/integrations/webhook_events.md),
so that a label is applied to merge requests or issues when a specific event occurs.
Then, you can add label-based stages to track your workflow.
To learn more about the implementation, see the blog post [Applying GitLab Labels Automatically](https://about.gitlab.com/blog/2016/08/19/applying-gitlab-labels-automatically/).
### Example configuration
In the previous example, two independent value streams are set up for two teams that are using different development workflows in the **Test Group** (top-level namespace).
The first value stream uses standard timestamp-based events for defining the stages. The second value stream uses label events.
## Edit a value stream
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- **Edit value stream** [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/381002) from a dialog to a page in GitLab 16.10 [with a flag](../../../administration/feature_flags/_index.md) named `vsa_standalone_settings_page`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/171856) in GitLab 17.7. Feature flag `vsa_standalone_settings_page` removed.
{{< /history >}}
After you create a value stream, you can customize it to suit your purposes. To edit a value stream:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. From the value stream dropdown list, select the value stream you want to edit.
1. Next to the value stream dropdown list, select **Edit**.
1. Optional:
- Rename the value stream.
- Hide or re-order default stages.
- Remove existing custom stages.
- To add new stages, select **Add a stage**.
- Select the start and end events for the stage.
1. Optional. To undo any modifications, select **Restore value stream defaults**.
1. Select **Save Value Stream**.
## Delete a value stream
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To delete a custom value stream:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. From the value stream dropdown list, select the value stream you want to delete, then **Delete (name of value stream)**.
1. To confirm, select **Delete**.
## View number of days for a cycle to complete
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The **Total time chart** shows the average number of days it takes for development cycles to complete.
The chart shows data for the last 500 workflow items.
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. Above the **Filter results** box, select a stage:
- To view a summary of the cycle time for all stages, select **Overview**.
- To view the cycle time for specific stage, select a stage.
1. Optional. Filter the results:
1. Select the **Filter results** text box.
1. Select a parameter.
1. Select a value or enter text to refine the results.
1. To adjust the date range:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
## Access permissions
Access permissions for value stream analytics depend on the project type.
| Project type | Permissions |
|--------------|---------------------------------------------------|
| Public | Anyone can access. |
| Internal | Any authenticated user can access. |
| Private | Any user with at least the Guest role can access. |
## Value Stream Analytics GraphQL API
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Loading stage metrics through GraphQL [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/410327) in GitLab 17.0.
{{< /history >}}
With the VSA GraphQL API, you can request metrics from your configured value streams and value stream stages. This can be useful if you want to export VSA data to an external system or for a report.
The following metrics are available:
- Number of completed items in the stage. The count is limited to a maximum of 10,000 items.
- Median duration for the completed items in the stage.
- Average duration for the completed items in the stage.
### Request the metrics
Prerequisites:
- You must have at least the Reporter role.
First, you must determine which value stream you want to use in the reporting.
To request the configured value streams for a group, run:
```graphql
group(fullPath: "your-group-path") {
valueStreams {
nodes {
id
name
}
}
}
```
Similarly, to request metrics for a project, run:
```graphl
project(fullPath: "your-project-path") {
valueStreams {
nodes {
id
name
}
}
}
```
To request metrics for stages of a value stream, run:
```graphql
group(fullPath: "your-group-path") {
valueStreams(id: "your-value-stream-id") {
nodes {
stages {
id
name
}
}
}
}
```
Depending how you want to consume the data, you can request metrics for one specific stage or all stages in your value stream.
{{< alert type="note" >}}
Requesting metrics for all stages might be too slow for some installations.
The recommended approach is to request metrics stage by stage.
{{< /alert >}}
Requesting metrics for the stage:
```graphql
group(fullPath: "your-group-path") {
valueStreams(id: "your-value-stream-id") {
nodes {
stages(id: "your-stage-id") {
id
name
metrics(timeframe: { start: "2024-03-01", end: "2024-03-31" }) {
average {
value
unit
}
median {
value
unit
}
count {
value
unit
}
}
}
}
}
}
```
{{< alert type="note" >}}
You should always request metrics with a given time frame.
The longest supported time frame is 180 days.
{{< /alert >}}
The `metrics` node supports additional filtering options:
- Assignee usernames
- Author username
- Label names
- Milestone title
Example request with filters:
```graphql
group(fullPath: "your-group-path") {
valueStreams(id: "your-value-stream-id") {
nodes {
stages(id: "your-stage-id") {
id
name
metrics(
labelNames: ["backend"],
milestoneTitle: "17.0",
timeframe: { start: "2024-03-01", end: "2024-03-31" }
) {
average {
value
unit
}
median {
value
unit
}
count {
value
unit
}
}
}
}
}
}
```
### Best practices
- To get an accurate view of the current status, request metrics as close to the end of the time frame as possible.
- For periodic reporting, you can create a script and use the [scheduled pipelines](../../../ci/pipelines/schedules.md) feature to export the data in a timely manner.
- When invoking the API, you get the current data from the database. Over time, the same metrics might change due to changes in the underlying data in the database. For example, moving or removing a project from the group might affect group-level metrics.
- Re-requesting the metrics for previous periods and comparing them to the previously collected metrics can show skews in the data, which can help in discovering and explaining changing trends.
## Forecast deployment frequency
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Experiment
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10228) in GitLab 16.2 as an [experiment](../../../policy/development_stages_support.md#experiment).
{{< /history >}}
Improve your planning and decision-making by predicting productivity metrics and
identifying anomalies across your software development lifecycle.
Prerequisites:
- You must belong to at least one group with the [experiment and beta features setting](../../gitlab_duo/turn_on_off.md#turn-on-beta-and-experimental-features) enabled.
- You must have permission to view the CI/CD analytics.
To view a forecast of deployment frequency in CI/CD Analytics:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > CI/CD analytics**.
1. Select the **Deployment frequency** tab.
1. Turn on the **Show forecast** toggle.
1. On the confirmation dialog, select **Accept testing terms**.
The forecast is displayed as a dotted line on the chart. Data is forecasted for
a duration that is half of the selected date range.
For example, if you select a 30-day range, a forecast for the following 15 days
is displayed.
Provide feedback on this experimental feature in [issue 416833](https://gitlab.com/gitlab-org/gitlab/-/issues/416833).
## Feature availability
Value stream analytics offers different features at the project and group level for FOSS and licensed versions.
- On GitLab Free, value stream analytics does not aggregate data. It queries the database directly where the date range filter is applied to the creation date of issues and merge request. You can view value stream analytics with pre-defined default stages.
- On GitLab Premium, value stream analytics aggregates data and applies the date range filter on the end event. You can also create, edit, and delete value streams.
| Feature | Group level (licensed) | Project level (licensed) | Project level (FOSS) |
|------------------------------------------------------|-----------------------------------------------------------------------------------------------|---------------------------------|----------------------|
| Create custom value streams | Yes | Yes | No, only one value stream (default) is present with the default stages |
| Create custom stages | Yes | Yes | No |
| Filtering (for example, by author, label, milestone) | Yes | Yes | Yes |
| Stage time chart | Yes | Yes | No |
| Total time chart | Yes | Yes | No |
| Task by type chart | Yes | No | No |
| DORA Metrics | Yes | Yes | No |
| Cycle time and lead time summary (Lifecycle metrics) | Yes | Yes | No |
| New issues, commits, and deploys (Lifecycle metrics) | Yes, excluding commits | Yes | Yes |
| Uses aggregated backend | Yes | Yes | No |
| Date filter behavior | Filters items [finished in the date range](https://gitlab.com/groups/gitlab-org/-/epics/6046) | Filters items by creation date. | Filters items by creation date. |
| Authorization | At least reporter | At least reporter | Can be public |
## Troubleshooting
### 100% CPU utilization by Sidekiq `cronjob:analytics_cycle_analytics`
It is possible that value stream analytics background jobs
strongly impact performance by monopolizing CPU resources.
To recover from this situation:
1. Disable the feature for all projects in [the Rails console](../../../administration/operations/rails_console.md),
and remove existing jobs:
```ruby
Project.find_each do |p|
p.analytics_access_level='disabled';
p.save!
end
Analytics::CycleAnalytics::GroupStage.delete_all
Analytics::CycleAnalytics::Aggregation.delete_all
```
1. Configure a [Sidekiq routing](../../../administration/sidekiq/processing_specific_job_classes.md)
with for example a single `feature_category=value_stream_management`
and multiple `feature_category!=value_stream_management` entries.
Find other relevant queue metadata in the
[Enterprise Edition list](../../../administration/sidekiq/processing_specific_job_classes.md#list-of-available-job-classes).
1. Enable value stream analytics for one project after another.
You might need to tweak the Sidekiq routing further according to your performance requirements.
|
https://docs.gitlab.com/user/group/group_sync
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/group_sync.md
|
2025-08-13
|
doc/user/group/saml_sso
|
[
"doc",
"user",
"group",
"saml_sso"
] |
group_sync.md
|
Fulfillment
|
Seat Management
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
SAML Group Sync
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363084) to GitLab Self-Managed in GitLab 15.1.
{{< /history >}}
Use SAML group sync to assign users with specific roles to existing GitLab groups,
based on the users' group assignment in the SAML identity provider (IdP).
With SAML group sync you can create a many-to-many mapping between SAML IdP groups and GitLab groups.
For example, if the user `@amelia` is assigned to the `security` group in the SAML IdP,
you can use SAML group sync to assign `@amelia` to the `security-gitlab` group with Maintainer role,
and to the `vulnerability` group with Reporter role.
SAML group sync does not create groups.
You have to first [create a group](../_index.md#create-a-group), then create the mapping.
On GitLab.com, SAML group sync is configured by default.
On GitLab Self-Managed, you must configure it manually.
## Role prioritization
Group sync determines the role and membership type of a user in the mapped group.
### Multiple SAML IdPs
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
When a user signs in, GitLab:
- Checks all the configured SAML group links.
- Adds that user to the corresponding GitLab groups based on the SAML groups the user belongs to across the different IdPs.
The group link mapping in GitLab is not tied to a specific IdP so you must configure all SAML IdPs to contain group attributes in the SAML response. This means that GitLab is able to match groups in the SAML response, regardless of the IdP that was used to sign in.
As an example, you have 2 IdPs: `SAML1` and `SAML2`.
In GitLab, on a specific group, you have configured two group links:
- `gtlb-owner => Owner role`.
- `gtlb-dev => Developer role`.
In `SAML1`, the user is a member of `gtlb-owner` but not `gtlb-dev`.
In `SAML2`, the user is a member of `gtlb-dev` but not `gtlb-owner`.
When a user signs in to a group with `SAML1`, the SAML response shows that the user is a member of `gtlb-owner`, so GitLab sets the user's role in that group to be `Owner`.
The user then signs out and signs back in to the group with `SAML2`. The SAML response shows that the user is a member of `gtlb-dev`, so GitLab sets the user's role in that group to be `Developer`.
Now let's change the previous example so that the user is not a member of either `gtlb-owner` or `gtlb-dev` in `SAML2`.
- When the user signs in to a group with `SAML1`, the user is given the `Owner` role in that group.
- When the user signs in with `SAML2`, the user is removed from the group because they are not a member of either configured group link.
### Multiple SAML groups
If a user is a member of multiple SAML groups that map to the same GitLab group, the user is assigned the highest role from any of those SAML groups.
For example, if a user has the Guest role in a group and the Maintainer role in another group, they are assigned the Maintainer role.
### Membership types
If a user's role in a SAML group is higher than their role in one of its subgroups, their [membership](../../project/members/_index.md#display-direct-members) in the mapped GitLab group is different based on their assigned role in the mapped group.
If through group sync the user was assigned:
- A higher role, they are a direct member of the group.
- A role that is the same as or lower, they are an inherited member of the group.
## Automatic member removal
After a group sync, users who are not members of a mapped SAML group are removed from the group.
On GitLab.com, users in the top-level group are assigned the
default membership role instead of being removed.
For example, in the following diagram:
- Alex Garcia signs into GitLab and is removed from GitLab Group C because they don't belong
to SAML Group C.
- Sidney Jones belongs to SAML Group C, but is not added to GitLab Group C because they have
not yet signed in.
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TB
accTitle: Automatic member removal
accDescr: How group membership of users is determined before sign in if group sync is set up.
subgraph SAML users
SAMLUserA[Sidney Jones]
SAMLUserB[Zhang Wei]
SAMLUserC[Alex Garcia]
SAMLUserD[Charlie Smith]
end
subgraph SAML groups
SAMLGroupA["Group A"] --> SAMLGroupB["Group B"]
SAMLGroupA --> SAMLGroupC["Group C"]
SAMLGroupA --> SAMLGroupD["Group D"]
end
SAMLGroupB --> |Member|SAMLUserA
SAMLGroupB --> |Member|SAMLUserB
SAMLGroupC --> |Member|SAMLUserA
SAMLGroupC --> |Member|SAMLUserB
SAMLGroupD --> |Member|SAMLUserD
SAMLGroupD --> |Member|SAMLUserC
```
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TB
accTitle: Automatic member removal
accDescr: User membership for Sidney when she has not signed into group C, and group B has not configured group links.
subgraph GitLab users
GitLabUserA[Sidney Jones]
GitLabUserB[Zhang Wei]
GitLabUserC[Alex Garcia]
GitLabUserD[Charlie Smith]
end
subgraph GitLab groups
GitLabGroupA["Group A<br> (SAML configured)"] --> GitLabGroupB["Group B<br> (SAML Group Link not configured)"]
GitLabGroupA --> GitLabGroupC["Group C<br> (SAML Group Link configured)"]
GitLabGroupA --> GitLabGroupD["Group D<br> (SAML Group Link configured)"]
end
GitLabGroupB --> |Member|GitLabUserA
GitLabGroupC --> |Member|GitLabUserB
GitLabGroupC --> |Member|GitLabUserC
GitLabGroupD --> |Member|GitLabUserC
GitLabGroupD --> |Member|GitLabUserD
```
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TB
accTitle: Automatic member removal
accDescr: How membership of Alex Garcia works once she has signed into a group that has group links enabled.
subgraph GitLab users
GitLabUserA[Sidney Jones]
GitLabUserB[Zhang Wei]
GitLabUserC[Alex Garcia]
GitLabUserD[Charlie Smith]
end
subgraph GitLab groups after Alex Garcia signs in
GitLabGroupA[Group A]
GitLabGroupA["Group A<br> (SAML configured)"] --> GitLabGroupB["Group B<br> (SAML Group Link not configured)"]
GitLabGroupA --> GitLabGroupC["Group C<br> (SAML Group Link configured)"]
GitLabGroupA --> GitLabGroupD["Group D<br> (SAML Group Link configured)"]
end
GitLabGroupB --> |Member|GitLabUserA
GitLabGroupC --> |Member|GitLabUserB
GitLabGroupD --> |Member|GitLabUserC
GitLabGroupD --> |Member|GitLabUserD
```
## Configure SAML Group Sync
Adding or changing a group sync configuration may remove users from the mapped GitLab group,
if the group names don't match the listed `groups` in the SAML response.
To avoid users being removed, before configuring group sync, ensure either:
- The SAML response includes the `groups` attribute and the `AttributeValue` value matches the **SAML Group Name** in GitLab.
- All groups are removed from GitLab to disable Group Sync.
If you use SAML Group Sync and have multiple GitLab nodes, for example in a distributed or highly available architecture,
you must include the SAML configuration block on all Sidekiq nodes in addition to Rails application nodes.
{{< tabs >}}
{{< tab title="GitLab.com" >}}
To configure SAML Group Sync:
1. See [SAML SSO for GitLab.com groups](_index.md).
1. Ensure your SAML identity provider sends an attribute statement named `Groups` or `groups`.
{{< /tab >}}
{{< tab title="GitLab Self-Managed" >}}
To configure SAML Group Sync:
1. Configure the [SAML OmniAuth Provider](../../../integration/saml.md).
1. Ensure your SAML identity provider sends an attribute statement with the same name as the value of the `groups_attribute` setting. This attribute is case-sensitive. See the following provider configuration example in `/etc/gitlab/gitlab.rb` for reference:
```ruby
gitlab_rails['omniauth_providers'] = [
{
name: "saml",
label: "Provider name", # optional label for login button, defaults to "Saml",
groups_attribute: 'Groups',
args: {
assertion_consumer_service_url: "https://gitlab.example.com/users/auth/saml/callback",
idp_cert_fingerprint: "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8",
idp_sso_target_url: "https://login.example.com/idp",
issuer: "https://gitlab.example.com",
name_identifier_format: "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
}
}
]
```
{{< /tab >}}
{{< /tabs >}}
The value for `Groups` or `groups` in the SAML response may be either the group name or an ID.
For example, Azure AD sends the Azure Group Object ID instead of the name. Use the ID value when configuring [SAML Group Links](#configure-saml-group-links).
```xml
<saml:AttributeStatement>
<saml:Attribute Name="Groups">
<saml:AttributeValue xsi:type="xs:string">Developers</saml:AttributeValue>
<saml:AttributeValue xsi:type="xs:string">Product Managers</saml:AttributeValue>
</saml:Attribute>
</saml:AttributeStatement>
```
Other attribute names such as `http://schemas.microsoft.com/ws/2008/06/identity/claims/groups`
are not accepted as a source of groups.
For more information on configuring the
required group attribute name in the SAML identity provider's settings, see
example configurations for [Azure AD](example_saml_config.md#group-sync) and [Okta](example_saml_config.md#group-sync-1).
## Configure SAML group links
SAML Group Sync only manages a group if that group has one or more SAML group links.
Prerequisites:
- Your GitLab Self-Managed instance must have configured SAML Group Sync.
When SAML is enabled, users with the Owner role see a new menu
item in group **Settings > SAML Group Links**.
- You can configure one or more **SAML Group Links** to map a SAML IdP group name to a GitLab role.
- Members of the SAML IdP group are added as members of the GitLab
group on their next SAML sign-in.
- Group membership is evaluated each time a user signs in using SAML.
- SAML Group Links can be configured for a top-level group or any subgroup.
- If a SAML group link is created then removed, and there are:
- Other SAML group links configured, users that were in the removed group
link are automatically removed from the group during sync.
- No other SAML group links configured, users remain in the group during sync.
Those users must be manually removed from the group.
To link the SAML groups:
1. In **SAML Group Name**, enter the value of the relevant `saml:AttributeValue`. The value entered here must exactly match the value sent in the SAML response. For some IdPs, this may be a group ID or object ID (Azure AD) instead of a friendly group name.
1. Choose a [default role](../../permissions.md) or [custom role](../../custom_roles/_index.md) in **Access Level**.
1. Select **Save**.
1. Repeat to add additional group links if required.
## Manage GitLab Duo seat assignment
{{< details >}}
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/480766) for GitLab.com in GitLab 17.8 [with a flag](../../../administration/feature_flags/_index.md) named `saml_groups_duo_pro_add_on_assignment`. Disabled by default.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/512141) for Self-Managed in GitLab 18.0.
{{< /history >}}
Prerequisites:
- An active [GitLab Duo add-on subscription](../../../subscriptions/subscription-add-ons.md)
SAML Group Sync can manage GitLab Duo seat assignment and removal based on IdP group membership. Seats are only assigned when there are seats remaining in the subscription.
{{< tabs >}}
{{< tab title="GitLab.com" >}}
To configure for GitLab.com:
1. When [configuring a SAML Group Link](#configure-saml-group-links), select the **Assign GitLab Duo seats to users in this group** checkbox.
1. Select **Save**.
1. Repeat to add additional group links for all SAML users that should be assigned a GitLab Duo Pro or GitLab Duo Enterprise seat.
GitLab Duo seats are unassigned for users whose identity provider group memberships do not match a group link with this setting enabled.
The checkbox does not appear for groups without an active GitLab Duo add-on subscription.
{{< /tab >}}
{{< tab title="GitLab Self-Managed" >}}
To configure Self-Managed:
1. Configure the [SAML OmniAuth Provider](../../../integration/saml.md).
1. Ensure your configuration includes `groups_attribute` and `duo_add_on_groups`. Any users who are a member of one or more of the `duo_add_on_groups` will have a GitLab Duo seat assigned, if a seat is available. See the following provider configuration example in `/etc/gitlab/gitlab.rb` for reference:
```ruby
gitlab_rails['omniauth_providers'] = [
{
name: "saml",
label: "Provider name",
groups_attribute: 'Groups',
duo_add_on_groups: ['Developers', 'Freelancers'],
args: {
assertion_consumer_service_url: "https://gitlab.example.com/users/auth/saml/callback",
idp_cert_fingerprint: "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8",
idp_sso_target_url: "https://login.example.com/idp",
issuer: "https://gitlab.example.com",
name_identifier_format: "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
}
}
]
```
{{< /tab >}}
{{< /tabs >}}
## Microsoft Azure Active Directory integration
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10507) in GitLab 16.3.
{{< /history >}}
{{< alert type="note" >}}
Microsoft has [announced](https://azure.microsoft.com/en-us/updates/azure-ad-is-becoming-microsoft-entra-id/) that Azure Active Directory (AD) is being renamed to Entra ID.
{{< /alert >}}
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For a demo of group sync using Microsoft Azure, see [Demo: SAML Group Sync](https://youtu.be/Iqvo2tJfXjg).
Azure AD sends up to 150 groups in the `groups` claim.
When using Azure AD with SAML Group Sync, if a user in your organization is a member of more than 150 groups,
Azure AD sends a `groups` claim attribute in the SAML response for [group overages](https://learn.microsoft.com/en-us/security/zero-trust/develop/configure-tokens-group-claims-app-roles#group-overages),
and the user may be automatically removed from groups.
To avoid this issue, you can use the Azure AD integration, which:
- Is not limited to 150 groups.
- Uses the Microsoft Graph API to obtain all user memberships.
The [Graph API endpoint](https://learn.microsoft.com/en-us/graph/api/user-list-transitivememberof?view=graph-rest-1.0&tabs=http#http-request) accepts only a
[user object ID](https://learn.microsoft.com/en-us/partner-center/find-ids-and-domain-names#find-the-user-object-id) or
[userPrincipalName](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/plan-connect-userprincipalname#what-is-userprincipalname)
as the [Azure-configured](_index.md#azure) Unique User Identifier (Name identifier) attribute.
- Supports only Group Links configured with group unique identifiers (like `12345678-9abc-def0-1234-56789abcde`)
when it processes Group Sync.
Alternatively, you can change the [group claims](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/how-to-connect-fed-group-claims) to use the **Groups assigned to the application** option.
### Configure Azure AD
As part of the integration, you must allow GitLab to communicate with the Microsoft Graph API.
<!-- vale gitlab_base.SentenceSpacing = NO -->
To configure Azure AD:
1. In the [Azure Portal](https://portal.azure.com), go to **Microsoft Entra ID > App registrations > All applications**, and select your GitLab SAML application.
1. Under **Essentials**, the **Application (client) ID** and **Directory (tenant) ID** values are displayed. Copy these values, because you need them for the GitLab configuration.
1. In the left navigation, select **Certificates & secrets**.
1. On the **Client secrets** tab, select **New client secret**.
1. In the **Description** text box, add a description.
1. In the **Expires** dropdown list, set the expiration date for the credentials. If the secret expires, the GitLab integration will no longer work until the credentials are updated.
1. To generate the credentials, select **Add**.
1. Copy the **Value** of the credential. This value is displayed only once, and you need it for the GitLab configuration.
1. In the left navigation, select **API permissions**.
1. Select **Microsoft Graph > Application permissions**.
1. Select the checkboxes **GroupMember.Read.All** and **User.Read.All**.
1. Select **Add permissions** to save.
1. Select **Grant admin consent for `<application_name>`**, then on the confirmation dialog select **Yes**. The **Status** column for both permissions should change to a green check with **Granted for `<application_name>`**.
<!-- vale gitlab_base.SentenceSpacing = YES -->
### Configure GitLab
After you configure Azure AD, you must configure GitLab to communicate with Azure AD.
With this configuration, if a user signs in with SAML and Azure sends a `group` claim in the response,
GitLab initiates a Group Sync job to call the Microsoft Graph API and retrieve the user's group membership.
Then the GitLab group membership is updated according to SAML Group Links.
The following table lists the GitLab settings and the corresponding Azure AD fields for the configuration:
| GitLab setting | Azure field |
| -------------- | ------------------------------------------ |
| Tenant ID | Directory (tenant) ID |
| Client ID | Application (client) ID |
| Client Secret | Value (on **Certificates & secrets** page) |
{{< tabs >}}
{{< tab title="GitLab.com" >}}
To configure Azure AD for a GitLab.com group:
1. On the left sidebar, select **Search or go to** and find your group.
This group must be at the top level.
1. Select **Settings > SAML SSO**.
1. Configure [SAML SSO for the group](_index.md).
1. In the **Microsoft Azure integration** section, select the **Enable Microsoft Azure integration for this group** checkbox.
This section is only visible if SAML SSO is configured and enabled for the group.
1. Enter the **Tenant ID**, **Client ID**, and **Client secret** obtained earlier when configuring Azure Active Directory in the Azure Portal.
1. Optional. If using Azure AD for US Government or Azure AD China, enter the appropriate **Login API endpoint** and **Graph API endpoint**. The default values work for most organizations.
1. Select **Save changes**.
{{< /tab >}}
{{< tab title="GitLab Self-Managed" >}}
To configure for GitLab Self-Managed:
1. Configure [SAML SSO for the instance](../../../integration/saml.md).
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > General**.
1. In the **Microsoft Azure integration** section, select the **Enable Microsoft Azure integration for this group** checkbox.
1. Enter the **Tenant ID**, **Client ID**, and **Client secret** obtained earlier when configuring Azure Active Directory in the Azure Portal.
1. Optional. If using Azure AD for US Government or Azure AD China, enter the appropriate **Login API endpoint** and **Graph API endpoint**. The default values work for most organizations.
1. Select **Save changes**.
{{< /tab >}}
{{< /tabs >}}
## Global SAML group memberships lock
{{< details >}}
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386390) in GitLab 15.10.
{{< /history >}}
You can enforce a global lock on SAML group memberships. This lock limits who can invite new members to subgroups where membership is synchronized with SAML Group Links.
When you lock group memberships:
- You cannot set a group or subgroup as a [Code Owner](../../project/codeowners/_index.md).
For more information, see [Incompatibility with Global SAML group memberships lock](../../project/codeowners/troubleshooting.md#incompatibility-with-global-saml-group-memberships-lock).
- Only administrators can manage group members and change their access levels.
- Group members cannot:
- Share a project with other groups.
- Invite members to a project created in a group.
- Modify the membership of a top-level group configured for SAML Group Links synchronization.
### Lock group memberships
Prerequisites:
- [SAML SSO for GitLab Self-Managed](../../../integration/saml.md) must be configured.
To lock memberships to SAML Group Links synchronization:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > General**.
1. Expand the **Visibility and access controls** section.
1. Select the **Lock memberships to SAML Group Links synchronization** checkbox.
|
---
stage: Fulfillment
group: Seat Management
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: SAML Group Sync
breadcrumbs:
- doc
- user
- group
- saml_sso
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363084) to GitLab Self-Managed in GitLab 15.1.
{{< /history >}}
Use SAML group sync to assign users with specific roles to existing GitLab groups,
based on the users' group assignment in the SAML identity provider (IdP).
With SAML group sync you can create a many-to-many mapping between SAML IdP groups and GitLab groups.
For example, if the user `@amelia` is assigned to the `security` group in the SAML IdP,
you can use SAML group sync to assign `@amelia` to the `security-gitlab` group with Maintainer role,
and to the `vulnerability` group with Reporter role.
SAML group sync does not create groups.
You have to first [create a group](../_index.md#create-a-group), then create the mapping.
On GitLab.com, SAML group sync is configured by default.
On GitLab Self-Managed, you must configure it manually.
## Role prioritization
Group sync determines the role and membership type of a user in the mapped group.
### Multiple SAML IdPs
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
When a user signs in, GitLab:
- Checks all the configured SAML group links.
- Adds that user to the corresponding GitLab groups based on the SAML groups the user belongs to across the different IdPs.
The group link mapping in GitLab is not tied to a specific IdP so you must configure all SAML IdPs to contain group attributes in the SAML response. This means that GitLab is able to match groups in the SAML response, regardless of the IdP that was used to sign in.
As an example, you have 2 IdPs: `SAML1` and `SAML2`.
In GitLab, on a specific group, you have configured two group links:
- `gtlb-owner => Owner role`.
- `gtlb-dev => Developer role`.
In `SAML1`, the user is a member of `gtlb-owner` but not `gtlb-dev`.
In `SAML2`, the user is a member of `gtlb-dev` but not `gtlb-owner`.
When a user signs in to a group with `SAML1`, the SAML response shows that the user is a member of `gtlb-owner`, so GitLab sets the user's role in that group to be `Owner`.
The user then signs out and signs back in to the group with `SAML2`. The SAML response shows that the user is a member of `gtlb-dev`, so GitLab sets the user's role in that group to be `Developer`.
Now let's change the previous example so that the user is not a member of either `gtlb-owner` or `gtlb-dev` in `SAML2`.
- When the user signs in to a group with `SAML1`, the user is given the `Owner` role in that group.
- When the user signs in with `SAML2`, the user is removed from the group because they are not a member of either configured group link.
### Multiple SAML groups
If a user is a member of multiple SAML groups that map to the same GitLab group, the user is assigned the highest role from any of those SAML groups.
For example, if a user has the Guest role in a group and the Maintainer role in another group, they are assigned the Maintainer role.
### Membership types
If a user's role in a SAML group is higher than their role in one of its subgroups, their [membership](../../project/members/_index.md#display-direct-members) in the mapped GitLab group is different based on their assigned role in the mapped group.
If through group sync the user was assigned:
- A higher role, they are a direct member of the group.
- A role that is the same as or lower, they are an inherited member of the group.
## Automatic member removal
After a group sync, users who are not members of a mapped SAML group are removed from the group.
On GitLab.com, users in the top-level group are assigned the
default membership role instead of being removed.
For example, in the following diagram:
- Alex Garcia signs into GitLab and is removed from GitLab Group C because they don't belong
to SAML Group C.
- Sidney Jones belongs to SAML Group C, but is not added to GitLab Group C because they have
not yet signed in.
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TB
accTitle: Automatic member removal
accDescr: How group membership of users is determined before sign in if group sync is set up.
subgraph SAML users
SAMLUserA[Sidney Jones]
SAMLUserB[Zhang Wei]
SAMLUserC[Alex Garcia]
SAMLUserD[Charlie Smith]
end
subgraph SAML groups
SAMLGroupA["Group A"] --> SAMLGroupB["Group B"]
SAMLGroupA --> SAMLGroupC["Group C"]
SAMLGroupA --> SAMLGroupD["Group D"]
end
SAMLGroupB --> |Member|SAMLUserA
SAMLGroupB --> |Member|SAMLUserB
SAMLGroupC --> |Member|SAMLUserA
SAMLGroupC --> |Member|SAMLUserB
SAMLGroupD --> |Member|SAMLUserD
SAMLGroupD --> |Member|SAMLUserC
```
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TB
accTitle: Automatic member removal
accDescr: User membership for Sidney when she has not signed into group C, and group B has not configured group links.
subgraph GitLab users
GitLabUserA[Sidney Jones]
GitLabUserB[Zhang Wei]
GitLabUserC[Alex Garcia]
GitLabUserD[Charlie Smith]
end
subgraph GitLab groups
GitLabGroupA["Group A<br> (SAML configured)"] --> GitLabGroupB["Group B<br> (SAML Group Link not configured)"]
GitLabGroupA --> GitLabGroupC["Group C<br> (SAML Group Link configured)"]
GitLabGroupA --> GitLabGroupD["Group D<br> (SAML Group Link configured)"]
end
GitLabGroupB --> |Member|GitLabUserA
GitLabGroupC --> |Member|GitLabUserB
GitLabGroupC --> |Member|GitLabUserC
GitLabGroupD --> |Member|GitLabUserC
GitLabGroupD --> |Member|GitLabUserD
```
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TB
accTitle: Automatic member removal
accDescr: How membership of Alex Garcia works once she has signed into a group that has group links enabled.
subgraph GitLab users
GitLabUserA[Sidney Jones]
GitLabUserB[Zhang Wei]
GitLabUserC[Alex Garcia]
GitLabUserD[Charlie Smith]
end
subgraph GitLab groups after Alex Garcia signs in
GitLabGroupA[Group A]
GitLabGroupA["Group A<br> (SAML configured)"] --> GitLabGroupB["Group B<br> (SAML Group Link not configured)"]
GitLabGroupA --> GitLabGroupC["Group C<br> (SAML Group Link configured)"]
GitLabGroupA --> GitLabGroupD["Group D<br> (SAML Group Link configured)"]
end
GitLabGroupB --> |Member|GitLabUserA
GitLabGroupC --> |Member|GitLabUserB
GitLabGroupD --> |Member|GitLabUserC
GitLabGroupD --> |Member|GitLabUserD
```
## Configure SAML Group Sync
Adding or changing a group sync configuration may remove users from the mapped GitLab group,
if the group names don't match the listed `groups` in the SAML response.
To avoid users being removed, before configuring group sync, ensure either:
- The SAML response includes the `groups` attribute and the `AttributeValue` value matches the **SAML Group Name** in GitLab.
- All groups are removed from GitLab to disable Group Sync.
If you use SAML Group Sync and have multiple GitLab nodes, for example in a distributed or highly available architecture,
you must include the SAML configuration block on all Sidekiq nodes in addition to Rails application nodes.
{{< tabs >}}
{{< tab title="GitLab.com" >}}
To configure SAML Group Sync:
1. See [SAML SSO for GitLab.com groups](_index.md).
1. Ensure your SAML identity provider sends an attribute statement named `Groups` or `groups`.
{{< /tab >}}
{{< tab title="GitLab Self-Managed" >}}
To configure SAML Group Sync:
1. Configure the [SAML OmniAuth Provider](../../../integration/saml.md).
1. Ensure your SAML identity provider sends an attribute statement with the same name as the value of the `groups_attribute` setting. This attribute is case-sensitive. See the following provider configuration example in `/etc/gitlab/gitlab.rb` for reference:
```ruby
gitlab_rails['omniauth_providers'] = [
{
name: "saml",
label: "Provider name", # optional label for login button, defaults to "Saml",
groups_attribute: 'Groups',
args: {
assertion_consumer_service_url: "https://gitlab.example.com/users/auth/saml/callback",
idp_cert_fingerprint: "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8",
idp_sso_target_url: "https://login.example.com/idp",
issuer: "https://gitlab.example.com",
name_identifier_format: "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
}
}
]
```
{{< /tab >}}
{{< /tabs >}}
The value for `Groups` or `groups` in the SAML response may be either the group name or an ID.
For example, Azure AD sends the Azure Group Object ID instead of the name. Use the ID value when configuring [SAML Group Links](#configure-saml-group-links).
```xml
<saml:AttributeStatement>
<saml:Attribute Name="Groups">
<saml:AttributeValue xsi:type="xs:string">Developers</saml:AttributeValue>
<saml:AttributeValue xsi:type="xs:string">Product Managers</saml:AttributeValue>
</saml:Attribute>
</saml:AttributeStatement>
```
Other attribute names such as `http://schemas.microsoft.com/ws/2008/06/identity/claims/groups`
are not accepted as a source of groups.
For more information on configuring the
required group attribute name in the SAML identity provider's settings, see
example configurations for [Azure AD](example_saml_config.md#group-sync) and [Okta](example_saml_config.md#group-sync-1).
## Configure SAML group links
SAML Group Sync only manages a group if that group has one or more SAML group links.
Prerequisites:
- Your GitLab Self-Managed instance must have configured SAML Group Sync.
When SAML is enabled, users with the Owner role see a new menu
item in group **Settings > SAML Group Links**.
- You can configure one or more **SAML Group Links** to map a SAML IdP group name to a GitLab role.
- Members of the SAML IdP group are added as members of the GitLab
group on their next SAML sign-in.
- Group membership is evaluated each time a user signs in using SAML.
- SAML Group Links can be configured for a top-level group or any subgroup.
- If a SAML group link is created then removed, and there are:
- Other SAML group links configured, users that were in the removed group
link are automatically removed from the group during sync.
- No other SAML group links configured, users remain in the group during sync.
Those users must be manually removed from the group.
To link the SAML groups:
1. In **SAML Group Name**, enter the value of the relevant `saml:AttributeValue`. The value entered here must exactly match the value sent in the SAML response. For some IdPs, this may be a group ID or object ID (Azure AD) instead of a friendly group name.
1. Choose a [default role](../../permissions.md) or [custom role](../../custom_roles/_index.md) in **Access Level**.
1. Select **Save**.
1. Repeat to add additional group links if required.
## Manage GitLab Duo seat assignment
{{< details >}}
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/480766) for GitLab.com in GitLab 17.8 [with a flag](../../../administration/feature_flags/_index.md) named `saml_groups_duo_pro_add_on_assignment`. Disabled by default.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/512141) for Self-Managed in GitLab 18.0.
{{< /history >}}
Prerequisites:
- An active [GitLab Duo add-on subscription](../../../subscriptions/subscription-add-ons.md)
SAML Group Sync can manage GitLab Duo seat assignment and removal based on IdP group membership. Seats are only assigned when there are seats remaining in the subscription.
{{< tabs >}}
{{< tab title="GitLab.com" >}}
To configure for GitLab.com:
1. When [configuring a SAML Group Link](#configure-saml-group-links), select the **Assign GitLab Duo seats to users in this group** checkbox.
1. Select **Save**.
1. Repeat to add additional group links for all SAML users that should be assigned a GitLab Duo Pro or GitLab Duo Enterprise seat.
GitLab Duo seats are unassigned for users whose identity provider group memberships do not match a group link with this setting enabled.
The checkbox does not appear for groups without an active GitLab Duo add-on subscription.
{{< /tab >}}
{{< tab title="GitLab Self-Managed" >}}
To configure Self-Managed:
1. Configure the [SAML OmniAuth Provider](../../../integration/saml.md).
1. Ensure your configuration includes `groups_attribute` and `duo_add_on_groups`. Any users who are a member of one or more of the `duo_add_on_groups` will have a GitLab Duo seat assigned, if a seat is available. See the following provider configuration example in `/etc/gitlab/gitlab.rb` for reference:
```ruby
gitlab_rails['omniauth_providers'] = [
{
name: "saml",
label: "Provider name",
groups_attribute: 'Groups',
duo_add_on_groups: ['Developers', 'Freelancers'],
args: {
assertion_consumer_service_url: "https://gitlab.example.com/users/auth/saml/callback",
idp_cert_fingerprint: "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8",
idp_sso_target_url: "https://login.example.com/idp",
issuer: "https://gitlab.example.com",
name_identifier_format: "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
}
}
]
```
{{< /tab >}}
{{< /tabs >}}
## Microsoft Azure Active Directory integration
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10507) in GitLab 16.3.
{{< /history >}}
{{< alert type="note" >}}
Microsoft has [announced](https://azure.microsoft.com/en-us/updates/azure-ad-is-becoming-microsoft-entra-id/) that Azure Active Directory (AD) is being renamed to Entra ID.
{{< /alert >}}
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For a demo of group sync using Microsoft Azure, see [Demo: SAML Group Sync](https://youtu.be/Iqvo2tJfXjg).
Azure AD sends up to 150 groups in the `groups` claim.
When using Azure AD with SAML Group Sync, if a user in your organization is a member of more than 150 groups,
Azure AD sends a `groups` claim attribute in the SAML response for [group overages](https://learn.microsoft.com/en-us/security/zero-trust/develop/configure-tokens-group-claims-app-roles#group-overages),
and the user may be automatically removed from groups.
To avoid this issue, you can use the Azure AD integration, which:
- Is not limited to 150 groups.
- Uses the Microsoft Graph API to obtain all user memberships.
The [Graph API endpoint](https://learn.microsoft.com/en-us/graph/api/user-list-transitivememberof?view=graph-rest-1.0&tabs=http#http-request) accepts only a
[user object ID](https://learn.microsoft.com/en-us/partner-center/find-ids-and-domain-names#find-the-user-object-id) or
[userPrincipalName](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/plan-connect-userprincipalname#what-is-userprincipalname)
as the [Azure-configured](_index.md#azure) Unique User Identifier (Name identifier) attribute.
- Supports only Group Links configured with group unique identifiers (like `12345678-9abc-def0-1234-56789abcde`)
when it processes Group Sync.
Alternatively, you can change the [group claims](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/how-to-connect-fed-group-claims) to use the **Groups assigned to the application** option.
### Configure Azure AD
As part of the integration, you must allow GitLab to communicate with the Microsoft Graph API.
<!-- vale gitlab_base.SentenceSpacing = NO -->
To configure Azure AD:
1. In the [Azure Portal](https://portal.azure.com), go to **Microsoft Entra ID > App registrations > All applications**, and select your GitLab SAML application.
1. Under **Essentials**, the **Application (client) ID** and **Directory (tenant) ID** values are displayed. Copy these values, because you need them for the GitLab configuration.
1. In the left navigation, select **Certificates & secrets**.
1. On the **Client secrets** tab, select **New client secret**.
1. In the **Description** text box, add a description.
1. In the **Expires** dropdown list, set the expiration date for the credentials. If the secret expires, the GitLab integration will no longer work until the credentials are updated.
1. To generate the credentials, select **Add**.
1. Copy the **Value** of the credential. This value is displayed only once, and you need it for the GitLab configuration.
1. In the left navigation, select **API permissions**.
1. Select **Microsoft Graph > Application permissions**.
1. Select the checkboxes **GroupMember.Read.All** and **User.Read.All**.
1. Select **Add permissions** to save.
1. Select **Grant admin consent for `<application_name>`**, then on the confirmation dialog select **Yes**. The **Status** column for both permissions should change to a green check with **Granted for `<application_name>`**.
<!-- vale gitlab_base.SentenceSpacing = YES -->
### Configure GitLab
After you configure Azure AD, you must configure GitLab to communicate with Azure AD.
With this configuration, if a user signs in with SAML and Azure sends a `group` claim in the response,
GitLab initiates a Group Sync job to call the Microsoft Graph API and retrieve the user's group membership.
Then the GitLab group membership is updated according to SAML Group Links.
The following table lists the GitLab settings and the corresponding Azure AD fields for the configuration:
| GitLab setting | Azure field |
| -------------- | ------------------------------------------ |
| Tenant ID | Directory (tenant) ID |
| Client ID | Application (client) ID |
| Client Secret | Value (on **Certificates & secrets** page) |
{{< tabs >}}
{{< tab title="GitLab.com" >}}
To configure Azure AD for a GitLab.com group:
1. On the left sidebar, select **Search or go to** and find your group.
This group must be at the top level.
1. Select **Settings > SAML SSO**.
1. Configure [SAML SSO for the group](_index.md).
1. In the **Microsoft Azure integration** section, select the **Enable Microsoft Azure integration for this group** checkbox.
This section is only visible if SAML SSO is configured and enabled for the group.
1. Enter the **Tenant ID**, **Client ID**, and **Client secret** obtained earlier when configuring Azure Active Directory in the Azure Portal.
1. Optional. If using Azure AD for US Government or Azure AD China, enter the appropriate **Login API endpoint** and **Graph API endpoint**. The default values work for most organizations.
1. Select **Save changes**.
{{< /tab >}}
{{< tab title="GitLab Self-Managed" >}}
To configure for GitLab Self-Managed:
1. Configure [SAML SSO for the instance](../../../integration/saml.md).
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > General**.
1. In the **Microsoft Azure integration** section, select the **Enable Microsoft Azure integration for this group** checkbox.
1. Enter the **Tenant ID**, **Client ID**, and **Client secret** obtained earlier when configuring Azure Active Directory in the Azure Portal.
1. Optional. If using Azure AD for US Government or Azure AD China, enter the appropriate **Login API endpoint** and **Graph API endpoint**. The default values work for most organizations.
1. Select **Save changes**.
{{< /tab >}}
{{< /tabs >}}
## Global SAML group memberships lock
{{< details >}}
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386390) in GitLab 15.10.
{{< /history >}}
You can enforce a global lock on SAML group memberships. This lock limits who can invite new members to subgroups where membership is synchronized with SAML Group Links.
When you lock group memberships:
- You cannot set a group or subgroup as a [Code Owner](../../project/codeowners/_index.md).
For more information, see [Incompatibility with Global SAML group memberships lock](../../project/codeowners/troubleshooting.md#incompatibility-with-global-saml-group-memberships-lock).
- Only administrators can manage group members and change their access levels.
- Group members cannot:
- Share a project with other groups.
- Invite members to a project created in a group.
- Modify the membership of a top-level group configured for SAML Group Links synchronization.
### Lock group memberships
Prerequisites:
- [SAML SSO for GitLab Self-Managed](../../../integration/saml.md) must be configured.
To lock memberships to SAML Group Links synchronization:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > General**.
1. Expand the **Visibility and access controls** section.
1. Select the **Lock memberships to SAML Group Links synchronization** checkbox.
|
https://docs.gitlab.com/user/group/saml_sso
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/_index.md
|
2025-08-13
|
doc/user/group/saml_sso
|
[
"doc",
"user",
"group",
"saml_sso"
] |
_index.md
|
Software Supply Chain Security
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
SAML SSO for GitLab.com groups
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
{{< alert type="note" >}}
For GitLab Self-Managed, see [SAML SSO for GitLab Self-Managed](../../../integration/saml.md).
{{< /alert >}}
Users can sign in to GitLab through their SAML identity provider.
[SCIM](scim_setup.md) synchronizes users with the group on GitLab.com.
- When you add or remove a user from the SCIM app, SCIM adds or removes the user
from the GitLab group.
- If the user is not already a group member, the user is added to the group as part of the sign-in process.
You can configure SAML SSO for the top-level group only.
## Set up your identity provider
The SAML standard means that you can use a wide range of identity providers with GitLab. Your identity provider might have relevant documentation. It can be generic SAML documentation or specifically targeted for GitLab.
When setting up your identity provider, use the following provider-specific documentation
to help avoid common issues and as a guide for terminology used.
For identity providers not listed, you can refer to the [instance SAML notes on configuring an identity provider](../../../integration/saml.md#configure-saml-on-your-idp)
for additional guidance on information your provider may require.
GitLab provides the following information for guidance only.
If you have any questions on configuring the SAML app, contact your provider's support.
If you are having issues setting up your identity provider, see the
[troubleshooting documentation](#troubleshooting).
### Azure
To set up SSO with Azure as your identity provider:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Note the information on this page.
1. Go to Azure, [create a non-gallery application](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/overview-application-gallery#create-your-own-application), and [configure SSO for an application](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/add-application-portal-setup-sso). The following GitLab settings correspond to the Azure fields.
| GitLab setting | Azure field |
| -----------------------------------------| ---------------------------------------------- |
| **Identifier** | **Identifier (Entity ID)** |
| **Assertion consumer service URL** | **Reply URL (Assertion Consumer Service URL)** |
| **GitLab single sign-on URL** | **Sign on URL** |
| **Identity provider single sign-on URL** | **Login URL** |
| **Certificate fingerprint** | **Thumbprint** |
1. You should set the following attributes:
- **Unique User Identifier (Name ID)** to `user.objectID`.
- **Name identifier format** to `persistent`. For more information, see how to [manage user SAML identity](#manage-user-saml-identity).
- **Additional claims** to [supported attributes](#configure-assertions).
1. Make sure the identity provider is set to have provider-initiated calls
to link existing GitLab accounts.
1. Optional. If you use [Group Sync](group_sync.md), customize the name of the
group claim to match the required attribute.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
View a demo of [SCIM provisioning on Azure using SAML SSO for groups](https://youtu.be/24-ZxmTeEBU). The `objectID` mapping is outdated in this video. Follow the [SCIM documentation](scim_setup.md#configure-microsoft-entra-id-formerly-azure-active-directory) instead.
For more information, see the [Azure configuration example](example_saml_config.md#azure-active-directory).
### Google Workspace
To set up Google Workspace as your identity provider:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Note the information on this page.
1. Follow the instructions for [setting up SSO with Google as your identity provider](https://support.google.com/a/answer/6087519?hl=en). The following GitLab settings correspond to the Google Workspace fields.
| GitLab setting | Google Workspace field |
|:-----------------------------------------|:-----------------------|
| **Identifier** | **Entity ID** |
| **Assertion consumer service URL** | **ACS URL** |
| **GitLab single sign-on URL** | **Start URL** |
| **Identity provider single sign-on URL** | **SSO URL** |
1. Google Workspace displays a SHA256 fingerprint when you retrieve the certificate. If you need to generate the SHA256 fingerprint later, see [calculate the fingerprint](troubleshooting.md#calculate-the-fingerprint).
1. Set these values:
- For **Primary email**: `email`.
- For **First name**: `first_name`.
- For **Last name**: `last_name`.
- For **Name ID format**: `EMAIL`.
- For **NameID**: `Basic Information > Primary email`.
For more information, see [supported attributes](#configure-assertions).
1. Make sure the identity provider is set to have provider-initiated calls
to link existing GitLab accounts.
On the GitLab SAML SSO page, when you select **Verify SAML Configuration**, disregard
the warning that recommends setting the **NameID** format to `persistent`.
For more information, see the [Google Workspace configuration example](example_saml_config.md#google-workspace).
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
View a demo of [how to configure SAML with Google Workspaces and set up Group Sync](https://youtu.be/NKs0FSQVfCY).
### Okta
To set up SSO with Okta as your identity provider:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Note the information on this page.
1. Follow the instructions for [setting up a SAML application in Okta](https://developer.okta.com/docs/guides/build-sso-integration/saml2/main/).
The following GitLab settings correspond to the Okta fields.
| GitLab setting | Okta field |
| ---------------------------------------- | -------------------------------------------------------------- |
| **Identifier** | **Audience URI** |
| **Assertion consumer service URL** | **Single sign-on URL** |
| **GitLab single sign-on URL** | **Login page URL** (under **Application Login Page** settings) |
| **Identity provider single sign-on URL** | **Identity Provider Single Sign-On URL** |
1. Under the Okta **Single sign-on URL** field, select the **Use this for Recipient URL and Destination URL** checkbox.
1. Set these values:
- For **Application username (NameID)**: **Custom** `user.getInternalProperty("id")`.
- For **Name ID Format**: `Persistent`. For more information, see [manage user SAML identity](#manage-user-saml-identity).
- For **email**: `user.email` or similar.
- For additional **Attribute Statements**, see [supported attributes](#configure-assertions).
1. Make sure the identity provider is set to have provider-initiated calls
to link existing GitLab accounts.
The Okta GitLab application available in the App Catalog only supports [SCIM](scim_setup.md). Support
for SAML is proposed in [issue 216173](https://gitlab.com/gitlab-org/gitlab/-/issues/216173).
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For a demo of the Okta SAML setup including SCIM, see [Demo: Okta Group SAML & SCIM setup](https://youtu.be/0ES9HsZq0AQ).
For more information, see the [Okta configuration example](example_saml_config.md#okta).
### OneLogin
OneLogin supports its own [GitLab (SaaS) application](https://onelogin.service-now.com/support?id=kb_article&sys_id=08e6b9d9879a6990c44486e5cebb3556&kb_category=50984e84db738300d5505eea4b961913).
To set up OneLogin as your identity provider:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Note the information on this page.
1. If you use the OneLogin generic
[SAML Test Connector (Advanced)](https://onelogin.service-now.com/support?id=kb_article&sys_id=b2c19353dbde7b8024c780c74b9619fb&kb_category=93e869b0db185340d5505eea4b961934),
you should [use the OneLogin SAML Test Connector](https://onelogin.service-now.com/support?id=kb_article&sys_id=93f95543db109700d5505eea4b96198f). The following GitLab settings correspond
to the OneLogin fields:
| GitLab setting | OneLogin field |
| ---------------------------------------------------- | -------------------------------- |
| **Identifier** | **Audience** |
| **Assertion consumer service URL** | **Recipient** |
| **Assertion consumer service URL** | **ACS (Consumer) URL** |
| **Assertion consumer service URL (escaped version)** | **ACS (Consumer) URL Validator** |
| **GitLab single sign-on URL** | **Login URL** |
| **Identity provider single sign-on URL** | **SAML 2.0 Endpoint** |
1. For **NameID**, use `OneLogin ID`. For more information, see [manage user SAML identity](#manage-user-saml-identity).
1. Configure [required and supported attributes](#configure-assertions).
1. Make sure the identity provider is set to have provider-initiated calls
to link existing GitLab accounts.
For more information, see the [OneLogin configuration example](example_saml_config.md#onelogin).
### Keycloak
To set up Keycloak as your identity provider:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Note the information on this page.
1. Follow the instructions to [create a SAML client in Keycloack](https://www.keycloak.org/docs/latest/server_admin/index.html#_client-saml-configuration).
The following GitLab settings correspond to the Keycloak fields.
| GitLab setting | Keycloak field |
|:-----------------------------------------|:------------------------------------------------|
| **Identifier** | **Client ID** |
| **Assertion consumer service URL** | **Valid redirect URIs** |
| **Assertion consumer service URL** | **Assertion Consumer Service POST Binding URL** |
| **GitLab single sign-on URL** | **Home URL** |
1. Configure your GitLab client in Keycloak.
1. In Keycloak, go to **Clients** and select your GitLab client configuration.
1. On the **Settings** tab, in the **SAML capabilities** section:
1. Set the **Name ID format** to `persistent`.
1. Turn on **Force name ID format**.
1. Turn on **Force POST binding**.
1. Turn on **Include AuthnStatement**.
1. In the **Signature and Encryption** section, turn on **Sign documents**.
1. On the **Keys** tab, make sure all sections are disabled.
1. On the **Client scopes** tab:
1. Select the client scope for GitLab.
1. Select the `email` AttributeStatement.
1. Set the **User Attribute** field to `email`.
1. Select **Save**.
1. Retrieve client information from Keycloak.
1. In the **Action** dropdown list, select **Download adapter config**.
1. In the **Download adapter config** dialog, select **mod-auth-mellon** from the dropdown list.
1. Select **Download**.
1. Extract the downloaded archive and open `idp-metadata.xml`.
1. Retrieve the identity provider single sign-on URL.
1. Locate the `<md:SingleSignOnService>` tag.
1. Note the value of the `Location` attribute.
1. Retrieve the certificate fingerprint.
1. Note the value of the `<ds:X509Certificate>` tag.
1. Convert the value to [PEM format](https://www.ssl.com/guide/pem-der-crt-and-cer-x-509-encodings-and-conversions/#ftoc-heading-3).
1. [Calculate the fingerprint](troubleshooting.md#calculate-the-fingerprint).
### Configure assertions
{{< alert type="note" >}}
These attributes are case-insensitive.
{{< /alert >}}
At minimum, you must configure the following assertions:
1. [NameID](#manage-user-saml-identity).
1. Email.
Optionally, you can pass user information to GitLab as attributes in the SAML assertion.
- The user's email address can be an **email** or **mail** attribute.
- The username can be either a **username** or **nickname** attribute. You should specify only
one of these.
For more information on available attributes, see [SAML SSO for GitLab Self-Managed](../../../integration/saml.md#configure-assertions).
### Use metadata
To configure some identity providers, you need a GitLab metadata URL.
To find this URL:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Copy the provided **GitLab metadata URL**.
1. Follow your identity provider's documentation and paste the metadata URL when it's requested.
Check your identity provider's documentation to see if it supports the GitLab metadata URL.
### Manage the identity provider
After you have set up your identity provider, you can:
- Change the identity provider.
- Change email domains.
#### Change the identity provider
You can change to a different identity provider. During the change process,
users cannot access any of the SAML groups. To mitigate this, you can disable
[SSO enforcement](#sso-enforcement).
To change identity providers:
1. [Configure](#set-up-your-identity-provider) the group with the new identity provider.
1. Optional. If the **NameID** is not identical, [change the **NameID** for users](#manage-user-saml-identity).
#### Change email domains
To migrate users to a new email domain, tell users to:
1. [Add their new email](../../profile/_index.md#change-your-primary-email) as the primary email to their accounts and verify it.
1. Optional. Remove their old email from the account.
If the **NameID** is configured with the email address, [change the **NameID** for users](#manage-user-saml-identity).
## Configure GitLab
{{< history >}}
- Ability to set a custom role as the default membership role [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/417285) in GitLab 16.7.
{{< /history >}}
After you set up your identity provider to work with GitLab, you must configure GitLab to use it for authentication:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Complete the fields:
- In the **Identity provider single sign-on URL** field, enter the SSO URL from your identity provider.
- In the **Certificate fingerprint** field, enter the fingerprint for the SAML token signing certificate.
1. For groups on GitLab.com: in the **Default membership role** field, select:
1. The role to assign to new users.
1. The role to assign to
[users who are not members of a mapped SAML group](group_sync.md#automatic-member-removal)
when SAML Group Links is configured for the group.
1. For groups on GitLab Self-Managed instances: in the **Default membership role** field,
select the role to assign to new users.
The default role is **Guest**. That role becomes the starting role of all users
added to the group:
- In GitLab 16.7 and later, group Owners can set a [custom role](../../custom_roles/_index.md)
- In GitLab 16.6 and earlier, group Owners can set a default membership role other than **Guest**.
as the default membership role.
1. Select the **Enable SAML authentication for this group** checkbox.
1. Recommended. Select:
- In GitLab 17.4 and later, **Disable password authentication for enterprise users**.
For more information, see the [Disable password authentication for enterprise users documentation](#disable-password-authentication-for-enterprise-users).
- **Enforce SSO-only authentication for web activity for this group**.
- **Enforce SSO-only authentication for Git and Dependency Proxy activity for this group**.
For more information, see the [SSO enforcement documentation](#sso-enforcement).
1. Select **Save changes**.
If you are having issues configuring GitLab, see the [troubleshooting documentation](#troubleshooting).
## User access and management
After group SSO is configured and enabled, users can access the GitLab.com group through the identity provider's dashboard.
If [SCIM](scim_setup.md) is configured, see [user access](scim_setup.md#user-access) on the SCIM page.
When a user tries to sign in with Group SSO, GitLab attempts to find or create a user based on the following:
- Find an existing user with a matching SAML identity. This would mean the user either had their account created by [SCIM](scim_setup.md) or they have previously signed in with the group's SAML IdP.
- If an account does not already exist with the same email address, create a new account automatically. GitLab tries to match both the primary and secondary email addresses.
- If an account already exists with the same email address, redirect the user to the sign-in page to:
- Create a new account with another email address.
- Sign-in to their existing account to link the SAML identity.
### Link SAML to your existing GitLab.com account
{{< history >}}
- **Remember me** checkbox [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/121569) in GitLab 15.7.
{{< /history >}}
{{< alert type="note" >}}
If the user is an [enterprise user](../../enterprise_user/_index.md) of that group, the following steps do not apply. The enterprise user must instead [sign in with a SAML account that has the same email as the GitLab account](#automatic-identity-linking-for-enterprise-users). This allows GitLab to link the SAML account to the existing account.
{{< /alert >}}
To link SAML to your existing GitLab.com account:
1. Sign in to your GitLab.com account. [Reset your password](https://gitlab.com/users/password/new)
if necessary.
1. Locate and visit the **GitLab single sign-on URL** for the group you're signing
in to. A group owner can find this on the group's **Settings > SAML SSO** page.
If the sign-in URL is configured, users can connect to the GitLab app from the identity provider.
1. Optional. Select the **Remember me** checkbox to stay signed in to GitLab for 2 weeks.
You may still be asked to re-authenticate with your SAML provider more frequently.
1. Select **Authorize**.
1. Enter your credentials on the identity provider if prompted.
1. You are then redirected back to GitLab.com and should now have access to the group.
In the future, you can use SAML to sign in to GitLab.com.
If a user is already a member of the group, linking the SAML identity does not
change their role.
On subsequent visits, you should be able to [sign in to GitLab.com with SAML](#sign-in-to-gitlabcom-with-saml)
or by visiting links directly. If the **enforce SSO** option is turned on, you
are then redirected to sign in through the identity provider.
#### Automatic identity linking for enterprise users
If an enterprise user is removed from the group and then returns, they can sign in
with their enterprise SSO account.
As long as the user's email address in the identity provider remains the same as the
email address on the existing GitLab account, the SSO identity is automatically linked
to the account and the user can sign in without any issues.
This functionality also applies to existing users that have been claimed as an
enterprise user but who may not have yet signed into the group.
### Sign in to GitLab.com with SAML
1. Sign in to your identity provider.
1. From the list of apps, select the "GitLab.com" app. (The name is set by the administrator of the identity provider.)
1. You are then signed in to GitLab.com and redirected to the group.
### Manage user SAML identity
{{< history >}}
- Update of SAML identities using the SAML API [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5.
{{< /history >}}
GitLab.com uses the SAML **NameID** to identify users. The **NameID** is:
- A required field in the SAML response.
- Case-insensitive.
The **NameID** must:
- Be unique to each user.
- Be a persistent value that never changes, such as a randomly generated unique user ID.
- Match exactly on subsequent sign-in attempts, so it should not rely on user input
that could change between upper and lowercase.
The **NameID** should not be an email address or username because:
- Email addresses and usernames are more likely to change over time. For example,
when a person's name changes.
- Email addresses are case-insensitive, which can result in users being unable to
sign in.
The **NameID** format must be `Persistent`, unless you are using a field, like email, that
requires a different format. You can use any format except `Transient`.
#### Change user **NameID**
Group owners can use the [SAML API](../../../api/saml.md#update-extern_uid-field-for-a-saml-identity) to change their group members' **NameID** and update their SAML identities.
If [SCIM](scim_setup.md) is configured, group owners can update the SCIM identities using the [SCIM API](../../../api/scim.md#update-extern_uid-field-for-a-scim-identity).
Alternatively, ask the users to reconnect their SAML account.
1. Ask relevant users to [unlink their account from the group](#unlink-accounts).
1. Ask relevant users to [link their account to the new SAML app](#link-saml-to-your-existing-gitlabcom-account).
{{< alert type="warning" >}}
After users have signed into GitLab using SSO SAML, changing the **NameID** value
breaks the configuration and could lock users out of the GitLab group.
{{< /alert >}}
For more information on the recommended value and format for specific identity
providers, see [set up your identity provider](#set-up-your-identity-provider).
### Configure enterprise user settings from SAML response
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/412898) to configure only enterprise user settings in GitLab 16.7.
{{< /history >}}
GitLab allows setting certain user attributes based on values from the SAML response.
An existing user's attributes are updated from the SAML response values if that
user is an [enterprise user](../../enterprise_user/_index.md) of the group.
#### Supported user attributes
- **can_create_group** - `true` or `false` to indicate whether an enterprise user can create
new top-level groups. Default is `true`.
- **projects_limit** - The total number of personal projects an enterprise user can create.
A value of `0` means the user cannot create new projects in their personal
namespace. Default is `100000`.
- **SessionNotOnOrAfter** - An ISO 8601 timestamp value that indicates when to end the user SAML session.
#### Example SAML response
You can find SAML responses in the developer tools or console of your browser,
in base64-encoded format. Use the base64 decoding tool of your choice to
convert the information to XML. An example SAML response is shown here.
```xml
<saml2:AttributeStatement>
<saml2:Attribute Name="email" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">user.email</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="username" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">user.nickName</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="first_name" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">user.firstName</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="last_name" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">user.lastName</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="can_create_group" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">true</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="projects_limit" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">10</saml2:AttributeValue>
</saml2:Attribute>
</saml2:AttributeStatement>
```
### Customize SAML session timeout
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262074) in GitLab 18.2 [with a flag](../../../administration/feature_flags/_index.md) named `saml_timeout_supplied_by_idp_override`.
{{< /history >}}
By default, GitLab ends SAML sessions after 24 hours. You can customize this duration with
the `SessionNotOnOrAfter` attribute in the SAML2 AuthnStatement. This attribute contains an
ISO 8601 timestamp value that indicates when to end the user session. When specified this
value overrides the default SAML session timeout of 24 hours.
If the instance has a custom [session duration](../../../administration/settings/account_and_limit_settings.md#session-duration) configured
that is earlier than the `SessionNotOnOrAfter` timestamp, users must re-authenticate
when their GitLab user session ends.
#### Example response
```xml
<saml:AuthnStatement SessionIndex="WDE5aBYjNEj_9IjCFiK0E1YelZT" SessionNotOnOrAfter="2025-08-25T01:23:45.067Z" AuthnInstant="2025-08-24T13:23:45.067Z">
<saml:AuthnContext>
<saml:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:unspecified</saml:AuthnContextClassRef>
</saml:AuthnContext>
</saml:AuthnStatement>
```
### Bypass user email confirmation with verified domains
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238461) in GitLab 15.4.
{{< /history >}}
By default, users provisioned with SAML or SCIM are sent a verification email to verify their identity. Instead, you can
[configure GitLab with a custom domain](../../enterprise_user/_index.md#set-up-a-verified-domain) and GitLab
automatically confirms user accounts. Users still receive an
[enterprise user](../../enterprise_user/_index.md) welcome email. Confirmation is bypassed if both of the following are true:
- The user is provisioned with SAML or SCIM.
- The user has an email address that belongs to the verified domain.
### Disable password authentication for enterprise users
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/373718) in GitLab 17.4.
{{< /history >}}
Prerequisites:
- You must have the Owner role for the group that the enterprise user belongs to.
- Group SSO must be enabled.
You can disable password authentication for all [enterprise users](../../enterprise_user/_index.md) of the group. This also applies to enterprise users who are administrators of the group. Configuring this setting stops enterprise users from changing, resetting, or authenticating with their password. Instead, these users can authenticate with:
- The group SAML IdP for the GitLab web UI.
- A personal access token for the GitLab API and Git with HTTP Basic Authentication unless the group has [disabled personal access tokens for enterprise users](../../profile/personal_access_tokens.md#disable-personal-access-tokens-for-enterprise-users).
To disable password authentication for enterprise users:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Under **Configuration**, select **Disable password authentication for enterprise users**.
1. Select **Save changes**.
### Block user access
To rescind a user's access to the group when only SAML SSO is configured, either:
- Remove (in order) the user from:
1. The user data store on the identity provider or the list of users on the specific app.
1. The GitLab.com group.
- Use [Group Sync](group_sync.md#automatic-member-removal) at the top-level of
your group with the default role set to [minimal access](../../permissions.md#users-with-minimal-access)
to automatically block access to all resources in the group.
To rescind a user's access to the group when also using SCIM, refer to [Remove access](scim_setup.md#remove-access).
### Unlink accounts
Users can unlink SAML for a group from their profile page. This can be helpful if:
- You no longer want a group to be able to sign you in to GitLab.com.
- Your SAML **NameID** has changed and so GitLab can no longer find your user.
{{< alert type="warning" >}}
Unlinking an account removes all roles assigned to that user in the group.
If a user re-links their account, roles need to be reassigned.
{{< /alert >}}
Groups require at least one owner. If your account is the only owner in the
group, you are not allowed to unlink the account. In that case, set up another user as a
group owner, and then you can unlink the account.
For example, to unlink the `MyOrg` account:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Account**.
1. In the **Service sign-in** section, select **Disconnect** next to the connected account.
## SSO enforcement
{{< history >}}
- [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/215155) in GitLab 15.5 [with a flag](../../../administration/feature_flags/_index.md) named `transparent_sso_enforcement` to include transparent enforcement even when SSO enforcement is not enabled. Disabled on GitLab.com.
- [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/375788) in GitLab 15.8 by enabling transparent SSO by default on GitLab.com.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/389562) in GitLab 15.10. Feature flag `transparent_sso_enforcement` removed.
{{< /history >}}
On GitLab.com, SSO is enforced:
- When SAML SSO is enabled.
- For users with an existing SAML identity when accessing groups and projects in the organization's
group hierarchy. By using their GitLab.com credentials, users can view other groups and projects outside their organization, as well as their user settings, without signing in through SAML SSO.
A user has a SAML identity if one or both of the following are true:
- They have signed in to GitLab by using their GitLab group's single sign-on URL.
- They were provisioned by SCIM.
Users are not prompted to sign in through SSO on each visit. GitLab checks
whether a user has authenticated through SSO. If the user last signed in more
than 24 hours ago, GitLab prompts the user to sign in again through SSO.
SSO is enforced as follows:
| Project/Group visibility | Enforce SSO setting | Member with identity | Member without identity | Non-member or not signed in |
|--------------------------|---------------------|----------------------|-------------------------|-----------------------------|
| Private | Off | Enforced | Not enforced | Not enforced |
| Private | On | Enforced | Enforced | Enforced |
| Public | Off | Enforced | Not enforced | Not enforced |
| Public | On | Enforced | Enforced | Not enforced |
An [issue exists](https://gitlab.com/gitlab-org/gitlab/-/issues/297389) to add a similar SSO requirement for API activity. Until this requirement is added, you can use features that rely on APIs without an active SSO session.
### SSO-only for web activity enforcement
When the **Enforce SSO-only authentication for web activity for this group** option is enabled:
- All members must access GitLab by using their GitLab group's single sign-on URL
to access group resources, regardless of whether they have an existing SAML
identity.
- SSO is enforced when users access groups and projects in the organization's
group hierarchy. Users can view other groups and projects outside their organization without signing in through SAML SSO.
- Users cannot be added as new members manually.
- Users with the Owner role can use the standard sign in process to make
necessary changes to top-level group settings.
- For non-members or users who are not signed in:
- SSO is not enforced when they access public group resources.
- SSO is enforced when they access private group resources.
- For items in the organization's group hierarchy, dashboard visibility is as
follows:
- SSO is enforced when viewing your [To-Do List](../../todos.md). Your
to-do items are hidden if your SSO session has expired, and an
[alert is shown](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115254).
- SSO is enforced when viewing your list of assigned issues. Your issues are
hidden if your SSO session has expired.
[Issue 414475](https://gitlab.com/gitlab-org/gitlab/-/issues/414475) proposes to change this
behavior so that issues are visible.
- SSO is not enforced when viewing merge requests where you are the
assignee or reviewer. You can see merge requests even if
your SSO session has expired.
- SSO is not enforced when viewing snippets for private projects where you have at least the Guest role.
SSO enforcement for web activity has the following effects when enabled:
- For groups, users cannot share a project in the group outside the top-level
group, even if the project is forked.
- Git activity originating from CI/CD jobs do not have the SSO check enforced.
- Credentials that are not tied to regular users (for example, project and group
access tokens, service accounts, and deploy keys) do not have the SSO check enforced.
- Users must be signed-in through SSO before they can pull images using the
[Dependency Proxy](../../packages/dependency_proxy/_index.md).
- When the **Enforce SSO-only authentication for Git and Dependency Proxy
activity for this group** option is enabled, any API endpoint that involves
Git activity is under SSO enforcement. For example, creating or deleting a
branch, commit, or tag. For Git activity over SSH and HTTPS, users must
have at least one active session signed-in through SSO before they can push to or
pull from a GitLab repository. The active session can be on a different device.
When SSO for web activity is enforced, non-SSO group members do not lose access
immediately. If the user:
- Has an active session, they can continue accessing the group for up to 24
hours until the identity provider session times out.
- Is signed out, they cannot access the group after being removed from the
identity provider.
## Migrate to a new identity provider
To migrate to a new identity provider, use the [SAML API](../../../api/saml.md) to update all of your group member's identities.
For example:
1. Set a maintenance window to ensure that no users are active at that time.
1. Use the SAML API [to update each user's identity](../../../api/saml.md#update-extern_uid-field-for-a-saml-identity).
1. Configure the new identity provider.
1. Test that sign in works.
## Related topics
- [SAML SSO for GitLab Self-Managed](../../../integration/saml.md)
- [Glossary](../../../integration/saml.md#glossary)
- [Blog post: The ultimate guide to enabling SAML and SSO on GitLab.com](https://about.gitlab.com/blog/2023/09/14/the-ultimate-guide-to-enabling-saml/)
- [Authentication comparison between SaaS and GitLab Self-Managed](../../../administration/auth/_index.md#gitlabcom-compared-to-gitlab-self-managed)
- [Passwords for users created through integrated authentication](../../../security/passwords_for_integrated_authentication_methods.md)
- [SAML Group Sync](group_sync.md)
## Troubleshooting
If you find it difficult to match the different SAML terms between GitLab and the
identity provider:
1. Check your identity provider's documentation. Look at their example SAML
configurations for information on the terms they use.
1. Check the [SAML SSO for GitLab Self-Managed documentation](../../../integration/saml.md).
The GitLab Self-Managed SAML configuration file supports more options
than the GitLab.com file. You can find information on the GitLab Self-Managed instance
file in the:
- External [OmniAuth SAML documentation](https://github.com/omniauth/omniauth-saml/).
- [`ruby-saml` library](https://github.com/onelogin/ruby-saml).
1. Compare the XML response from your provider with our
[example XML used for internal testing](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/spec/fixtures/saml/response.xml).
For other troubleshooting information, see the [troubleshooting SAML guide](troubleshooting.md).
|
---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: SAML SSO for GitLab.com groups
breadcrumbs:
- doc
- user
- group
- saml_sso
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
{{< alert type="note" >}}
For GitLab Self-Managed, see [SAML SSO for GitLab Self-Managed](../../../integration/saml.md).
{{< /alert >}}
Users can sign in to GitLab through their SAML identity provider.
[SCIM](scim_setup.md) synchronizes users with the group on GitLab.com.
- When you add or remove a user from the SCIM app, SCIM adds or removes the user
from the GitLab group.
- If the user is not already a group member, the user is added to the group as part of the sign-in process.
You can configure SAML SSO for the top-level group only.
## Set up your identity provider
The SAML standard means that you can use a wide range of identity providers with GitLab. Your identity provider might have relevant documentation. It can be generic SAML documentation or specifically targeted for GitLab.
When setting up your identity provider, use the following provider-specific documentation
to help avoid common issues and as a guide for terminology used.
For identity providers not listed, you can refer to the [instance SAML notes on configuring an identity provider](../../../integration/saml.md#configure-saml-on-your-idp)
for additional guidance on information your provider may require.
GitLab provides the following information for guidance only.
If you have any questions on configuring the SAML app, contact your provider's support.
If you are having issues setting up your identity provider, see the
[troubleshooting documentation](#troubleshooting).
### Azure
To set up SSO with Azure as your identity provider:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Note the information on this page.
1. Go to Azure, [create a non-gallery application](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/overview-application-gallery#create-your-own-application), and [configure SSO for an application](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/add-application-portal-setup-sso). The following GitLab settings correspond to the Azure fields.
| GitLab setting | Azure field |
| -----------------------------------------| ---------------------------------------------- |
| **Identifier** | **Identifier (Entity ID)** |
| **Assertion consumer service URL** | **Reply URL (Assertion Consumer Service URL)** |
| **GitLab single sign-on URL** | **Sign on URL** |
| **Identity provider single sign-on URL** | **Login URL** |
| **Certificate fingerprint** | **Thumbprint** |
1. You should set the following attributes:
- **Unique User Identifier (Name ID)** to `user.objectID`.
- **Name identifier format** to `persistent`. For more information, see how to [manage user SAML identity](#manage-user-saml-identity).
- **Additional claims** to [supported attributes](#configure-assertions).
1. Make sure the identity provider is set to have provider-initiated calls
to link existing GitLab accounts.
1. Optional. If you use [Group Sync](group_sync.md), customize the name of the
group claim to match the required attribute.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
View a demo of [SCIM provisioning on Azure using SAML SSO for groups](https://youtu.be/24-ZxmTeEBU). The `objectID` mapping is outdated in this video. Follow the [SCIM documentation](scim_setup.md#configure-microsoft-entra-id-formerly-azure-active-directory) instead.
For more information, see the [Azure configuration example](example_saml_config.md#azure-active-directory).
### Google Workspace
To set up Google Workspace as your identity provider:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Note the information on this page.
1. Follow the instructions for [setting up SSO with Google as your identity provider](https://support.google.com/a/answer/6087519?hl=en). The following GitLab settings correspond to the Google Workspace fields.
| GitLab setting | Google Workspace field |
|:-----------------------------------------|:-----------------------|
| **Identifier** | **Entity ID** |
| **Assertion consumer service URL** | **ACS URL** |
| **GitLab single sign-on URL** | **Start URL** |
| **Identity provider single sign-on URL** | **SSO URL** |
1. Google Workspace displays a SHA256 fingerprint when you retrieve the certificate. If you need to generate the SHA256 fingerprint later, see [calculate the fingerprint](troubleshooting.md#calculate-the-fingerprint).
1. Set these values:
- For **Primary email**: `email`.
- For **First name**: `first_name`.
- For **Last name**: `last_name`.
- For **Name ID format**: `EMAIL`.
- For **NameID**: `Basic Information > Primary email`.
For more information, see [supported attributes](#configure-assertions).
1. Make sure the identity provider is set to have provider-initiated calls
to link existing GitLab accounts.
On the GitLab SAML SSO page, when you select **Verify SAML Configuration**, disregard
the warning that recommends setting the **NameID** format to `persistent`.
For more information, see the [Google Workspace configuration example](example_saml_config.md#google-workspace).
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
View a demo of [how to configure SAML with Google Workspaces and set up Group Sync](https://youtu.be/NKs0FSQVfCY).
### Okta
To set up SSO with Okta as your identity provider:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Note the information on this page.
1. Follow the instructions for [setting up a SAML application in Okta](https://developer.okta.com/docs/guides/build-sso-integration/saml2/main/).
The following GitLab settings correspond to the Okta fields.
| GitLab setting | Okta field |
| ---------------------------------------- | -------------------------------------------------------------- |
| **Identifier** | **Audience URI** |
| **Assertion consumer service URL** | **Single sign-on URL** |
| **GitLab single sign-on URL** | **Login page URL** (under **Application Login Page** settings) |
| **Identity provider single sign-on URL** | **Identity Provider Single Sign-On URL** |
1. Under the Okta **Single sign-on URL** field, select the **Use this for Recipient URL and Destination URL** checkbox.
1. Set these values:
- For **Application username (NameID)**: **Custom** `user.getInternalProperty("id")`.
- For **Name ID Format**: `Persistent`. For more information, see [manage user SAML identity](#manage-user-saml-identity).
- For **email**: `user.email` or similar.
- For additional **Attribute Statements**, see [supported attributes](#configure-assertions).
1. Make sure the identity provider is set to have provider-initiated calls
to link existing GitLab accounts.
The Okta GitLab application available in the App Catalog only supports [SCIM](scim_setup.md). Support
for SAML is proposed in [issue 216173](https://gitlab.com/gitlab-org/gitlab/-/issues/216173).
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For a demo of the Okta SAML setup including SCIM, see [Demo: Okta Group SAML & SCIM setup](https://youtu.be/0ES9HsZq0AQ).
For more information, see the [Okta configuration example](example_saml_config.md#okta).
### OneLogin
OneLogin supports its own [GitLab (SaaS) application](https://onelogin.service-now.com/support?id=kb_article&sys_id=08e6b9d9879a6990c44486e5cebb3556&kb_category=50984e84db738300d5505eea4b961913).
To set up OneLogin as your identity provider:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Note the information on this page.
1. If you use the OneLogin generic
[SAML Test Connector (Advanced)](https://onelogin.service-now.com/support?id=kb_article&sys_id=b2c19353dbde7b8024c780c74b9619fb&kb_category=93e869b0db185340d5505eea4b961934),
you should [use the OneLogin SAML Test Connector](https://onelogin.service-now.com/support?id=kb_article&sys_id=93f95543db109700d5505eea4b96198f). The following GitLab settings correspond
to the OneLogin fields:
| GitLab setting | OneLogin field |
| ---------------------------------------------------- | -------------------------------- |
| **Identifier** | **Audience** |
| **Assertion consumer service URL** | **Recipient** |
| **Assertion consumer service URL** | **ACS (Consumer) URL** |
| **Assertion consumer service URL (escaped version)** | **ACS (Consumer) URL Validator** |
| **GitLab single sign-on URL** | **Login URL** |
| **Identity provider single sign-on URL** | **SAML 2.0 Endpoint** |
1. For **NameID**, use `OneLogin ID`. For more information, see [manage user SAML identity](#manage-user-saml-identity).
1. Configure [required and supported attributes](#configure-assertions).
1. Make sure the identity provider is set to have provider-initiated calls
to link existing GitLab accounts.
For more information, see the [OneLogin configuration example](example_saml_config.md#onelogin).
### Keycloak
To set up Keycloak as your identity provider:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Note the information on this page.
1. Follow the instructions to [create a SAML client in Keycloack](https://www.keycloak.org/docs/latest/server_admin/index.html#_client-saml-configuration).
The following GitLab settings correspond to the Keycloak fields.
| GitLab setting | Keycloak field |
|:-----------------------------------------|:------------------------------------------------|
| **Identifier** | **Client ID** |
| **Assertion consumer service URL** | **Valid redirect URIs** |
| **Assertion consumer service URL** | **Assertion Consumer Service POST Binding URL** |
| **GitLab single sign-on URL** | **Home URL** |
1. Configure your GitLab client in Keycloak.
1. In Keycloak, go to **Clients** and select your GitLab client configuration.
1. On the **Settings** tab, in the **SAML capabilities** section:
1. Set the **Name ID format** to `persistent`.
1. Turn on **Force name ID format**.
1. Turn on **Force POST binding**.
1. Turn on **Include AuthnStatement**.
1. In the **Signature and Encryption** section, turn on **Sign documents**.
1. On the **Keys** tab, make sure all sections are disabled.
1. On the **Client scopes** tab:
1. Select the client scope for GitLab.
1. Select the `email` AttributeStatement.
1. Set the **User Attribute** field to `email`.
1. Select **Save**.
1. Retrieve client information from Keycloak.
1. In the **Action** dropdown list, select **Download adapter config**.
1. In the **Download adapter config** dialog, select **mod-auth-mellon** from the dropdown list.
1. Select **Download**.
1. Extract the downloaded archive and open `idp-metadata.xml`.
1. Retrieve the identity provider single sign-on URL.
1. Locate the `<md:SingleSignOnService>` tag.
1. Note the value of the `Location` attribute.
1. Retrieve the certificate fingerprint.
1. Note the value of the `<ds:X509Certificate>` tag.
1. Convert the value to [PEM format](https://www.ssl.com/guide/pem-der-crt-and-cer-x-509-encodings-and-conversions/#ftoc-heading-3).
1. [Calculate the fingerprint](troubleshooting.md#calculate-the-fingerprint).
### Configure assertions
{{< alert type="note" >}}
These attributes are case-insensitive.
{{< /alert >}}
At minimum, you must configure the following assertions:
1. [NameID](#manage-user-saml-identity).
1. Email.
Optionally, you can pass user information to GitLab as attributes in the SAML assertion.
- The user's email address can be an **email** or **mail** attribute.
- The username can be either a **username** or **nickname** attribute. You should specify only
one of these.
For more information on available attributes, see [SAML SSO for GitLab Self-Managed](../../../integration/saml.md#configure-assertions).
### Use metadata
To configure some identity providers, you need a GitLab metadata URL.
To find this URL:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Copy the provided **GitLab metadata URL**.
1. Follow your identity provider's documentation and paste the metadata URL when it's requested.
Check your identity provider's documentation to see if it supports the GitLab metadata URL.
### Manage the identity provider
After you have set up your identity provider, you can:
- Change the identity provider.
- Change email domains.
#### Change the identity provider
You can change to a different identity provider. During the change process,
users cannot access any of the SAML groups. To mitigate this, you can disable
[SSO enforcement](#sso-enforcement).
To change identity providers:
1. [Configure](#set-up-your-identity-provider) the group with the new identity provider.
1. Optional. If the **NameID** is not identical, [change the **NameID** for users](#manage-user-saml-identity).
#### Change email domains
To migrate users to a new email domain, tell users to:
1. [Add their new email](../../profile/_index.md#change-your-primary-email) as the primary email to their accounts and verify it.
1. Optional. Remove their old email from the account.
If the **NameID** is configured with the email address, [change the **NameID** for users](#manage-user-saml-identity).
## Configure GitLab
{{< history >}}
- Ability to set a custom role as the default membership role [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/417285) in GitLab 16.7.
{{< /history >}}
After you set up your identity provider to work with GitLab, you must configure GitLab to use it for authentication:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Complete the fields:
- In the **Identity provider single sign-on URL** field, enter the SSO URL from your identity provider.
- In the **Certificate fingerprint** field, enter the fingerprint for the SAML token signing certificate.
1. For groups on GitLab.com: in the **Default membership role** field, select:
1. The role to assign to new users.
1. The role to assign to
[users who are not members of a mapped SAML group](group_sync.md#automatic-member-removal)
when SAML Group Links is configured for the group.
1. For groups on GitLab Self-Managed instances: in the **Default membership role** field,
select the role to assign to new users.
The default role is **Guest**. That role becomes the starting role of all users
added to the group:
- In GitLab 16.7 and later, group Owners can set a [custom role](../../custom_roles/_index.md)
- In GitLab 16.6 and earlier, group Owners can set a default membership role other than **Guest**.
as the default membership role.
1. Select the **Enable SAML authentication for this group** checkbox.
1. Recommended. Select:
- In GitLab 17.4 and later, **Disable password authentication for enterprise users**.
For more information, see the [Disable password authentication for enterprise users documentation](#disable-password-authentication-for-enterprise-users).
- **Enforce SSO-only authentication for web activity for this group**.
- **Enforce SSO-only authentication for Git and Dependency Proxy activity for this group**.
For more information, see the [SSO enforcement documentation](#sso-enforcement).
1. Select **Save changes**.
If you are having issues configuring GitLab, see the [troubleshooting documentation](#troubleshooting).
## User access and management
After group SSO is configured and enabled, users can access the GitLab.com group through the identity provider's dashboard.
If [SCIM](scim_setup.md) is configured, see [user access](scim_setup.md#user-access) on the SCIM page.
When a user tries to sign in with Group SSO, GitLab attempts to find or create a user based on the following:
- Find an existing user with a matching SAML identity. This would mean the user either had their account created by [SCIM](scim_setup.md) or they have previously signed in with the group's SAML IdP.
- If an account does not already exist with the same email address, create a new account automatically. GitLab tries to match both the primary and secondary email addresses.
- If an account already exists with the same email address, redirect the user to the sign-in page to:
- Create a new account with another email address.
- Sign-in to their existing account to link the SAML identity.
### Link SAML to your existing GitLab.com account
{{< history >}}
- **Remember me** checkbox [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/121569) in GitLab 15.7.
{{< /history >}}
{{< alert type="note" >}}
If the user is an [enterprise user](../../enterprise_user/_index.md) of that group, the following steps do not apply. The enterprise user must instead [sign in with a SAML account that has the same email as the GitLab account](#automatic-identity-linking-for-enterprise-users). This allows GitLab to link the SAML account to the existing account.
{{< /alert >}}
To link SAML to your existing GitLab.com account:
1. Sign in to your GitLab.com account. [Reset your password](https://gitlab.com/users/password/new)
if necessary.
1. Locate and visit the **GitLab single sign-on URL** for the group you're signing
in to. A group owner can find this on the group's **Settings > SAML SSO** page.
If the sign-in URL is configured, users can connect to the GitLab app from the identity provider.
1. Optional. Select the **Remember me** checkbox to stay signed in to GitLab for 2 weeks.
You may still be asked to re-authenticate with your SAML provider more frequently.
1. Select **Authorize**.
1. Enter your credentials on the identity provider if prompted.
1. You are then redirected back to GitLab.com and should now have access to the group.
In the future, you can use SAML to sign in to GitLab.com.
If a user is already a member of the group, linking the SAML identity does not
change their role.
On subsequent visits, you should be able to [sign in to GitLab.com with SAML](#sign-in-to-gitlabcom-with-saml)
or by visiting links directly. If the **enforce SSO** option is turned on, you
are then redirected to sign in through the identity provider.
#### Automatic identity linking for enterprise users
If an enterprise user is removed from the group and then returns, they can sign in
with their enterprise SSO account.
As long as the user's email address in the identity provider remains the same as the
email address on the existing GitLab account, the SSO identity is automatically linked
to the account and the user can sign in without any issues.
This functionality also applies to existing users that have been claimed as an
enterprise user but who may not have yet signed into the group.
### Sign in to GitLab.com with SAML
1. Sign in to your identity provider.
1. From the list of apps, select the "GitLab.com" app. (The name is set by the administrator of the identity provider.)
1. You are then signed in to GitLab.com and redirected to the group.
### Manage user SAML identity
{{< history >}}
- Update of SAML identities using the SAML API [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5.
{{< /history >}}
GitLab.com uses the SAML **NameID** to identify users. The **NameID** is:
- A required field in the SAML response.
- Case-insensitive.
The **NameID** must:
- Be unique to each user.
- Be a persistent value that never changes, such as a randomly generated unique user ID.
- Match exactly on subsequent sign-in attempts, so it should not rely on user input
that could change between upper and lowercase.
The **NameID** should not be an email address or username because:
- Email addresses and usernames are more likely to change over time. For example,
when a person's name changes.
- Email addresses are case-insensitive, which can result in users being unable to
sign in.
The **NameID** format must be `Persistent`, unless you are using a field, like email, that
requires a different format. You can use any format except `Transient`.
#### Change user **NameID**
Group owners can use the [SAML API](../../../api/saml.md#update-extern_uid-field-for-a-saml-identity) to change their group members' **NameID** and update their SAML identities.
If [SCIM](scim_setup.md) is configured, group owners can update the SCIM identities using the [SCIM API](../../../api/scim.md#update-extern_uid-field-for-a-scim-identity).
Alternatively, ask the users to reconnect their SAML account.
1. Ask relevant users to [unlink their account from the group](#unlink-accounts).
1. Ask relevant users to [link their account to the new SAML app](#link-saml-to-your-existing-gitlabcom-account).
{{< alert type="warning" >}}
After users have signed into GitLab using SSO SAML, changing the **NameID** value
breaks the configuration and could lock users out of the GitLab group.
{{< /alert >}}
For more information on the recommended value and format for specific identity
providers, see [set up your identity provider](#set-up-your-identity-provider).
### Configure enterprise user settings from SAML response
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/412898) to configure only enterprise user settings in GitLab 16.7.
{{< /history >}}
GitLab allows setting certain user attributes based on values from the SAML response.
An existing user's attributes are updated from the SAML response values if that
user is an [enterprise user](../../enterprise_user/_index.md) of the group.
#### Supported user attributes
- **can_create_group** - `true` or `false` to indicate whether an enterprise user can create
new top-level groups. Default is `true`.
- **projects_limit** - The total number of personal projects an enterprise user can create.
A value of `0` means the user cannot create new projects in their personal
namespace. Default is `100000`.
- **SessionNotOnOrAfter** - An ISO 8601 timestamp value that indicates when to end the user SAML session.
#### Example SAML response
You can find SAML responses in the developer tools or console of your browser,
in base64-encoded format. Use the base64 decoding tool of your choice to
convert the information to XML. An example SAML response is shown here.
```xml
<saml2:AttributeStatement>
<saml2:Attribute Name="email" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">user.email</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="username" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">user.nickName</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="first_name" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">user.firstName</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="last_name" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">user.lastName</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="can_create_group" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">true</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="projects_limit" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">10</saml2:AttributeValue>
</saml2:Attribute>
</saml2:AttributeStatement>
```
### Customize SAML session timeout
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262074) in GitLab 18.2 [with a flag](../../../administration/feature_flags/_index.md) named `saml_timeout_supplied_by_idp_override`.
{{< /history >}}
By default, GitLab ends SAML sessions after 24 hours. You can customize this duration with
the `SessionNotOnOrAfter` attribute in the SAML2 AuthnStatement. This attribute contains an
ISO 8601 timestamp value that indicates when to end the user session. When specified this
value overrides the default SAML session timeout of 24 hours.
If the instance has a custom [session duration](../../../administration/settings/account_and_limit_settings.md#session-duration) configured
that is earlier than the `SessionNotOnOrAfter` timestamp, users must re-authenticate
when their GitLab user session ends.
#### Example response
```xml
<saml:AuthnStatement SessionIndex="WDE5aBYjNEj_9IjCFiK0E1YelZT" SessionNotOnOrAfter="2025-08-25T01:23:45.067Z" AuthnInstant="2025-08-24T13:23:45.067Z">
<saml:AuthnContext>
<saml:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:unspecified</saml:AuthnContextClassRef>
</saml:AuthnContext>
</saml:AuthnStatement>
```
### Bypass user email confirmation with verified domains
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238461) in GitLab 15.4.
{{< /history >}}
By default, users provisioned with SAML or SCIM are sent a verification email to verify their identity. Instead, you can
[configure GitLab with a custom domain](../../enterprise_user/_index.md#set-up-a-verified-domain) and GitLab
automatically confirms user accounts. Users still receive an
[enterprise user](../../enterprise_user/_index.md) welcome email. Confirmation is bypassed if both of the following are true:
- The user is provisioned with SAML or SCIM.
- The user has an email address that belongs to the verified domain.
### Disable password authentication for enterprise users
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/373718) in GitLab 17.4.
{{< /history >}}
Prerequisites:
- You must have the Owner role for the group that the enterprise user belongs to.
- Group SSO must be enabled.
You can disable password authentication for all [enterprise users](../../enterprise_user/_index.md) of the group. This also applies to enterprise users who are administrators of the group. Configuring this setting stops enterprise users from changing, resetting, or authenticating with their password. Instead, these users can authenticate with:
- The group SAML IdP for the GitLab web UI.
- A personal access token for the GitLab API and Git with HTTP Basic Authentication unless the group has [disabled personal access tokens for enterprise users](../../profile/personal_access_tokens.md#disable-personal-access-tokens-for-enterprise-users).
To disable password authentication for enterprise users:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Under **Configuration**, select **Disable password authentication for enterprise users**.
1. Select **Save changes**.
### Block user access
To rescind a user's access to the group when only SAML SSO is configured, either:
- Remove (in order) the user from:
1. The user data store on the identity provider or the list of users on the specific app.
1. The GitLab.com group.
- Use [Group Sync](group_sync.md#automatic-member-removal) at the top-level of
your group with the default role set to [minimal access](../../permissions.md#users-with-minimal-access)
to automatically block access to all resources in the group.
To rescind a user's access to the group when also using SCIM, refer to [Remove access](scim_setup.md#remove-access).
### Unlink accounts
Users can unlink SAML for a group from their profile page. This can be helpful if:
- You no longer want a group to be able to sign you in to GitLab.com.
- Your SAML **NameID** has changed and so GitLab can no longer find your user.
{{< alert type="warning" >}}
Unlinking an account removes all roles assigned to that user in the group.
If a user re-links their account, roles need to be reassigned.
{{< /alert >}}
Groups require at least one owner. If your account is the only owner in the
group, you are not allowed to unlink the account. In that case, set up another user as a
group owner, and then you can unlink the account.
For example, to unlink the `MyOrg` account:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Account**.
1. In the **Service sign-in** section, select **Disconnect** next to the connected account.
## SSO enforcement
{{< history >}}
- [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/215155) in GitLab 15.5 [with a flag](../../../administration/feature_flags/_index.md) named `transparent_sso_enforcement` to include transparent enforcement even when SSO enforcement is not enabled. Disabled on GitLab.com.
- [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/375788) in GitLab 15.8 by enabling transparent SSO by default on GitLab.com.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/389562) in GitLab 15.10. Feature flag `transparent_sso_enforcement` removed.
{{< /history >}}
On GitLab.com, SSO is enforced:
- When SAML SSO is enabled.
- For users with an existing SAML identity when accessing groups and projects in the organization's
group hierarchy. By using their GitLab.com credentials, users can view other groups and projects outside their organization, as well as their user settings, without signing in through SAML SSO.
A user has a SAML identity if one or both of the following are true:
- They have signed in to GitLab by using their GitLab group's single sign-on URL.
- They were provisioned by SCIM.
Users are not prompted to sign in through SSO on each visit. GitLab checks
whether a user has authenticated through SSO. If the user last signed in more
than 24 hours ago, GitLab prompts the user to sign in again through SSO.
SSO is enforced as follows:
| Project/Group visibility | Enforce SSO setting | Member with identity | Member without identity | Non-member or not signed in |
|--------------------------|---------------------|----------------------|-------------------------|-----------------------------|
| Private | Off | Enforced | Not enforced | Not enforced |
| Private | On | Enforced | Enforced | Enforced |
| Public | Off | Enforced | Not enforced | Not enforced |
| Public | On | Enforced | Enforced | Not enforced |
An [issue exists](https://gitlab.com/gitlab-org/gitlab/-/issues/297389) to add a similar SSO requirement for API activity. Until this requirement is added, you can use features that rely on APIs without an active SSO session.
### SSO-only for web activity enforcement
When the **Enforce SSO-only authentication for web activity for this group** option is enabled:
- All members must access GitLab by using their GitLab group's single sign-on URL
to access group resources, regardless of whether they have an existing SAML
identity.
- SSO is enforced when users access groups and projects in the organization's
group hierarchy. Users can view other groups and projects outside their organization without signing in through SAML SSO.
- Users cannot be added as new members manually.
- Users with the Owner role can use the standard sign in process to make
necessary changes to top-level group settings.
- For non-members or users who are not signed in:
- SSO is not enforced when they access public group resources.
- SSO is enforced when they access private group resources.
- For items in the organization's group hierarchy, dashboard visibility is as
follows:
- SSO is enforced when viewing your [To-Do List](../../todos.md). Your
to-do items are hidden if your SSO session has expired, and an
[alert is shown](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115254).
- SSO is enforced when viewing your list of assigned issues. Your issues are
hidden if your SSO session has expired.
[Issue 414475](https://gitlab.com/gitlab-org/gitlab/-/issues/414475) proposes to change this
behavior so that issues are visible.
- SSO is not enforced when viewing merge requests where you are the
assignee or reviewer. You can see merge requests even if
your SSO session has expired.
- SSO is not enforced when viewing snippets for private projects where you have at least the Guest role.
SSO enforcement for web activity has the following effects when enabled:
- For groups, users cannot share a project in the group outside the top-level
group, even if the project is forked.
- Git activity originating from CI/CD jobs do not have the SSO check enforced.
- Credentials that are not tied to regular users (for example, project and group
access tokens, service accounts, and deploy keys) do not have the SSO check enforced.
- Users must be signed-in through SSO before they can pull images using the
[Dependency Proxy](../../packages/dependency_proxy/_index.md).
- When the **Enforce SSO-only authentication for Git and Dependency Proxy
activity for this group** option is enabled, any API endpoint that involves
Git activity is under SSO enforcement. For example, creating or deleting a
branch, commit, or tag. For Git activity over SSH and HTTPS, users must
have at least one active session signed-in through SSO before they can push to or
pull from a GitLab repository. The active session can be on a different device.
When SSO for web activity is enforced, non-SSO group members do not lose access
immediately. If the user:
- Has an active session, they can continue accessing the group for up to 24
hours until the identity provider session times out.
- Is signed out, they cannot access the group after being removed from the
identity provider.
## Migrate to a new identity provider
To migrate to a new identity provider, use the [SAML API](../../../api/saml.md) to update all of your group member's identities.
For example:
1. Set a maintenance window to ensure that no users are active at that time.
1. Use the SAML API [to update each user's identity](../../../api/saml.md#update-extern_uid-field-for-a-saml-identity).
1. Configure the new identity provider.
1. Test that sign in works.
## Related topics
- [SAML SSO for GitLab Self-Managed](../../../integration/saml.md)
- [Glossary](../../../integration/saml.md#glossary)
- [Blog post: The ultimate guide to enabling SAML and SSO on GitLab.com](https://about.gitlab.com/blog/2023/09/14/the-ultimate-guide-to-enabling-saml/)
- [Authentication comparison between SaaS and GitLab Self-Managed](../../../administration/auth/_index.md#gitlabcom-compared-to-gitlab-self-managed)
- [Passwords for users created through integrated authentication](../../../security/passwords_for_integrated_authentication_methods.md)
- [SAML Group Sync](group_sync.md)
## Troubleshooting
If you find it difficult to match the different SAML terms between GitLab and the
identity provider:
1. Check your identity provider's documentation. Look at their example SAML
configurations for information on the terms they use.
1. Check the [SAML SSO for GitLab Self-Managed documentation](../../../integration/saml.md).
The GitLab Self-Managed SAML configuration file supports more options
than the GitLab.com file. You can find information on the GitLab Self-Managed instance
file in the:
- External [OmniAuth SAML documentation](https://github.com/omniauth/omniauth-saml/).
- [`ruby-saml` library](https://github.com/onelogin/ruby-saml).
1. Compare the XML response from your provider with our
[example XML used for internal testing](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/spec/fixtures/saml/response.xml).
For other troubleshooting information, see the [troubleshooting SAML guide](troubleshooting.md).
|
https://docs.gitlab.com/user/group/scim_setup
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/scim_setup.md
|
2025-08-13
|
doc/user/group/saml_sso
|
[
"doc",
"user",
"group",
"saml_sso"
] |
scim_setup.md
|
Fulfillment
|
Seat Management
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Configure SCIM for GitLab.com groups
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
You can use the open standard System for Cross-domain Identity Management (SCIM) to automatically:
- Create users.
- Remove users (deactivate SCIM identity).
- Re-add users (reactivate SCIM identity).
GitLab SAML SSO SCIM doesn't support updating users.
When SCIM is enabled for a GitLab group, membership of that group is synchronized between GitLab and an identity provider.
The [internal GitLab group SCIM API](../../../development/internal_api/_index.md#group-scim-api) implements part of [the RFC7644 protocol](https://www.rfc-editor.org/rfc/rfc7644).
Identity providers can use the [internal GitLab group SCIM API](../../../development/internal_api/_index.md#group-scim-api) to develop a SCIM app.
To set up SCIM on GitLab Self-Managed, see [Configure SCIM for GitLab Self-Managed](../../../administration/settings/scim_setup.md).
## Configure GitLab
Prerequisites:
- [Group single sign-on](_index.md) must be configured.
To configure GitLab SAML SSO SCIM:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Select **Generate a SCIM token**.
1. For configuration of your identity provider, save the:
- Token from the **Your SCIM token** field.
- URL from the **SCIM API endpoint URL** field.
## Configure an identity provider
You can configure one of the following as an identity provider:
- [Azure Active Directory](#configure-microsoft-entra-id-formerly-azure-active-directory).
- [Okta](#configure-okta).
{{< alert type="note" >}}
Other providers can work with GitLab but they have not been tested and are not supported. You should contact the provider for support. GitLab support can assist by reviewing related log entries.
{{< /alert >}}
### Configure Microsoft Entra ID (formerly Azure Active Directory)
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/143146) to Microsoft Entra ID terminology in GitLab 16.10.
{{< /history >}}
Prerequisites:
- [GitLab is configured](#configure-gitlab).
- [Group single sign-on](_index.md) is configured.
The SAML application created during [single sign-on](_index.md) set up for
[Azure Active Directory](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/view-applications-portal)
must be set up for SCIM. For an example, see [example configuration](example_saml_config.md#scim-mapping).
{{< alert type="note" >}}
You must configure SCIM provisioning exactly as detailed in the following instructions. If misconfigured, you will encounter issues with user provisioning
and sign in, which require a lot of effort to resolve. If you have any trouble or questions with any step, contact GitLab support.
{{< /alert >}}
To configure Microsoft Entra ID for SCIM:
1. In your app, go to the **Provisioning** tab and select **Get started**.
1. Set the **Provisioning Mode** to **Automatic**.
1. Complete the **Admin Credentials** using the value of:
- **SCIM API endpoint URL** in GitLab for the **Tenant URL** field.
- **Your SCIM token** in GitLab for the **Secret Token** field.
1. Select **Test Connection**. If the test is successful, save your configuration before continuing, or see the
[troubleshooting](troubleshooting.md) information.
1. Select **Save**.
After saving, **Mappings** and **Settings** sections appear.
#### Configure mappings
Under the **Mappings** section, first provision the groups:
1. Select **Provision Microsoft Entra ID Groups**.
1. On the Attribute Mapping page, turn off the **Enabled** toggle. SCIM group provisioning is not supported in
GitLab. Leaving group provisioning enabled does not break the SCIM user provisioning, but it causes errors in the
Entra ID SCIM provisioning log that may be confusing and misleading.
{{< alert type="note" >}}
Even when **Provision Microsoft Entra ID Groups** is disabled, the mappings section may display "Enabled: Yes". This behavior is a display bug that you can safely ignore.
{{< /alert >}}
1. Select **Save**.
Next, provision the users:
1. Select **Provision Microsoft Entra ID Users**.
1. Ensure that the **Enabled** toggle is set to **Yes**.
1. Ensure that all **Target Object Actions** are enabled.
1. Under **Attribute Mappings**, configure mappings to match
the [configured attribute mappings](#configure-attribute-mappings):
1. Optional. In the **customappsso Attribute** column, find `externalId` and delete it.
1. Edit the first attribute to have a:
- **source attribute** of `objectId`
- **target attribute** of `externalId`
- **matching precedence** of `1`
1. Update the existing **customappsso** attributes to match the
[configured attribute mappings](#configure-attribute-mappings).
1. Delete any additional attributes that are not present in the following table. They do not cause problems if they are
not deleted, but GitLab does not consume the attributes.
1. Under the mapping list, select the **Show advanced options** checkbox.
1. Select the **Edit attribute list for customappsso** link.
1. Ensure the `id` is the primary and required field, and `externalId` is also required.
1. Select **Save**, which returns you to the Attribute Mapping configuration page.
1. Close the **Attribute Mapping** configuration page by clicking the `X` in the top right corner.
#### Configure settings
Under the **Settings** section:
1. Optional. If desired, select the **Send an email notification when a failure occurs** checkbox.
1. Optional. If desired, select the **Prevent accidental deletion** checkbox.
1. If necessary, select **Save** to ensure all changes have been saved.
After you have configured the mappings and the settings, return to the app overview page and select **Start provisioning** to start automatic SCIM provisioning of users in GitLab.
{{< alert type="warning" >}}
Once synchronized, changing the field mapped to `id` and `externalId` may cause errors. These include
provisioning errors, duplicate users, and may prevent existing users from accessing the GitLab group.
{{< /alert >}}
#### Configure attribute mappings
{{< alert type="note" >}}
While Microsoft transitions from Azure Active Directory to Entra ID naming schemes, you might notice inconsistencies in
your user interface. If you're having trouble, you can view an older version of this document or contact GitLab Support.
{{< /alert >}}
While [configuring Entra ID for SCIM](#configure-microsoft-entra-id-formerly-azure-active-directory), you configure
attribute mappings. For an example, see [example configuration](example_saml_config.md#scim-mapping).
The following table provides attribute mappings that are required for GitLab.
| Source attribute | Target attribute | Matching precedence |
|:---------------------------------------------------------------------------|:-------------------------------|:--------------------|
| `objectId` | `externalId` | 1 |
| `userPrincipalName` OR `mail` <sup>1</sup> | `emails[type eq "work"].value` | |
| `mailNickname` | `userName` | |
| `displayName` OR `Join(" ", [givenName], [surname])` <sup>2</sup> | `name.formatted` | |
| `Switch([IsSoftDeleted], , "False", "True", "True", "False")` <sup>3</sup> | `active` | |
1. Use `mail` as a source attribute when the `userPrincipalName` is not an email address or is not deliverable.
1. Use the `Join` expression if your `displayName` does not match the format of `Firstname Lastname`.
1. This is an expression mapping type, not a direct mapping. Select `Expression` in the **Mapping type** dropdown list.
Each attribute mapping has:
- A **customappsso Attribute**, which corresponds to **target attribute**.
- A **Microsoft Entra ID Attribute**, which corresponds to **source attribute**.
- A matching precedence.
For each attribute:
1. Edit the existing attribute or add a new attribute.
1. Select the required source and target attribute mappings from the dropdown lists.
1. Select **Ok**.
1. Select **Save**.
If your SAML configuration differs from [the recommended SAML settings](_index.md#azure), select the mapping
attributes and modify them accordingly. The source attribute that you map to the `externalId`
target attribute must match the attribute used for the SAML `NameID`.
If a mapping is not listed in the table, use the Microsoft Entra ID defaults. For a list of required attributes,
refer to the [internal group SCIM API](../../../development/internal_api/_index.md#group-scim-api) documentation.
### Configure Okta
The SAML application created during [single sign-on](_index.md) set up for Okta must be set up for SCIM.
Prerequisites:
- You must use the Okta [Lifecycle Management](https://www.okta.com/products/lifecycle-management/) product. This
product tier is required to use SCIM on Okta.
- [GitLab is configured](#configure-gitlab).
- SAML application for [Okta](https://developer.okta.com/docs/guides/build-sso-integration/saml2/main/) set up as
described in the [Okta setup notes](_index.md#okta).
- Your Okta SAML setup matches the [configuration steps exactly](_index.md), especially the NameID configuration.
To configure Okta for SCIM:
1. Sign in to Okta.
1. In the upper-right corner, select **Admin**. The button is not visible from the **Admin** area.
1. In the **Application** tab, select **Browse App Catalog**.
1. Search for **GitLab**, find and select the **GitLab** application.
1. On the GitLab application overview page, select **Add**.
1. Under **Application Visibility** select both checkboxes. Currently the GitLab application does not support SAML
authentication so the icon should not be shown to users.
1. Select **Done** to finish adding the application.
1. In the **Provisioning** tab, select **Configure API integration**.
1. Select **Enable API integration**.
- For **Base URL**, paste the URL you copied from **SCIM API endpoint URL** on the GitLab SCIM configuration page.
- For **API Token**, paste the SCIM token you copied from **Your SCIM token** on the GitLab SCIM
configuration page.
1. To verify the configuration, select **Test API Credentials**.
1. Select **Save**.
1. After saving the API integration details, new settings tabs appear on the left. Select **To App**.
1. Select **Edit**.
1. Select the **Enable** checkbox for both **Create Users** and **Deactivate Users**.
1. Select **Save**.
1. Assign users in the **Assignments** tab. Assigned users are created and managed in your GitLab group.
## User access
During the synchronization process, all new users:
- Receive GitLab accounts.
- Are welcomed to their groups with an invitation email.
You can [bypass email confirmation with a verified domain](_index.md#bypass-user-email-confirmation-with-verified-domains).
The following diagram describes what happens when you add users to your SCIM app:
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
accTitle: Adding users to your SCIM application
accDescr: How GitLab determines whether or not to associate a SCIM identity with a user.
A[Add User to SCIM app] -->|IdP sends user info to GitLab| B(GitLab: Does the email exist?)
B -->|No| C[GitLab creates user with SCIM identity]
B -->|Yes| D(GitLab: Is the user part of the group?)
D -->|No| E(GitLab: Is SSO enforcement enabled?)
E -->|No| G
E -->|Yes| F[GitLab sends message back:
The member's email address is not linked to a SAML account]
D -->|Yes| G[Associate SCIM identity to user]
```
During provisioning:
- Both primary and secondary emails are considered when checking whether a GitLab user account exists.
- Duplicate usernames are handled by adding suffix `1` when creating the user. For example, if `test_user` already
exists, `test_user1` is used. If `test_user1` already exists, GitLab increments the suffix to find an unused username. If no unused username is found after 4 tries, a random string is attached to the username.
On subsequent visits, new and existing users can access groups either:
- Through the identity provider's dashboard.
- By visiting links directly.
For role information, see the [Group SAML](_index.md#user-access-and-management) page.
### Passwords for users created through SCIM for GitLab groups
GitLab requires passwords for all user accounts. For users created using SCIM provisioning, GitLab automatically
generates a random password, and users do not need to set one during their first sign-in. For more information on how
GitLab generates passwords for users created through SCIM for GitLab groups, see
[generated passwords for users created through integrated authentication](../../../security/passwords_for_integrated_authentication_methods.md).
### Link SCIM and SAML identities
If [group SAML](_index.md) is configured and you have an existing GitLab.com account, users can link their SCIM and SAML
identities. Users should do this before synchronization is turned on because there can be provisioning errors for
existing users when synchronization is active.
To link your SCIM and SAML identities:
1. Update the [primary email](../../profile/_index.md#change-your-primary-email) address in your GitLab.com user account
to match the user profile email address in your identity provider.
1. [Link your SAML identity](_index.md#link-saml-to-your-existing-gitlabcom-account).
### Remove access
Remove or deactivate a user on the identity provider to remove their access to:
- The top-level group.
- All subgroups and projects.
After the identity provider performs a sync based on its configured schedule,
the user's membership is revoked and they lose access.
When you enable SCIM, this does not automatically remove existing users who do
not have a SAML identity.
{{< alert type="note" >}}
Deprovisioning does not delete the GitLab user account.
{{< /alert >}}
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
accTitle: Deprovisioning users
accDescr: How removing users from your SCIM app removes them from GitLab groups.
A[Remove User from SCIM app] -->|IdP sends request to GitLab| B(GitLab: Is the user part of the group?)
B -->|No| C[Nothing to do]
B -->|Yes| D[GitLab removes user from GitLab group]
```
### Reactivate access
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/379149) in GitLab 16.0 [with a flag](../../feature_flags.md) named `skip_saml_identity_destroy_during_scim_deprovision`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121226) in GitLab 16.4. Feature flag `skip_saml_identity_destroy_during_scim_deprovision` removed.
{{< /history >}}
After a user is removed or deactivated through SCIM, you can reactivate that user by
adding them to the SCIM identity provider.
After the identity provider performs a sync based on its configured schedule,
the user's SCIM identity is reactivated and their group memberships are restored.
|
---
stage: Fulfillment
group: Seat Management
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Configure SCIM for GitLab.com groups
breadcrumbs:
- doc
- user
- group
- saml_sso
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
You can use the open standard System for Cross-domain Identity Management (SCIM) to automatically:
- Create users.
- Remove users (deactivate SCIM identity).
- Re-add users (reactivate SCIM identity).
GitLab SAML SSO SCIM doesn't support updating users.
When SCIM is enabled for a GitLab group, membership of that group is synchronized between GitLab and an identity provider.
The [internal GitLab group SCIM API](../../../development/internal_api/_index.md#group-scim-api) implements part of [the RFC7644 protocol](https://www.rfc-editor.org/rfc/rfc7644).
Identity providers can use the [internal GitLab group SCIM API](../../../development/internal_api/_index.md#group-scim-api) to develop a SCIM app.
To set up SCIM on GitLab Self-Managed, see [Configure SCIM for GitLab Self-Managed](../../../administration/settings/scim_setup.md).
## Configure GitLab
Prerequisites:
- [Group single sign-on](_index.md) must be configured.
To configure GitLab SAML SSO SCIM:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > SAML SSO**.
1. Select **Generate a SCIM token**.
1. For configuration of your identity provider, save the:
- Token from the **Your SCIM token** field.
- URL from the **SCIM API endpoint URL** field.
## Configure an identity provider
You can configure one of the following as an identity provider:
- [Azure Active Directory](#configure-microsoft-entra-id-formerly-azure-active-directory).
- [Okta](#configure-okta).
{{< alert type="note" >}}
Other providers can work with GitLab but they have not been tested and are not supported. You should contact the provider for support. GitLab support can assist by reviewing related log entries.
{{< /alert >}}
### Configure Microsoft Entra ID (formerly Azure Active Directory)
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/143146) to Microsoft Entra ID terminology in GitLab 16.10.
{{< /history >}}
Prerequisites:
- [GitLab is configured](#configure-gitlab).
- [Group single sign-on](_index.md) is configured.
The SAML application created during [single sign-on](_index.md) set up for
[Azure Active Directory](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/view-applications-portal)
must be set up for SCIM. For an example, see [example configuration](example_saml_config.md#scim-mapping).
{{< alert type="note" >}}
You must configure SCIM provisioning exactly as detailed in the following instructions. If misconfigured, you will encounter issues with user provisioning
and sign in, which require a lot of effort to resolve. If you have any trouble or questions with any step, contact GitLab support.
{{< /alert >}}
To configure Microsoft Entra ID for SCIM:
1. In your app, go to the **Provisioning** tab and select **Get started**.
1. Set the **Provisioning Mode** to **Automatic**.
1. Complete the **Admin Credentials** using the value of:
- **SCIM API endpoint URL** in GitLab for the **Tenant URL** field.
- **Your SCIM token** in GitLab for the **Secret Token** field.
1. Select **Test Connection**. If the test is successful, save your configuration before continuing, or see the
[troubleshooting](troubleshooting.md) information.
1. Select **Save**.
After saving, **Mappings** and **Settings** sections appear.
#### Configure mappings
Under the **Mappings** section, first provision the groups:
1. Select **Provision Microsoft Entra ID Groups**.
1. On the Attribute Mapping page, turn off the **Enabled** toggle. SCIM group provisioning is not supported in
GitLab. Leaving group provisioning enabled does not break the SCIM user provisioning, but it causes errors in the
Entra ID SCIM provisioning log that may be confusing and misleading.
{{< alert type="note" >}}
Even when **Provision Microsoft Entra ID Groups** is disabled, the mappings section may display "Enabled: Yes". This behavior is a display bug that you can safely ignore.
{{< /alert >}}
1. Select **Save**.
Next, provision the users:
1. Select **Provision Microsoft Entra ID Users**.
1. Ensure that the **Enabled** toggle is set to **Yes**.
1. Ensure that all **Target Object Actions** are enabled.
1. Under **Attribute Mappings**, configure mappings to match
the [configured attribute mappings](#configure-attribute-mappings):
1. Optional. In the **customappsso Attribute** column, find `externalId` and delete it.
1. Edit the first attribute to have a:
- **source attribute** of `objectId`
- **target attribute** of `externalId`
- **matching precedence** of `1`
1. Update the existing **customappsso** attributes to match the
[configured attribute mappings](#configure-attribute-mappings).
1. Delete any additional attributes that are not present in the following table. They do not cause problems if they are
not deleted, but GitLab does not consume the attributes.
1. Under the mapping list, select the **Show advanced options** checkbox.
1. Select the **Edit attribute list for customappsso** link.
1. Ensure the `id` is the primary and required field, and `externalId` is also required.
1. Select **Save**, which returns you to the Attribute Mapping configuration page.
1. Close the **Attribute Mapping** configuration page by clicking the `X` in the top right corner.
#### Configure settings
Under the **Settings** section:
1. Optional. If desired, select the **Send an email notification when a failure occurs** checkbox.
1. Optional. If desired, select the **Prevent accidental deletion** checkbox.
1. If necessary, select **Save** to ensure all changes have been saved.
After you have configured the mappings and the settings, return to the app overview page and select **Start provisioning** to start automatic SCIM provisioning of users in GitLab.
{{< alert type="warning" >}}
Once synchronized, changing the field mapped to `id` and `externalId` may cause errors. These include
provisioning errors, duplicate users, and may prevent existing users from accessing the GitLab group.
{{< /alert >}}
#### Configure attribute mappings
{{< alert type="note" >}}
While Microsoft transitions from Azure Active Directory to Entra ID naming schemes, you might notice inconsistencies in
your user interface. If you're having trouble, you can view an older version of this document or contact GitLab Support.
{{< /alert >}}
While [configuring Entra ID for SCIM](#configure-microsoft-entra-id-formerly-azure-active-directory), you configure
attribute mappings. For an example, see [example configuration](example_saml_config.md#scim-mapping).
The following table provides attribute mappings that are required for GitLab.
| Source attribute | Target attribute | Matching precedence |
|:---------------------------------------------------------------------------|:-------------------------------|:--------------------|
| `objectId` | `externalId` | 1 |
| `userPrincipalName` OR `mail` <sup>1</sup> | `emails[type eq "work"].value` | |
| `mailNickname` | `userName` | |
| `displayName` OR `Join(" ", [givenName], [surname])` <sup>2</sup> | `name.formatted` | |
| `Switch([IsSoftDeleted], , "False", "True", "True", "False")` <sup>3</sup> | `active` | |
1. Use `mail` as a source attribute when the `userPrincipalName` is not an email address or is not deliverable.
1. Use the `Join` expression if your `displayName` does not match the format of `Firstname Lastname`.
1. This is an expression mapping type, not a direct mapping. Select `Expression` in the **Mapping type** dropdown list.
Each attribute mapping has:
- A **customappsso Attribute**, which corresponds to **target attribute**.
- A **Microsoft Entra ID Attribute**, which corresponds to **source attribute**.
- A matching precedence.
For each attribute:
1. Edit the existing attribute or add a new attribute.
1. Select the required source and target attribute mappings from the dropdown lists.
1. Select **Ok**.
1. Select **Save**.
If your SAML configuration differs from [the recommended SAML settings](_index.md#azure), select the mapping
attributes and modify them accordingly. The source attribute that you map to the `externalId`
target attribute must match the attribute used for the SAML `NameID`.
If a mapping is not listed in the table, use the Microsoft Entra ID defaults. For a list of required attributes,
refer to the [internal group SCIM API](../../../development/internal_api/_index.md#group-scim-api) documentation.
### Configure Okta
The SAML application created during [single sign-on](_index.md) set up for Okta must be set up for SCIM.
Prerequisites:
- You must use the Okta [Lifecycle Management](https://www.okta.com/products/lifecycle-management/) product. This
product tier is required to use SCIM on Okta.
- [GitLab is configured](#configure-gitlab).
- SAML application for [Okta](https://developer.okta.com/docs/guides/build-sso-integration/saml2/main/) set up as
described in the [Okta setup notes](_index.md#okta).
- Your Okta SAML setup matches the [configuration steps exactly](_index.md), especially the NameID configuration.
To configure Okta for SCIM:
1. Sign in to Okta.
1. In the upper-right corner, select **Admin**. The button is not visible from the **Admin** area.
1. In the **Application** tab, select **Browse App Catalog**.
1. Search for **GitLab**, find and select the **GitLab** application.
1. On the GitLab application overview page, select **Add**.
1. Under **Application Visibility** select both checkboxes. Currently the GitLab application does not support SAML
authentication so the icon should not be shown to users.
1. Select **Done** to finish adding the application.
1. In the **Provisioning** tab, select **Configure API integration**.
1. Select **Enable API integration**.
- For **Base URL**, paste the URL you copied from **SCIM API endpoint URL** on the GitLab SCIM configuration page.
- For **API Token**, paste the SCIM token you copied from **Your SCIM token** on the GitLab SCIM
configuration page.
1. To verify the configuration, select **Test API Credentials**.
1. Select **Save**.
1. After saving the API integration details, new settings tabs appear on the left. Select **To App**.
1. Select **Edit**.
1. Select the **Enable** checkbox for both **Create Users** and **Deactivate Users**.
1. Select **Save**.
1. Assign users in the **Assignments** tab. Assigned users are created and managed in your GitLab group.
## User access
During the synchronization process, all new users:
- Receive GitLab accounts.
- Are welcomed to their groups with an invitation email.
You can [bypass email confirmation with a verified domain](_index.md#bypass-user-email-confirmation-with-verified-domains).
The following diagram describes what happens when you add users to your SCIM app:
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
accTitle: Adding users to your SCIM application
accDescr: How GitLab determines whether or not to associate a SCIM identity with a user.
A[Add User to SCIM app] -->|IdP sends user info to GitLab| B(GitLab: Does the email exist?)
B -->|No| C[GitLab creates user with SCIM identity]
B -->|Yes| D(GitLab: Is the user part of the group?)
D -->|No| E(GitLab: Is SSO enforcement enabled?)
E -->|No| G
E -->|Yes| F[GitLab sends message back:
The member's email address is not linked to a SAML account]
D -->|Yes| G[Associate SCIM identity to user]
```
During provisioning:
- Both primary and secondary emails are considered when checking whether a GitLab user account exists.
- Duplicate usernames are handled by adding suffix `1` when creating the user. For example, if `test_user` already
exists, `test_user1` is used. If `test_user1` already exists, GitLab increments the suffix to find an unused username. If no unused username is found after 4 tries, a random string is attached to the username.
On subsequent visits, new and existing users can access groups either:
- Through the identity provider's dashboard.
- By visiting links directly.
For role information, see the [Group SAML](_index.md#user-access-and-management) page.
### Passwords for users created through SCIM for GitLab groups
GitLab requires passwords for all user accounts. For users created using SCIM provisioning, GitLab automatically
generates a random password, and users do not need to set one during their first sign-in. For more information on how
GitLab generates passwords for users created through SCIM for GitLab groups, see
[generated passwords for users created through integrated authentication](../../../security/passwords_for_integrated_authentication_methods.md).
### Link SCIM and SAML identities
If [group SAML](_index.md) is configured and you have an existing GitLab.com account, users can link their SCIM and SAML
identities. Users should do this before synchronization is turned on because there can be provisioning errors for
existing users when synchronization is active.
To link your SCIM and SAML identities:
1. Update the [primary email](../../profile/_index.md#change-your-primary-email) address in your GitLab.com user account
to match the user profile email address in your identity provider.
1. [Link your SAML identity](_index.md#link-saml-to-your-existing-gitlabcom-account).
### Remove access
Remove or deactivate a user on the identity provider to remove their access to:
- The top-level group.
- All subgroups and projects.
After the identity provider performs a sync based on its configured schedule,
the user's membership is revoked and they lose access.
When you enable SCIM, this does not automatically remove existing users who do
not have a SAML identity.
{{< alert type="note" >}}
Deprovisioning does not delete the GitLab user account.
{{< /alert >}}
```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
accTitle: Deprovisioning users
accDescr: How removing users from your SCIM app removes them from GitLab groups.
A[Remove User from SCIM app] -->|IdP sends request to GitLab| B(GitLab: Is the user part of the group?)
B -->|No| C[Nothing to do]
B -->|Yes| D[GitLab removes user from GitLab group]
```
### Reactivate access
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/379149) in GitLab 16.0 [with a flag](../../feature_flags.md) named `skip_saml_identity_destroy_during_scim_deprovision`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121226) in GitLab 16.4. Feature flag `skip_saml_identity_destroy_during_scim_deprovision` removed.
{{< /history >}}
After a user is removed or deactivated through SCIM, you can reactivate that user by
adding them to the SCIM identity provider.
After the identity provider performs a sync based on its configured schedule,
the user's SCIM identity is reactivated and their group memberships are restored.
|
https://docs.gitlab.com/user/group/troubleshooting_scim
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/troubleshooting_scim.md
|
2025-08-13
|
doc/user/group/saml_sso
|
[
"doc",
"user",
"group",
"saml_sso"
] |
troubleshooting_scim.md
|
Fulfillment
|
Seat Management
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Troubleshooting SCIM
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This section contains possible solutions for problems you might encounter.
## User cannot be added after they are removed
When you remove a user, they are removed from the group but their account is not deleted
(see [remove access](scim_setup.md#remove-access)).
When the user is added back to the SCIM app, GitLab does not create a new user because the user already exists.
From August 11, 2023, the `skip_saml_identity_destroy_during_scim_deprovision` feature flag is enabled.
For a user de-provisioned by SCIM from that date, their SAML identity is not removed.
When that user is added back to the SCIM app:
- Their SCIM identity `active` attribute is set to `true`.
- They can sign in using SSO.
For users de-provisioned by SCIM before that date, their SAML identity is destroyed.
To solve this problem, the user must [link SAML to their existing GitLab.com account](_index.md#link-saml-to-your-existing-gitlabcom-account).
### GitLab Self-Managed
For GitLab Self-Managed, administrators of that instance can instead [add the user identity themselves](../../../administration/admin_area.md#user-identities). This might save time if administrators need to re-add multiple identities.
## User cannot sign in
The following are possible solutions for problems where users cannot sign in:
- Ensure that the user was added to the SCIM app.
- If you receive the `User is not linked to a SAML account` error, the user probably already exists in GitLab. Have the
user follow the [Link SCIM and SAML identities](scim_setup.md#link-scim-and-saml-identities) instructions.
Alternatively, self-managed administrators can [add a user identity](../../../administration/admin_area.md#user-identities).
- The **Identity** (`extern_uid`) value stored by GitLab is updated by SCIM whenever `id` or `externalId` changes. Users
cannot sign in unless the GitLab identifier (`extern_uid`) of the sign-in method matches the ID sent by the provider, such as
the `NameId` sent by SAML. This value is also used by SCIM to match users on the `id`, and is updated by SCIM whenever the `id` or `externalId` values change.
- On GitLab.com, the SCIM `id` and SCIM `externalId` must be configured to the same value as the SAML `NameId`. You can trace SAML responses
using [debugging tools](troubleshooting.md#saml-debugging-tools), and check any errors against the
[SAML troubleshooting](troubleshooting.md) information.
## Unsure if user's SAML `NameId` matches the SCIM `externalId`
To check if a user's SAML `NameId` matches their SCIM `externalId`:
- Administrators can use the **Admin** area to [list SCIM identities for a user](../../../administration/admin_area.md#user-identities).
- Group owners can see the list of users and the identifier stored for each user in the group SAML SSO Settings page.
- You can use the [SCIM API](../../../api/scim.md) to manually retrieve the `extern_uid` GitLab has stored for users and compare the value for each user from the [SAML API](../../../api/saml.md) .
- Have the user use a [SAML Tracer](troubleshooting.md#saml-debugging-tools) and compare the `extern_uid` to
the value returned as the SAML `NameId`.
## Mismatched SCIM `extern_uid` and SAML `NameId`
Whether the value was changed or you need to map to a different field, the following must map to the same field:
- `extern_Id`
- `NameId`
If the SCIM `extern_uid` does not match the SAML `NameId`, you must update the SCIM `extern_uid` to enable the user to sign in.
Be cautious if you revise the fields used by your SCIM identity provider, typically `extern_Id`.
Your identity provider should be configured to do this update.
In some cases the identity provider cannot do the update, for example when a user lookup fails.
GitLab uses these IDs to look up users.
If the identity provider does not know the current values for these fields,
that provider may create duplicate users, or fail to complete expected actions.
To change the identifier values to match, you can do one of the following:
- Have users unlink and relink themselves, based on the
[SAML authentication failed: User has already been taken](troubleshooting.md#message-saml-authentication-failed-user-has-already-been-taken)
section.
- Unlink all users simultaneously by removing all users from the SCIM app while provisioning is turned on.
{{< alert type="warning" >}}
This resets all users' roles in the top-level group and subgroups to the [configured default membership role](_index.md#configure-gitlab).
{{< /alert >}}
- Use the [SAML API](../../../api/saml.md) or [SCIM API](../../../api/scim.md) to manually correct the `extern_uid` stored for users to match the SAML
`NameId` or SCIM `externalId`.
You must not:
- Update these to incorrect values because this causes users to be unable to sign in.
- Assign a value to the wrong user because this causes users to be signed in to the wrong account.
Additionally, the user's primary email must match the email in your SCIM identity provider.
## Change SCIM app
When the SCIM app changes:
- Users can follow the instructions in the [Change the SAML app](_index.md#change-the-identity-provider) section.
- Administrators of the identity provider can:
1. Remove users from the SCIM app, which:
- In GitLab.com, removes all removed users from the group.
- In GitLab Self-Managed, blocks users.
1. Turn on sync for the new SCIM app to [link existing users](scim_setup.md#link-scim-and-saml-identities).
## SCIM app returns `"User has already been taken","status":409` error
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
Changing the SAML or SCIM configuration or provider can cause the following problems:
- SAML and SCIM identity mismatch. To solve this problem:
1. [Verify that the user's SAML `NameId` matches the SCIM `extern_uid`](#unsure-if-users-saml-nameid-matches-the-scim-externalid).
1. [Update or fix the mismatched SCIM `extern_uid` and SAML `NameId`](#mismatched-scim-extern_uid-and-saml-nameid).
- SCIM identity mismatch between GitLab and the identity provider SCIM app. To solve this problem:
1. Use the [SCIM API](../../../api/scim.md), which displays the user's `extern_uid` stored in GitLab and compares it with the user `externalId` in
the SCIM app.
1. Use the same SCIM API to update the SCIM `extern_uid` for the user on GitLab.com.
## The member's email address is not allowed for this group
SCIM provisioning may fail with HTTP status `412` and the following error message:
```plaintext
The member's email address is not allowed for this group. Check with your administrator.
```
This error occurs when both of the following are true:
- [Restrict group access by domain](../access_and_permissions.md) is configured
for the group.
- The user account being provisioned has an email domain that is not allowed.
To resolve this issue, you can do either of the following:
- Add the user account's email domain to the list of allowed domains.
- Disable the [Restrict group access by domain](../access_and_permissions.md)
feature by removing all domains.
## Search Rails logs for SCIM requests
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
GitLab.com administrators can search for SCIM requests in the `api_json.log` using the `pubsub-rails-inf-gprd-*` index in
Kibana. Use the following filters based
on the internal [group SCIM API](../../../development/internal_api/_index.md#group-scim-api):
- `json.path`: `/scim/v2/groups/<group-path>`
- `json.params.value`: `<externalId>`
In a relevant log entry, the `json.params.value` shows the values of SCIM parameters GitLab receives. Use these values
to verify if SCIM parameters configured in an identity provider's SCIM app are communicated to GitLab as intended.
For example, use these values as a definitive source on why an account was provisioned with a certain set of
details. This information can help where an account was SCIM provisioned with details that do not match
the SCIM app configuration.
## Member's email address is not linked error in SCIM log
When you attempt to provision a SCIM user on GitLab.com, GitLab checks to see if
a user with that email address already exists. You might see the following error
when the:
- User exists, but does not have a SAML identity linked.
- User exists, has a SAML identity, **and** has a SCIM identity that is set to `active: false`.
- User exists, but is not a member of the associated top-level group and SAML SSO enforcement is enabled.
```plaintext
The member's email address is not linked to a SAML account or has an inactive
SCIM identity.
```
This error message is returned with the status `412`.
This might prevent the affected end user from accessing their account correctly.
The first workaround is:
1. Have the end user [link SAML to their existing GitLab.com account](_index.md#link-saml-to-your-existing-gitlabcom-account).
1. After the user has done this, initiate a SCIM sync from your identity provider.
If the SCIM sync completes without the same error, GitLab has
successfully linked the SCIM identity to the existing user account, and the user
should now be able to sign in using SAML SSO.
If the error persists, the user most likely already exists, has both a SAML and
SCIM identity, and a SCIM identity that is set to `active: false`. To resolve
this:
1. Optional. If you did not save your SCIM token when you first configured SCIM, [generate a new token](scim_setup.md#configure-gitlab). If you generate a new SCIM token, you **must** update the token in your identity provider's SCIM configuration, or SCIM will stop working.
1. Locate your SCIM token.
1. Use the API to [get a single SCIM provisioned user](../../../development/internal_api/_index.md#get-a-single-scim-provisioned-user).
1. Check the returned information to make sure that:
- The user's identifier (`id`) and email match what your identity provider is sending.
- `active` is set to `false`.
If any of this information does not match, [contact GitLab Support](https://support.gitlab.com/).
1. Use the API to [update the SCIM provisioned user's `active` value to `true`](../../../development/internal_api/_index.md#update-a-single-scim-provisioned-user).
1. If the update returns a status code `204`, have the user attempt to sign in
using SAML SSO.
## Azure Active Directory
The following troubleshooting information is specifically for SCIM provisioned through Azure Active Directory.
### Verify my SCIM configuration is correct
Ensure that:
- The matching precedence for `externalId` is 1.
- The SCIM value for `externalId` matches the SAML value for `NameId`.
Review the following SCIM parameters for sensible values:
- `userName`
- `displayName`
- `emails[type eq "work"].value`
### `invalid credentials` error when testing connection
When testing the connection, you may encounter an error:
```plaintext
You appear to have entered invalid credentials. Please confirm
you are using the correct information for an administrative account
```
If `Tenant URL` and `secret token` are correct, check whether your group path contains characters that may be considered
invalid JSON primitives (such as `.`). Removing or URL encoding these characters in the group path typically resolves the error.
### `(Field) can't be blank` sync error
When checking the audit events for the provisioning, you sometimes see a
`Namespace can't be blank, Name can't be blank, and User can't be blank.` error.
This error can occur because not all required fields (such as first name and last name) are present for all users
being mapped.
As a workaround, try an alternate mapping:
1. Follow the [Azure mapping instructions](scim_setup.md#configure-attribute-mappings).
1. Delete the `name.formatted` target attribute entry.
1. Change the `displayName` source attribute to have `name.formatted` target attribute.
### `Failed to match an entry in the source and target systems Group 'Group-Name'` error
Group provisioning in Azure can fail with the `Failed to match an entry in the source and target systems Group 'Group-Name'`
error. The error response can include a HTML result of the GitLab URL `https://gitlab.com/users/sign_in`.
This error is harmless and occurs because group provisioning was turned on but GitLab SCIM integration does not support
it nor require it. To remove the error, follow the instructions in the Azure configuration guide to disable the option
to [synchronize Azure Active Directory groups to AppName](scim_setup.md#configure-microsoft-entra-id-formerly-azure-active-directory).
## Okta
The following troubleshooting information is specifically for SCIM provisioned through Okta.
### `Error authenticating: null` message when testing API SCIM credentials
When testing the API credentials in your Okta SCIM application, you may encounter an error:
```plaintext
Error authenticating: null
```
Okta needs to be able to connect to your GitLab instance to provision or deprovision users.
In your Okta SCIM application, check that the SCIM **Base URL** is correct and pointing to a valid GitLab
SCIM API endpoint URL. Check the following documentation to find information on this URL for:
- [GitLab.com groups](scim_setup.md#configure-gitlab).
- [GitLab Self-Managed](../../../administration/settings/scim_setup.md#configure-gitlab).
For GitLab Self-Managed, ensure your instance is publicly available so Okta can connect to it. If needed,
you can [allow access to Okta IP addresses](https://help.okta.com/en-us/Content/Topics/Security/ip-address-allow-listing.htm)
on your firewall.
|
---
stage: Fulfillment
group: Seat Management
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting SCIM
breadcrumbs:
- doc
- user
- group
- saml_sso
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This section contains possible solutions for problems you might encounter.
## User cannot be added after they are removed
When you remove a user, they are removed from the group but their account is not deleted
(see [remove access](scim_setup.md#remove-access)).
When the user is added back to the SCIM app, GitLab does not create a new user because the user already exists.
From August 11, 2023, the `skip_saml_identity_destroy_during_scim_deprovision` feature flag is enabled.
For a user de-provisioned by SCIM from that date, their SAML identity is not removed.
When that user is added back to the SCIM app:
- Their SCIM identity `active` attribute is set to `true`.
- They can sign in using SSO.
For users de-provisioned by SCIM before that date, their SAML identity is destroyed.
To solve this problem, the user must [link SAML to their existing GitLab.com account](_index.md#link-saml-to-your-existing-gitlabcom-account).
### GitLab Self-Managed
For GitLab Self-Managed, administrators of that instance can instead [add the user identity themselves](../../../administration/admin_area.md#user-identities). This might save time if administrators need to re-add multiple identities.
## User cannot sign in
The following are possible solutions for problems where users cannot sign in:
- Ensure that the user was added to the SCIM app.
- If you receive the `User is not linked to a SAML account` error, the user probably already exists in GitLab. Have the
user follow the [Link SCIM and SAML identities](scim_setup.md#link-scim-and-saml-identities) instructions.
Alternatively, self-managed administrators can [add a user identity](../../../administration/admin_area.md#user-identities).
- The **Identity** (`extern_uid`) value stored by GitLab is updated by SCIM whenever `id` or `externalId` changes. Users
cannot sign in unless the GitLab identifier (`extern_uid`) of the sign-in method matches the ID sent by the provider, such as
the `NameId` sent by SAML. This value is also used by SCIM to match users on the `id`, and is updated by SCIM whenever the `id` or `externalId` values change.
- On GitLab.com, the SCIM `id` and SCIM `externalId` must be configured to the same value as the SAML `NameId`. You can trace SAML responses
using [debugging tools](troubleshooting.md#saml-debugging-tools), and check any errors against the
[SAML troubleshooting](troubleshooting.md) information.
## Unsure if user's SAML `NameId` matches the SCIM `externalId`
To check if a user's SAML `NameId` matches their SCIM `externalId`:
- Administrators can use the **Admin** area to [list SCIM identities for a user](../../../administration/admin_area.md#user-identities).
- Group owners can see the list of users and the identifier stored for each user in the group SAML SSO Settings page.
- You can use the [SCIM API](../../../api/scim.md) to manually retrieve the `extern_uid` GitLab has stored for users and compare the value for each user from the [SAML API](../../../api/saml.md) .
- Have the user use a [SAML Tracer](troubleshooting.md#saml-debugging-tools) and compare the `extern_uid` to
the value returned as the SAML `NameId`.
## Mismatched SCIM `extern_uid` and SAML `NameId`
Whether the value was changed or you need to map to a different field, the following must map to the same field:
- `extern_Id`
- `NameId`
If the SCIM `extern_uid` does not match the SAML `NameId`, you must update the SCIM `extern_uid` to enable the user to sign in.
Be cautious if you revise the fields used by your SCIM identity provider, typically `extern_Id`.
Your identity provider should be configured to do this update.
In some cases the identity provider cannot do the update, for example when a user lookup fails.
GitLab uses these IDs to look up users.
If the identity provider does not know the current values for these fields,
that provider may create duplicate users, or fail to complete expected actions.
To change the identifier values to match, you can do one of the following:
- Have users unlink and relink themselves, based on the
[SAML authentication failed: User has already been taken](troubleshooting.md#message-saml-authentication-failed-user-has-already-been-taken)
section.
- Unlink all users simultaneously by removing all users from the SCIM app while provisioning is turned on.
{{< alert type="warning" >}}
This resets all users' roles in the top-level group and subgroups to the [configured default membership role](_index.md#configure-gitlab).
{{< /alert >}}
- Use the [SAML API](../../../api/saml.md) or [SCIM API](../../../api/scim.md) to manually correct the `extern_uid` stored for users to match the SAML
`NameId` or SCIM `externalId`.
You must not:
- Update these to incorrect values because this causes users to be unable to sign in.
- Assign a value to the wrong user because this causes users to be signed in to the wrong account.
Additionally, the user's primary email must match the email in your SCIM identity provider.
## Change SCIM app
When the SCIM app changes:
- Users can follow the instructions in the [Change the SAML app](_index.md#change-the-identity-provider) section.
- Administrators of the identity provider can:
1. Remove users from the SCIM app, which:
- In GitLab.com, removes all removed users from the group.
- In GitLab Self-Managed, blocks users.
1. Turn on sync for the new SCIM app to [link existing users](scim_setup.md#link-scim-and-saml-identities).
## SCIM app returns `"User has already been taken","status":409` error
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
Changing the SAML or SCIM configuration or provider can cause the following problems:
- SAML and SCIM identity mismatch. To solve this problem:
1. [Verify that the user's SAML `NameId` matches the SCIM `extern_uid`](#unsure-if-users-saml-nameid-matches-the-scim-externalid).
1. [Update or fix the mismatched SCIM `extern_uid` and SAML `NameId`](#mismatched-scim-extern_uid-and-saml-nameid).
- SCIM identity mismatch between GitLab and the identity provider SCIM app. To solve this problem:
1. Use the [SCIM API](../../../api/scim.md), which displays the user's `extern_uid` stored in GitLab and compares it with the user `externalId` in
the SCIM app.
1. Use the same SCIM API to update the SCIM `extern_uid` for the user on GitLab.com.
## The member's email address is not allowed for this group
SCIM provisioning may fail with HTTP status `412` and the following error message:
```plaintext
The member's email address is not allowed for this group. Check with your administrator.
```
This error occurs when both of the following are true:
- [Restrict group access by domain](../access_and_permissions.md) is configured
for the group.
- The user account being provisioned has an email domain that is not allowed.
To resolve this issue, you can do either of the following:
- Add the user account's email domain to the list of allowed domains.
- Disable the [Restrict group access by domain](../access_and_permissions.md)
feature by removing all domains.
## Search Rails logs for SCIM requests
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
GitLab.com administrators can search for SCIM requests in the `api_json.log` using the `pubsub-rails-inf-gprd-*` index in
Kibana. Use the following filters based
on the internal [group SCIM API](../../../development/internal_api/_index.md#group-scim-api):
- `json.path`: `/scim/v2/groups/<group-path>`
- `json.params.value`: `<externalId>`
In a relevant log entry, the `json.params.value` shows the values of SCIM parameters GitLab receives. Use these values
to verify if SCIM parameters configured in an identity provider's SCIM app are communicated to GitLab as intended.
For example, use these values as a definitive source on why an account was provisioned with a certain set of
details. This information can help where an account was SCIM provisioned with details that do not match
the SCIM app configuration.
## Member's email address is not linked error in SCIM log
When you attempt to provision a SCIM user on GitLab.com, GitLab checks to see if
a user with that email address already exists. You might see the following error
when the:
- User exists, but does not have a SAML identity linked.
- User exists, has a SAML identity, **and** has a SCIM identity that is set to `active: false`.
- User exists, but is not a member of the associated top-level group and SAML SSO enforcement is enabled.
```plaintext
The member's email address is not linked to a SAML account or has an inactive
SCIM identity.
```
This error message is returned with the status `412`.
This might prevent the affected end user from accessing their account correctly.
The first workaround is:
1. Have the end user [link SAML to their existing GitLab.com account](_index.md#link-saml-to-your-existing-gitlabcom-account).
1. After the user has done this, initiate a SCIM sync from your identity provider.
If the SCIM sync completes without the same error, GitLab has
successfully linked the SCIM identity to the existing user account, and the user
should now be able to sign in using SAML SSO.
If the error persists, the user most likely already exists, has both a SAML and
SCIM identity, and a SCIM identity that is set to `active: false`. To resolve
this:
1. Optional. If you did not save your SCIM token when you first configured SCIM, [generate a new token](scim_setup.md#configure-gitlab). If you generate a new SCIM token, you **must** update the token in your identity provider's SCIM configuration, or SCIM will stop working.
1. Locate your SCIM token.
1. Use the API to [get a single SCIM provisioned user](../../../development/internal_api/_index.md#get-a-single-scim-provisioned-user).
1. Check the returned information to make sure that:
- The user's identifier (`id`) and email match what your identity provider is sending.
- `active` is set to `false`.
If any of this information does not match, [contact GitLab Support](https://support.gitlab.com/).
1. Use the API to [update the SCIM provisioned user's `active` value to `true`](../../../development/internal_api/_index.md#update-a-single-scim-provisioned-user).
1. If the update returns a status code `204`, have the user attempt to sign in
using SAML SSO.
## Azure Active Directory
The following troubleshooting information is specifically for SCIM provisioned through Azure Active Directory.
### Verify my SCIM configuration is correct
Ensure that:
- The matching precedence for `externalId` is 1.
- The SCIM value for `externalId` matches the SAML value for `NameId`.
Review the following SCIM parameters for sensible values:
- `userName`
- `displayName`
- `emails[type eq "work"].value`
### `invalid credentials` error when testing connection
When testing the connection, you may encounter an error:
```plaintext
You appear to have entered invalid credentials. Please confirm
you are using the correct information for an administrative account
```
If `Tenant URL` and `secret token` are correct, check whether your group path contains characters that may be considered
invalid JSON primitives (such as `.`). Removing or URL encoding these characters in the group path typically resolves the error.
### `(Field) can't be blank` sync error
When checking the audit events for the provisioning, you sometimes see a
`Namespace can't be blank, Name can't be blank, and User can't be blank.` error.
This error can occur because not all required fields (such as first name and last name) are present for all users
being mapped.
As a workaround, try an alternate mapping:
1. Follow the [Azure mapping instructions](scim_setup.md#configure-attribute-mappings).
1. Delete the `name.formatted` target attribute entry.
1. Change the `displayName` source attribute to have `name.formatted` target attribute.
### `Failed to match an entry in the source and target systems Group 'Group-Name'` error
Group provisioning in Azure can fail with the `Failed to match an entry in the source and target systems Group 'Group-Name'`
error. The error response can include a HTML result of the GitLab URL `https://gitlab.com/users/sign_in`.
This error is harmless and occurs because group provisioning was turned on but GitLab SCIM integration does not support
it nor require it. To remove the error, follow the instructions in the Azure configuration guide to disable the option
to [synchronize Azure Active Directory groups to AppName](scim_setup.md#configure-microsoft-entra-id-formerly-azure-active-directory).
## Okta
The following troubleshooting information is specifically for SCIM provisioned through Okta.
### `Error authenticating: null` message when testing API SCIM credentials
When testing the API credentials in your Okta SCIM application, you may encounter an error:
```plaintext
Error authenticating: null
```
Okta needs to be able to connect to your GitLab instance to provision or deprovision users.
In your Okta SCIM application, check that the SCIM **Base URL** is correct and pointing to a valid GitLab
SCIM API endpoint URL. Check the following documentation to find information on this URL for:
- [GitLab.com groups](scim_setup.md#configure-gitlab).
- [GitLab Self-Managed](../../../administration/settings/scim_setup.md#configure-gitlab).
For GitLab Self-Managed, ensure your instance is publicly available so Okta can connect to it. If needed,
you can [allow access to Okta IP addresses](https://help.okta.com/en-us/Content/Topics/Security/ip-address-allow-listing.htm)
on your firewall.
|
https://docs.gitlab.com/user/group/troubleshooting
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/troubleshooting.md
|
2025-08-13
|
doc/user/group/saml_sso
|
[
"doc",
"user",
"group",
"saml_sso"
] |
troubleshooting.md
|
Software Supply Chain Security
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Troubleshooting SAML
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This page contains possible solutions for problems you might encounter when using:
- [SAML SSO for GitLab.com groups](_index.md).
- The GitLab Self-Managed instance-level [SAML OmniAuth Provider](../../../integration/saml.md).
- [Switchboard](../../../administration/dedicated/configure_instance/authentication/saml.md#add-a-saml-provider-with-switchboard) to configure SAML for GitLab Dedicated instances.
## SAML debugging tools
SAML responses are base64 encoded. To decode them on the fly you can use the **SAML-tracer** browser extension ([Firefox](https://addons.mozilla.org/en-US/firefox/addon/saml-tracer/), [Chrome](https://chromewebstore.google.com/detail/saml-tracer/mpdajninpobndbfcldcmbpnnbhibjmch?hl=en)).
If you cannot install a browser plugin, you can [manually generate and capture a SAML response](#manually-generate-a-saml-response) instead.
Pay specific attention to:
- The `NameID`, which we use to identify which user is signing in. If the user has previously signed in, this
[must match the value we have stored](#verify-nameid).
- The presence of a `X509Certificate`, which we require to verify the response signature.
- The `SubjectConfirmation` and `Conditions`, which can cause errors if misconfigured.
### Generate a SAML response
Use SAML responses to preview the attribute names and values sent in the assertions list while attempting to sign in
using an identity provider.
To generate a SAML Response:
1. Install one of the [browser debugging tools](#saml-debugging-tools).
1. Open a new browser tab.
1. Open the SAML tracer console:
- Chrome: On a context menu on the page, select **Inspect**, then select the **SAML** tab in the developer console.
- Firefox: Select the SAML-tracer icon located on the browser toolbar.
1. For GitLab.com Groups:
- Go to the GitLab single sign-on URL for the group.
- Select **Authorize** or attempt to sign
1. For GitLab Self-Managed instance:
- Go to the instance home page
- Click on the `SAML Login` button to sign in
1. A SAML response is displayed in the tracer console that resembles this
[example SAML response](_index.md#example-saml-response).
1. Within the SAML tracer, select the **Export** icon to save the response in JSON format.
#### Manually generate a SAML response
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For an overview, see this [video on manually generating a SAML response without using a browser plugin (using Google Chrome)](https://youtu.be/umMPj6ohF_I), uploaded by GitLab Support.
<!-- Video published on 2024-09-09 -->
Regardless of what browser you use, the process is similar to the following:
1. Right-click on a new browser and click on **Inspect** to open the **DevTools** window.
1. Select the **Network** tab. Make sure that **Preserve log** is selected.
1. Switch to the browser page and sign in to GitLab using SAML SSO.
1. Switch back to the **DevTools** window and filter for the `callback` event.
1. Select the **Payload** tab for the callback event and right-click to copy the value.
1. Paste this value into the following command: `echo "<value>" | base64 --decode > saml_response.xml`.
1. Open `saml_response.xml` in a code editor.
If you have an XML "prettifier" installed in your code editor, you should be able to automatically
format the response to be easier to read.
## Search Rails logs for a SAML sign-in
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
You can find detailed information about a SAML sign-in in the [`audit_json.log` file](../../../administration/logs/_index.md#audit_jsonlog).
For example, by searching for `system_access`, you can find entries that show when a user signed into GitLab using SAML:
```json
{
"severity": "INFO",
"time": "2024-08-13T06:05:35.721Z",
"correlation_id": "01J555EZK136DQ8S7P32G9GEND",
"meta.caller_id": "OmniauthCallbacksController#saml",
"meta.remote_ip": "45.87.213.198",
"meta.feature_category": "system_access",
"meta.user": "bbtest",
"meta.user_id": 16,
"meta.client_id": "user/16",
"author_id": 16,
"author_name": "bbtest@agounder.onmicrosoft.com",
"entity_id": 16,
"entity_type": "User",
"created_at": "2024-08-13T06:05:35.708+00:00",
"ip_address": "45.87.213.198",
"with": "saml",
"target_id": 16,
"target_type": "User",
"target_details": "bbtest@agounder.onmicrosoft.com",
"entity_path": "bbtest"
}
```
If you have configured SAML Group Links, the log also shows entries detailing membership being removed:
```json
{
"severity": "INFO",
"time": "2024-08-13T05:24:07.769Z",
"correlation_id": "01J55330SRTKTD5CHMS96DNZEN",
"meta.caller_id": "Auth::SamlGroupSyncWorker",
"meta.remote_ip": "45.87.213.206",
"meta.feature_category": "system_access",
"meta.client_id": "ip/45.87.213.206",
"meta.root_caller_id": "OmniauthCallbacksController#saml",
"id": 179,
"author_id": 6,
"entity_id": 2,
"entity_type": "Group",
"details": {
"remove": "user_access",
"member_id": 7,
"author_name": "BB Test",
"author_class": "User",
"target_id": 6,
"target_type": "User",
"target_details": "BB Test",
"custom_message": "Membership destroyed",
"ip_address": "45.87.213.198",
"entity_path": "group1"
},
```
You can also see details of the user that GitLab received from the SAML provider in `auth_json.log`, for example:
```json
{
"severity": "INFO",
"time": "2024-08-20T07:01:20.979Z",
"correlation_id": "01J5Q9E59X4P40ZT3MCE35C2A9",
"meta.caller_id": "OmniauthCallbacksController#saml",
"meta.remote_ip": "xxx.xxx.xxx.xxx",
"meta.feature_category": "system_access",
"meta.client_id": "ip/xxx.xxx.xxx.xxx",
"payload_type": "saml_response",
"saml_response": {
"issuer": [
"https://sts.windows.net/03b8c6c5-104b-43e2-aed3-abb07df387cc/"
],
"name_id": "ab260d59-0317-47f5-9afb-885c7a1257ab",
"name_id_format": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
"name_id_spnamequalifier": null,
"name_id_namequalifier": null,
"destination": "https://dh-gitlab.agounder.com/users/auth/saml/callback",
"audiences": [
"https://dh-gitlab.agounder.com/16.11.6"
],
"attributes": {
"http://schemas.microsoft.com/identity/claims/tenantid": [
"03b8c6c5-104b-43e2-aed3-abb07df387cc"
],
"http://schemas.microsoft.com/identity/claims/objectidentifier": [
"ab260d59-0317-47f5-9afb-885c7a1257ab"
],
"http://schemas.microsoft.com/identity/claims/identityprovider": [
"https://sts.windows.net/03b8c6c5-104b-43e2-aed3-abb07df387cc/"
],
"http://schemas.microsoft.com/claims/authnmethodsreferences": [
"http://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/password"
],
"email": [
"bbtest@agounder.com"
],
"firstname": [
"BB"
],
"name": [
"bbtest@agounder.onmicrosoft.com"
],
"lastname": [
"Test"
]
},
"in_response_to": "_f8863f68-b5f1-43f0-9534-e73933e6ed39",
"allowed_clock_drift": 2.220446049250313e-16,
"success": true,
"status_code": "urn:oasis:names:tc:SAML:2.0:status:Success",
"status_message": null,
"session_index": "_b4f253e2-aa61-46a4-902b-43592fe30800",
"assertion_encrypted": false,
"response_id": "_392cc747-7c8b-41de-8be0-23f5590d5ded",
"assertion_id": "_b4f253e2-aa61-46a4-902b-43592fe30800"
}
}
```
## Testing GitLab SAML
You can use one of the following to troubleshoot SAML:
- A [complete GitLab with SAML testing environment using Docker compose](https://gitlab.com/gitlab-com/support/toolbox/replication/tree/master/compose_files).
- A [quick start guide to start a Docker container](../../../administration/troubleshooting/test_environments.md#saml)
with a plug and play SAML 2.0 identity provider if you only require a SAML provider.
- A local environment by
[enabling SAML for groups on a GitLab Self-Managed instance](../../../integration/saml.md#configure-group-saml-sso-on-gitlab-self-managed).
## Verify configuration
For convenience, we've included some [example resources](example_saml_config.md) used by our Support Team. While they may help you verify the SAML app configuration, they are not guaranteed to reflect the current state of third-party products.
### Calculate the fingerprint
When configuring the `idp_cert_fingerprint` you should use a SHA256 fingerprint whenever possible. SHA1 is also supported, but is not recommended. You can calculate the fingerprint by running the following command on the certificate file:
```shell
openssl x509 -in <certificate.crt> -noout -fingerprint -sha256
```
Replace `<certificate.crt>` with the name of the certificate file.
## SSO Certificate updates
When the certificate used for your identity provider changes (for example when updating or renewing the certificate), you must update the certificate fingerprint as well. You can find the certificate fingerprint in your identity provider's UI. If you cannot get the certificate in the identity provider UI, follow the steps in the [calculate the fingerprint](#calculate-the-fingerprint) documentation.
## Configuration errors
### Invalid audience
This error means that the identity provider doesn't recognize GitLab as a valid sender and
receiver of SAML requests. Make sure to:
- Add the GitLab callback URL to the approved audiences of the identity provider server.
- Avoid trailing whitespace in the `issuer` string.
### Key validation error, Digest mismatch or Fingerprint mismatch
These errors all come from a similar place, the SAML certificate. SAML requests
must be validated using either a fingerprint, a certificate, or a validator.
For this requirement, be sure to take the following into account:
- If you use a fingerprint, confirm your SHA256 fingerprint:
1. Re-download the certificate file.
1. [Calculate the fingerprint](#calculate-the-fingerprint).
1. Compare the fingerprint to the value provided in `idp_cert_fingerprint`. The values should be the same.
- If no certificate is provided in the settings, a fingerprint or fingerprint
validator needs to be provided and the response from the server must contain
a certificate (`<ds:KeyInfo><ds:X509Data><ds:X509Certificate>`).
- If a certificate is provided in the settings, it is no longer necessary for
the request to contain one. In this case the fingerprint or fingerprint
validators are optional.
If none of the previously described scenarios is valid, the request
fails with one of the mentioned errors.
### Missing claims, or `Email can't be blank` errors
The identity provider server needs to pass certain information in order for GitLab to either
create an account, or match the login information to an existing account. `email`
is the minimum amount of information that needs to be passed. If the identity provider server
is not providing this information, all SAML requests fail.
Make sure this information is provided.
Another issue that can result in this error is when the correct information is being sent by
the identity provider, but the attributes don't match the names in the OmniAuth `info` hash. In this case,
you must set `attribute_statements` in the SAML configuration to
[map the attribute names in your SAML Response to the corresponding OmniAuth `info` hash names](../../../integration/saml.md#map-saml-response-attribute-names).
## User sign in banner error messages
### Message: "SAML authentication failed: SAML NameID is missing from your SAML response."
You might get an error that states `SAML authentication failed: SAML NameID is missing from your SAML response. Please contact your administrator.`
This issue occurs when you try sign into GitLab using Group SSO, but your SAML response did not include a `NameID`.
To resolve this issue:
- Contact your administrator to ensure your IdP account has an assigned `NameID`.
- Use a [SAML debugging tool](#saml-debugging-tools) to verify that your SAML response has a valid `NameID`.
### Message: "SAML authentication failed: Extern uid has already been taken."
You might get an error that states `SAML authentication failed: Extern uid has already been taken. Please contact your administrator to generate a unique external_uid (NameID).`
This issue occurs when you try to link your existing GitLab account to a SAML identity using Group SSO, but there is an existing GitLab account with your current `NameID`.
To resolve this issue, tell your administrator to re-generate a unique `Extern UID` (`NameID`) for your IdP account. Make sure this new `Extern UID` adheres to the [GitLab `NameID` constraints](_index.md#manage-user-saml-identity).
If you do not wish to use that GitLab user with the SAML login, you can [unlink the GitLab account from the SAML app](_index.md#unlink-accounts).
### Message: "SAML authentication failed: User has already been taken"
The user that you're signed in with already has SAML linked to a different identity, or the `NameID` value has changed.
Here are possible causes and solutions:
| Cause | Solution |
| ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| You've tried to link multiple SAML identities to the same user, for a given identity provider. | Change the identity that you sign in with. To do so, [unlink the previous SAML identity](_index.md#unlink-accounts) from this GitLab account before attempting to sign in again. |
| The `NameID` changes every time the user requests SSO identification | [Check the `NameID`](#verify-nameid) is not set with `Transient` format, or the `NameID` is not changing on subsequent requests.|
### Message: "SAML authentication failed: Email has already been taken"
| Cause | Solution |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| If a GitLab user account exists with the same email address, but the account is not associated with a SAML identity. | On GitLab.com, the user needs to [link their account](_index.md#user-access-and-management). On GitLab Self-Managed, administrators can configure the instance to [automatically link the SAML identity with the GitLab user account](../../../integration/saml.md#link-saml-identity-for-an-existing-user) when they first sign in. |
User accounts are created in one of the following ways:
- User registration
- Sign in through OAuth
- Sign in through SAML
- SCIM provisioning
### Error: user has already been taken
Getting both of these errors at the same time suggests the `NameID` capitalization provided by the identity provider didn't exactly match the previous value for that user:
- `SAML authentication failed: Extern UID has already been taken`
- `User has already been taken`
This can be prevented by configuring the `NameID` to return a consistent value. Fixing this for an individual user involves changing the identifier for the user. For GitLab.com, the user needs to [unlink their SAML from the GitLab account](_index.md#unlink-accounts).
### Message: "Request to link SAML account must be authorized"
Ensure that the user who is trying to link their GitLab account has been added as a user within the identity provider's SAML app.
Alternatively, the SAML response may be missing the `InResponseTo` attribute in the
`samlp:Response` tag, which is [expected by the SAML gem](https://github.com/onelogin/ruby-saml/blob/9f710c5028b069bfab4b9e2b66891e0549765af5/lib/onelogin/ruby-saml/response.rb#L307-L316).
The identity provider administrator should ensure that the login is
initiated by the service provider and not only the identity provider.
### Message: `There is already a GitLab account associated with this email address.`
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
A user can see this message when they are trying to [manually link SAML to their existing GitLab.com account](_index.md#link-saml-to-your-existing-gitlabcom-account):
```plaintext
There is already a GitLab account associated with this email address.
Sign in with your existing credentials to connect your organization's account
```
To resolve this problem, the user should check they are using the correct GitLab password to sign in. The user first needs
to [reset their password](https://gitlab.com/users/password/new) if both:
- The account was provisioned by SCIM.
- They are signing in with username and password for the first time.
### Message: "SAML Name ID and email address do not match your user account"
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
Users might get an error that states "SAML Name ID and email address do not match your user account. Contact an administrator."
This means:
- The NameID value sent by SAML does not match the existing SAML identity `extern_uid` value. Both the NameID and the `extern_uid` are case-sensitive. For more information, see [manage user SAML identity](_index.md#manage-user-saml-identity).
- Either the SAML response did not include an email address or the email address did not match the user's GitLab email address.
The workaround is that a GitLab group Owner uses the [SAML API](../../../api/saml.md) to update the user's SAML `extern_uid`.
The `extern_uid` value must match the Name ID value sent by the SAML identity provider (IdP). Depending on the IdP configuration
this may be a generated unique ID, an email address, or other value.
### Error: Certificate element missing in response (`ds:x509certificate`)
This error suggests that the IdP is not configured to include the X.509 certificate in the SAML response:
```plaintext
Certificate element missing in response (ds:x509certificate) and not cert provided at settings
```
The X.509 certificate must be included in the response.
To resolve this problem, configure your IdP to include the X.509 certificate in the SAML response.
For more information, see the documentation on [additional configuration for SAML apps on your IdP](../../../integration/saml.md#additional-configuration-for-saml-apps-on-your-idp).
## Other user sign in issues
### Verify `NameID`
In troubleshooting, any authenticated user can use the API to verify the `NameID` GitLab already has linked to their user by visiting [`https://gitlab.com/api/v4/user`](https://gitlab.com/api/v4/user) and checking the `extern_uid` under identities.
For GitLab Self-Managed, administrators can use the [users API](../../../api/users.md) to see the same information.
When using SAML for groups, group members of a role with the appropriate permissions can make use of the [members API](../../../api/members.md) to view group SAML identity information for members of the group.
This can then be compared to the `NameID` being sent by the identity provider by decoding the message with a [SAML debugging tool](#saml-debugging-tools). We require that these match to identify users.
### Stuck in a login "loop"
Ensure that the **GitLab single sign-on URL** (for GitLab.com) or the instance URL (for GitLab Self-Managed) has been configured as "Login URL" (or similarly named field) in the identity provider's SAML app.
For GitLab.com, alternatively, when users need to [link SAML to their existing GitLab.com account](_index.md#link-saml-to-your-existing-gitlabcom-account), provide the **GitLab single sign-on URL** and instruct users not to use the SAML app on first sign in.
### Users receive a 404
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
If the user receives a `404` after signing in successfully, check if you have IP restrictions configured. IP restriction settings are configured:
- On GitLab.com, [at the group level](../access_and_permissions.md#restrict-group-access-by-ip-address).
- For GitLab Self-Managed, [at the instance level](../../../administration/reporting/ip_addr_restrictions.md).
Because SAML SSO for groups is a paid feature, your subscription expiring can result in a `404` error when you're signing in using SAML SSO on GitLab.com.
If all users are receiving a `404` when attempting to sign in using SAML, confirm
[there is an active subscription](../../../subscriptions/manage_subscription.md#view-subscription) being used in this SAML SSO namespace.
If you receive a `404` during setup when using "verify configuration", make sure you have used the correct
[SHA-1 generated fingerprint](../../../integration/saml.md#configure-saml-on-your-idp).
If a user is trying to sign in for the first time and the GitLab single sign-on URL has not [been configured](_index.md#set-up-your-identity-provider), they may see a 404.
As outlined in the [user access section](_index.md#link-saml-to-your-existing-gitlabcom-account), a group Owner needs to provide the URL to users.
If the top-level group has [restricted membership by email domain](../access_and_permissions.md#restrict-group-access-by-domain), and a user with an email domain that is not allowed tries to sign in with SSO, that user might receive a 404. Users might have multiple accounts, and their SAML identity might be linked to their personal account which has an email address that is different than the company domain. To check this, verify the following:
- That the top-level group has restricted membership by email domain.
- That, in [audit events](../../../administration/compliance/audit_event_reports.md) for the top-level group:
- You can see **Signed in with GROUP_SAML authentication** action for that user.
- That the user's username is the same as the username you configured for SAML SSO, by selecting the **Author** name.
- If the username is different to the username you configured for SAML SSO, ask the user to [unlink the SAML identity](_index.md#unlink-accounts) from their personal account.
If all users are receiving a `404` after signing in to the identity provider (IdP):
- Verify the `assertion_consumer_service_url`:
- In the GitLab configuration by [matching it to the HTTPS endpoint of GitLab](../../../integration/saml.md#configure-saml-support-in-gitlab).
- As the `Assertion Consumer Service URL` or equivalent when setting up the SAML app on your IdP.
- Verify if the `404` is related to [the user having too many groups assigned to them in their Azure IdP](group_sync.md#microsoft-azure-active-directory-integration).
- Verify the clocks on the IdP server and GitLab are synced to the same time.
If a subset of users receive a `404` error after they sign in to the IdP, first verify what audit events are returned if the user is added to the group and then immediately removed. Alternatively, if the user can successfully sign in, but they do not show as [a member of the top-level group](../_index.md#search-a-group):
- Ensure the user has been [added to the SAML identity provider](_index.md#user-access-and-management), and [SCIM](scim_setup.md) if configured.
- Ensure the user's SCIM identity's `active` attribute is `true` using the [SCIM API](../../../api/scim.md).
If the `active` attribute is `false`, you can do one of the following to possibly resolve the issue:
- Trigger a sync for the user in the SCIM identity provider. For example, Azure has a "Provision on demand" option.
- Remove and re-add the user in the SCIM identity provider.
- Have the user [unlink their account](_index.md#unlink-accounts) if possible, then [link their account](_index.md#link-saml-to-your-existing-gitlabcom-account).
- Use the [internal SCIM API](../../../development/internal_api/_index.md#update-a-single-scim-provisioned-user) to update the user's SCIM identity using your group's SCIM token.
If you do not know your group's SCIM token, reset the token and update the SCIM identity provider app with the new token.
Example request:
```plaintext
curl --request PATCH "https://gitlab.example.com/api/scim/v2/groups/test_group/Users/f0b1d561c-21ff-4092-beab-8154b17f82f2" --header "Authorization: Bearer <SCIM_TOKEN>" --header "Content-Type: application/scim+json" --data '{ "Operations": [{"op":"Replace","path":"active","value":"true"}] }'
```
### 500 error after login
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
If you see a "500 error" in GitLab when you are redirected back from the SAML
sign-in page, this could indicate that:
- GitLab couldn't get the email address for the SAML user. Ensure the identity provider provides a claim containing the user's
email address using the claim name `email` or `mail`.
- The certificate set your `gitlab.rb` file for `identity provider_cert_fingerprint` or `identity provider_cert` file is incorrect.
- Your `gitlab.rb` file is set to enable `identity provider_cert_fingerprint`, and `identity provider_cert` is being provided, or the reverse.
### 422 error after login
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
If you see a "422 error" in GitLab when you are redirected from the SAML
sign-in page, you might have an incorrectly configured Assertion Consumer
Service (ACS) URL on the identity provider.
Make sure the ACS URL points to `https://gitlab.example.com/users/auth/saml/callback`, where
`gitlab.example.com` is the URL of your GitLab instance.
If the ACS URL is correct, and you still have errors, review the other
Troubleshooting sections.
#### 422 error with non-allowed email
You might get a 422 error that states "Email is not allowed for sign-up. Please use your regular email address."
This message might indicate that you must add or remove a domain from your domain allowlist or denylist settings.
To implement this workaround:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings** > **General**.
1. Expand **Sign-up restrictions**.
1. Add or remove a domain as appropriate to **Allowed domains for sign-ups** and **Denied domains for sign-ups**.
1. Select **Save changes**.
### User is blocked when signing in through SAML
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The following are the most likely reasons that a user is blocked when signing in through SAML:
- In the configuration, `gitlab_rails['omniauth_block_auto_created_users'] = true` is set and this is the user's first time signing in.
- [`required_groups`](../../../integration/saml.md#required-groups) are configured but the user is not a member of one.
## Google workspace troubleshooting tips
The Google Workspace documentation on [SAML app error messages](https://support.google.com/a/answer/6301076?hl=en) is helpful for debugging if you are seeing an error from Google while signing in.
Pay particular attention to the following 403 errors:
- `app_not_configured`
- `app_not_configured_for_user`
## Message: "The member's email address is not linked to a SAML account"
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
This error appears when you try to invite a user to a GitLab.com group (or subgroup or project within a group) that has [SAML SSO enforcement](_index.md#sso-enforcement) enabled.
If you see this message after trying to invite a user to a group:
1. Ensure the user has been [added to the SAML identity provider](_index.md#user-access-and-management).
1. Ask the user to [link SAML to their existing GitLab.com account](_index.md#link-saml-to-your-existing-gitlabcom-account), if they have one. Otherwise, ask the user to create a GitLab.com account by [accessing GitLab.com through the identity provider's dashboard](_index.md#user-access-and-management), or by [signing up manually](https://gitlab.com/users/sign_up) and linking SAML to their new account.
1. Ensure the user is a [member of the top-level group](../_index.md#search-a-group).
Additionally, see [troubleshooting users receiving a 404 after sign in](#users-receive-a-404).
## Message: `The SAML response did not contain an email address.`
If you see this error:
```plaintext
The SAML response did not contain an email address.
Either the SAML identity provider is not configured to send the attribute, or the
identity provider directory does not have an email address value for your user
```
This error appears when:
- the SAML response does not contain the user's email address in an **email** or **mail** attribute.
- a user attempts to [link SAML](_index.md#user-access-and-management) to their account but has not yet completed the [identity verification process](../../../security/identity_verification.md).
Ensure the SAML identity provider is configured to send a [supported mail attribute](../../../integration/saml.md):
```xml
<Attribute Name="email">
<AttributeValue>user@example.com‹/AttributeValue>
</Attribute>
```
Attribute names starting with phrases such as `http://schemas.xmlsoap.org/ws/2005/05/identity/claims` and `http://schemas.microsoft.com/ws/2008/06/identity/claims/` are supported by default beginning in GitLab 16.7.
```xml
<Attribute Name="http://schemas.microsoft.com/ws/2008/06/identity/claims/emailaddress">
<AttributeValue>user@example.com‹/AttributeValue>
</Attribute>
```
|
---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting SAML
breadcrumbs:
- doc
- user
- group
- saml_sso
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This page contains possible solutions for problems you might encounter when using:
- [SAML SSO for GitLab.com groups](_index.md).
- The GitLab Self-Managed instance-level [SAML OmniAuth Provider](../../../integration/saml.md).
- [Switchboard](../../../administration/dedicated/configure_instance/authentication/saml.md#add-a-saml-provider-with-switchboard) to configure SAML for GitLab Dedicated instances.
## SAML debugging tools
SAML responses are base64 encoded. To decode them on the fly you can use the **SAML-tracer** browser extension ([Firefox](https://addons.mozilla.org/en-US/firefox/addon/saml-tracer/), [Chrome](https://chromewebstore.google.com/detail/saml-tracer/mpdajninpobndbfcldcmbpnnbhibjmch?hl=en)).
If you cannot install a browser plugin, you can [manually generate and capture a SAML response](#manually-generate-a-saml-response) instead.
Pay specific attention to:
- The `NameID`, which we use to identify which user is signing in. If the user has previously signed in, this
[must match the value we have stored](#verify-nameid).
- The presence of a `X509Certificate`, which we require to verify the response signature.
- The `SubjectConfirmation` and `Conditions`, which can cause errors if misconfigured.
### Generate a SAML response
Use SAML responses to preview the attribute names and values sent in the assertions list while attempting to sign in
using an identity provider.
To generate a SAML Response:
1. Install one of the [browser debugging tools](#saml-debugging-tools).
1. Open a new browser tab.
1. Open the SAML tracer console:
- Chrome: On a context menu on the page, select **Inspect**, then select the **SAML** tab in the developer console.
- Firefox: Select the SAML-tracer icon located on the browser toolbar.
1. For GitLab.com Groups:
- Go to the GitLab single sign-on URL for the group.
- Select **Authorize** or attempt to sign
1. For GitLab Self-Managed instance:
- Go to the instance home page
- Click on the `SAML Login` button to sign in
1. A SAML response is displayed in the tracer console that resembles this
[example SAML response](_index.md#example-saml-response).
1. Within the SAML tracer, select the **Export** icon to save the response in JSON format.
#### Manually generate a SAML response
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For an overview, see this [video on manually generating a SAML response without using a browser plugin (using Google Chrome)](https://youtu.be/umMPj6ohF_I), uploaded by GitLab Support.
<!-- Video published on 2024-09-09 -->
Regardless of what browser you use, the process is similar to the following:
1. Right-click on a new browser and click on **Inspect** to open the **DevTools** window.
1. Select the **Network** tab. Make sure that **Preserve log** is selected.
1. Switch to the browser page and sign in to GitLab using SAML SSO.
1. Switch back to the **DevTools** window and filter for the `callback` event.
1. Select the **Payload** tab for the callback event and right-click to copy the value.
1. Paste this value into the following command: `echo "<value>" | base64 --decode > saml_response.xml`.
1. Open `saml_response.xml` in a code editor.
If you have an XML "prettifier" installed in your code editor, you should be able to automatically
format the response to be easier to read.
## Search Rails logs for a SAML sign-in
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
You can find detailed information about a SAML sign-in in the [`audit_json.log` file](../../../administration/logs/_index.md#audit_jsonlog).
For example, by searching for `system_access`, you can find entries that show when a user signed into GitLab using SAML:
```json
{
"severity": "INFO",
"time": "2024-08-13T06:05:35.721Z",
"correlation_id": "01J555EZK136DQ8S7P32G9GEND",
"meta.caller_id": "OmniauthCallbacksController#saml",
"meta.remote_ip": "45.87.213.198",
"meta.feature_category": "system_access",
"meta.user": "bbtest",
"meta.user_id": 16,
"meta.client_id": "user/16",
"author_id": 16,
"author_name": "bbtest@agounder.onmicrosoft.com",
"entity_id": 16,
"entity_type": "User",
"created_at": "2024-08-13T06:05:35.708+00:00",
"ip_address": "45.87.213.198",
"with": "saml",
"target_id": 16,
"target_type": "User",
"target_details": "bbtest@agounder.onmicrosoft.com",
"entity_path": "bbtest"
}
```
If you have configured SAML Group Links, the log also shows entries detailing membership being removed:
```json
{
"severity": "INFO",
"time": "2024-08-13T05:24:07.769Z",
"correlation_id": "01J55330SRTKTD5CHMS96DNZEN",
"meta.caller_id": "Auth::SamlGroupSyncWorker",
"meta.remote_ip": "45.87.213.206",
"meta.feature_category": "system_access",
"meta.client_id": "ip/45.87.213.206",
"meta.root_caller_id": "OmniauthCallbacksController#saml",
"id": 179,
"author_id": 6,
"entity_id": 2,
"entity_type": "Group",
"details": {
"remove": "user_access",
"member_id": 7,
"author_name": "BB Test",
"author_class": "User",
"target_id": 6,
"target_type": "User",
"target_details": "BB Test",
"custom_message": "Membership destroyed",
"ip_address": "45.87.213.198",
"entity_path": "group1"
},
```
You can also see details of the user that GitLab received from the SAML provider in `auth_json.log`, for example:
```json
{
"severity": "INFO",
"time": "2024-08-20T07:01:20.979Z",
"correlation_id": "01J5Q9E59X4P40ZT3MCE35C2A9",
"meta.caller_id": "OmniauthCallbacksController#saml",
"meta.remote_ip": "xxx.xxx.xxx.xxx",
"meta.feature_category": "system_access",
"meta.client_id": "ip/xxx.xxx.xxx.xxx",
"payload_type": "saml_response",
"saml_response": {
"issuer": [
"https://sts.windows.net/03b8c6c5-104b-43e2-aed3-abb07df387cc/"
],
"name_id": "ab260d59-0317-47f5-9afb-885c7a1257ab",
"name_id_format": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
"name_id_spnamequalifier": null,
"name_id_namequalifier": null,
"destination": "https://dh-gitlab.agounder.com/users/auth/saml/callback",
"audiences": [
"https://dh-gitlab.agounder.com/16.11.6"
],
"attributes": {
"http://schemas.microsoft.com/identity/claims/tenantid": [
"03b8c6c5-104b-43e2-aed3-abb07df387cc"
],
"http://schemas.microsoft.com/identity/claims/objectidentifier": [
"ab260d59-0317-47f5-9afb-885c7a1257ab"
],
"http://schemas.microsoft.com/identity/claims/identityprovider": [
"https://sts.windows.net/03b8c6c5-104b-43e2-aed3-abb07df387cc/"
],
"http://schemas.microsoft.com/claims/authnmethodsreferences": [
"http://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/password"
],
"email": [
"bbtest@agounder.com"
],
"firstname": [
"BB"
],
"name": [
"bbtest@agounder.onmicrosoft.com"
],
"lastname": [
"Test"
]
},
"in_response_to": "_f8863f68-b5f1-43f0-9534-e73933e6ed39",
"allowed_clock_drift": 2.220446049250313e-16,
"success": true,
"status_code": "urn:oasis:names:tc:SAML:2.0:status:Success",
"status_message": null,
"session_index": "_b4f253e2-aa61-46a4-902b-43592fe30800",
"assertion_encrypted": false,
"response_id": "_392cc747-7c8b-41de-8be0-23f5590d5ded",
"assertion_id": "_b4f253e2-aa61-46a4-902b-43592fe30800"
}
}
```
## Testing GitLab SAML
You can use one of the following to troubleshoot SAML:
- A [complete GitLab with SAML testing environment using Docker compose](https://gitlab.com/gitlab-com/support/toolbox/replication/tree/master/compose_files).
- A [quick start guide to start a Docker container](../../../administration/troubleshooting/test_environments.md#saml)
with a plug and play SAML 2.0 identity provider if you only require a SAML provider.
- A local environment by
[enabling SAML for groups on a GitLab Self-Managed instance](../../../integration/saml.md#configure-group-saml-sso-on-gitlab-self-managed).
## Verify configuration
For convenience, we've included some [example resources](example_saml_config.md) used by our Support Team. While they may help you verify the SAML app configuration, they are not guaranteed to reflect the current state of third-party products.
### Calculate the fingerprint
When configuring the `idp_cert_fingerprint` you should use a SHA256 fingerprint whenever possible. SHA1 is also supported, but is not recommended. You can calculate the fingerprint by running the following command on the certificate file:
```shell
openssl x509 -in <certificate.crt> -noout -fingerprint -sha256
```
Replace `<certificate.crt>` with the name of the certificate file.
## SSO Certificate updates
When the certificate used for your identity provider changes (for example when updating or renewing the certificate), you must update the certificate fingerprint as well. You can find the certificate fingerprint in your identity provider's UI. If you cannot get the certificate in the identity provider UI, follow the steps in the [calculate the fingerprint](#calculate-the-fingerprint) documentation.
## Configuration errors
### Invalid audience
This error means that the identity provider doesn't recognize GitLab as a valid sender and
receiver of SAML requests. Make sure to:
- Add the GitLab callback URL to the approved audiences of the identity provider server.
- Avoid trailing whitespace in the `issuer` string.
### Key validation error, Digest mismatch or Fingerprint mismatch
These errors all come from a similar place, the SAML certificate. SAML requests
must be validated using either a fingerprint, a certificate, or a validator.
For this requirement, be sure to take the following into account:
- If you use a fingerprint, confirm your SHA256 fingerprint:
1. Re-download the certificate file.
1. [Calculate the fingerprint](#calculate-the-fingerprint).
1. Compare the fingerprint to the value provided in `idp_cert_fingerprint`. The values should be the same.
- If no certificate is provided in the settings, a fingerprint or fingerprint
validator needs to be provided and the response from the server must contain
a certificate (`<ds:KeyInfo><ds:X509Data><ds:X509Certificate>`).
- If a certificate is provided in the settings, it is no longer necessary for
the request to contain one. In this case the fingerprint or fingerprint
validators are optional.
If none of the previously described scenarios is valid, the request
fails with one of the mentioned errors.
### Missing claims, or `Email can't be blank` errors
The identity provider server needs to pass certain information in order for GitLab to either
create an account, or match the login information to an existing account. `email`
is the minimum amount of information that needs to be passed. If the identity provider server
is not providing this information, all SAML requests fail.
Make sure this information is provided.
Another issue that can result in this error is when the correct information is being sent by
the identity provider, but the attributes don't match the names in the OmniAuth `info` hash. In this case,
you must set `attribute_statements` in the SAML configuration to
[map the attribute names in your SAML Response to the corresponding OmniAuth `info` hash names](../../../integration/saml.md#map-saml-response-attribute-names).
## User sign in banner error messages
### Message: "SAML authentication failed: SAML NameID is missing from your SAML response."
You might get an error that states `SAML authentication failed: SAML NameID is missing from your SAML response. Please contact your administrator.`
This issue occurs when you try sign into GitLab using Group SSO, but your SAML response did not include a `NameID`.
To resolve this issue:
- Contact your administrator to ensure your IdP account has an assigned `NameID`.
- Use a [SAML debugging tool](#saml-debugging-tools) to verify that your SAML response has a valid `NameID`.
### Message: "SAML authentication failed: Extern uid has already been taken."
You might get an error that states `SAML authentication failed: Extern uid has already been taken. Please contact your administrator to generate a unique external_uid (NameID).`
This issue occurs when you try to link your existing GitLab account to a SAML identity using Group SSO, but there is an existing GitLab account with your current `NameID`.
To resolve this issue, tell your administrator to re-generate a unique `Extern UID` (`NameID`) for your IdP account. Make sure this new `Extern UID` adheres to the [GitLab `NameID` constraints](_index.md#manage-user-saml-identity).
If you do not wish to use that GitLab user with the SAML login, you can [unlink the GitLab account from the SAML app](_index.md#unlink-accounts).
### Message: "SAML authentication failed: User has already been taken"
The user that you're signed in with already has SAML linked to a different identity, or the `NameID` value has changed.
Here are possible causes and solutions:
| Cause | Solution |
| ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| You've tried to link multiple SAML identities to the same user, for a given identity provider. | Change the identity that you sign in with. To do so, [unlink the previous SAML identity](_index.md#unlink-accounts) from this GitLab account before attempting to sign in again. |
| The `NameID` changes every time the user requests SSO identification | [Check the `NameID`](#verify-nameid) is not set with `Transient` format, or the `NameID` is not changing on subsequent requests.|
### Message: "SAML authentication failed: Email has already been taken"
| Cause | Solution |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| If a GitLab user account exists with the same email address, but the account is not associated with a SAML identity. | On GitLab.com, the user needs to [link their account](_index.md#user-access-and-management). On GitLab Self-Managed, administrators can configure the instance to [automatically link the SAML identity with the GitLab user account](../../../integration/saml.md#link-saml-identity-for-an-existing-user) when they first sign in. |
User accounts are created in one of the following ways:
- User registration
- Sign in through OAuth
- Sign in through SAML
- SCIM provisioning
### Error: user has already been taken
Getting both of these errors at the same time suggests the `NameID` capitalization provided by the identity provider didn't exactly match the previous value for that user:
- `SAML authentication failed: Extern UID has already been taken`
- `User has already been taken`
This can be prevented by configuring the `NameID` to return a consistent value. Fixing this for an individual user involves changing the identifier for the user. For GitLab.com, the user needs to [unlink their SAML from the GitLab account](_index.md#unlink-accounts).
### Message: "Request to link SAML account must be authorized"
Ensure that the user who is trying to link their GitLab account has been added as a user within the identity provider's SAML app.
Alternatively, the SAML response may be missing the `InResponseTo` attribute in the
`samlp:Response` tag, which is [expected by the SAML gem](https://github.com/onelogin/ruby-saml/blob/9f710c5028b069bfab4b9e2b66891e0549765af5/lib/onelogin/ruby-saml/response.rb#L307-L316).
The identity provider administrator should ensure that the login is
initiated by the service provider and not only the identity provider.
### Message: `There is already a GitLab account associated with this email address.`
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
A user can see this message when they are trying to [manually link SAML to their existing GitLab.com account](_index.md#link-saml-to-your-existing-gitlabcom-account):
```plaintext
There is already a GitLab account associated with this email address.
Sign in with your existing credentials to connect your organization's account
```
To resolve this problem, the user should check they are using the correct GitLab password to sign in. The user first needs
to [reset their password](https://gitlab.com/users/password/new) if both:
- The account was provisioned by SCIM.
- They are signing in with username and password for the first time.
### Message: "SAML Name ID and email address do not match your user account"
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
Users might get an error that states "SAML Name ID and email address do not match your user account. Contact an administrator."
This means:
- The NameID value sent by SAML does not match the existing SAML identity `extern_uid` value. Both the NameID and the `extern_uid` are case-sensitive. For more information, see [manage user SAML identity](_index.md#manage-user-saml-identity).
- Either the SAML response did not include an email address or the email address did not match the user's GitLab email address.
The workaround is that a GitLab group Owner uses the [SAML API](../../../api/saml.md) to update the user's SAML `extern_uid`.
The `extern_uid` value must match the Name ID value sent by the SAML identity provider (IdP). Depending on the IdP configuration
this may be a generated unique ID, an email address, or other value.
### Error: Certificate element missing in response (`ds:x509certificate`)
This error suggests that the IdP is not configured to include the X.509 certificate in the SAML response:
```plaintext
Certificate element missing in response (ds:x509certificate) and not cert provided at settings
```
The X.509 certificate must be included in the response.
To resolve this problem, configure your IdP to include the X.509 certificate in the SAML response.
For more information, see the documentation on [additional configuration for SAML apps on your IdP](../../../integration/saml.md#additional-configuration-for-saml-apps-on-your-idp).
## Other user sign in issues
### Verify `NameID`
In troubleshooting, any authenticated user can use the API to verify the `NameID` GitLab already has linked to their user by visiting [`https://gitlab.com/api/v4/user`](https://gitlab.com/api/v4/user) and checking the `extern_uid` under identities.
For GitLab Self-Managed, administrators can use the [users API](../../../api/users.md) to see the same information.
When using SAML for groups, group members of a role with the appropriate permissions can make use of the [members API](../../../api/members.md) to view group SAML identity information for members of the group.
This can then be compared to the `NameID` being sent by the identity provider by decoding the message with a [SAML debugging tool](#saml-debugging-tools). We require that these match to identify users.
### Stuck in a login "loop"
Ensure that the **GitLab single sign-on URL** (for GitLab.com) or the instance URL (for GitLab Self-Managed) has been configured as "Login URL" (or similarly named field) in the identity provider's SAML app.
For GitLab.com, alternatively, when users need to [link SAML to their existing GitLab.com account](_index.md#link-saml-to-your-existing-gitlabcom-account), provide the **GitLab single sign-on URL** and instruct users not to use the SAML app on first sign in.
### Users receive a 404
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
If the user receives a `404` after signing in successfully, check if you have IP restrictions configured. IP restriction settings are configured:
- On GitLab.com, [at the group level](../access_and_permissions.md#restrict-group-access-by-ip-address).
- For GitLab Self-Managed, [at the instance level](../../../administration/reporting/ip_addr_restrictions.md).
Because SAML SSO for groups is a paid feature, your subscription expiring can result in a `404` error when you're signing in using SAML SSO on GitLab.com.
If all users are receiving a `404` when attempting to sign in using SAML, confirm
[there is an active subscription](../../../subscriptions/manage_subscription.md#view-subscription) being used in this SAML SSO namespace.
If you receive a `404` during setup when using "verify configuration", make sure you have used the correct
[SHA-1 generated fingerprint](../../../integration/saml.md#configure-saml-on-your-idp).
If a user is trying to sign in for the first time and the GitLab single sign-on URL has not [been configured](_index.md#set-up-your-identity-provider), they may see a 404.
As outlined in the [user access section](_index.md#link-saml-to-your-existing-gitlabcom-account), a group Owner needs to provide the URL to users.
If the top-level group has [restricted membership by email domain](../access_and_permissions.md#restrict-group-access-by-domain), and a user with an email domain that is not allowed tries to sign in with SSO, that user might receive a 404. Users might have multiple accounts, and their SAML identity might be linked to their personal account which has an email address that is different than the company domain. To check this, verify the following:
- That the top-level group has restricted membership by email domain.
- That, in [audit events](../../../administration/compliance/audit_event_reports.md) for the top-level group:
- You can see **Signed in with GROUP_SAML authentication** action for that user.
- That the user's username is the same as the username you configured for SAML SSO, by selecting the **Author** name.
- If the username is different to the username you configured for SAML SSO, ask the user to [unlink the SAML identity](_index.md#unlink-accounts) from their personal account.
If all users are receiving a `404` after signing in to the identity provider (IdP):
- Verify the `assertion_consumer_service_url`:
- In the GitLab configuration by [matching it to the HTTPS endpoint of GitLab](../../../integration/saml.md#configure-saml-support-in-gitlab).
- As the `Assertion Consumer Service URL` or equivalent when setting up the SAML app on your IdP.
- Verify if the `404` is related to [the user having too many groups assigned to them in their Azure IdP](group_sync.md#microsoft-azure-active-directory-integration).
- Verify the clocks on the IdP server and GitLab are synced to the same time.
If a subset of users receive a `404` error after they sign in to the IdP, first verify what audit events are returned if the user is added to the group and then immediately removed. Alternatively, if the user can successfully sign in, but they do not show as [a member of the top-level group](../_index.md#search-a-group):
- Ensure the user has been [added to the SAML identity provider](_index.md#user-access-and-management), and [SCIM](scim_setup.md) if configured.
- Ensure the user's SCIM identity's `active` attribute is `true` using the [SCIM API](../../../api/scim.md).
If the `active` attribute is `false`, you can do one of the following to possibly resolve the issue:
- Trigger a sync for the user in the SCIM identity provider. For example, Azure has a "Provision on demand" option.
- Remove and re-add the user in the SCIM identity provider.
- Have the user [unlink their account](_index.md#unlink-accounts) if possible, then [link their account](_index.md#link-saml-to-your-existing-gitlabcom-account).
- Use the [internal SCIM API](../../../development/internal_api/_index.md#update-a-single-scim-provisioned-user) to update the user's SCIM identity using your group's SCIM token.
If you do not know your group's SCIM token, reset the token and update the SCIM identity provider app with the new token.
Example request:
```plaintext
curl --request PATCH "https://gitlab.example.com/api/scim/v2/groups/test_group/Users/f0b1d561c-21ff-4092-beab-8154b17f82f2" --header "Authorization: Bearer <SCIM_TOKEN>" --header "Content-Type: application/scim+json" --data '{ "Operations": [{"op":"Replace","path":"active","value":"true"}] }'
```
### 500 error after login
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
If you see a "500 error" in GitLab when you are redirected back from the SAML
sign-in page, this could indicate that:
- GitLab couldn't get the email address for the SAML user. Ensure the identity provider provides a claim containing the user's
email address using the claim name `email` or `mail`.
- The certificate set your `gitlab.rb` file for `identity provider_cert_fingerprint` or `identity provider_cert` file is incorrect.
- Your `gitlab.rb` file is set to enable `identity provider_cert_fingerprint`, and `identity provider_cert` is being provided, or the reverse.
### 422 error after login
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
If you see a "422 error" in GitLab when you are redirected from the SAML
sign-in page, you might have an incorrectly configured Assertion Consumer
Service (ACS) URL on the identity provider.
Make sure the ACS URL points to `https://gitlab.example.com/users/auth/saml/callback`, where
`gitlab.example.com` is the URL of your GitLab instance.
If the ACS URL is correct, and you still have errors, review the other
Troubleshooting sections.
#### 422 error with non-allowed email
You might get a 422 error that states "Email is not allowed for sign-up. Please use your regular email address."
This message might indicate that you must add or remove a domain from your domain allowlist or denylist settings.
To implement this workaround:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings** > **General**.
1. Expand **Sign-up restrictions**.
1. Add or remove a domain as appropriate to **Allowed domains for sign-ups** and **Denied domains for sign-ups**.
1. Select **Save changes**.
### User is blocked when signing in through SAML
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The following are the most likely reasons that a user is blocked when signing in through SAML:
- In the configuration, `gitlab_rails['omniauth_block_auto_created_users'] = true` is set and this is the user's first time signing in.
- [`required_groups`](../../../integration/saml.md#required-groups) are configured but the user is not a member of one.
## Google workspace troubleshooting tips
The Google Workspace documentation on [SAML app error messages](https://support.google.com/a/answer/6301076?hl=en) is helpful for debugging if you are seeing an error from Google while signing in.
Pay particular attention to the following 403 errors:
- `app_not_configured`
- `app_not_configured_for_user`
## Message: "The member's email address is not linked to a SAML account"
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
This error appears when you try to invite a user to a GitLab.com group (or subgroup or project within a group) that has [SAML SSO enforcement](_index.md#sso-enforcement) enabled.
If you see this message after trying to invite a user to a group:
1. Ensure the user has been [added to the SAML identity provider](_index.md#user-access-and-management).
1. Ask the user to [link SAML to their existing GitLab.com account](_index.md#link-saml-to-your-existing-gitlabcom-account), if they have one. Otherwise, ask the user to create a GitLab.com account by [accessing GitLab.com through the identity provider's dashboard](_index.md#user-access-and-management), or by [signing up manually](https://gitlab.com/users/sign_up) and linking SAML to their new account.
1. Ensure the user is a [member of the top-level group](../_index.md#search-a-group).
Additionally, see [troubleshooting users receiving a 404 after sign in](#users-receive-a-404).
## Message: `The SAML response did not contain an email address.`
If you see this error:
```plaintext
The SAML response did not contain an email address.
Either the SAML identity provider is not configured to send the attribute, or the
identity provider directory does not have an email address value for your user
```
This error appears when:
- the SAML response does not contain the user's email address in an **email** or **mail** attribute.
- a user attempts to [link SAML](_index.md#user-access-and-management) to their account but has not yet completed the [identity verification process](../../../security/identity_verification.md).
Ensure the SAML identity provider is configured to send a [supported mail attribute](../../../integration/saml.md):
```xml
<Attribute Name="email">
<AttributeValue>user@example.com‹/AttributeValue>
</Attribute>
```
Attribute names starting with phrases such as `http://schemas.xmlsoap.org/ws/2005/05/identity/claims` and `http://schemas.microsoft.com/ws/2008/06/identity/claims/` are supported by default beginning in GitLab 16.7.
```xml
<Attribute Name="http://schemas.microsoft.com/ws/2008/06/identity/claims/emailaddress">
<AttributeValue>user@example.com‹/AttributeValue>
</Attribute>
```
|
https://docs.gitlab.com/user/group/example_saml_config
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/group/example_saml_config.md
|
2025-08-13
|
doc/user/group/saml_sso
|
[
"doc",
"user",
"group",
"saml_sso"
] |
example_saml_config.md
|
Software Supply Chain Security
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Example group SAML and SCIM configurations
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
These are notes and screenshots regarding Group SAML and SCIM that the GitLab Support Team sometimes uses while troubleshooting, but which do not fit into the official documentation. GitLab is making this public, so that anyone can make use of the Support team's collected knowledge.
Refer to the GitLab [Group SAML](_index.md) documentation for information on the feature and how to set it up.
When troubleshooting a SAML configuration, GitLab team members will frequently start with the [SAML troubleshooting section](_index.md#troubleshooting).
They may then set up a test configuration of the desired identity provider. We include example screenshots in this section.
## SAML and SCIM screenshots
This section includes relevant screenshots of the following example configurations of [Group SAML](_index.md) and [Group SCIM](scim_setup.md):
- [Azure Active Directory](#azure-active-directory)
- [Google Workspace](#google-workspace)
- [Okta](#okta)
- [OneLogin](#onelogin)
{{< alert type="warning" >}}
These screenshots are updated only as needed by GitLab Support. They are **not** official documentation.
{{< /alert >}}
If you are currently having an issue with GitLab, you may want to check your [support options](https://about.gitlab.com/support/).
## Azure Active Directory
This section has screenshots for the elements of Azure Active Directory configuration.
### Basic SAML app configuration
### User claims and attributes
### SCIM mapping
Provisioning:
### Attribute mapping
### Group Sync
Using the **Group ID** source attribute requires users to enter the group ID or object ID when configuring SAML group links.
If available, you can add user-friendly group names instead. When setting up Azure group claims:
1. Select the **sAMAccountName** source attribute.
1. Enter a group name. You can specify a name up to 256 characters long.
1. To ensure the attribute is part of the assertion, select **Emit group names for cloud-only groups**.
[Azure AD limits the number of groups that can be sent in a SAML response to 150](https://support.esri.com/en-us/knowledge-base/when-azure-ad-is-the-saml-identify-provider-the-group-a-000022190). If a user is a member of more than 150 groups, Azure does not include that user's group claim in the SAML response.
## Google Workspace
### Basic SAML app configuration
### User claims and attributes
### IdP links and certificate
## Okta
### Basic SAML app configuration for GitLab.com groups
### Basic SAML app configuration for GitLab Self-Managed
### User claims and attributes
### Group Sync
### Advanced SAML app settings (defaults)
### IdP links and certificate
### SAML sign on settings
### SCIM settings
Setting the username for the newly provisioned users when assigning them the SCIM app:
## OneLogin
### Basic SAML app configuration
### Parameters
### Adding a user
### SSO settings
## SAML response example
When a user signs in using SAML, GitLab receives a SAML response. The SAML response can be found in `production.log` logs as a base64-encoded message. Locate the response by
searching for `SAMLResponse`. The decoded SAML response is in XML format. For example:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<saml2p:Response xmlns:saml2p="urn:oasis:names:tc:SAML:2.0:protocol" xmlns:xs="http://www.w3.org/2001/XMLSchema" Destination="https://gitlabexample/-/saml/callback" ID="id4898983630840142426821432" InResponseTo="_c65e4c88-9425-4472-b42c-37f4186ac0ee" IssueInstant="2022-05-30T21:30:35.696Z" Version="2.0">
<saml2:Issuer xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">http://www.okta.com/exk2y6j57o1Pdr2lI8qh7</saml2:Issuer>
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<ds:SignedInfo>
<ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
<ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
<ds:Reference URI="#id4898983630840142426821432">
<ds:Transforms>
<ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
<ec:InclusiveNamespaces xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#" PrefixList="xs"/>
</ds:Transform>
</ds:Transforms>
<ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
<ds:DigestValue>neiQvv9d3OgS4GZW8Nptp4JhjpKs3GCefibn+vmRgk4=</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>dMsQX8ivi...HMuKGhyLRvabGU6CuPrf7==</ds:SignatureValue>
<ds:KeyInfo>
<ds:X509Data>
<ds:X509Certificate>MIIDq...cptGr3vN9TQ==</ds:X509Certificate>
</ds:X509Data>
</ds:KeyInfo>
</ds:Signature>
<saml2p:Status xmlns:saml2p="urn:oasis:names:tc:SAML:2.0:protocol">
<saml2p:StatusCode Value="urn:oasis:names:tc:SAML:2.0:status:Success"/>
</saml2p:Status>
<saml2:Assertion xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:xs="http://www.w3.org/2001/XMLSchema" ID="id489" IssueInstant="2022-05-30T21:30:35.696Z" Version="2.0">
<saml2:Issuer xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">http://www.okta.com/exk2y6j57o1Pdr2lI8qh7</saml2:Issuer>
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<ds:SignedInfo>
<ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
<ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
<ds:Reference URI="#id48989836309833801859473359">
<ds:Transforms>
<ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
<ec:InclusiveNamespaces xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#" PrefixList="xs"/>
</ds:Transform>
</ds:Transforms>
<ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
<ds:DigestValue>MaIsoi8hbT9gsi/mNZsz449mUuAcuEWY0q3bc4asOQs=</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>dMsQX8ivi...HMuKGhyLRvabGU6CuPrf7==<</ds:SignatureValue>
<ds:KeyInfo>
<ds:X509Data>
<ds:X509Certificate>MIIDq...cptGr3vN9TQ==</ds:X509Certificate>
</ds:X509Data>
</ds:KeyInfo>
</ds:Signature>
<saml2:Subject xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion">
<saml2:NameID Format="urn:oasis:names:tc:SAML:2.0:nameid-format:persistent">useremail@domain.com</saml2:NameID>
<saml2:SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:bearer">
<saml2:SubjectConfirmationData InResponseTo="_c65e4c88-9425-4472-b42c-37f4186ac0ee" NotOnOrAfter="2022-05-30T21:35:35.696Z" Recipient="https://gitlab.example.com/-/saml/callback"/>
</saml2:SubjectConfirmation>
</saml2:Subject>
<saml2:Conditions xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" NotBefore="2022-05-30T21:25:35.696Z" NotOnOrAfter="2022-05-30T21:35:35.696Z">
<saml2:AudienceRestriction>
<saml2:Audience>https://gitlab.example.com/</saml2:Audience>
</saml2:AudienceRestriction>
</saml2:Conditions>
<saml2:AuthnStatement xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" AuthnInstant="2022-05-30T21:30:35.696Z" SessionIndex="_c65e4c88-9425-4472-b42c-37f4186ac0ee">
<saml2:AuthnContext>
<saml2:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport</saml2:AuthnContextClassRef>
</saml2:AuthnContext>
</saml2:AuthnStatement>
<saml2:AttributeStatement xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion">
<saml2:Attribute Name="email" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">useremail@domain.com</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="firtname" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">John</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="lastname" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Doe</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="Groups" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Super-awesome-group</saml2:AttributeValue>
</saml2:Attribute>
</saml2:AttributeStatement>
</saml2:Assertion>
</saml2p:Response>
```
|
---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Example group SAML and SCIM configurations
breadcrumbs:
- doc
- user
- group
- saml_sso
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
These are notes and screenshots regarding Group SAML and SCIM that the GitLab Support Team sometimes uses while troubleshooting, but which do not fit into the official documentation. GitLab is making this public, so that anyone can make use of the Support team's collected knowledge.
Refer to the GitLab [Group SAML](_index.md) documentation for information on the feature and how to set it up.
When troubleshooting a SAML configuration, GitLab team members will frequently start with the [SAML troubleshooting section](_index.md#troubleshooting).
They may then set up a test configuration of the desired identity provider. We include example screenshots in this section.
## SAML and SCIM screenshots
This section includes relevant screenshots of the following example configurations of [Group SAML](_index.md) and [Group SCIM](scim_setup.md):
- [Azure Active Directory](#azure-active-directory)
- [Google Workspace](#google-workspace)
- [Okta](#okta)
- [OneLogin](#onelogin)
{{< alert type="warning" >}}
These screenshots are updated only as needed by GitLab Support. They are **not** official documentation.
{{< /alert >}}
If you are currently having an issue with GitLab, you may want to check your [support options](https://about.gitlab.com/support/).
## Azure Active Directory
This section has screenshots for the elements of Azure Active Directory configuration.
### Basic SAML app configuration
### User claims and attributes
### SCIM mapping
Provisioning:
### Attribute mapping
### Group Sync
Using the **Group ID** source attribute requires users to enter the group ID or object ID when configuring SAML group links.
If available, you can add user-friendly group names instead. When setting up Azure group claims:
1. Select the **sAMAccountName** source attribute.
1. Enter a group name. You can specify a name up to 256 characters long.
1. To ensure the attribute is part of the assertion, select **Emit group names for cloud-only groups**.
[Azure AD limits the number of groups that can be sent in a SAML response to 150](https://support.esri.com/en-us/knowledge-base/when-azure-ad-is-the-saml-identify-provider-the-group-a-000022190). If a user is a member of more than 150 groups, Azure does not include that user's group claim in the SAML response.
## Google Workspace
### Basic SAML app configuration
### User claims and attributes
### IdP links and certificate
## Okta
### Basic SAML app configuration for GitLab.com groups
### Basic SAML app configuration for GitLab Self-Managed
### User claims and attributes
### Group Sync
### Advanced SAML app settings (defaults)
### IdP links and certificate
### SAML sign on settings
### SCIM settings
Setting the username for the newly provisioned users when assigning them the SCIM app:
## OneLogin
### Basic SAML app configuration
### Parameters
### Adding a user
### SSO settings
## SAML response example
When a user signs in using SAML, GitLab receives a SAML response. The SAML response can be found in `production.log` logs as a base64-encoded message. Locate the response by
searching for `SAMLResponse`. The decoded SAML response is in XML format. For example:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<saml2p:Response xmlns:saml2p="urn:oasis:names:tc:SAML:2.0:protocol" xmlns:xs="http://www.w3.org/2001/XMLSchema" Destination="https://gitlabexample/-/saml/callback" ID="id4898983630840142426821432" InResponseTo="_c65e4c88-9425-4472-b42c-37f4186ac0ee" IssueInstant="2022-05-30T21:30:35.696Z" Version="2.0">
<saml2:Issuer xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">http://www.okta.com/exk2y6j57o1Pdr2lI8qh7</saml2:Issuer>
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<ds:SignedInfo>
<ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
<ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
<ds:Reference URI="#id4898983630840142426821432">
<ds:Transforms>
<ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
<ec:InclusiveNamespaces xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#" PrefixList="xs"/>
</ds:Transform>
</ds:Transforms>
<ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
<ds:DigestValue>neiQvv9d3OgS4GZW8Nptp4JhjpKs3GCefibn+vmRgk4=</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>dMsQX8ivi...HMuKGhyLRvabGU6CuPrf7==</ds:SignatureValue>
<ds:KeyInfo>
<ds:X509Data>
<ds:X509Certificate>MIIDq...cptGr3vN9TQ==</ds:X509Certificate>
</ds:X509Data>
</ds:KeyInfo>
</ds:Signature>
<saml2p:Status xmlns:saml2p="urn:oasis:names:tc:SAML:2.0:protocol">
<saml2p:StatusCode Value="urn:oasis:names:tc:SAML:2.0:status:Success"/>
</saml2p:Status>
<saml2:Assertion xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:xs="http://www.w3.org/2001/XMLSchema" ID="id489" IssueInstant="2022-05-30T21:30:35.696Z" Version="2.0">
<saml2:Issuer xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">http://www.okta.com/exk2y6j57o1Pdr2lI8qh7</saml2:Issuer>
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<ds:SignedInfo>
<ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
<ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
<ds:Reference URI="#id48989836309833801859473359">
<ds:Transforms>
<ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
<ec:InclusiveNamespaces xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#" PrefixList="xs"/>
</ds:Transform>
</ds:Transforms>
<ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
<ds:DigestValue>MaIsoi8hbT9gsi/mNZsz449mUuAcuEWY0q3bc4asOQs=</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>dMsQX8ivi...HMuKGhyLRvabGU6CuPrf7==<</ds:SignatureValue>
<ds:KeyInfo>
<ds:X509Data>
<ds:X509Certificate>MIIDq...cptGr3vN9TQ==</ds:X509Certificate>
</ds:X509Data>
</ds:KeyInfo>
</ds:Signature>
<saml2:Subject xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion">
<saml2:NameID Format="urn:oasis:names:tc:SAML:2.0:nameid-format:persistent">useremail@domain.com</saml2:NameID>
<saml2:SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:bearer">
<saml2:SubjectConfirmationData InResponseTo="_c65e4c88-9425-4472-b42c-37f4186ac0ee" NotOnOrAfter="2022-05-30T21:35:35.696Z" Recipient="https://gitlab.example.com/-/saml/callback"/>
</saml2:SubjectConfirmation>
</saml2:Subject>
<saml2:Conditions xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" NotBefore="2022-05-30T21:25:35.696Z" NotOnOrAfter="2022-05-30T21:35:35.696Z">
<saml2:AudienceRestriction>
<saml2:Audience>https://gitlab.example.com/</saml2:Audience>
</saml2:AudienceRestriction>
</saml2:Conditions>
<saml2:AuthnStatement xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" AuthnInstant="2022-05-30T21:30:35.696Z" SessionIndex="_c65e4c88-9425-4472-b42c-37f4186ac0ee">
<saml2:AuthnContext>
<saml2:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport</saml2:AuthnContextClassRef>
</saml2:AuthnContext>
</saml2:AuthnStatement>
<saml2:AttributeStatement xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion">
<saml2:Attribute Name="email" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">useremail@domain.com</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="firtname" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">John</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="lastname" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Doe</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="Groups" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
<saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Super-awesome-group</saml2:AttributeValue>
</saml2:Attribute>
</saml2:AttributeStatement>
</saml2:Assertion>
</saml2p:Response>
```
|
https://docs.gitlab.com/user/security
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/security.md
|
2025-08-13
|
doc/user/duo_agent_platform
|
[
"doc",
"user",
"duo_agent_platform"
] |
security.md
|
AI-powered
|
Duo Workflow
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
GitLab Duo Agent Platform authentication and authorization
| null |
GitLab Duo Agent Platform uses a service account to perform actions on behalf of a user.
The token that authenticates requests is a composite of two identities:
- The primary author, which is the Duo Agent Platform [service account](../profile/service_accounts.md).
This service account is instance-wide and has the Developer role
on the project where the Duo Agent Platform was used. The service account is the owner of the token.
- The secondary author, which is the human user who submitted the quick action.
This user's `id` is included in the scopes of the token.
This composite identity ensures that any activities authored by Duo Agent Platform are
correctly attributed to the Duo Agent Platform service account.
At the same time, the composite identity ensures that there is no
[privilege escalation](https://en.wikipedia.org/wiki/Privilege_escalation) for the human user.
This [dynamic scope](https://github.com/doorkeeper-gem/doorkeeper/pull/1739)
is checked during the authorization of the API request.
When authorization is requested, GitLab validates that both the service account
and the user who originated the quick action have sufficient permissions.
|
---
stage: AI-powered
group: Duo Workflow
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab Duo Agent Platform authentication and authorization
breadcrumbs:
- doc
- user
- duo_agent_platform
---
GitLab Duo Agent Platform uses a service account to perform actions on behalf of a user.
The token that authenticates requests is a composite of two identities:
- The primary author, which is the Duo Agent Platform [service account](../profile/service_accounts.md).
This service account is instance-wide and has the Developer role
on the project where the Duo Agent Platform was used. The service account is the owner of the token.
- The secondary author, which is the human user who submitted the quick action.
This user's `id` is included in the scopes of the token.
This composite identity ensures that any activities authored by Duo Agent Platform are
correctly attributed to the Duo Agent Platform service account.
At the same time, the composite identity ensures that there is no
[privilege escalation](https://en.wikipedia.org/wiki/Privilege_escalation) for the human user.
This [dynamic scope](https://github.com/doorkeeper-gem/doorkeeper/pull/1739)
is checked during the authorization of the API request.
When authorization is requested, GitLab validates that both the service account
and the user who originated the quick action have sufficient permissions.
|
https://docs.gitlab.com/user/troubleshooting
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/troubleshooting.md
|
2025-08-13
|
doc/user/duo_agent_platform
|
[
"doc",
"user",
"duo_agent_platform"
] |
troubleshooting.md
|
AI-powered
|
Duo Workflow
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Troubleshooting the software development flow
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
{{< /details >}}
## General guidance
If you encounter issues, ensure that you have:
1. The latest version of the GitLab Workflow extension for VS Code.
1. A project that meets the [prerequisites](flows/software_development.md#prerequisites).
1. The repository open in VS Code.
1. The branch checked out.
For details on these steps, see [the prerequisites](flows/software_development.md#prerequisites) and
[how to connect to your repository](flows/software_development.md#connect-to-your-repository).
## View debugging logs
You can troubleshoot some issues by viewing debugging logs.
1. Open local debugging logs:
- On macOS: <kbd>Cmd</kbd> + <kbd>,</kbd>
- On Windows and Linux: <kbd>Ctrl</kbd> + <kbd>,</kbd>
1. Search for the setting **GitLab: Debug** and enable it.
1. Open the language server logs:
1. In VS Code, select **View** > **Output**.
1. In the output panel at the bottom, in the upper-right corner,
select **GitLab Workflow** or **GitLab Language Server** from the list.
1. Review for errors, warnings, connection issues, or authentication problems.
## Network issues
Your network might block the connection to the Agent Platform service,
for example, by using a firewall. By default the Agent Platform uses a gRPC
(Google Remote Procedure Call) connection. The network must let HTTP/2 traffic through to
the service for gRPC to work.
gRPC can be [changed to a WebSocket connection](#use-websocket-connection-instead-of-grpc) in the IDE.
To confirm that you can connect to the Agent Platform service using gRPC:
1. In Google Chrome or Firefox, open Developer Tools and select the **Network** tab.
1. Right-click the column headers to show the **Protocol** column.
1. In the address bar, enter `https://duo-workflow-svc.runway.gitlab.net/DuoWorkflow/ExecuteWorkflow`.
1. Ensure the request was successful and the **Protocol** column includes `h2` in Chrome or `HTTP/2` in Firefox.
If the request fails or does not show the HTTP/2 protocol:
- A security system like Netskope or Zscaler might be configured to block or inspect traffic.
- The HTTP/2 protocol downgrades to HTTP/1.1, which prevents the Agent Platform from working correctly.
To correct this issue, ask your network administrator to put `https://duo-workflow-svc.runway.gitlab.net/DuoWorkflow/ExecuteWorkflow`
on the correct allowlist, or to exempt it from traffic inspection.
### Use WebSocket connection instead of gRPC
If your network conditions do not allow a gRPC connection, WebSocket is an alternative in
VS Code and JetBrains IDEs:
- In VS Code:
1. Select **File** > **Preferences** > **Settings**
1. Search for the setting **GitLab: Duo Agent Platform: Connection Type**, then select `WebSocket`.
- In JetBrains:
1. On the top bar, select the main menu, then select **Settings**.
1. On the left sidebar, select **Tools > GitLab Duo**.
1. In the **GitLab Duo Agent Platform** > **Connection Type** section, select `WebSocket`.
## IDE configuration
You can try several things to ensure your repository is properly configured and connected.
### View the project in the GitLab Workflow extension
Start by ensuring the correct project is selected in the GitLab Workflow extension for VS Code.
1. In VS Code, on the left sidebar, select **GitLab Workflow** ({{< icon name="tanuki" >}}).
1. Ensure the project is listed and selected.
If an error message appears next to the project name, select it to reveal what needs to be updated.
For example, you might have multiple repositories and need to select one, or there might be no repositories at all.
#### No Git repository
If your workspace doesn't have a Git repository initialized, you must create a new one:
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. Select **Initialize Repository**.
When the repository is initialized, you should see the name in the **Source Control** view.
#### Git repository with no GitLab remote
You might have a Git repository but it's not properly connected to GitLab.
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. On the **Source Control** label, right-click and select **Repositories**.
1. Next to your repository, select the ellipsis ({{< icon name=ellipsis_h >}}), then **Remote > Add Remote**.
1. Enter your GitLab project URL.
1. Select the newly added remote as your upstream.
#### Multiple GitLab remotes
Your repository might have multiple GitLab remotes configured.
To select the correct one:
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. On the status bar, select the current remote name.
1. From the list, select the appropriate GitLab remote.
1. Ensure the selected remote belongs to a group namespace in GitLab.
#### Multiple GitLab projects
If your VS Code workspace contains multiple GitLab projects, you might want
to close all the projects you're not using.
To close projects:
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. Ensure repositories are shown: on the **Source Control** label, right-click and select **Repositories**.
1. Right-click the repository you want to close and select **Close Repository**.
### Project not in a group namespace
GitLab Duo Agent Platform requires that projects belong to a group namespace.
To determine the namespace your project is in, [look at the URL](../namespace/_index.md#determine-which-type-of-namespace-youre-in).
If necessary, you can
[transfer your project to a group namespace](../../tutorials/move_personal_project_to_group/_index.md#move-your-project-to-a-group).
## Still having issues?
Contact your GitLab administrator for assistance.
|
---
stage: AI-powered
group: Duo Workflow
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting the software development flow
breadcrumbs:
- doc
- user
- duo_agent_platform
---
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
{{< /details >}}
## General guidance
If you encounter issues, ensure that you have:
1. The latest version of the GitLab Workflow extension for VS Code.
1. A project that meets the [prerequisites](flows/software_development.md#prerequisites).
1. The repository open in VS Code.
1. The branch checked out.
For details on these steps, see [the prerequisites](flows/software_development.md#prerequisites) and
[how to connect to your repository](flows/software_development.md#connect-to-your-repository).
## View debugging logs
You can troubleshoot some issues by viewing debugging logs.
1. Open local debugging logs:
- On macOS: <kbd>Cmd</kbd> + <kbd>,</kbd>
- On Windows and Linux: <kbd>Ctrl</kbd> + <kbd>,</kbd>
1. Search for the setting **GitLab: Debug** and enable it.
1. Open the language server logs:
1. In VS Code, select **View** > **Output**.
1. In the output panel at the bottom, in the upper-right corner,
select **GitLab Workflow** or **GitLab Language Server** from the list.
1. Review for errors, warnings, connection issues, or authentication problems.
## Network issues
Your network might block the connection to the Agent Platform service,
for example, by using a firewall. By default the Agent Platform uses a gRPC
(Google Remote Procedure Call) connection. The network must let HTTP/2 traffic through to
the service for gRPC to work.
gRPC can be [changed to a WebSocket connection](#use-websocket-connection-instead-of-grpc) in the IDE.
To confirm that you can connect to the Agent Platform service using gRPC:
1. In Google Chrome or Firefox, open Developer Tools and select the **Network** tab.
1. Right-click the column headers to show the **Protocol** column.
1. In the address bar, enter `https://duo-workflow-svc.runway.gitlab.net/DuoWorkflow/ExecuteWorkflow`.
1. Ensure the request was successful and the **Protocol** column includes `h2` in Chrome or `HTTP/2` in Firefox.
If the request fails or does not show the HTTP/2 protocol:
- A security system like Netskope or Zscaler might be configured to block or inspect traffic.
- The HTTP/2 protocol downgrades to HTTP/1.1, which prevents the Agent Platform from working correctly.
To correct this issue, ask your network administrator to put `https://duo-workflow-svc.runway.gitlab.net/DuoWorkflow/ExecuteWorkflow`
on the correct allowlist, or to exempt it from traffic inspection.
### Use WebSocket connection instead of gRPC
If your network conditions do not allow a gRPC connection, WebSocket is an alternative in
VS Code and JetBrains IDEs:
- In VS Code:
1. Select **File** > **Preferences** > **Settings**
1. Search for the setting **GitLab: Duo Agent Platform: Connection Type**, then select `WebSocket`.
- In JetBrains:
1. On the top bar, select the main menu, then select **Settings**.
1. On the left sidebar, select **Tools > GitLab Duo**.
1. In the **GitLab Duo Agent Platform** > **Connection Type** section, select `WebSocket`.
## IDE configuration
You can try several things to ensure your repository is properly configured and connected.
### View the project in the GitLab Workflow extension
Start by ensuring the correct project is selected in the GitLab Workflow extension for VS Code.
1. In VS Code, on the left sidebar, select **GitLab Workflow** ({{< icon name="tanuki" >}}).
1. Ensure the project is listed and selected.
If an error message appears next to the project name, select it to reveal what needs to be updated.
For example, you might have multiple repositories and need to select one, or there might be no repositories at all.
#### No Git repository
If your workspace doesn't have a Git repository initialized, you must create a new one:
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. Select **Initialize Repository**.
When the repository is initialized, you should see the name in the **Source Control** view.
#### Git repository with no GitLab remote
You might have a Git repository but it's not properly connected to GitLab.
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. On the **Source Control** label, right-click and select **Repositories**.
1. Next to your repository, select the ellipsis ({{< icon name=ellipsis_h >}}), then **Remote > Add Remote**.
1. Enter your GitLab project URL.
1. Select the newly added remote as your upstream.
#### Multiple GitLab remotes
Your repository might have multiple GitLab remotes configured.
To select the correct one:
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. On the status bar, select the current remote name.
1. From the list, select the appropriate GitLab remote.
1. Ensure the selected remote belongs to a group namespace in GitLab.
#### Multiple GitLab projects
If your VS Code workspace contains multiple GitLab projects, you might want
to close all the projects you're not using.
To close projects:
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. Ensure repositories are shown: on the **Source Control** label, right-click and select **Repositories**.
1. Right-click the repository you want to close and select **Close Repository**.
### Project not in a group namespace
GitLab Duo Agent Platform requires that projects belong to a group namespace.
To determine the namespace your project is in, [look at the URL](../namespace/_index.md#determine-which-type-of-namespace-youre-in).
If necessary, you can
[transfer your project to a group namespace](../../tutorials/move_personal_project_to_group/_index.md#move-your-project-to-a-group).
## Still having issues?
Contact your GitLab administrator for assistance.
|
https://docs.gitlab.com/user/duo_agent_platform
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/_index.md
|
2025-08-13
|
doc/user/duo_agent_platform
|
[
"doc",
"user",
"duo_agent_platform"
] |
_index.md
|
AI-powered
|
Duo Workflow
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
GitLab Duo Agent Platform
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
- LLM: Anthropic [Claude Sonnet 4](https://www.anthropic.com/claude/sonnet)
- Available on GitLab Duo with self-hosted models: Not supported
{{< /details >}}
{{< history >}}
- Introduced as [a beta](../../policy/development_stages_support.md) in GitLab 18.2.
{{< /history >}}
With the GitLab Duo Agent Platform, multiple AI agents can work in parallel, helping you create code, research results, and perform tasks simultaneously.
The agents have full context across your entire software development lifecycle.
For more details, view this blog post about [what's next for intelligent DevSecOps](https://about.gitlab.com/blog/gitlab-duo-agent-platform-what-is-next-for-intelligent-devsecops/).
The Agent Platform is made up of multiple agents and flows, which are available
in the GitLab UI and the VS Code and JetBrains IDEs.
## Related topics
- [GitLab Duo Agentic Chat](../gitlab_duo_chat/agentic_chat.md)
- [Flows](flows/_index.md)
|
---
stage: AI-powered
group: Duo Workflow
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab Duo Agent Platform
breadcrumbs:
- doc
- user
- duo_agent_platform
---
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
- LLM: Anthropic [Claude Sonnet 4](https://www.anthropic.com/claude/sonnet)
- Available on GitLab Duo with self-hosted models: Not supported
{{< /details >}}
{{< history >}}
- Introduced as [a beta](../../policy/development_stages_support.md) in GitLab 18.2.
{{< /history >}}
With the GitLab Duo Agent Platform, multiple AI agents can work in parallel, helping you create code, research results, and perform tasks simultaneously.
The agents have full context across your entire software development lifecycle.
For more details, view this blog post about [what's next for intelligent DevSecOps](https://about.gitlab.com/blog/gitlab-duo-agent-platform-what-is-next-for-intelligent-devsecops/).
The Agent Platform is made up of multiple agents and flows, which are available
in the GitLab UI and the VS Code and JetBrains IDEs.
## Related topics
- [GitLab Duo Agentic Chat](../gitlab_duo_chat/agentic_chat.md)
- [Flows](flows/_index.md)
|
https://docs.gitlab.com/user/software_development_flow
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/software_development_flow.md
|
2025-08-13
|
doc/user/duo_agent_platform
|
[
"doc",
"user",
"duo_agent_platform"
] |
software_development_flow.md
| null | null | null | null | null |
<!-- markdownlint-disable -->
This document was moved to [another location](flows/software_development.md).
<!-- This redirect file can be deleted after <2025-09-29>. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. -->
<!-- Before deletion, see: https://docs.gitlab.com/development/documentation/redirects -->
|
---
redirect_to: flows/software_development.md
remove_date: '2025-09-29'
breadcrumbs:
- doc
- user
- duo_agent_platform
---
<!-- markdownlint-disable -->
This document was moved to [another location](flows/software_development.md).
<!-- This redirect file can be deleted after <2025-09-29>. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. -->
<!-- Before deletion, see: https://docs.gitlab.com/development/documentation/redirects -->
|
https://docs.gitlab.com/user/duo_agent_platform/issue_to_mr
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/duo_agent_platform/issue_to_mr.md
|
2025-08-13
|
doc/user/duo_agent_platform/flows
|
[
"doc",
"user",
"duo_agent_platform",
"flows"
] |
issue_to_mr.md
|
AI-powered
|
Duo Workflow
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Issue to MR flow
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
{{< /details >}}
{{< history >}}
- Introduced as [a beta](../../../policy/development_stages_support.md) in GitLab 18.3 [with a flag](../../../administration/feature_flags/_index.md) named `duo_workflow_in_ci`. Disabled by default. The `duo_workflow` flag must also be enabled.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
The **Issue to MR** flow streamlines the process of converting issues into actionable merge requests. This flow:
- Analyzes the issue description and requirements.
- Opens a draft merge request that's linked to the original issue.
- Creates a development plan based on the issue details.
- Creates code structure or implementation.
- Updates the merge request with the code changes.
This flow is available in the GitLab UI only.
## Prerequisites
Before you can create a merge request from an issue, you must have:
- An existing GitLab issue with clear requirements.
- At least Developer role in the project.
- GitLab Duo [turned on for your group or project](../../gitlab_duo/turn_on_off.md).
- Feature flags [`duo_workflow` and `duo_workflow_in_ci` enabled](../../../administration/feature_flags/_index.md).
## Use the Issue to MR flow
To use the **Issue to MR** flow:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Plan** > **Issues**.
1. Below the issue header, select **Generate MR with Duo**.
1. Monitor progress by selecting **Automate** > **Sessions**.
1. When the pipeline has successfully executed, a link to the merge request
is displayed in the issue's activity section.
1. Review the merge request and make changes as needed.
## Best practices
- Keep the issues well-scoped. Break down complex tasks into smaller, focused, and action-oriented requests.
- Specify exact file paths.
- Write specific acceptance criteria.
- Include code examples of existing patterns to maintain consistency.
## Example
This example shows a well-crafted issue that can be used to generate a merge request.
```plaintext
## Description
The users endpoint currently returns all users at once,
which will cause performance issues as the user base grows.
Implement cursor-based pagination for the `/api/users` endpoint
to handle large datasets efficiently.
## Implementation plan
Add pagination to GET /users API endpoint.
Include pagination metadata in /users API response (per_page, page).
Add query parameters for per page size limit (default 5, max 20).
#### Files to modify
- `src/api/users.py` - Add pagination parameters and logic.
- `src/models/user.py` - Add pagination query method.
- `tests/api/test_users_api.py` - Add pagination tests.
## Acceptance criteria
- Accepts page and per_page query parameters (default: page=5, per_page=10).
- Limits per_page to a maximum of 20 users.
- Maintains existing response format for user objects in data array.
```
|
---
stage: AI-powered
group: Duo Workflow
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Issue to MR flow
breadcrumbs:
- doc
- user
- duo_agent_platform
- flows
---
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
{{< /details >}}
{{< history >}}
- Introduced as [a beta](../../../policy/development_stages_support.md) in GitLab 18.3 [with a flag](../../../administration/feature_flags/_index.md) named `duo_workflow_in_ci`. Disabled by default. The `duo_workflow` flag must also be enabled.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
The **Issue to MR** flow streamlines the process of converting issues into actionable merge requests. This flow:
- Analyzes the issue description and requirements.
- Opens a draft merge request that's linked to the original issue.
- Creates a development plan based on the issue details.
- Creates code structure or implementation.
- Updates the merge request with the code changes.
This flow is available in the GitLab UI only.
## Prerequisites
Before you can create a merge request from an issue, you must have:
- An existing GitLab issue with clear requirements.
- At least Developer role in the project.
- GitLab Duo [turned on for your group or project](../../gitlab_duo/turn_on_off.md).
- Feature flags [`duo_workflow` and `duo_workflow_in_ci` enabled](../../../administration/feature_flags/_index.md).
## Use the Issue to MR flow
To use the **Issue to MR** flow:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Plan** > **Issues**.
1. Below the issue header, select **Generate MR with Duo**.
1. Monitor progress by selecting **Automate** > **Sessions**.
1. When the pipeline has successfully executed, a link to the merge request
is displayed in the issue's activity section.
1. Review the merge request and make changes as needed.
## Best practices
- Keep the issues well-scoped. Break down complex tasks into smaller, focused, and action-oriented requests.
- Specify exact file paths.
- Write specific acceptance criteria.
- Include code examples of existing patterns to maintain consistency.
## Example
This example shows a well-crafted issue that can be used to generate a merge request.
```plaintext
## Description
The users endpoint currently returns all users at once,
which will cause performance issues as the user base grows.
Implement cursor-based pagination for the `/api/users` endpoint
to handle large datasets efficiently.
## Implementation plan
Add pagination to GET /users API endpoint.
Include pagination metadata in /users API response (per_page, page).
Add query parameters for per page size limit (default 5, max 20).
#### Files to modify
- `src/api/users.py` - Add pagination parameters and logic.
- `src/models/user.py` - Add pagination query method.
- `tests/api/test_users_api.py` - Add pagination tests.
## Acceptance criteria
- Accepts page and per_page query parameters (default: page=5, per_page=10).
- Limits per_page to a maximum of 20 users.
- Maintains existing response format for user objects in data array.
```
|
https://docs.gitlab.com/user/duo_agent_platform/flows
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/duo_agent_platform/_index.md
|
2025-08-13
|
doc/user/duo_agent_platform/flows
|
[
"doc",
"user",
"duo_agent_platform",
"flows"
] |
_index.md
|
AI-powered
|
Duo Workflow
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Flows
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
- LLM: Anthropic [Claude Sonnet 4](https://www.anthropic.com/claude/sonnet)
{{< /details >}}
{{< history >}}
- Introduced as [a beta](../../../policy/development_stages_support.md) in GitLab 18.3.
{{< /history >}}
A flow is a combination of one or more agents working together to solve a complex problem.
Flows are available in IDEs and the GitLab UI.
- In the UI, they run directly in GitLab CI/CD,
helping you automate common development tasks without the need to leave your browser.
- In IDEs, flows are available in VS Code and JetBrains.
## Available flows
The following flows are available:
- A flow to [convert a Jenkinsfile to `.gitlab-ci.yml` file](convert_to_gitlab_ci.md).
- A flow to [convert an issue to a merge request](issue_to_mr.md).
- A flow for any aspect of [software development](software_development.md). In this flow,
you describe your needs and GitLab Duo understands your repository, the codebase,
and its structure.
For more focused pieces of work, like understanding selected code,
use [GitLab Duo Agentic Chat](../../gitlab_duo_chat/agentic_chat.md).
## Monitor running flows in the GitLab UI
To view flows that are running for your project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Automate > Sessions**.
## View flow history in the IDEs
To view a history of flows you've run in your project:
- On the **Flows** tab, scroll down and view **Recent agent sessions**.
## Supported APIs and permissions
In the GitLab UI, flows have access to the following GitLab APIs:
- [Projects API](../../../api/projects.md)
- [Issues API](../../../api/issues.md)
- [Merge Requests API](../../../api/merge_requests.md)
- [Repository Files API](../../../api/repository_files.md)
- [Branches API](../../../api/branches.md)
- [Commits API](../../../api/commits.md)
- [CI Pipelines API](../../../api/pipelines.md)
- [Labels API](../../../api/labels.md)
- [Epics API](../../../api/epics.md)
- [Notes API](../../../api/notes.md)
- [Search API](../../../api/search.md)
Flows use each user's permissions and respect all project access controls and security policies.
## Give feedback
Agents flows are part of GitLab AI-powered development platform. Your feedback helps us improve these workflows.
To report issues or suggest improvements for flows,
[complete this survey](https://gitlab.fra1.qualtrics.com/jfe/form/SV_9GmCPTV7oH9KNuu).
|
---
stage: AI-powered
group: Duo Workflow
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Flows
breadcrumbs:
- doc
- user
- duo_agent_platform
- flows
---
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
- LLM: Anthropic [Claude Sonnet 4](https://www.anthropic.com/claude/sonnet)
{{< /details >}}
{{< history >}}
- Introduced as [a beta](../../../policy/development_stages_support.md) in GitLab 18.3.
{{< /history >}}
A flow is a combination of one or more agents working together to solve a complex problem.
Flows are available in IDEs and the GitLab UI.
- In the UI, they run directly in GitLab CI/CD,
helping you automate common development tasks without the need to leave your browser.
- In IDEs, flows are available in VS Code and JetBrains.
## Available flows
The following flows are available:
- A flow to [convert a Jenkinsfile to `.gitlab-ci.yml` file](convert_to_gitlab_ci.md).
- A flow to [convert an issue to a merge request](issue_to_mr.md).
- A flow for any aspect of [software development](software_development.md). In this flow,
you describe your needs and GitLab Duo understands your repository, the codebase,
and its structure.
For more focused pieces of work, like understanding selected code,
use [GitLab Duo Agentic Chat](../../gitlab_duo_chat/agentic_chat.md).
## Monitor running flows in the GitLab UI
To view flows that are running for your project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Automate > Sessions**.
## View flow history in the IDEs
To view a history of flows you've run in your project:
- On the **Flows** tab, scroll down and view **Recent agent sessions**.
## Supported APIs and permissions
In the GitLab UI, flows have access to the following GitLab APIs:
- [Projects API](../../../api/projects.md)
- [Issues API](../../../api/issues.md)
- [Merge Requests API](../../../api/merge_requests.md)
- [Repository Files API](../../../api/repository_files.md)
- [Branches API](../../../api/branches.md)
- [Commits API](../../../api/commits.md)
- [CI Pipelines API](../../../api/pipelines.md)
- [Labels API](../../../api/labels.md)
- [Epics API](../../../api/epics.md)
- [Notes API](../../../api/notes.md)
- [Search API](../../../api/search.md)
Flows use each user's permissions and respect all project access controls and security policies.
## Give feedback
Agents flows are part of GitLab AI-powered development platform. Your feedback helps us improve these workflows.
To report issues or suggest improvements for flows,
[complete this survey](https://gitlab.fra1.qualtrics.com/jfe/form/SV_9GmCPTV7oH9KNuu).
|
https://docs.gitlab.com/user/duo_agent_platform/software_development
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/duo_agent_platform/software_development.md
|
2025-08-13
|
doc/user/duo_agent_platform/flows
|
[
"doc",
"user",
"duo_agent_platform",
"flows"
] |
software_development.md
|
AI-powered
|
Duo Workflow
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Software development flow
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
- LLM: Anthropic [Claude Sonnet 4](https://www.anthropic.com/claude/sonnet)
- Available on GitLab Duo with self-hosted models: Not supported
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14153) in GitLab 17.4 [with a flag](../../../administration/feature_flags/_index.md) named `duo_workflow`. Enabled for GitLab team members only. This feature is a [private beta](../../../policy/development_stages_support.md).
- [Changed name](https://gitlab.com/gitlab-org/gitlab/-/issues/551382), `duo_workflow` [flag enabled](../../../administration/feature_flags/_index.md), and status changed to beta in GitLab 18.2.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
The software development flow is the first flow that's available in the VS Code IDE.
Formerly known as GitLab Duo Workflow, the software development flow:
- Runs in your IDE so that you do not have to switch contexts or tools.
- Creates and works through a plan, in response to your prompt.
- Stages proposed changes in your project's repository.
You control when to accept, modify, or reject the suggestions.
- Understands the context of your project structure, codebase, and history.
You can also add your own context, such as relevant GitLab issues or merge requests.
This flow is available in the VS Code IDE only.
## Prerequisites
Before you can use the software development flow in Visual Studio Code (VS Code), you must:
### Step 1: Configure your GitLab environment
#### For GitLab.com
- Have an account on GitLab.com.
- Have a project that meets the following requirements:
- The project is on GitLab.com.
- You have at least the Developer role.
- The project belongs to a [group namespace](../../namespace/_index.md) with an Ultimate subscription.
- [Beta and experimental features must be turned on](../../gitlab_duo/turn_on_off.md#turn-on-beta-and-experimental-features).
- [GitLab Duo must be turned on](../../gitlab_duo/turn_on_off.md).
#### For GitLab Self-Managed
- Follow [the documentation](../../gitlab_duo/setup.md) to configure GitLab Duo on a GitLab Self-Managed instance.
- [GitLab Duo must be enabled](../../gitlab_duo/turn_on_off.md#turn-gitlab-duo-core-on-or-off).
- [Beta and experimental features must be turned on](../../gitlab_duo/turn_on_off.md#on-gitlab-self-managed).
### Step 2: Set up your local development environment
- [Install VS Code](https://code.visualstudio.com/download).
- [Set up the GitLab Workflow extension for VS Code](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow#setup). Minimum version 5.16.0.
- [Successfully connect to your repository](#connect-to-your-repository).
- [Ensure an HTTP/2 connection to the backend service is possible](../troubleshooting.md#network-issues).
## Connect to your repository
To use the software development flow in VS Code, ensure your repository is properly connected.
1. In VS Code, on the top menu, select **Terminal > New Terminal**.
1. Clone your repository: `git clone <repository>`.
1. Change to the directory where your repository was cloned and check out your branch: `git checkout <branch_name>`.
1. Ensure your project is selected:
1. On the left sidebar, select **GitLab Workflow** ({{< icon name="tanuki" >}}).
1. Select the project name. If you have multiple projects, select the one you want to work with.
1. In the terminal, ensure your repository is configured with a remote: `git remote -v`. The results should look similar to:
```plaintext
origin git@gitlab.com:gitlab-org/gitlab.git (fetch)
origin git@gitlab.com:gitlab-org/gitlab.git (push)
```
If no remote is defined, or you have multiple remotes:
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. On the **Source Control** label, right-click and select **Repositories**.
1. Next to your repository, select the ellipsis ({{< icon name=ellipsis_h >}}), then **Remote > Add Remote**.
1. Select **Add remote from GitLab**.
1. Choose a remote.
Now you can use the software development flow to help solve your coding tasks.
## Use the software development flow in VS Code
The software development flow is one flow in the Agent Platform.
To use the software development flow:
1. On the left sidebar, select **GitLab Duo Agent Platform (Beta)** ({{< icon name="duo-agentic-chat" >}}).
1. Select the **Flows** tab.
1. In the text box, specify a code task in detail.
- The software development flow is aware of all files available to Git in the project branch.
- You can provide additional [context](../../gitlab_duo/context.md#gitlab-duo-chat) for your chat.
- The software development flow cannot access external sources or the web.
1. Select **Start**.
After you describe your task, a plan is generated and executed.
You can pause or ask it to adjust the plan.
## Supported languages
The software development flow officially supports the following languages:
- CSS
- Go
- HTML
- Java
- JavaScript
- Markdown
- Python
- Ruby
- TypeScript
## APIs that the software development flow has access to
To create solutions and understand the context of the problem,
the software development flow accesses several GitLab APIs.
Specifically, an OAuth token with the `ai_workflows` scope has access
to the following APIs:
- [Projects API](../../../api/projects.md)
- [Search API](../../../api/search.md)
- [CI Pipelines API](../../../api/pipelines.md)
- [CI Jobs API](../../../api/jobs.md)
- [Merge Requests API](../../../api/merge_requests.md)
- [Epics API](../../../api/epics.md)
- [Issues API](../../../api/issues.md)
- [Notes API](../../../api/notes.md)
- [Usage Data API](../../../api/usage_data.md)
## Audit log
An audit event is created for each API request done by the software development flow.
On your GitLab Self-Managed instance, you can view these events on the
[instance audit events](../../../administration/compliance/audit_event_reports.md#instance-audit-events) page.
## Risks
The software development flow is an experimental product and users should consider their
circumstances before using this tool. It is subject to [the GitLab Testing Agreement](https://handbook.gitlab.com/handbook/legal/testing-agreement/).
The software development flow is an AI agent that is given some ability to perform actions on the user's behalf. AI tools based on LLMs are
inherently unpredictable and you should take appropriate precautions.
The software development flow in VS Code runs workflows on your local workstation.
All the documented risks should be considered before using this
product. The following risks are important to understand:
1. The software development flow has access to the local file system of the
project where you started running it. The software development flow respects your local `.gitignore` file,
but it can still access files that are not committed to the project and not called out in `.gitignore`.
Such files can contain credentials (for example, `.env` files).
1. The software development flow also gets access to a time-limited `ai_workflows` scoped GitLab
OAuth token with your user's identity. This token can be used to access
GitLab APIs on your behalf. This token is limited to the duration of
the workflow and only has access to certain APIs in GitLab.
Without user approval, the software development performs only read operations. By design, the token can still
perform write operations on the users behalf. You should consider
the access your user has in GitLab before running the software development flow.
1. You should not give the software development flow any additional credentials or secrets, in
goals or messages, as there is a chance it might end up using those in code
or other API calls.
## Give feedback
The software development flow is an experiment and your feedback is crucial to improve it for you and others.
To report issues or suggest improvements,
[complete this survey](https://gitlab.fra1.qualtrics.com/jfe/form/SV_9GmCPTV7oH9KNuu).
|
---
stage: AI-powered
group: Duo Workflow
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Software development flow
breadcrumbs:
- doc
- user
- duo_agent_platform
- flows
---
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
- LLM: Anthropic [Claude Sonnet 4](https://www.anthropic.com/claude/sonnet)
- Available on GitLab Duo with self-hosted models: Not supported
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14153) in GitLab 17.4 [with a flag](../../../administration/feature_flags/_index.md) named `duo_workflow`. Enabled for GitLab team members only. This feature is a [private beta](../../../policy/development_stages_support.md).
- [Changed name](https://gitlab.com/gitlab-org/gitlab/-/issues/551382), `duo_workflow` [flag enabled](../../../administration/feature_flags/_index.md), and status changed to beta in GitLab 18.2.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
The software development flow is the first flow that's available in the VS Code IDE.
Formerly known as GitLab Duo Workflow, the software development flow:
- Runs in your IDE so that you do not have to switch contexts or tools.
- Creates and works through a plan, in response to your prompt.
- Stages proposed changes in your project's repository.
You control when to accept, modify, or reject the suggestions.
- Understands the context of your project structure, codebase, and history.
You can also add your own context, such as relevant GitLab issues or merge requests.
This flow is available in the VS Code IDE only.
## Prerequisites
Before you can use the software development flow in Visual Studio Code (VS Code), you must:
### Step 1: Configure your GitLab environment
#### For GitLab.com
- Have an account on GitLab.com.
- Have a project that meets the following requirements:
- The project is on GitLab.com.
- You have at least the Developer role.
- The project belongs to a [group namespace](../../namespace/_index.md) with an Ultimate subscription.
- [Beta and experimental features must be turned on](../../gitlab_duo/turn_on_off.md#turn-on-beta-and-experimental-features).
- [GitLab Duo must be turned on](../../gitlab_duo/turn_on_off.md).
#### For GitLab Self-Managed
- Follow [the documentation](../../gitlab_duo/setup.md) to configure GitLab Duo on a GitLab Self-Managed instance.
- [GitLab Duo must be enabled](../../gitlab_duo/turn_on_off.md#turn-gitlab-duo-core-on-or-off).
- [Beta and experimental features must be turned on](../../gitlab_duo/turn_on_off.md#on-gitlab-self-managed).
### Step 2: Set up your local development environment
- [Install VS Code](https://code.visualstudio.com/download).
- [Set up the GitLab Workflow extension for VS Code](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow#setup). Minimum version 5.16.0.
- [Successfully connect to your repository](#connect-to-your-repository).
- [Ensure an HTTP/2 connection to the backend service is possible](../troubleshooting.md#network-issues).
## Connect to your repository
To use the software development flow in VS Code, ensure your repository is properly connected.
1. In VS Code, on the top menu, select **Terminal > New Terminal**.
1. Clone your repository: `git clone <repository>`.
1. Change to the directory where your repository was cloned and check out your branch: `git checkout <branch_name>`.
1. Ensure your project is selected:
1. On the left sidebar, select **GitLab Workflow** ({{< icon name="tanuki" >}}).
1. Select the project name. If you have multiple projects, select the one you want to work with.
1. In the terminal, ensure your repository is configured with a remote: `git remote -v`. The results should look similar to:
```plaintext
origin git@gitlab.com:gitlab-org/gitlab.git (fetch)
origin git@gitlab.com:gitlab-org/gitlab.git (push)
```
If no remote is defined, or you have multiple remotes:
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. On the **Source Control** label, right-click and select **Repositories**.
1. Next to your repository, select the ellipsis ({{< icon name=ellipsis_h >}}), then **Remote > Add Remote**.
1. Select **Add remote from GitLab**.
1. Choose a remote.
Now you can use the software development flow to help solve your coding tasks.
## Use the software development flow in VS Code
The software development flow is one flow in the Agent Platform.
To use the software development flow:
1. On the left sidebar, select **GitLab Duo Agent Platform (Beta)** ({{< icon name="duo-agentic-chat" >}}).
1. Select the **Flows** tab.
1. In the text box, specify a code task in detail.
- The software development flow is aware of all files available to Git in the project branch.
- You can provide additional [context](../../gitlab_duo/context.md#gitlab-duo-chat) for your chat.
- The software development flow cannot access external sources or the web.
1. Select **Start**.
After you describe your task, a plan is generated and executed.
You can pause or ask it to adjust the plan.
## Supported languages
The software development flow officially supports the following languages:
- CSS
- Go
- HTML
- Java
- JavaScript
- Markdown
- Python
- Ruby
- TypeScript
## APIs that the software development flow has access to
To create solutions and understand the context of the problem,
the software development flow accesses several GitLab APIs.
Specifically, an OAuth token with the `ai_workflows` scope has access
to the following APIs:
- [Projects API](../../../api/projects.md)
- [Search API](../../../api/search.md)
- [CI Pipelines API](../../../api/pipelines.md)
- [CI Jobs API](../../../api/jobs.md)
- [Merge Requests API](../../../api/merge_requests.md)
- [Epics API](../../../api/epics.md)
- [Issues API](../../../api/issues.md)
- [Notes API](../../../api/notes.md)
- [Usage Data API](../../../api/usage_data.md)
## Audit log
An audit event is created for each API request done by the software development flow.
On your GitLab Self-Managed instance, you can view these events on the
[instance audit events](../../../administration/compliance/audit_event_reports.md#instance-audit-events) page.
## Risks
The software development flow is an experimental product and users should consider their
circumstances before using this tool. It is subject to [the GitLab Testing Agreement](https://handbook.gitlab.com/handbook/legal/testing-agreement/).
The software development flow is an AI agent that is given some ability to perform actions on the user's behalf. AI tools based on LLMs are
inherently unpredictable and you should take appropriate precautions.
The software development flow in VS Code runs workflows on your local workstation.
All the documented risks should be considered before using this
product. The following risks are important to understand:
1. The software development flow has access to the local file system of the
project where you started running it. The software development flow respects your local `.gitignore` file,
but it can still access files that are not committed to the project and not called out in `.gitignore`.
Such files can contain credentials (for example, `.env` files).
1. The software development flow also gets access to a time-limited `ai_workflows` scoped GitLab
OAuth token with your user's identity. This token can be used to access
GitLab APIs on your behalf. This token is limited to the duration of
the workflow and only has access to certain APIs in GitLab.
Without user approval, the software development performs only read operations. By design, the token can still
perform write operations on the users behalf. You should consider
the access your user has in GitLab before running the software development flow.
1. You should not give the software development flow any additional credentials or secrets, in
goals or messages, as there is a chance it might end up using those in code
or other API calls.
## Give feedback
The software development flow is an experiment and your feedback is crucial to improve it for you and others.
To report issues or suggest improvements,
[complete this survey](https://gitlab.fra1.qualtrics.com/jfe/form/SV_9GmCPTV7oH9KNuu).
|
https://docs.gitlab.com/user/duo_agent_platform/convert_to_gitlab_ci
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/duo_agent_platform/convert_to_gitlab_ci.md
|
2025-08-13
|
doc/user/duo_agent_platform/flows
|
[
"doc",
"user",
"duo_agent_platform",
"flows"
] |
convert_to_gitlab_ci.md
|
AI-powered
|
Duo Workflow
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Convert to GitLab CI/CD flow
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
{{< /details >}}
{{< history >}}
- Introduced as [a beta](../../../policy/development_stages_support.md) in GitLab 18.3 [with a flag](../../../administration/feature_flags/_index.md) named `duo_workflow_in_ci`. Disabled by default. The `duo_workflow` flag must also be enabled.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
The **Convert to GitLab CI/CD** flow helps you migrate your Jenkins pipelines to GitLab CI/CD. This flow:
- Analyzes your existing Jenkins pipeline configuration.
- Converts Jenkins pipeline syntax to GitLab CI/CD YAML.
- Suggests best practices for GitLab CI/CD implementation.
- Creates a merge request with the converted pipeline configuration.
- Provides guidance on migrating Jenkins plugins to GitLab features.
This flow is available in the GitLab UI only.
## Prerequisites
Before you can convert a Jenkinsfile, you must have:
- Access to your Jenkins pipeline configuration.
- At least Developer role in the target GitLab project.
- GitLab Duo [turned on for your group or project](../../gitlab_duo/turn_on_off.md).
- Feature flags [`duo_workflow` and `duo_workflow_in_ci` enabled](../../../administration/feature_flags/_index.md).
## Use the flow
To convert your Jenkinsfile to GitLab CI/CD:
1. On the left sidebar, select **Search or go to** and find your project.
1. Open your Jenkinsfile.
1. Above the file, select **Convert to GitLab CI/CD**.
1. Monitor progress by selecting **Automate** > **Sessions**.
1. When the pipeline has successfully executed, on the left sidebar, select **Code** > **Merge requests**.
A merge request with the title `Duo Workflow: Convert to GitLab CI` is displayed.
1. Review the merge request and make changes as needed.
### Conversion process
The process converts:
- Pipeline stages and steps.
- Environment variables.
- Build triggers and parameters.
- Artifacts and dependencies.
- Parallel execution.
- Conditional logic.
- Post-build actions.
## Example
Jenkinsfile input:
```groovy
pipeline {
agent any
stages {
stage('Build') {
steps {
sh 'npm install'
sh 'npm build'
}
}
stage('Test') {
steps {
sh 'npm test'
}
}
stage('Deploy') {
when { branch 'main' }
steps {
sh './deploy.sh'
}
}
}
}
```
GitLab output:
```yaml
stages:
- build
- test
- deploy
build:
stage: build
script:
- npm install
- npm build
artifacts:
paths:
- node_modules/
- dist/
test:
stage: test
script:
- npm test
deploy:
stage: deploy
script:
- ./deploy.sh
only:
- main
```
|
---
stage: AI-powered
group: Duo Workflow
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Convert to GitLab CI/CD flow
breadcrumbs:
- doc
- user
- duo_agent_platform
- flows
---
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Core, Pro, or Enterprise
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
{{< /details >}}
{{< history >}}
- Introduced as [a beta](../../../policy/development_stages_support.md) in GitLab 18.3 [with a flag](../../../administration/feature_flags/_index.md) named `duo_workflow_in_ci`. Disabled by default. The `duo_workflow` flag must also be enabled.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
The **Convert to GitLab CI/CD** flow helps you migrate your Jenkins pipelines to GitLab CI/CD. This flow:
- Analyzes your existing Jenkins pipeline configuration.
- Converts Jenkins pipeline syntax to GitLab CI/CD YAML.
- Suggests best practices for GitLab CI/CD implementation.
- Creates a merge request with the converted pipeline configuration.
- Provides guidance on migrating Jenkins plugins to GitLab features.
This flow is available in the GitLab UI only.
## Prerequisites
Before you can convert a Jenkinsfile, you must have:
- Access to your Jenkins pipeline configuration.
- At least Developer role in the target GitLab project.
- GitLab Duo [turned on for your group or project](../../gitlab_duo/turn_on_off.md).
- Feature flags [`duo_workflow` and `duo_workflow_in_ci` enabled](../../../administration/feature_flags/_index.md).
## Use the flow
To convert your Jenkinsfile to GitLab CI/CD:
1. On the left sidebar, select **Search or go to** and find your project.
1. Open your Jenkinsfile.
1. Above the file, select **Convert to GitLab CI/CD**.
1. Monitor progress by selecting **Automate** > **Sessions**.
1. When the pipeline has successfully executed, on the left sidebar, select **Code** > **Merge requests**.
A merge request with the title `Duo Workflow: Convert to GitLab CI` is displayed.
1. Review the merge request and make changes as needed.
### Conversion process
The process converts:
- Pipeline stages and steps.
- Environment variables.
- Build triggers and parameters.
- Artifacts and dependencies.
- Parallel execution.
- Conditional logic.
- Post-build actions.
## Example
Jenkinsfile input:
```groovy
pipeline {
agent any
stages {
stage('Build') {
steps {
sh 'npm install'
sh 'npm build'
}
}
stage('Test') {
steps {
sh 'npm test'
}
}
stage('Deploy') {
when { branch 'main' }
steps {
sh './deploy.sh'
}
}
}
}
```
GitLab output:
```yaml
stages:
- build
- test
- deploy
build:
stage: build
script:
- npm install
- npm build
artifacts:
paths:
- node_modules/
- dist/
test:
stage: test
script:
- npm test
deploy:
stage: deploy
script:
- ./deploy.sh
only:
- main
```
|
https://docs.gitlab.com/user/crm
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/_index.md
|
2025-08-13
|
doc/user/crm
|
[
"doc",
"user",
"crm"
] |
_index.md
|
Plan
|
Project Management
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Customer relations management (CRM)
|
Customer management, organizations, contacts, and permissions.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2256) in GitLab 14.6 [with a flag](../../administration/feature_flags/_index.md) named `customer_relations`. Disabled by default.
- In GitLab 14.8 and later, you can [create contacts and organizations only in top-level groups](https://gitlab.com/gitlab-org/gitlab/-/issues/350634).
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/346082) in GitLab 15.0.
- [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/346082) in GitLab 15.1.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
{{< alert type="note" >}}
This feature is not under active development, but
[community contributions](https://about.gitlab.com/community/contribute/) are welcome.
To determine if the feature meets your needs, see the open issues in the [Managing and billing Clients Epic](https://gitlab.com/groups/gitlab-org/-/epics/5323).
{{< /alert >}}
With customer relations management (CRM) you can create a record of contacts
(individuals) and organizations (companies) and relate them to issues.
By default, contacts and organizations can only be created for top-level groups.
To create contacts and organizations in other groups, [assign the group as a contact source](#configure-the-contact-source).
You can use contacts and organizations to tie work to customers for billing and reporting purposes.
For more information about what is planned for the future, see [issue 2256](https://gitlab.com/gitlab-org/gitlab/-/issues/2256).
## Permissions
| Permission | Guest | Planner | Group Reporter | Group Developer, Maintainer, and Owner |
|------------------------------------|-------|---------|----------------|----------------------------------------|
| View contacts/organizations | | ✓ | ✓ | ✓ |
| View issue contacts | | ✓ | ✓ | ✓ |
| Add/remove issue contacts | | ✓ | ✓ | ✓ |
| Create/edit contacts/organizations | | | | ✓ |
## Enable customer relations management (CRM)
{{< history >}}
- [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108378) in GitLab 16.9.
{{< /history >}}
Customer relations management features are enabled at the group level. If your
group also contains subgroups, and you want to use CRM features in the subgroup,
CRM features must also be enabled for the subgroup.
To enable customer relations management in a group or subgroup:
1. On the left sidebar, select **Search or go to** and find your group or subgroup.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Select **Customer relations is enabled**.
1. Select **Save changes**.
## Configure the contact source
{{< history >}}
- [Available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/167475) in GitLab 17.6.
{{< /history >}}
By default, contacts are sourced from an issue's top-level group.
The contact source for a group will apply to all subgroups,
unless they have a contact source configured.
To configure the contact source for a group or subgroup:
1. On the left sidebar, select **Search or go to** and find your group or subgroup.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Select **Contact source > Search for a group**.
1. Select the group from which you wish to source contacts.
1. Select **Save changes**.
## Contacts
### View contacts linked to a group
Prerequisites:
- You must have at least the Planner role for the group.
To view a group's contacts:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
### Create a contact
Prerequisites:
- You must have at least the Developer role for the group.
To create a contact:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. Select **New contact**.
1. Complete all required fields.
1. Select **Create new contact**.
You can also [create](../../api/graphql/reference/_index.md#mutationcustomerrelationscontactcreate)
contacts using the GraphQL API.
### Edit a contact
Prerequisites:
- You must have at least the Developer role for the group.
To edit an existing contact:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. Next to the contact you wish to edit, select **Edit** ({{< icon name="pencil" >}}).
1. Edit the required fields.
1. Select **Save changes**.
You can also [edit](../../api/graphql/reference/_index.md#mutationcustomerrelationscontactupdate)
contacts using the GraphQL API.
#### Change the state of a contact
Each contact can be in one of two states:
- **Active**: contacts in this state can be added to an issue.
- **Inactive**: contacts in this state cannot be added to an issue.
To change the state of a contact:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. Next to the contact you wish to edit, select **Edit** ({{< icon name="pencil" >}}).
1. Select or clear the **Active** checkbox.
1. Select **Save changes**.
## Organizations
### View organizations
Prerequisites:
- You must have at least the Planner role for the group.
To view a group's organizations:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. In the upper right, select **Organizations**.
### Create an organization
Prerequisites:
- You must have at least the Developer role for the group.
To create an organization:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. In the upper right, select **Organizations**.
1. Select **New organization**.
1. Complete all required fields.
1. Select **Create new organization**.
You can also [create](../../api/graphql/reference/_index.md#mutationcustomerrelationsorganizationcreate)
organizations using the GraphQL API.
### Edit an organization
Prerequisites:
- You must have at least the Developer role for the group.
To edit an existing organization:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. In the upper right, select **Organizations**.
1. Next to the organization you wish to edit, select **Edit** ({{< icon name="pencil" >}}).
1. Edit the required fields.
1. Select **Save changes**.
You can also [edit](../../api/graphql/reference/_index.md#mutationcustomerrelationsorganizationupdate)
organizations using the GraphQL API.
## Issues
If you use [Service Desk](../project/service_desk/_index.md) and create issues from emails,
issues are linked to contacts matching the email addresses in the sender and CC of the email.
### View issues linked to a contact
Prerequisites:
- You must have at least the Planner role for the group.
To view a contact's issues, select a contact from the issue sidebar, or:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. Next to the contact whose issues you wish to view, select **View issues** ({{< icon name="issues" >}}).
### View issues linked to an organization
Prerequisites:
- You must have at least the Planner role for the group.
To view an organization's issues:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. In the upper right, select **Organizations**.
1. Next to the organization whose issues you wish to view, select **View issues** ({{< icon name="issues" >}}).
### View contacts linked to an issue
Prerequisites:
- You must have at least the Planner role for the group.
You can view contacts associated with an issue in the right sidebar.
To view a contact's details, hover over the contact's name.
You can also view issue contacts using the
[GraphQL](../../api/graphql/reference/_index.md#mutationcustomerrelationsorganizationcreate)
API.
### Add contacts to an issue
Prerequisites:
- You must have at least the Planner role for the group.
To add [active](#change-the-state-of-a-contact) contacts to an issue use the `/add_contacts [contact:address@example.com]`
[quick action](../project/quick_actions.md).
You can also add, remove, or replace issue contacts using the
[GraphQL](../../api/graphql/reference/_index.md#mutationissuesetcrmcontacts)
API.
### Remove contacts from an issue
Prerequisites:
- You must have at least the Planner role for the group.
To remove contacts from an issue use the `/remove_contacts [contact:address@example.com]`
[quick action](../project/quick_actions.md).
You can also add, remove, or replace issue contacts using the
[GraphQL](../../api/graphql/reference/_index.md#mutationissuesetcrmcontacts)
API.
## Autocomplete contacts
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2256) in GitLab 14.8 [with a flag](../../administration/feature_flags/_index.md) named `contacts_autocomplete`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/352123) in GitLab 15.0.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/352123) in GitLab 15.2. [Feature flag `contacts_autocomplete`](https://gitlab.com/gitlab-org/gitlab/-/issues/352123) removed.
{{< /history >}}
When you use the `/add_contacts` quick action, follow it with `[contact:` and an autocomplete list with the [active](#change-the-state-of-a-contact) contacts appears:
```plaintext
/add_contacts [contact:
```
When you use the `/remove_contacts` quick action, follow it with `[contact:` and an autocomplete list with the contacts added to the issue appears:
```plaintext
/remove_contacts [contact:
```
## Moving objects with CRM entries
When you move an issue or project and the **parent group contact source matches**,
issues retain their contacts.
When you move an issue or project and the **parent group contact source changes**,
issues lose their contacts.
When you move a group with a [contact source configured](#configure-the-contact-source)
or it's **contact source remains unchanged**,
issues retain their contacts.
When you move a group and its **contact source changes**:
- All unique contacts and organizations are migrated to the new top-level group.
- Contacts that already exist (by email address) are deemed duplicates and deleted.
- Organizations that already exist (by name) are deemed duplicates and deleted.
- All issues retain their contacts or are updated to point at contacts with the same email address.
If you do not have permission to create contacts and organizations in the new
top-level group, the group transfer fails.
|
---
stage: Plan
group: Project Management
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Customer relations management (CRM)
description: Customer management, organizations, contacts, and permissions.
breadcrumbs:
- doc
- user
- crm
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2256) in GitLab 14.6 [with a flag](../../administration/feature_flags/_index.md) named `customer_relations`. Disabled by default.
- In GitLab 14.8 and later, you can [create contacts and organizations only in top-level groups](https://gitlab.com/gitlab-org/gitlab/-/issues/350634).
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/346082) in GitLab 15.0.
- [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/346082) in GitLab 15.1.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169256) the minimum user role from Reporter to Planner in GitLab 17.7.
{{< /history >}}
{{< alert type="note" >}}
This feature is not under active development, but
[community contributions](https://about.gitlab.com/community/contribute/) are welcome.
To determine if the feature meets your needs, see the open issues in the [Managing and billing Clients Epic](https://gitlab.com/groups/gitlab-org/-/epics/5323).
{{< /alert >}}
With customer relations management (CRM) you can create a record of contacts
(individuals) and organizations (companies) and relate them to issues.
By default, contacts and organizations can only be created for top-level groups.
To create contacts and organizations in other groups, [assign the group as a contact source](#configure-the-contact-source).
You can use contacts and organizations to tie work to customers for billing and reporting purposes.
For more information about what is planned for the future, see [issue 2256](https://gitlab.com/gitlab-org/gitlab/-/issues/2256).
## Permissions
| Permission | Guest | Planner | Group Reporter | Group Developer, Maintainer, and Owner |
|------------------------------------|-------|---------|----------------|----------------------------------------|
| View contacts/organizations | | ✓ | ✓ | ✓ |
| View issue contacts | | ✓ | ✓ | ✓ |
| Add/remove issue contacts | | ✓ | ✓ | ✓ |
| Create/edit contacts/organizations | | | | ✓ |
## Enable customer relations management (CRM)
{{< history >}}
- [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108378) in GitLab 16.9.
{{< /history >}}
Customer relations management features are enabled at the group level. If your
group also contains subgroups, and you want to use CRM features in the subgroup,
CRM features must also be enabled for the subgroup.
To enable customer relations management in a group or subgroup:
1. On the left sidebar, select **Search or go to** and find your group or subgroup.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Select **Customer relations is enabled**.
1. Select **Save changes**.
## Configure the contact source
{{< history >}}
- [Available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/167475) in GitLab 17.6.
{{< /history >}}
By default, contacts are sourced from an issue's top-level group.
The contact source for a group will apply to all subgroups,
unless they have a contact source configured.
To configure the contact source for a group or subgroup:
1. On the left sidebar, select **Search or go to** and find your group or subgroup.
1. Select **Settings > General**.
1. Expand the **Permissions and group features** section.
1. Select **Contact source > Search for a group**.
1. Select the group from which you wish to source contacts.
1. Select **Save changes**.
## Contacts
### View contacts linked to a group
Prerequisites:
- You must have at least the Planner role for the group.
To view a group's contacts:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
### Create a contact
Prerequisites:
- You must have at least the Developer role for the group.
To create a contact:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. Select **New contact**.
1. Complete all required fields.
1. Select **Create new contact**.
You can also [create](../../api/graphql/reference/_index.md#mutationcustomerrelationscontactcreate)
contacts using the GraphQL API.
### Edit a contact
Prerequisites:
- You must have at least the Developer role for the group.
To edit an existing contact:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. Next to the contact you wish to edit, select **Edit** ({{< icon name="pencil" >}}).
1. Edit the required fields.
1. Select **Save changes**.
You can also [edit](../../api/graphql/reference/_index.md#mutationcustomerrelationscontactupdate)
contacts using the GraphQL API.
#### Change the state of a contact
Each contact can be in one of two states:
- **Active**: contacts in this state can be added to an issue.
- **Inactive**: contacts in this state cannot be added to an issue.
To change the state of a contact:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. Next to the contact you wish to edit, select **Edit** ({{< icon name="pencil" >}}).
1. Select or clear the **Active** checkbox.
1. Select **Save changes**.
## Organizations
### View organizations
Prerequisites:
- You must have at least the Planner role for the group.
To view a group's organizations:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. In the upper right, select **Organizations**.
### Create an organization
Prerequisites:
- You must have at least the Developer role for the group.
To create an organization:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. In the upper right, select **Organizations**.
1. Select **New organization**.
1. Complete all required fields.
1. Select **Create new organization**.
You can also [create](../../api/graphql/reference/_index.md#mutationcustomerrelationsorganizationcreate)
organizations using the GraphQL API.
### Edit an organization
Prerequisites:
- You must have at least the Developer role for the group.
To edit an existing organization:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. In the upper right, select **Organizations**.
1. Next to the organization you wish to edit, select **Edit** ({{< icon name="pencil" >}}).
1. Edit the required fields.
1. Select **Save changes**.
You can also [edit](../../api/graphql/reference/_index.md#mutationcustomerrelationsorganizationupdate)
organizations using the GraphQL API.
## Issues
If you use [Service Desk](../project/service_desk/_index.md) and create issues from emails,
issues are linked to contacts matching the email addresses in the sender and CC of the email.
### View issues linked to a contact
Prerequisites:
- You must have at least the Planner role for the group.
To view a contact's issues, select a contact from the issue sidebar, or:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. Next to the contact whose issues you wish to view, select **View issues** ({{< icon name="issues" >}}).
### View issues linked to an organization
Prerequisites:
- You must have at least the Planner role for the group.
To view an organization's issues:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Plan > Customer relations**.
1. In the upper right, select **Organizations**.
1. Next to the organization whose issues you wish to view, select **View issues** ({{< icon name="issues" >}}).
### View contacts linked to an issue
Prerequisites:
- You must have at least the Planner role for the group.
You can view contacts associated with an issue in the right sidebar.
To view a contact's details, hover over the contact's name.
You can also view issue contacts using the
[GraphQL](../../api/graphql/reference/_index.md#mutationcustomerrelationsorganizationcreate)
API.
### Add contacts to an issue
Prerequisites:
- You must have at least the Planner role for the group.
To add [active](#change-the-state-of-a-contact) contacts to an issue use the `/add_contacts [contact:address@example.com]`
[quick action](../project/quick_actions.md).
You can also add, remove, or replace issue contacts using the
[GraphQL](../../api/graphql/reference/_index.md#mutationissuesetcrmcontacts)
API.
### Remove contacts from an issue
Prerequisites:
- You must have at least the Planner role for the group.
To remove contacts from an issue use the `/remove_contacts [contact:address@example.com]`
[quick action](../project/quick_actions.md).
You can also add, remove, or replace issue contacts using the
[GraphQL](../../api/graphql/reference/_index.md#mutationissuesetcrmcontacts)
API.
## Autocomplete contacts
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2256) in GitLab 14.8 [with a flag](../../administration/feature_flags/_index.md) named `contacts_autocomplete`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/352123) in GitLab 15.0.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/352123) in GitLab 15.2. [Feature flag `contacts_autocomplete`](https://gitlab.com/gitlab-org/gitlab/-/issues/352123) removed.
{{< /history >}}
When you use the `/add_contacts` quick action, follow it with `[contact:` and an autocomplete list with the [active](#change-the-state-of-a-contact) contacts appears:
```plaintext
/add_contacts [contact:
```
When you use the `/remove_contacts` quick action, follow it with `[contact:` and an autocomplete list with the contacts added to the issue appears:
```plaintext
/remove_contacts [contact:
```
## Moving objects with CRM entries
When you move an issue or project and the **parent group contact source matches**,
issues retain their contacts.
When you move an issue or project and the **parent group contact source changes**,
issues lose their contacts.
When you move a group with a [contact source configured](#configure-the-contact-source)
or it's **contact source remains unchanged**,
issues retain their contacts.
When you move a group and its **contact source changes**:
- All unique contacts and organizations are migrated to the new top-level group.
- Contacts that already exist (by email address) are deemed duplicates and deleted.
- Organizations that already exist (by name) are deemed duplicates and deleted.
- All issues retain their contacts or are updated to point at contacts with the same email address.
If you do not have permission to create contacts and organizations in the new
top-level group, the group transfer fails.
|
https://docs.gitlab.com/user/set_up_infrastructure
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/set_up_infrastructure.md
|
2025-08-13
|
doc/user/workspace
|
[
"doc",
"user",
"workspace"
] |
set_up_infrastructure.md
|
Create
|
Remote Development
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Tutorial: Set up workspaces infrastructure on AWS
|
Create the infrastructure needed to support GitLab Workspaces for on-demand, cloud-based development environments.
|
<!-- vale gitlab_base.FutureTense = NO -->
This tutorial guides you through the GitLab workspaces infrastructure setup on AWS using
[OpenTofu](https://opentofu.org/), an open-source fork of Terraform through Infrastructure as Code (IaC).
## Before you begin
To follow this tutorial, you must have:
- An Amazon Web Services (AWS) account.
- A domain name for your workspaces environment.
To set up GitLab workspaces infrastructure:
1. [Fork the repository](#fork-the-repository)
1. [Set up AWS credentials](#set-up-aws-credentials)
1. [Prepare domain and certificates](#prepare-domain-and-certificates)
1. [Create required keys](#create-required-keys)
1. [Create a GitLab Agent for Kubernetes token](#create-a-gitlab-agent-for-kubernetes-token)
1. [Configure GitLab OAuth](#configure-gitlab-oauth)
1. [Configure CI/CD variables](#configure-cicd-variables)
1. [Update the GitLab agent for Kubernetes configuration](#update-the-gitlab-agent-for-kubernetes-configuration)
1. [Run the pipeline](#run-the-pipeline)
1. [Configure DNS records](#configure-dns-records)
1. [Authorize the agent](#authorize-the-agent)
1. [Create a workspace and verify setup](#create-a-workspace-and-verify-setup)
## Fork the repository
First, you need to create your own copy of the infrastructure setup repository so that you can
configure it for your environment.
{{< alert type="note" >}}
It is not possible to create workspaces from projects in your personal namespace. Instead, fork the
repository to a top-level group or subgroup.
{{< /alert >}}
To fork the repository:
1. Go to the [Workspaces Infrastructure Setup AWS](https://gitlab.com/gitlab-org/workspaces/examples/workspaces-infrastructure-setup-aws) repository.
1. Create a fork of the repository. For more information, see [Create a fork](../project/repository/forking_workflow.md#create-a-fork).
## Set up AWS credentials
Next, set up the necessary permissions in AWS so the infrastructure can be properly provisioned.
To set up AWS credentials:
1. Create an [IAM User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) or
[IAM Role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html).
1. Assign the following permissions:
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"ec2:*",
"eks:*",
"elasticloadbalancing:*",
"autoscaling:*",
"cloudwatch:*",
"logs:*",
"kms:DescribeKey",
"kms:TagResource",
"kms:UntagResource",
"kms:ListResourceTags",
"kms:CreateKey",
"kms:CreateAlias",
"kms:ListAliases",
"kms:DeleteAlias",
"iam:AddRoleToInstanceProfile",
"iam:AttachRolePolicy",
"iam:CreateInstanceProfile",
"iam:CreateRole",
"iam:CreateServiceLinkedRole",
"iam:GetRole",
"iam:ListAttachedRolePolicies",
"iam:ListRolePolicies",
"iam:ListRoles",
"iam:PassRole",
"iam:DetachRolePolicy",
"iam:ListInstanceProfilesForRole",
"iam:DeleteRole",
"iam:CreateOpenIDConnectProvider",
"iam:CreatePolicy",
"iam:TagOpenIDConnectProvider",
"iam:GetPolicy",
"iam:GetPolicyVersion",
"iam:GetOpenIDConnectProvider",
"iam:DeleteOpenIDConnectProvider",
"iam:ListPolicyVersions",
"iam:DeletePolicy"
],
"Resource": "*"
}
]
}
```
1. [Create an access key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)
for the user or role.
1. Save your access key ID and secret access key. You'll need them when configuring CI/CD variables later.
## Prepare domain and certificates
For your workspaces to be accessible, you'll need a domain and TLS certificates to secure the
connections.
To prepare your domain and certificates:
1. Buy a domain or use an existing domain for your workspaces environment.
1. Create TLS certificates for:
- GitLab Workspaces Proxy Domain. For example, `workspaces.example.dev`.
- GitLab Workspaces Proxy Wildcard Domain. For example, `*.workspaces.example.dev`.
For more information, see [Generate TLS certificates](set_up_gitlab_agent_and_proxies.md#generate-tls-certificates).
## Create required keys
Now you need to create security keys for authentication and SSH connections.
To create the required keys:
1. Generate a signing key consisting of random letters, numbers, and special characters.
For example, run:
```shell
openssl rand -base64 32
```
1. Generate an SSH host key:
```shell
ssh-keygen -f ssh-host-key -N '' -t rsa
```
## Create a GitLab agent for Kubernetes token
The GitLab agent for Kubernetes connects your AWS Kubernetes cluster to GitLab.
To create a token for the agent:
1. Go to your group.
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Operate** > **Kubernetes clusters**.
1. Select **Connect a cluster**.
1. Enter a name for your agent and save for later use. For example, `gitlab-workspaces-agentk-eks`.
1. Select **Create and register**.
1. Save the token and KAS address for later use.
1. Select **Continue**.
## Configure GitLab OAuth
Next, set up OAuth authentication to securely access workspaces.
To configure GitLab OAuth:
1. Go to **User settings**:
1. Select your profile picture, then select **Preferences**.
1. On the left sidebar, select **Applications**.
1. Scroll down to **OAuth applications**.
1. Select **Add new application**.
1. Update the following settings:
- Name: GitLab Workspaces Proxy
- Redirect URI: For example, `https://workspaces.example.dev/auth/callback`. Replace with your
user-defined domain.
- Select the **Confidential** checkbox.
- Scopes: `api`, `read_user`, `openid`, and `profile`.
1. Select **Save application**.
1. Save the **Application ID** and **Secret** for your CI/CD variables.
1. Select **Continue**.
## Configure CI/CD variables
Now, you need to add the necessary variables to your CI/CD configuration so the infrastructure
pipeline can run.
To configure CI/CD variables:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings** > **CI/CD**.
1. Expand **Variables**.
1. In the **Project variables** section, add the following required variables:
| Variable | Value |
|------------------------------------------------|-------|
| `AWS_ACCESS_KEY_ID` | AWS access key ID. |
| `AWS_SECRET_ACCESS_KEY` | AWS secret access key. |
| `TF_VAR_agent_token` | GitLab agent for Kubernetes token. |
| `TF_VAR_kas_address` | GitLab Kubernetes Agent Server address. Required if on a GitLab Self-Managed instance. For example, `wss://kas.gitlab.com`. |
| `TF_VAR_workspaces_proxy_auth_client_id` | OAuth application client ID. |
| `TF_VAR_workspaces_proxy_auth_client_secret` | OAuth application secret. |
| `TF_VAR_workspaces_proxy_auth_redirect_uri` | OAuth callback URL. For example, `https://workspaces.example.dev/auth/callback`. |
| `TF_VAR_workspaces_proxy_auth_signing_key` | Your generated signing key. |
| `TF_VAR_workspaces_proxy_domain` | Domain for the workspaces proxy. |
| `TF_VAR_workspaces_proxy_domain_cert` | TLS certificate for the proxy domain. |
| `TF_VAR_workspaces_proxy_domain_key` | TLS key for the proxy domain. |
| `TF_VAR_workspaces_proxy_ssh_host_key` | Your generated SSH host key. |
| `TF_VAR_workspaces_proxy_wildcard_domain` | Wildcard domain for workspaces. |
| `TF_VAR_workspaces_proxy_wildcard_domain_cert` | TLS certificate for the wildcard domain. |
| `TF_VAR_workspaces_proxy_wildcard_domain_key` | TLS key for the wildcard domain. |
1. Optional. Add any of these variables to customize your deployment:
| Variable | Value |
|----------------------------------------------|-------|
| `TF_VAR_region` | AWS region. |
| `TF_VAR_zones` | AWS availability zones. |
| `TF_VAR_name` | Name prefix for resources. |
| `TF_VAR_cluster_endpoint_public_access` | Public access to cluster endpoint. |
| `TF_VAR_cluster_node_instance_type` | EC2 instance type for Kubernetes nodes. |
| `TF_VAR_cluster_node_count_min` | Minimum number of worker nodes. |
| `TF_VAR_cluster_node_count_max` | Maximum number of worker nodes. |
| `TF_VAR_cluster_node_count` | Number of worker nodes. |
| `TF_VAR_cluster_node_labels` | Map of labels to apply on the cluster nodes. |
| `TF_VAR_agent_namespace` | Kubernetes namespace for the agent. |
| `TF_VAR_workspaces_proxy_namespace` | Kubernetes namespace for workspaces proxy. |
| `TF_VAR_workspaces_proxy_ingress_class_name` | Ingress class name. |
| `TF_VAR_ingress_nginx_namespace` | Kubernetes namespace for Ingress-NGINX. |
Great job! You've configured all the necessary variables for your infrastructure deployment.
## Update the GitLab agent for Kubernetes configuration
Now, you need to configure the GitLab agent for Kubernetes to support workspaces.
To update the agent configuration:
1. In your forked repository, open the `.gitlab/agents/gitlab-workspaces-agentk-eks/config.yaml` file.
{{< alert type="note" >}}
The directory that contains the `config.yaml` file must match the agent name you created in the
[Create a GitLab agent for Kubernetes token](#create-a-gitlab-agent-for-kubernetes-token) step.
{{< /alert >}}
1. Update the file with the following required fields:
```yaml
remote_development:
enabled: true
dns_zone: "workspaces.example.dev" # Replace with your domain
```
For more configuration options, see [Workspace settings](settings.md).
1. Commit and push these changes to your repository.
## Run the pipeline
It's time to deploy your infrastructure. You'll run the CI/CD pipeline to create all the necessary
resources in AWS.
To run the pipeline:
1. Create a new pipeline in your GitLab project:
1. On the left sidebar, select **Build** > **Pipelines**.
1. Select **New pipeline** and select **New pipeline** again to confirm.
1. Verify the `plan` job succeeds, then manually trigger the `apply` job.
When the OpenTofu code runs, it creates these resources in AWS:
- A Virtual Private Cloud (VPC).
- An Elastic Kubernetes Service (EKS) cluster.
- A GitLab agent for Kubernetes Helm release.
- A GitLab Workspaces Proxy Helm release.
- An Ingress NGINX Helm release.
Excellent! Your infrastructure is now being deployed. This might take some time to complete.
## Configure DNS records
Now that your infrastructure is deployed, you need to configure DNS records to point to your new
environment.
To configure DNS records:
1. Get the Ingress-NGINX load balancer address from the pipeline output:
```shell
kubectl get services -n ingress-nginx ingress-nginx-controller
```
1. Create DNS records that point your domains to this address. For example:
- `workspaces.example.dev` → Load balancer IP address
- `*.workspaces.example.dev` → Load balancer IP address
## Authorize the agent
Next, you'll authorize the GitLab agent for Kubernetes to connect to your GitLab instance.
To authorize the agent:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings** > **Workspaces**.
1. In the **Group agents** section, select the **All agents** tab.
1. From the list of available agents, find the agent with status **Blocked**, and select **Allow**.
1. On the confirmation dialog, select **Allow agent**.
## Create a workspace and verify setup
Finally, let's make sure everything is working correctly by creating a test workspace.
To verify your workspace setup:
1. Create a new workspace by following the steps in [Create a workspace](configuration.md#create-a-workspace).
1. From your project, select **Code**.
1. Select your workspace name.
1. Interact with the workspace by opening the Web IDE, accessing the terminal, or making changes to project files.
Congratulations! You've successfully set up GitLab workspaces infrastructure on AWS. Your users
can now create development workspace environments for their projects.
If you encounter any issues, check the logs for additional details and refer to
[Troubleshooting workspaces](workspaces_troubleshooting.md) for guidance.
## Related topics
- [Workspaces](_index.md)
- [Configure workspaces](configuration.md)
- [Workspace settings](settings.md)
- [Tutorial: Create a custom workspace image that supports arbitrary user IDs](create_image.md)
|
---
stage: Create
group: Remote Development
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Create the infrastructure needed to support GitLab Workspaces for on-demand,
cloud-based development environments.
title: 'Tutorial: Set up workspaces infrastructure on AWS'
breadcrumbs:
- doc
- user
- workspace
---
<!-- vale gitlab_base.FutureTense = NO -->
This tutorial guides you through the GitLab workspaces infrastructure setup on AWS using
[OpenTofu](https://opentofu.org/), an open-source fork of Terraform through Infrastructure as Code (IaC).
## Before you begin
To follow this tutorial, you must have:
- An Amazon Web Services (AWS) account.
- A domain name for your workspaces environment.
To set up GitLab workspaces infrastructure:
1. [Fork the repository](#fork-the-repository)
1. [Set up AWS credentials](#set-up-aws-credentials)
1. [Prepare domain and certificates](#prepare-domain-and-certificates)
1. [Create required keys](#create-required-keys)
1. [Create a GitLab Agent for Kubernetes token](#create-a-gitlab-agent-for-kubernetes-token)
1. [Configure GitLab OAuth](#configure-gitlab-oauth)
1. [Configure CI/CD variables](#configure-cicd-variables)
1. [Update the GitLab agent for Kubernetes configuration](#update-the-gitlab-agent-for-kubernetes-configuration)
1. [Run the pipeline](#run-the-pipeline)
1. [Configure DNS records](#configure-dns-records)
1. [Authorize the agent](#authorize-the-agent)
1. [Create a workspace and verify setup](#create-a-workspace-and-verify-setup)
## Fork the repository
First, you need to create your own copy of the infrastructure setup repository so that you can
configure it for your environment.
{{< alert type="note" >}}
It is not possible to create workspaces from projects in your personal namespace. Instead, fork the
repository to a top-level group or subgroup.
{{< /alert >}}
To fork the repository:
1. Go to the [Workspaces Infrastructure Setup AWS](https://gitlab.com/gitlab-org/workspaces/examples/workspaces-infrastructure-setup-aws) repository.
1. Create a fork of the repository. For more information, see [Create a fork](../project/repository/forking_workflow.md#create-a-fork).
## Set up AWS credentials
Next, set up the necessary permissions in AWS so the infrastructure can be properly provisioned.
To set up AWS credentials:
1. Create an [IAM User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) or
[IAM Role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html).
1. Assign the following permissions:
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"ec2:*",
"eks:*",
"elasticloadbalancing:*",
"autoscaling:*",
"cloudwatch:*",
"logs:*",
"kms:DescribeKey",
"kms:TagResource",
"kms:UntagResource",
"kms:ListResourceTags",
"kms:CreateKey",
"kms:CreateAlias",
"kms:ListAliases",
"kms:DeleteAlias",
"iam:AddRoleToInstanceProfile",
"iam:AttachRolePolicy",
"iam:CreateInstanceProfile",
"iam:CreateRole",
"iam:CreateServiceLinkedRole",
"iam:GetRole",
"iam:ListAttachedRolePolicies",
"iam:ListRolePolicies",
"iam:ListRoles",
"iam:PassRole",
"iam:DetachRolePolicy",
"iam:ListInstanceProfilesForRole",
"iam:DeleteRole",
"iam:CreateOpenIDConnectProvider",
"iam:CreatePolicy",
"iam:TagOpenIDConnectProvider",
"iam:GetPolicy",
"iam:GetPolicyVersion",
"iam:GetOpenIDConnectProvider",
"iam:DeleteOpenIDConnectProvider",
"iam:ListPolicyVersions",
"iam:DeletePolicy"
],
"Resource": "*"
}
]
}
```
1. [Create an access key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)
for the user or role.
1. Save your access key ID and secret access key. You'll need them when configuring CI/CD variables later.
## Prepare domain and certificates
For your workspaces to be accessible, you'll need a domain and TLS certificates to secure the
connections.
To prepare your domain and certificates:
1. Buy a domain or use an existing domain for your workspaces environment.
1. Create TLS certificates for:
- GitLab Workspaces Proxy Domain. For example, `workspaces.example.dev`.
- GitLab Workspaces Proxy Wildcard Domain. For example, `*.workspaces.example.dev`.
For more information, see [Generate TLS certificates](set_up_gitlab_agent_and_proxies.md#generate-tls-certificates).
## Create required keys
Now you need to create security keys for authentication and SSH connections.
To create the required keys:
1. Generate a signing key consisting of random letters, numbers, and special characters.
For example, run:
```shell
openssl rand -base64 32
```
1. Generate an SSH host key:
```shell
ssh-keygen -f ssh-host-key -N '' -t rsa
```
## Create a GitLab agent for Kubernetes token
The GitLab agent for Kubernetes connects your AWS Kubernetes cluster to GitLab.
To create a token for the agent:
1. Go to your group.
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Operate** > **Kubernetes clusters**.
1. Select **Connect a cluster**.
1. Enter a name for your agent and save for later use. For example, `gitlab-workspaces-agentk-eks`.
1. Select **Create and register**.
1. Save the token and KAS address for later use.
1. Select **Continue**.
## Configure GitLab OAuth
Next, set up OAuth authentication to securely access workspaces.
To configure GitLab OAuth:
1. Go to **User settings**:
1. Select your profile picture, then select **Preferences**.
1. On the left sidebar, select **Applications**.
1. Scroll down to **OAuth applications**.
1. Select **Add new application**.
1. Update the following settings:
- Name: GitLab Workspaces Proxy
- Redirect URI: For example, `https://workspaces.example.dev/auth/callback`. Replace with your
user-defined domain.
- Select the **Confidential** checkbox.
- Scopes: `api`, `read_user`, `openid`, and `profile`.
1. Select **Save application**.
1. Save the **Application ID** and **Secret** for your CI/CD variables.
1. Select **Continue**.
## Configure CI/CD variables
Now, you need to add the necessary variables to your CI/CD configuration so the infrastructure
pipeline can run.
To configure CI/CD variables:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings** > **CI/CD**.
1. Expand **Variables**.
1. In the **Project variables** section, add the following required variables:
| Variable | Value |
|------------------------------------------------|-------|
| `AWS_ACCESS_KEY_ID` | AWS access key ID. |
| `AWS_SECRET_ACCESS_KEY` | AWS secret access key. |
| `TF_VAR_agent_token` | GitLab agent for Kubernetes token. |
| `TF_VAR_kas_address` | GitLab Kubernetes Agent Server address. Required if on a GitLab Self-Managed instance. For example, `wss://kas.gitlab.com`. |
| `TF_VAR_workspaces_proxy_auth_client_id` | OAuth application client ID. |
| `TF_VAR_workspaces_proxy_auth_client_secret` | OAuth application secret. |
| `TF_VAR_workspaces_proxy_auth_redirect_uri` | OAuth callback URL. For example, `https://workspaces.example.dev/auth/callback`. |
| `TF_VAR_workspaces_proxy_auth_signing_key` | Your generated signing key. |
| `TF_VAR_workspaces_proxy_domain` | Domain for the workspaces proxy. |
| `TF_VAR_workspaces_proxy_domain_cert` | TLS certificate for the proxy domain. |
| `TF_VAR_workspaces_proxy_domain_key` | TLS key for the proxy domain. |
| `TF_VAR_workspaces_proxy_ssh_host_key` | Your generated SSH host key. |
| `TF_VAR_workspaces_proxy_wildcard_domain` | Wildcard domain for workspaces. |
| `TF_VAR_workspaces_proxy_wildcard_domain_cert` | TLS certificate for the wildcard domain. |
| `TF_VAR_workspaces_proxy_wildcard_domain_key` | TLS key for the wildcard domain. |
1. Optional. Add any of these variables to customize your deployment:
| Variable | Value |
|----------------------------------------------|-------|
| `TF_VAR_region` | AWS region. |
| `TF_VAR_zones` | AWS availability zones. |
| `TF_VAR_name` | Name prefix for resources. |
| `TF_VAR_cluster_endpoint_public_access` | Public access to cluster endpoint. |
| `TF_VAR_cluster_node_instance_type` | EC2 instance type for Kubernetes nodes. |
| `TF_VAR_cluster_node_count_min` | Minimum number of worker nodes. |
| `TF_VAR_cluster_node_count_max` | Maximum number of worker nodes. |
| `TF_VAR_cluster_node_count` | Number of worker nodes. |
| `TF_VAR_cluster_node_labels` | Map of labels to apply on the cluster nodes. |
| `TF_VAR_agent_namespace` | Kubernetes namespace for the agent. |
| `TF_VAR_workspaces_proxy_namespace` | Kubernetes namespace for workspaces proxy. |
| `TF_VAR_workspaces_proxy_ingress_class_name` | Ingress class name. |
| `TF_VAR_ingress_nginx_namespace` | Kubernetes namespace for Ingress-NGINX. |
Great job! You've configured all the necessary variables for your infrastructure deployment.
## Update the GitLab agent for Kubernetes configuration
Now, you need to configure the GitLab agent for Kubernetes to support workspaces.
To update the agent configuration:
1. In your forked repository, open the `.gitlab/agents/gitlab-workspaces-agentk-eks/config.yaml` file.
{{< alert type="note" >}}
The directory that contains the `config.yaml` file must match the agent name you created in the
[Create a GitLab agent for Kubernetes token](#create-a-gitlab-agent-for-kubernetes-token) step.
{{< /alert >}}
1. Update the file with the following required fields:
```yaml
remote_development:
enabled: true
dns_zone: "workspaces.example.dev" # Replace with your domain
```
For more configuration options, see [Workspace settings](settings.md).
1. Commit and push these changes to your repository.
## Run the pipeline
It's time to deploy your infrastructure. You'll run the CI/CD pipeline to create all the necessary
resources in AWS.
To run the pipeline:
1. Create a new pipeline in your GitLab project:
1. On the left sidebar, select **Build** > **Pipelines**.
1. Select **New pipeline** and select **New pipeline** again to confirm.
1. Verify the `plan` job succeeds, then manually trigger the `apply` job.
When the OpenTofu code runs, it creates these resources in AWS:
- A Virtual Private Cloud (VPC).
- An Elastic Kubernetes Service (EKS) cluster.
- A GitLab agent for Kubernetes Helm release.
- A GitLab Workspaces Proxy Helm release.
- An Ingress NGINX Helm release.
Excellent! Your infrastructure is now being deployed. This might take some time to complete.
## Configure DNS records
Now that your infrastructure is deployed, you need to configure DNS records to point to your new
environment.
To configure DNS records:
1. Get the Ingress-NGINX load balancer address from the pipeline output:
```shell
kubectl get services -n ingress-nginx ingress-nginx-controller
```
1. Create DNS records that point your domains to this address. For example:
- `workspaces.example.dev` → Load balancer IP address
- `*.workspaces.example.dev` → Load balancer IP address
## Authorize the agent
Next, you'll authorize the GitLab agent for Kubernetes to connect to your GitLab instance.
To authorize the agent:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings** > **Workspaces**.
1. In the **Group agents** section, select the **All agents** tab.
1. From the list of available agents, find the agent with status **Blocked**, and select **Allow**.
1. On the confirmation dialog, select **Allow agent**.
## Create a workspace and verify setup
Finally, let's make sure everything is working correctly by creating a test workspace.
To verify your workspace setup:
1. Create a new workspace by following the steps in [Create a workspace](configuration.md#create-a-workspace).
1. From your project, select **Code**.
1. Select your workspace name.
1. Interact with the workspace by opening the Web IDE, accessing the terminal, or making changes to project files.
Congratulations! You've successfully set up GitLab workspaces infrastructure on AWS. Your users
can now create development workspace environments for their projects.
If you encounter any issues, check the logs for additional details and refer to
[Troubleshooting workspaces](workspaces_troubleshooting.md) for guidance.
## Related topics
- [Workspaces](_index.md)
- [Configure workspaces](configuration.md)
- [Workspace settings](settings.md)
- [Tutorial: Create a custom workspace image that supports arbitrary user IDs](create_image.md)
|
https://docs.gitlab.com/user/create_image
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/create_image.md
|
2025-08-13
|
doc/user/workspace
|
[
"doc",
"user",
"workspace"
] |
create_image.md
|
Create
|
Remote Development
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Tutorial: Create a custom workspace image that supports arbitrary user IDs
|
Create a custom workspace image to support any workspace you create in GitLab.
|
<!-- vale gitlab_base.FutureTense = NO -->
This tutorial guides you through creating a custom workspace image that supports arbitrary user IDs.
Once complete, you can use this custom image with any [workspace](_index.md) you create in GitLab.
To create a custom workspace image that supports arbitrary user IDs:
1. [Create a base Dockerfile](#create-a-base-dockerfile).
1. [Add support for arbitrary user IDs](#add-support-for-arbitrary-user-ids).
1. [Build the custom workspace image](#build-the-custom-workspace-image).
1. [Push the custom workspace image to the GitLab container registry](#push-the-custom-workspace-image-to-the-gitlab-container-registry).
1. [Use the custom workspace image in GitLab](#use-the-custom-workspace-image-in-gitlab).
## Before you begin
You need the following:
- A GitLab account with permission to create and push container images to the GitLab container
registry.
- Docker installed on your local machine.
## Create a base Dockerfile
Let's start by creating a base Dockerfile for our container image. Use the Python
`3.11-slim-bullseye` image from Docker Hub as our starting point:
```Dockerfile
FROM python:3.11-slim-bullseye
```
Great! You've created the foundation for your custom workspace image. Next, add the code
that enables arbitrary user ID support.
## Add support for arbitrary user IDs
Next, you will add support for arbitrary user IDs to the base image.
This ensures your workspace runs in GitLab.
To add a new `gitlab-workspaces` user with an ID of `5001`, and assign them the necessary
directory permissions, add the following code to your Dockerfile:
```dockerfile
RUN useradd -l -u 5001 -G sudo -md /home/gitlab-workspaces -s /bin/bash -p gitlab-workspaces gitlab-workspaces
ENV HOME=/home/gitlab-workspaces
WORKDIR $HOME
RUN mkdir -p /home/gitlab-workspaces && chgrp -R 0 /home && chmod -R g=u /etc/passwd /etc/group /home
USER 5001
```
## Build the custom workspace image
With your Dockerfile complete, you're ready to build your custom workspace image:
1. Run the following command in the directory where you created the Dockerfile:
```shell
docker build -t my-gitlab-workspace .
```
This might take a few minutes depending on your internet connection and system speed.
1. After the build process completes, test the image locally:
```shell
docker run -ti my-gitlab-workspace sh
```
You should now have permission to run commands as the `gitlab-workspaces` user. Perfect! Your image
is working locally. Next, you will make it available in GitLab.
## Push the custom workspace image to the GitLab container registry
Push your custom workspace image to the GitLab container registry for use in your projects:
1. Sign in to your GitLab account:
```shell
docker login registry.gitlab.com
```
1. Tag the image with the GitLab container registry URL:
```shell
docker tag my-gitlab-workspace registry.gitlab.com/your-namespace/my-gitlab-workspace:latest
```
Remember to replace `your-namespace` with your actual GitLab namespace.
1. Push the image to the GitLab container registry:
```shell
docker push registry.gitlab.com/your-namespace/my-gitlab-workspace:latest
```
This upload might take a while depending on your internet connection speed.
Well done! Your custom workspace image is now safely stored in the GitLab container registry
and ready to use.
## Use the custom workspace image in GitLab
For the final step, you will configure your project to use your custom workspace image:
1. Update the container image in your project's `.devfile.yaml`:
```yaml
schemaVersion: 2.2.0
components:
- name: tooling-container
attributes:
gl/inject-editor: true
container:
image: registry.gitlab.com/your-namespace/my-gitlab-workspace:latest
```
Remember to replace `your-namespace` with your actual GitLab namespace.
Congratulations! You've successfully created and configured a custom workspace image that supports
arbitrary user IDs. You can now use this custom image with any [workspace](_index.md) you create
in GitLab.
## Related topics
- [Troubleshooting Workspaces](workspaces_troubleshooting.md)
|
---
stage: Create
group: Remote Development
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Create a custom workspace image to support any workspace you create in
GitLab.
title: 'Tutorial: Create a custom workspace image that supports arbitrary user IDs'
breadcrumbs:
- doc
- user
- workspace
---
<!-- vale gitlab_base.FutureTense = NO -->
This tutorial guides you through creating a custom workspace image that supports arbitrary user IDs.
Once complete, you can use this custom image with any [workspace](_index.md) you create in GitLab.
To create a custom workspace image that supports arbitrary user IDs:
1. [Create a base Dockerfile](#create-a-base-dockerfile).
1. [Add support for arbitrary user IDs](#add-support-for-arbitrary-user-ids).
1. [Build the custom workspace image](#build-the-custom-workspace-image).
1. [Push the custom workspace image to the GitLab container registry](#push-the-custom-workspace-image-to-the-gitlab-container-registry).
1. [Use the custom workspace image in GitLab](#use-the-custom-workspace-image-in-gitlab).
## Before you begin
You need the following:
- A GitLab account with permission to create and push container images to the GitLab container
registry.
- Docker installed on your local machine.
## Create a base Dockerfile
Let's start by creating a base Dockerfile for our container image. Use the Python
`3.11-slim-bullseye` image from Docker Hub as our starting point:
```Dockerfile
FROM python:3.11-slim-bullseye
```
Great! You've created the foundation for your custom workspace image. Next, add the code
that enables arbitrary user ID support.
## Add support for arbitrary user IDs
Next, you will add support for arbitrary user IDs to the base image.
This ensures your workspace runs in GitLab.
To add a new `gitlab-workspaces` user with an ID of `5001`, and assign them the necessary
directory permissions, add the following code to your Dockerfile:
```dockerfile
RUN useradd -l -u 5001 -G sudo -md /home/gitlab-workspaces -s /bin/bash -p gitlab-workspaces gitlab-workspaces
ENV HOME=/home/gitlab-workspaces
WORKDIR $HOME
RUN mkdir -p /home/gitlab-workspaces && chgrp -R 0 /home && chmod -R g=u /etc/passwd /etc/group /home
USER 5001
```
## Build the custom workspace image
With your Dockerfile complete, you're ready to build your custom workspace image:
1. Run the following command in the directory where you created the Dockerfile:
```shell
docker build -t my-gitlab-workspace .
```
This might take a few minutes depending on your internet connection and system speed.
1. After the build process completes, test the image locally:
```shell
docker run -ti my-gitlab-workspace sh
```
You should now have permission to run commands as the `gitlab-workspaces` user. Perfect! Your image
is working locally. Next, you will make it available in GitLab.
## Push the custom workspace image to the GitLab container registry
Push your custom workspace image to the GitLab container registry for use in your projects:
1. Sign in to your GitLab account:
```shell
docker login registry.gitlab.com
```
1. Tag the image with the GitLab container registry URL:
```shell
docker tag my-gitlab-workspace registry.gitlab.com/your-namespace/my-gitlab-workspace:latest
```
Remember to replace `your-namespace` with your actual GitLab namespace.
1. Push the image to the GitLab container registry:
```shell
docker push registry.gitlab.com/your-namespace/my-gitlab-workspace:latest
```
This upload might take a while depending on your internet connection speed.
Well done! Your custom workspace image is now safely stored in the GitLab container registry
and ready to use.
## Use the custom workspace image in GitLab
For the final step, you will configure your project to use your custom workspace image:
1. Update the container image in your project's `.devfile.yaml`:
```yaml
schemaVersion: 2.2.0
components:
- name: tooling-container
attributes:
gl/inject-editor: true
container:
image: registry.gitlab.com/your-namespace/my-gitlab-workspace:latest
```
Remember to replace `your-namespace` with your actual GitLab namespace.
Congratulations! You've successfully created and configured a custom workspace image that supports
arbitrary user IDs. You can now use this custom image with any [workspace](_index.md) you create
in GitLab.
## Related topics
- [Troubleshooting Workspaces](workspaces_troubleshooting.md)
|
https://docs.gitlab.com/user/workspace
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/_index.md
|
2025-08-13
|
doc/user/workspace
|
[
"doc",
"user",
"workspace"
] |
_index.md
|
Create
|
Remote Development
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Workspaces
|
Workspaces are virtual sandbox environments for creating and managing your GitLab development environments.
|
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Feature flag `remote_development_feature_flag` [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/391543) in GitLab 16.0.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136744) in GitLab 16.7. Feature flag `remote_development_feature_flag` removed.
{{< /history >}}
A workspace is a virtual sandbox environment for your code in GitLab.
You can use workspaces to create and manage isolated development environments for your GitLab projects.
These environments ensure that different projects don't interfere with each other.
Each workspace includes its own set of dependencies, libraries, and tools,
which you can customize to meet the specific needs of each project.
A workspace can exist for a maximum of approximately one calendar year, `8760` hours. After this, it is automatically terminated.
For a click-through demo, see [GitLab workspaces](https://tech-marketing.gitlab.io/static-demos/workspaces/ws_html.html).
{{< alert type="note" >}}
A Workspace runs on any `linux/amd64` Kubernetes cluster. If you need to run sudo commands, or
build and run containers in your workspace, there might be platform-specific requirements.
For more information, see [Platform compatibility](configuration.md#platform-compatibility).
{{< /alert >}}
## Workspaces and projects
Workspaces are scoped to a project.
When you [create a workspace](configuration.md#create-a-workspace), you must:
- Assign the workspace to a specific project.
- Select a project with a [devfile](#devfile).
The workspace can interact with the GitLab API, with the access level defined by current user permissions.
A running workspace remains accessible to the user even if user permissions are later revoked.
### Manage workspaces from a project
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125331) in GitLab 16.2.
{{< /history >}}
To manage workspaces from a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. In the upper right, select **Code**.
1. From the dropdown list, under **Your workspaces**, you can:
- Restart, stop, or terminate an existing workspace.
- Create a new workspace.
{{< alert type="warning" >}}
When you terminate a workspace, GitLab deletes any unsaved or uncommitted data
in that workspace. The data cannot be recovered.
{{< /alert >}}
### Deleting resources associated with a workspace
When you terminate a workspace, you delete all resources associated with the workspace.
When you delete a project, agent, user, or token associated with a running workspace:
- The workspace is deleted from the user interface.
- In the Kubernetes cluster, the running workspace resources become orphaned and are not automatically deleted.
To clean up orphaned resources, an administrator must manually delete the workspace in Kubernetes.
[Issue 414384](https://gitlab.com/gitlab-org/gitlab/-/issues/414384) proposes to change this behavior.
## Manage workspaces at the agent level
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/419281) in GitLab 16.8.
{{< /history >}}
To manage all workspaces associated with an agent:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Operate > Kubernetes clusters**.
1. Select the agent configured for remote development.
1. Select the **Workspaces** tab.
1. From the list, you can restart, stop, or terminate an existing workspace.
{{< alert type="warning" >}}
When you terminate a workspace, GitLab deletes any unsaved or uncommitted data
in that workspace. The data cannot be recovered.
{{< /alert >}}
### Identify an agent from a running workspace
In deployments that contain multiple agents, you might want to identify an agent from a running workspace.
To identify an agent associated with a running workspace, use one of the following GraphQL endpoints:
- `agent-id` to return the project the agent belongs to.
- [`Query.workspaces`](../../api/graphql/reference/_index.md#queryworkspaces) to return:
- The [cluster agent](../../api/graphql/reference/_index.md#clusteragent) associated with the workspace.
- The project the agent belongs to.
## Devfile
Workspaces have built-in support for devfiles. Devfiles are files that define a development environment
by specifying the necessary tools, languages, runtimes, and other components for a GitLab project.
Use them to automatically configure your development environment with your defined specifications.
They create consistent and reproducible development environments, regardless of the machine or platform you use.
Workspaces support both GitLab default devfile and custom devfiles.
### GitLab default devfile
{{< history >}}
- [Introduced with Go](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/171230) in GitLab 17.8.
- [Added support for Node, Ruby, and Rust](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/185393) in GitLab 17.9.
- [Added support for Python, PHP, Java, and GCC](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/188199) in GitLab 18.0.
{{< /history >}}
A GitLab default devfile is available for all projects when you create a workspace.
This devfile contains:
```yaml
schemaVersion: 2.2.0
components:
- name: development-environment
attributes:
gl/inject-editor: true
container:
image: "registry.gitlab.com/gitlab-org/gitlab-build-images/workspaces/ubuntu-24.04:[VERSION_TAG]"
```
{{< alert type="note" >}}
This container `image` is updated regularly. `[VERSION_TAG]` is a placeholder only. For the latest version, see the
[default `default_devfile.yaml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/remote_development/settings/default_devfile.yaml).
{{< /alert >}}
The workspace default image includes development tools such as Ruby, Node.js, Rust, Go, Python,
Java, PHP, GCC, and their corresponding package managers. These tools are updated regularly.
A GitLab default devfile might not be suitable for all development environments configurations.
In these cases, you can create a [custom devfile](#custom-devfile).
### Custom devfile
If you need a specific development environment configuration, create a custom devfile.
You can define a devfile in the following locations, relative to your project's root directory:
```plaintext
- /.devfile.yaml
- /.devfile.yml
- /.devfile/{devfile_name}.yaml
- /.devfile/{devfile_name}.yml
```
{{< alert type="note" >}}
Devfiles must be placed directly in the `.devfile` folder. Nested subfolders are not supported.
For example, `.devfile/subfolder/devfile.yaml` is not recognized.
{{< /alert >}}
### Validation rules
- `schemaVersion` must be [`2.2.0`](https://devfile.io/docs/2.2.0/devfile-schema).
- The devfile must have at least one component.
- The devfile size must not exceed 3 MB.
- For `components`:
- Names must not start with `gl-`.
- Only [`container`](#container-component-type) and `volume` are supported.
- For `commands`:
- IDs must not start with `gl-`.
- Only `exec` and `apply` command types are supported.
- For `exec` commands, only the following options are supported: `commandLine`, `component`, `label`, and `hotReloadCapable`.
- When `hotReloadCapable` is specified for `exec` commands, it must be set to `false`.
- For `events`:
- Names must not start with `gl-`.
- Only `preStart` and [`postStart`](#user-defined-poststart-events) are supported.
- The Devfile standard only allows exec commands to be linked to `postStart` events. If you want an apply command, you must use a `preStart` event.
- `parent`, `projects`, and `starterProjects` are not supported.
- For `variables`, keys must not start with `gl-`, `gl_`, `GL-`, or `GL_`.
- For `attributes`:
- `pod-overrides` must not be set at the root level or in `components`.
- `container-overrides` must not be set in `components`.
### `container` component type
Use the `container` component type to define a container image as the execution environment for a workspace.
You can specify the base image, dependencies, and other settings.
The `container` component type supports the following schema properties only:
| Property | Description |
|---------------- | -------------------------------------------------------------------------------------------------------------------------------|
| `image` | Name of the container image to use for the workspace. |
| `memoryRequest` | Minimum amount of memory the container can use. |
| `memoryLimit` | Maximum amount of memory the container can use. |
| `cpuRequest` | Minimum amount of CPU the container can use. |
| `cpuLimit` | Maximum amount of CPU the container can use. |
| `env` | Environment variables to use in the container. Names must not start with `gl-`. |
| `endpoints` | Port mappings to expose from the container. Names must not start with `gl-`. |
| `volumeMounts` | Storage volume to mount in the container. |
| `overrideCommand` | Override the container entrypoint with a keep-alive command. Defaults vary by component type. |
#### `overrideCommand` attribute
The `overrideCommand` attribute is a boolean that controls how Workspaces handle container entrypoints.
This attribute determines whether the container's original entrypoint is preserved or replaced
with a keep-alive command.
The default value for `overrideCommand` depends on the component type:
- Main component with attribute `gl/inject-editor: true`: Defaults to `true` when not specified.
- All other components: Defaults to `false` when not specified.
When `true`, the container entrypoint is replaced with `tail -f /dev/null` to keep the
container running.
When `false`, the container uses either the devfile component `command`/`args` or the built container
image's `Entrypoint`/`Cmd`.
The following table shows how `overrideCommand` affects container behavior. For clarity, these terms
are used in the table:
- Devfile component: The `command` and `args` properties in the devfile component entry.
- Container image: The `Entrypoint` and `Cmd` fields in the OCI container image.
| `overrideCommand` | Devfile component | Container image | Result |
|-------------------|-------------------|-----------------|--------|
| `true` | Specified | Specified | Validation error: Devfile component `command`/`args` cannot be specified when `overrideCommand` is `true`. |
| `true` | Specified | Not specified | Validation error: Devfile component `command`/`args` cannot be specified when `overrideCommand` is `true`. |
| `true` | Not specified | Specified | Container entrypoint replaced with `tail -f /dev/null`. |
| `true` | Not specified | Not specified | Container entrypoint replaced with `tail -f /dev/null`. |
| `false` | Specified | Specified | Devfile component `command`/`args` used as entrypoint. |
| `false` | Specified | Not specified | Devfile component `command`/`args` used as entrypoint. |
| `false` | Not specified | Specified | Container image `Entrypoint`/`Cmd` used. |
| `false` | Not specified | Not specified | Container exits prematurely (`CrashLoopBackOff`). <sup>1</sup> |
**Footnotes**:
1. When you create a workspace, it cannot access container image details, for example, from private
or internal registries. When `overrideCommand` is `false` and the Devfile doesn't specify `command`
or `args`, GitLab does not validate container images or check for required `Entrypoint` or `Cmd` fields.
You must ensure that either the Devfile or container specifies these fields, or the container exits
prematurely and the workspace fails to start.
### User-defined `postStart` events
You can define custom `postStart` events in your devfile to run commands after the workspace starts.
These `postStart` events do not block workspace accessibility. The workspace becomes available as
soon as internal initialization is complete, even if your custom `postStart` commands are still
running or waiting to run.
Use this type of event to:
- Set up development dependencies.
- Configure the workspace environment.
- Run initialization scripts.
`postStart` event names must not start with `gl-` and can only reference `exec` type commands.
For an example that shows how to configure `postStart` events,
see the [example configurations](#example-configurations).
#### Monitor `postStart` event progress
When your workspace runs `postStart` events, you can monitor their progress and check the workspace logs.
All `postStart` command output is captured in log files located in the [workspace logs directory](#workspace-logs-directory).
To check the progress of your `postStart` scripts:
1. Open a terminal in your workspace.
1. Go to the workspace logs directory:
```shell
cd /tmp/workspace-logs/
```
1. View the output logs to see command results:
```shell
tail -f poststart-stdout.log
```
### Example configurations
The following is an example devfile configuration:
```yaml
schemaVersion: 2.2.0
variables:
registry-root: registry.gitlab.com
components:
- name: tooling-container
attributes:
gl/inject-editor: true
container:
image: "{{registry-root}}/gitlab-org/remote-development/gitlab-remote-development-docs/ubuntu:22.04"
env:
- name: KEY
value: VALUE
endpoints:
- name: http-3000
targetPort: 3000
commands:
- id: install-dependencies
exec:
component: tooling-container
commandLine: "npm install"
- id: setup-environment
exec:
component: tooling-container
commandLine: "echo 'Setting up development environment'"
events:
postStart:
- install-dependencies
- setup-environment
```
{{< alert type="note" >}}
This container image is for demonstration purposes only. To use your own container image,
see [Arbitrary user IDs](#arbitrary-user-ids).
{{< /alert >}}
For more information, see the [devfile documentation](https://devfile.io/docs/2.2.0/devfile-schema).
For other examples, see the [`examples` projects](https://gitlab.com/gitlab-org/remote-development/examples).
## Workspace container requirements
By default, workspaces inject and start the [GitLab VS Code fork](https://gitlab.com/gitlab-org/gitlab-web-ide-vscode-fork)
in the container that has a defined `gl/inject-editor` attribute in the devfile.
The workspace container where the GitLab VS Code fork is injected
must meet the following system requirements:
- System architecture: AMD64
- System libraries:
- `glibc` 2.28 and later
- `glibcxx` 3.4.25 and later
These requirements have been tested on Debian 10.13 and Ubuntu 20.04.
For more information, see the [VS Code documentation](https://code.visualstudio.com/docs/remote/linux).
{{< alert type="note" >}}
GitLab always pulls the workspace injector image (`gl-tools-injector`) and project cloner image
(`gl-project-cloner`) from the GitLab registry (`registry.gitlab.com/gitlab-org/gitlab-web-ide-vscode-fork/web-ide-injector`).
These images cannot be overridden.
If you use a private container registry for your other images, GitLab still needs to fetch these
specific images from the GitLab registry. This requirement may impact environments with strict network
controls, such as offline environments.
{{< /alert >}}
## Workspace add-ons
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385157) in GitLab 17.2.
{{< /history >}}
The GitLab Workflow extension for VS Code is configured by default in workspaces.
With this extension, you can view issues, create merge requests, and manage CI/CD pipelines.
This extension also powers AI features like [GitLab Duo Code Suggestions](../project/repository/code_suggestions/_index.md)
and [GitLab Duo Chat](../gitlab_duo_chat/_index.md).
For more information, see [GitLab Workflow extension for VS Code](https://gitlab.com/gitlab-org/gitlab-vscode-extension).
## Extension marketplace
{{< details >}}
- Status: Beta
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/438491) as a [beta](../../policy/development_stages_support.md#beta) in GitLab 16.9 [with a flag](../../administration/feature_flags/_index.md) named `allow_extensions_marketplace_in_workspace`. Disabled by default.
- Feature flag `allow_extensions_marketplace_in_workspace` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/454669) in GitLab 17.6.
{{< /history >}}
The VS Code Extension Marketplace provides you with access to extensions that enhance the
functionality of your workspace.
You can use the [extension marketplace](../project/web_ide/_index.md#manage-extensions) in your
workspace Web IDE. The extension marketplace connects to the [Open VSX Registry](https://open-vsx.org/).
For more information, see [Configure VS Code Extension Marketplace](../../administration/settings/vscode_extension_marketplace.md).
## Personal access token
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129715) in GitLab 16.4.
- `api` permission [added](https://gitlab.com/gitlab-org/gitlab/-/issues/385157) in GitLab 17.2.
{{< /history >}}
When you [create a workspace](configuration.md#create-a-workspace), you get a personal access token
with `write_repository` and `api` permissions.
Use this token to clone the project initially, while starting the workspace,
and to configure the GitLab Workflow extension for VS Code.
Any Git operation you perform in the workspace uses this token for authentication and authorization.
Terminating the workspace revokes the token.
Use the `GIT_CONFIG_COUNT`, `GIT_CONFIG_KEY_n`, and `GIT_CONFIG_VALUE_n`
[environment variables](https://git-scm.com/docs/git-config/#Documentation/git-config.txt-GITCONFIGCOUNT)
for Git authentication in the workspace. These variables require Git 2.31 or later in the workspace container.
## Pod interaction in a cluster
Workspaces run as pods in a Kubernetes cluster.
GitLab does not impose any restrictions on the manner in which pods interact with each other.
Consider isolating this feature from other containers in your cluster, because of this requirement.
## Network access and workspace authorization
It's the client's responsibility to restrict network access to the Kubernetes control plane
because GitLab does not have control over the API.
Only the workspace creator can access the workspace and any endpoints exposed in that workspace.
The workspace creator is only authorized to access the workspace after user authentication with OAuth.
## Compute resources and volume storage
When you stop a workspace, GitLab scales the compute resources for that workspace down to zero.
However, the volume provisioned for the workspace still exists.
To delete the provisioned volume, you must terminate the workspace.
## Automatic workspace stop and termination
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14910) in GitLab 17.6.
{{< /history >}}
By default, a workspace automatically:
- Stops 36 hours after the workspace was last started or restarted.
For more information, see [`max_active_hours_before_stop`](settings.md#max_active_hours_before_stop).
- Terminates 722 hours after the workspace was last stopped.
For more information, see [`max_stopped_hours_before_termination`](settings.md#max_stopped_hours_before_termination).
## Arbitrary user IDs
You can provide your own container image, which can run as any Linux user ID.
It's not possible for GitLab to predict the Linux user ID for a container image.
GitLab uses the Linux `root` group ID permission to create, update, or delete files in a container.
The container runtime used by the Kubernetes cluster must ensure all containers have a default Linux group ID of `0`.
If you have a container image that does not support arbitrary user IDs,
you cannot create, update, or delete files in a workspace.
To create a container image that supports arbitrary user IDs,
see [Create a custom workspace image that supports arbitrary user IDs](create_image.md).
For more information, see the
[OpenShift documentation](https://docs.openshift.com/container-platform/4.12/openshift_images/create-images.html#use-uid_create-images).
## Workspace logs directory
When a workspace starts, GitLab creates a logs directory to capture output
from various initialization and startup processes.
The workspace logs are stored in `/tmp/workspace-logs/`.
This directory helps you monitor workspace startup progress and troubleshoot
issues with `postStart` events, development tools, and other workspace components.
For more information, see [Debug `postStart` events](workspaces_troubleshooting.md#debug-poststart-events).
### Available log files
The logs directory contains the following log files:
| Log file | Purpose | Content |
|------------------------|----------------------------|---------|
| `poststart-stdout.log` | `postStart` command output | Standard output from all `postStart` commands, including user-defined commands and internal GitLab startup tasks. |
| `poststart-stderr.log` | `postStart` command errors | Error output and `stderr` from `postStart` commands. You can use these logs to troubleshoot failed startup scripts. |
| `start-vscode.log` | VS Code server startup | Logs from the GitLab VS Code fork server initialization. |
| `start-sshd.log` | SSH daemon startup | Output from SSH daemon initialization, including server startup and configuration details. |
| `clone-unshallow.log` | Git repository conversion | Logs from the background process that converts the shallow clone to a full clone and retrieves the complete Git history for the project. |
{{< alert type="note" >}}
Log files are recreated each time you restart a workspace. Previous log files are not preserved
when you stop and restart a workspace.
{{< /alert >}}
## Shallow cloning
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/543982) in GitLab 18.2 [with a flag](../../administration/feature_flags/_index.md) named `workspaces_shallow_clone_project`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.
{{< /alert >}}
When you create a workspace, GitLab uses shallow cloning to improve performance.
A shallow clone downloads only the latest commit history instead of the complete Git history,
which significantly reduces the initial clone time for large repositories.
After the workspace starts, Git converts the shallow clone to a full clone in the background.
This process is transparent and doesn't affect your development workflow.
## Related topics
- [Troubleshooting Workspaces](workspaces_troubleshooting.md)
|
---
stage: Create
group: Remote Development
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Workspaces are virtual sandbox environments for creating and managing
your GitLab development environments.
title: Workspaces
breadcrumbs:
- doc
- user
- workspace
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Feature flag `remote_development_feature_flag` [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/391543) in GitLab 16.0.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136744) in GitLab 16.7. Feature flag `remote_development_feature_flag` removed.
{{< /history >}}
A workspace is a virtual sandbox environment for your code in GitLab.
You can use workspaces to create and manage isolated development environments for your GitLab projects.
These environments ensure that different projects don't interfere with each other.
Each workspace includes its own set of dependencies, libraries, and tools,
which you can customize to meet the specific needs of each project.
A workspace can exist for a maximum of approximately one calendar year, `8760` hours. After this, it is automatically terminated.
For a click-through demo, see [GitLab workspaces](https://tech-marketing.gitlab.io/static-demos/workspaces/ws_html.html).
{{< alert type="note" >}}
A Workspace runs on any `linux/amd64` Kubernetes cluster. If you need to run sudo commands, or
build and run containers in your workspace, there might be platform-specific requirements.
For more information, see [Platform compatibility](configuration.md#platform-compatibility).
{{< /alert >}}
## Workspaces and projects
Workspaces are scoped to a project.
When you [create a workspace](configuration.md#create-a-workspace), you must:
- Assign the workspace to a specific project.
- Select a project with a [devfile](#devfile).
The workspace can interact with the GitLab API, with the access level defined by current user permissions.
A running workspace remains accessible to the user even if user permissions are later revoked.
### Manage workspaces from a project
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125331) in GitLab 16.2.
{{< /history >}}
To manage workspaces from a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. In the upper right, select **Code**.
1. From the dropdown list, under **Your workspaces**, you can:
- Restart, stop, or terminate an existing workspace.
- Create a new workspace.
{{< alert type="warning" >}}
When you terminate a workspace, GitLab deletes any unsaved or uncommitted data
in that workspace. The data cannot be recovered.
{{< /alert >}}
### Deleting resources associated with a workspace
When you terminate a workspace, you delete all resources associated with the workspace.
When you delete a project, agent, user, or token associated with a running workspace:
- The workspace is deleted from the user interface.
- In the Kubernetes cluster, the running workspace resources become orphaned and are not automatically deleted.
To clean up orphaned resources, an administrator must manually delete the workspace in Kubernetes.
[Issue 414384](https://gitlab.com/gitlab-org/gitlab/-/issues/414384) proposes to change this behavior.
## Manage workspaces at the agent level
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/419281) in GitLab 16.8.
{{< /history >}}
To manage all workspaces associated with an agent:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Operate > Kubernetes clusters**.
1. Select the agent configured for remote development.
1. Select the **Workspaces** tab.
1. From the list, you can restart, stop, or terminate an existing workspace.
{{< alert type="warning" >}}
When you terminate a workspace, GitLab deletes any unsaved or uncommitted data
in that workspace. The data cannot be recovered.
{{< /alert >}}
### Identify an agent from a running workspace
In deployments that contain multiple agents, you might want to identify an agent from a running workspace.
To identify an agent associated with a running workspace, use one of the following GraphQL endpoints:
- `agent-id` to return the project the agent belongs to.
- [`Query.workspaces`](../../api/graphql/reference/_index.md#queryworkspaces) to return:
- The [cluster agent](../../api/graphql/reference/_index.md#clusteragent) associated with the workspace.
- The project the agent belongs to.
## Devfile
Workspaces have built-in support for devfiles. Devfiles are files that define a development environment
by specifying the necessary tools, languages, runtimes, and other components for a GitLab project.
Use them to automatically configure your development environment with your defined specifications.
They create consistent and reproducible development environments, regardless of the machine or platform you use.
Workspaces support both GitLab default devfile and custom devfiles.
### GitLab default devfile
{{< history >}}
- [Introduced with Go](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/171230) in GitLab 17.8.
- [Added support for Node, Ruby, and Rust](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/185393) in GitLab 17.9.
- [Added support for Python, PHP, Java, and GCC](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/188199) in GitLab 18.0.
{{< /history >}}
A GitLab default devfile is available for all projects when you create a workspace.
This devfile contains:
```yaml
schemaVersion: 2.2.0
components:
- name: development-environment
attributes:
gl/inject-editor: true
container:
image: "registry.gitlab.com/gitlab-org/gitlab-build-images/workspaces/ubuntu-24.04:[VERSION_TAG]"
```
{{< alert type="note" >}}
This container `image` is updated regularly. `[VERSION_TAG]` is a placeholder only. For the latest version, see the
[default `default_devfile.yaml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/remote_development/settings/default_devfile.yaml).
{{< /alert >}}
The workspace default image includes development tools such as Ruby, Node.js, Rust, Go, Python,
Java, PHP, GCC, and their corresponding package managers. These tools are updated regularly.
A GitLab default devfile might not be suitable for all development environments configurations.
In these cases, you can create a [custom devfile](#custom-devfile).
### Custom devfile
If you need a specific development environment configuration, create a custom devfile.
You can define a devfile in the following locations, relative to your project's root directory:
```plaintext
- /.devfile.yaml
- /.devfile.yml
- /.devfile/{devfile_name}.yaml
- /.devfile/{devfile_name}.yml
```
{{< alert type="note" >}}
Devfiles must be placed directly in the `.devfile` folder. Nested subfolders are not supported.
For example, `.devfile/subfolder/devfile.yaml` is not recognized.
{{< /alert >}}
### Validation rules
- `schemaVersion` must be [`2.2.0`](https://devfile.io/docs/2.2.0/devfile-schema).
- The devfile must have at least one component.
- The devfile size must not exceed 3 MB.
- For `components`:
- Names must not start with `gl-`.
- Only [`container`](#container-component-type) and `volume` are supported.
- For `commands`:
- IDs must not start with `gl-`.
- Only `exec` and `apply` command types are supported.
- For `exec` commands, only the following options are supported: `commandLine`, `component`, `label`, and `hotReloadCapable`.
- When `hotReloadCapable` is specified for `exec` commands, it must be set to `false`.
- For `events`:
- Names must not start with `gl-`.
- Only `preStart` and [`postStart`](#user-defined-poststart-events) are supported.
- The Devfile standard only allows exec commands to be linked to `postStart` events. If you want an apply command, you must use a `preStart` event.
- `parent`, `projects`, and `starterProjects` are not supported.
- For `variables`, keys must not start with `gl-`, `gl_`, `GL-`, or `GL_`.
- For `attributes`:
- `pod-overrides` must not be set at the root level or in `components`.
- `container-overrides` must not be set in `components`.
### `container` component type
Use the `container` component type to define a container image as the execution environment for a workspace.
You can specify the base image, dependencies, and other settings.
The `container` component type supports the following schema properties only:
| Property | Description |
|---------------- | -------------------------------------------------------------------------------------------------------------------------------|
| `image` | Name of the container image to use for the workspace. |
| `memoryRequest` | Minimum amount of memory the container can use. |
| `memoryLimit` | Maximum amount of memory the container can use. |
| `cpuRequest` | Minimum amount of CPU the container can use. |
| `cpuLimit` | Maximum amount of CPU the container can use. |
| `env` | Environment variables to use in the container. Names must not start with `gl-`. |
| `endpoints` | Port mappings to expose from the container. Names must not start with `gl-`. |
| `volumeMounts` | Storage volume to mount in the container. |
| `overrideCommand` | Override the container entrypoint with a keep-alive command. Defaults vary by component type. |
#### `overrideCommand` attribute
The `overrideCommand` attribute is a boolean that controls how Workspaces handle container entrypoints.
This attribute determines whether the container's original entrypoint is preserved or replaced
with a keep-alive command.
The default value for `overrideCommand` depends on the component type:
- Main component with attribute `gl/inject-editor: true`: Defaults to `true` when not specified.
- All other components: Defaults to `false` when not specified.
When `true`, the container entrypoint is replaced with `tail -f /dev/null` to keep the
container running.
When `false`, the container uses either the devfile component `command`/`args` or the built container
image's `Entrypoint`/`Cmd`.
The following table shows how `overrideCommand` affects container behavior. For clarity, these terms
are used in the table:
- Devfile component: The `command` and `args` properties in the devfile component entry.
- Container image: The `Entrypoint` and `Cmd` fields in the OCI container image.
| `overrideCommand` | Devfile component | Container image | Result |
|-------------------|-------------------|-----------------|--------|
| `true` | Specified | Specified | Validation error: Devfile component `command`/`args` cannot be specified when `overrideCommand` is `true`. |
| `true` | Specified | Not specified | Validation error: Devfile component `command`/`args` cannot be specified when `overrideCommand` is `true`. |
| `true` | Not specified | Specified | Container entrypoint replaced with `tail -f /dev/null`. |
| `true` | Not specified | Not specified | Container entrypoint replaced with `tail -f /dev/null`. |
| `false` | Specified | Specified | Devfile component `command`/`args` used as entrypoint. |
| `false` | Specified | Not specified | Devfile component `command`/`args` used as entrypoint. |
| `false` | Not specified | Specified | Container image `Entrypoint`/`Cmd` used. |
| `false` | Not specified | Not specified | Container exits prematurely (`CrashLoopBackOff`). <sup>1</sup> |
**Footnotes**:
1. When you create a workspace, it cannot access container image details, for example, from private
or internal registries. When `overrideCommand` is `false` and the Devfile doesn't specify `command`
or `args`, GitLab does not validate container images or check for required `Entrypoint` or `Cmd` fields.
You must ensure that either the Devfile or container specifies these fields, or the container exits
prematurely and the workspace fails to start.
### User-defined `postStart` events
You can define custom `postStart` events in your devfile to run commands after the workspace starts.
These `postStart` events do not block workspace accessibility. The workspace becomes available as
soon as internal initialization is complete, even if your custom `postStart` commands are still
running or waiting to run.
Use this type of event to:
- Set up development dependencies.
- Configure the workspace environment.
- Run initialization scripts.
`postStart` event names must not start with `gl-` and can only reference `exec` type commands.
For an example that shows how to configure `postStart` events,
see the [example configurations](#example-configurations).
#### Monitor `postStart` event progress
When your workspace runs `postStart` events, you can monitor their progress and check the workspace logs.
All `postStart` command output is captured in log files located in the [workspace logs directory](#workspace-logs-directory).
To check the progress of your `postStart` scripts:
1. Open a terminal in your workspace.
1. Go to the workspace logs directory:
```shell
cd /tmp/workspace-logs/
```
1. View the output logs to see command results:
```shell
tail -f poststart-stdout.log
```
### Example configurations
The following is an example devfile configuration:
```yaml
schemaVersion: 2.2.0
variables:
registry-root: registry.gitlab.com
components:
- name: tooling-container
attributes:
gl/inject-editor: true
container:
image: "{{registry-root}}/gitlab-org/remote-development/gitlab-remote-development-docs/ubuntu:22.04"
env:
- name: KEY
value: VALUE
endpoints:
- name: http-3000
targetPort: 3000
commands:
- id: install-dependencies
exec:
component: tooling-container
commandLine: "npm install"
- id: setup-environment
exec:
component: tooling-container
commandLine: "echo 'Setting up development environment'"
events:
postStart:
- install-dependencies
- setup-environment
```
{{< alert type="note" >}}
This container image is for demonstration purposes only. To use your own container image,
see [Arbitrary user IDs](#arbitrary-user-ids).
{{< /alert >}}
For more information, see the [devfile documentation](https://devfile.io/docs/2.2.0/devfile-schema).
For other examples, see the [`examples` projects](https://gitlab.com/gitlab-org/remote-development/examples).
## Workspace container requirements
By default, workspaces inject and start the [GitLab VS Code fork](https://gitlab.com/gitlab-org/gitlab-web-ide-vscode-fork)
in the container that has a defined `gl/inject-editor` attribute in the devfile.
The workspace container where the GitLab VS Code fork is injected
must meet the following system requirements:
- System architecture: AMD64
- System libraries:
- `glibc` 2.28 and later
- `glibcxx` 3.4.25 and later
These requirements have been tested on Debian 10.13 and Ubuntu 20.04.
For more information, see the [VS Code documentation](https://code.visualstudio.com/docs/remote/linux).
{{< alert type="note" >}}
GitLab always pulls the workspace injector image (`gl-tools-injector`) and project cloner image
(`gl-project-cloner`) from the GitLab registry (`registry.gitlab.com/gitlab-org/gitlab-web-ide-vscode-fork/web-ide-injector`).
These images cannot be overridden.
If you use a private container registry for your other images, GitLab still needs to fetch these
specific images from the GitLab registry. This requirement may impact environments with strict network
controls, such as offline environments.
{{< /alert >}}
## Workspace add-ons
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385157) in GitLab 17.2.
{{< /history >}}
The GitLab Workflow extension for VS Code is configured by default in workspaces.
With this extension, you can view issues, create merge requests, and manage CI/CD pipelines.
This extension also powers AI features like [GitLab Duo Code Suggestions](../project/repository/code_suggestions/_index.md)
and [GitLab Duo Chat](../gitlab_duo_chat/_index.md).
For more information, see [GitLab Workflow extension for VS Code](https://gitlab.com/gitlab-org/gitlab-vscode-extension).
## Extension marketplace
{{< details >}}
- Status: Beta
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/438491) as a [beta](../../policy/development_stages_support.md#beta) in GitLab 16.9 [with a flag](../../administration/feature_flags/_index.md) named `allow_extensions_marketplace_in_workspace`. Disabled by default.
- Feature flag `allow_extensions_marketplace_in_workspace` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/454669) in GitLab 17.6.
{{< /history >}}
The VS Code Extension Marketplace provides you with access to extensions that enhance the
functionality of your workspace.
You can use the [extension marketplace](../project/web_ide/_index.md#manage-extensions) in your
workspace Web IDE. The extension marketplace connects to the [Open VSX Registry](https://open-vsx.org/).
For more information, see [Configure VS Code Extension Marketplace](../../administration/settings/vscode_extension_marketplace.md).
## Personal access token
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129715) in GitLab 16.4.
- `api` permission [added](https://gitlab.com/gitlab-org/gitlab/-/issues/385157) in GitLab 17.2.
{{< /history >}}
When you [create a workspace](configuration.md#create-a-workspace), you get a personal access token
with `write_repository` and `api` permissions.
Use this token to clone the project initially, while starting the workspace,
and to configure the GitLab Workflow extension for VS Code.
Any Git operation you perform in the workspace uses this token for authentication and authorization.
Terminating the workspace revokes the token.
Use the `GIT_CONFIG_COUNT`, `GIT_CONFIG_KEY_n`, and `GIT_CONFIG_VALUE_n`
[environment variables](https://git-scm.com/docs/git-config/#Documentation/git-config.txt-GITCONFIGCOUNT)
for Git authentication in the workspace. These variables require Git 2.31 or later in the workspace container.
## Pod interaction in a cluster
Workspaces run as pods in a Kubernetes cluster.
GitLab does not impose any restrictions on the manner in which pods interact with each other.
Consider isolating this feature from other containers in your cluster, because of this requirement.
## Network access and workspace authorization
It's the client's responsibility to restrict network access to the Kubernetes control plane
because GitLab does not have control over the API.
Only the workspace creator can access the workspace and any endpoints exposed in that workspace.
The workspace creator is only authorized to access the workspace after user authentication with OAuth.
## Compute resources and volume storage
When you stop a workspace, GitLab scales the compute resources for that workspace down to zero.
However, the volume provisioned for the workspace still exists.
To delete the provisioned volume, you must terminate the workspace.
## Automatic workspace stop and termination
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14910) in GitLab 17.6.
{{< /history >}}
By default, a workspace automatically:
- Stops 36 hours after the workspace was last started or restarted.
For more information, see [`max_active_hours_before_stop`](settings.md#max_active_hours_before_stop).
- Terminates 722 hours after the workspace was last stopped.
For more information, see [`max_stopped_hours_before_termination`](settings.md#max_stopped_hours_before_termination).
## Arbitrary user IDs
You can provide your own container image, which can run as any Linux user ID.
It's not possible for GitLab to predict the Linux user ID for a container image.
GitLab uses the Linux `root` group ID permission to create, update, or delete files in a container.
The container runtime used by the Kubernetes cluster must ensure all containers have a default Linux group ID of `0`.
If you have a container image that does not support arbitrary user IDs,
you cannot create, update, or delete files in a workspace.
To create a container image that supports arbitrary user IDs,
see [Create a custom workspace image that supports arbitrary user IDs](create_image.md).
For more information, see the
[OpenShift documentation](https://docs.openshift.com/container-platform/4.12/openshift_images/create-images.html#use-uid_create-images).
## Workspace logs directory
When a workspace starts, GitLab creates a logs directory to capture output
from various initialization and startup processes.
The workspace logs are stored in `/tmp/workspace-logs/`.
This directory helps you monitor workspace startup progress and troubleshoot
issues with `postStart` events, development tools, and other workspace components.
For more information, see [Debug `postStart` events](workspaces_troubleshooting.md#debug-poststart-events).
### Available log files
The logs directory contains the following log files:
| Log file | Purpose | Content |
|------------------------|----------------------------|---------|
| `poststart-stdout.log` | `postStart` command output | Standard output from all `postStart` commands, including user-defined commands and internal GitLab startup tasks. |
| `poststart-stderr.log` | `postStart` command errors | Error output and `stderr` from `postStart` commands. You can use these logs to troubleshoot failed startup scripts. |
| `start-vscode.log` | VS Code server startup | Logs from the GitLab VS Code fork server initialization. |
| `start-sshd.log` | SSH daemon startup | Output from SSH daemon initialization, including server startup and configuration details. |
| `clone-unshallow.log` | Git repository conversion | Logs from the background process that converts the shallow clone to a full clone and retrieves the complete Git history for the project. |
{{< alert type="note" >}}
Log files are recreated each time you restart a workspace. Previous log files are not preserved
when you stop and restart a workspace.
{{< /alert >}}
## Shallow cloning
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/543982) in GitLab 18.2 [with a flag](../../administration/feature_flags/_index.md) named `workspaces_shallow_clone_project`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.
{{< /alert >}}
When you create a workspace, GitLab uses shallow cloning to improve performance.
A shallow clone downloads only the latest commit history instead of the complete Git history,
which significantly reduces the initial clone time for large repositories.
After the workspace starts, Git converts the shallow clone to a full clone in the background.
This process is transparent and doesn't affect your development workflow.
## Related topics
- [Troubleshooting Workspaces](workspaces_troubleshooting.md)
|
https://docs.gitlab.com/user/settings
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/settings.md
|
2025-08-13
|
doc/user/workspace
|
[
"doc",
"user",
"workspace"
] |
settings.md
|
Create
|
Remote Development
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Workspace settings
|
Configure the GitLab agent for Kubernetes to support workspaces.
|
Workspace settings configure how the GitLab agent for Kubernetes manages remote development environments
in
your Kubernetes cluster. These settings control:
- Resource allocation
- Security
- Networking
- Lifecycle management
## Set up a basic workspace configuration
To set up a basic workspace configuration:
1. Open your configuration YAML file.
1. Add these minimum required settings:
```yaml
remote_development:
enabled: true
dns_zone: "<workspaces.example.dev>"
```
1. Commit the changes.
If your workspace configuration is not working, see [Troubleshooting workspaces](workspaces_troubleshooting.md).
{{< alert type="note" >}}
If a setting has an invalid value, it's not possible to update any setting until you fix that value.
Updating any of these settings, except `enabled`, does not affect existing workspaces.
{{< /alert >}}
## Configuration reference
| Setting | Description | Format | Default value | Required |
|-------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-------------------------------------------------------------|-----------------------------------------|----------|
| [`enabled`](#enabled) | Indicates whether remote development is enabled for the GitLab agent for Kubernetes. | Boolean | `false` | Yes |
| [`dns_zone`](#dns_zone) | DNS zone where workspaces are available. | String. Valid DNS format. | None | Yes |
| [`gitlab_workspaces_proxy`](#gitlab_workspaces_proxy) | Namespace where [`gitlab-workspaces-proxy`](set_up_gitlab_agent_and_proxies.md) is installed. | String. Valid Kubernetes namespace name. | `gitlab-workspaces` | No |
| [`network_policy`](#network_policy) | Firewall rules for workspaces. | Object containing `enabled` and `egress` fields. | See [`network_policy`](#network_policy) | No |
| [`default_resources_per_workspace_container`](#default_resources_per_workspace_container) | Default requests and limits for CPU and memory per workspace container. | Object with `requests` and `limits` for CPU and memory. | `{}` | No |
| [`max_resources_per_workspace`](#max_resources_per_workspace) | Maximum requests and limits for CPU and memory per workspace. | Object with `requests` and `limits` for CPU and memory | `{}` | No |
| [`workspaces_quota`](#workspaces_quota) | Maximum number of workspaces for the GitLab agent for Kubernetes. | Integer | `-1` | No |
| [`workspaces_per_user_quota`](#workspaces_per_user_quota) | Maximum number of workspaces per user. | Integer | `-1` | No |
| [`use_kubernetes_user_namespaces`](#use_kubernetes_user_namespaces) | Indicates whether to use user namespaces in Kubernetes. | Boolean: `true` or `false` | `false` | No |
| [`default_runtime_class`](#default_runtime_class) | Default Kubernetes `RuntimeClass`. | String. Valid `RuntimeClass` name. | `""` | No |
| [`allow_privilege_escalation`](#allow_privilege_escalation) | Allow privilege escalation. | Boolean | `false` | No |
| [`image_pull_secrets`](#image_pull_secrets) | Existing Kubernetes secrets to pull private images for workspaces. | Array of objects with `name` and `namespace` fields. | `[]` | No |
| [`annotations`](#annotations) | Annotations to apply to Kubernetes objects. | Map of key-value pairs. Valid Kubernetes annotation format. | `{}` | No |
| [`labels`](#labels) | Labels to apply to Kubernetes objects. | Map of key-value pairs. Valid Kubernetes label format | `{}` | No |
| [`max_active_hours_before_stop`](#max_active_hours_before_stop) | Maximum number of hours a workspace can be active before it is stopped. | Integer | `36` | No |
| [`max_stopped_hours_before_termination`](#max_stopped_hours_before_termination) | Maximum number of hours a workspace can be stopped before it is terminated. | Integer | `744` | No |
| [`shared_namespace`](#shared_namespace) | Indicates whether to use a shared Kubernetes namespace. | String | `""` | No |
### `enabled`
Use this setting to define whether:
- The GitLab agent for Kubernetes can communicate with the GitLab instance.
- You can [create a workspace](configuration.md#create-a-workspace) with the GitLab agent for Kubernetes.
The default value is `false`.
To enable remote development in the agent configuration, set `enabled` to `true`:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
enabled: true
```
{{< alert type="note" >}}
If `enabled` is set to `false` for an agent that has active or stopped workspaces,
those workspaces become orphaned and unusable.
Before you disable remote development on an agent:
- Ensure all associated workspaces are no longer needed.
- Manually delete any running workspaces to remove them from the Kubernetes cluster.
{{< /alert >}}
### `dns_zone`
Use this setting to define the DNS zone of the URL where workspaces are available.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
dns_zone: "<workspaces.example.dev>"
```
### `gitlab_workspaces_proxy`
Use this setting to define the namespace where
[`gitlab-workspaces-proxy`](set_up_gitlab_agent_and_proxies.md) is installed.
The default value for `gitlab_workspaces_proxy.namespace` is `gitlab-workspaces`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
gitlab_workspaces_proxy:
namespace: "<custom-gitlab-workspaces-proxy-namespace>"
```
### `network_policy`
Use this setting to define the network policy for each workspace.
This setting controls network traffic for workspaces.
The default value is:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
network_policy:
enabled: true
egress:
- allow: "0.0.0.0/0"
except:
- "10.0.0.0/8"
- "172.16.0.0/12"
- "192.168.0.0/16"
```
In this configuration:
- The network policy is generated for each workspace because `enabled` is `true`.
- The egress rules allow all traffic to the internet (`0.0.0.0/0`) except to the
IP CIDR ranges `10.0.0.0/8`, `172.16.0.0/12`, and `192.168.0.0/16`.
The behavior of the network policy depends on the Kubernetes network plugin.
For more information, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/services-networking/network-policies/).
#### `network_policy.enabled`
Use this setting to define whether the network policy is generated for each workspace.
The default value for `network_policy.enabled` is `true`.
#### `network_policy.egress`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11629) in GitLab 16.7.
{{< /history >}}
Use this setting to define a list of IP CIDR ranges to allow as egress destinations from a workspace.
Define egress rules when:
- The GitLab instance is on a private IP range.
- The workspace must access a cloud resource on a private IP range.
Each element of the list defines an `allow` attribute with an optional `except` attribute.
`allow` defines an IP range to allow traffic from.
`except` lists IP ranges to exclude from the `allow` range.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
network_policy:
egress:
- allow: "0.0.0.0/0"
except:
- "10.0.0.0/8"
- "172.16.0.0/12"
- "192.168.0.0/16"
- allow: "172.16.123.1/32"
```
In this example, traffic from the workspace is allowed if:
- The destination IP is any range except `10.0.0.0/8`, `172.16.0.0/12`, or `192.168.0.0/16`.
- The destination IP is `172.16.123.1/32`.
### `default_resources_per_workspace_container`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11625) in GitLab 16.8.
{{< /history >}}
Use this setting to define the default [requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits)
for CPU and memory per workspace container.
Any resources you define in your [devfile](_index.md#devfile) override this setting.
For `default_resources_per_workspace_container`, `requests` and `limits` are required.
For more information about possible CPU and memory values, see [Resource units in Kubernetes](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes).
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
default_resources_per_workspace_container:
requests:
cpu: "0.5"
memory: "512Mi"
limits:
cpu: "1"
memory: "1Gi"
```
### `max_resources_per_workspace`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11625) in GitLab 16.8.
{{< /history >}}
Use this setting to define the maximum [requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits)
for CPU and memory per workspace.
For `max_resources_per_workspace`, `requests` and `limits` are required.
For more information about possible CPU and memory values, see:
- [Resource units in Kubernetes](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes)
- [Resource quotas](https://kubernetes.io/docs/concepts/policy/resource-quotas/)
Workspaces fail when they exceed the values you set for `requests` and `limits`.
{{< alert type="note" >}}
If [`shared_namespace`](#shared_namespace) is set, `max_resources_per_workspace` must be an
empty hash. Users can create a Kubernetes [Resource quota](https://kubernetes.io/docs/concepts/policy/resource-quotas/)
in the `shared_namespace` to achieve the same result as specifying this value here.
{{< /alert >}}
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
max_resources_per_workspace:
requests:
cpu: "1"
memory: "1Gi"
limits:
cpu: "2"
memory: "2Gi"
```
The maximum resources you define must include any resources required for init containers
to perform bootstrapping operations such as cloning the project repository.
### `workspaces_quota`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11586) in GitLab 16.9.
{{< /history >}}
Use this setting to set the maximum number of workspaces for the GitLab agent for Kubernetes.
You cannot create new workspaces for an agent when:
- The number of workspaces for the agent has reached the defined `workspaces_quota`.
- `workspaces_quota` is set to `0`.
If `workspaces_quota` is set to a value below the number of non-terminated workspaces
for an agent, the agent's workspaces are not terminated automatically.
The default value is `-1` (unlimited).
Possible values are greater than or equal to `-1`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
workspaces_quota: 10
```
### `workspaces_per_user_quota`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11586) in GitLab 16.9.
{{< /history >}}
Use this setting to set the maximum number of workspaces per user.
You cannot create new workspaces for a user when:
- The number of workspaces for the user has reached the defined `workspaces_per_user_quota`.
- `workspaces_per_user_quota` is set to `0`.
If `workspaces_per_user_quota` is set to a value below the number of non-terminated workspaces
for a user, the user's workspaces are not terminated automatically.
The default value is `-1` (unlimited).
Possible values are greater than or equal to `-1`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
workspaces_per_user_quota: 3
```
### `use_kubernetes_user_namespaces`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Use this setting to specify whether to use the user namespaces feature in Kubernetes.
[User namespaces](https://kubernetes.io/docs/concepts/workloads/pods/user-namespaces/) isolate the user
running inside the container from the user on the host.
The default value is `false`. Before you set the value to `true`, ensure your Kubernetes cluster supports user namespaces.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
use_kubernetes_user_namespaces: true
```
For more information about `use_kubernetes_user_namespaces`, see
[user namespaces](https://kubernetes.io/docs/concepts/workloads/pods/user-namespaces/).
### `default_runtime_class`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Use this setting to select the container runtime configuration used to run the containers in the workspace.
The default value is `""`, which denotes the absence of a value.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
default_runtime_class: "example-runtime-class-name"
```
A valid value:
- Contains 253 characters or less.
- Contains only lowercase letters, numbers, `-`, or `.`.
- Starts with an alphanumeric character
- Ends with an alphanumeric character.
For more information about `default_runtime_class`, see
[Runtime Class](https://kubernetes.io/docs/concepts/containers/runtime-class/).
### `allow_privilege_escalation`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Use this setting to control whether a process can gain more privileges than its parent process.
This setting directly controls whether the [`no_new_privs`](https://www.kernel.org/doc/Documentation/prctl/no_new_privs.txt)
flag gets set on the container process.
The default value is `false`. The value can be set to `true` only if either:
- [`default_runtime_class`](#default_runtime_class) is set to a non-empty value.
- [`use_kubernetes_user_namespaces`](#use_kubernetes_user_namespaces) is set to `true`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
default_runtime_class: "example-runtime-class-name"
allow_privilege_escalation: true
```
For more information about `allow_privilege_escalation`, see
[Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/).
### `image_pull_secrets`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14664) in GitLab 17.6.
{{< /history >}}
Use this setting to specify existing Kubernetes secrets of the type `kubernetes.io/dockercfg`
or `kubernetes.io/dockerconfigjson` required by workspaces to pull private images.
The default value is `[]`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
image_pull_secrets:
- name: "image-pull-secret-name"
namespace: "image-pull-secret-namespace"
```
In this example, the secret `image-pull-secret-name` from the namespace
`image-pull-secret-namespace` is synced to the namespace of the workspace.
For `image_pull_secrets`, the `name` and `namespace` attributes are required.
The name of the secret must be unique.
If [`shared_namespace`](#shared_namespace) is set, the namespace of the secret must be the same as the `shared_namespace`.
If the secret you've specified does not exist in the Kubernetes cluster, the secret is ignored.
When you delete or update the secret, the secret is deleted or updated
in all the namespaces of the workspaces where the secret is referenced.
### `annotations`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Use this setting to attach arbitrary non-identifying metadata to the Kubernetes objects.
The default value is `{}`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
annotations:
"example.com/key": "value"
```
A valid annotation key is a string made of two parts:
- Optional. A prefix. The prefix must be 253 characters or less, and contain period-separated DNS labels. The prefix must end with a slash (`/`).
- A name. The name must be 63 characters or less and contain only alphanumeric characters, dashes (`-`), underscores (`_`), and periods (`.`). The name must begin and end with an alphanumeric character.
You shouldn't use prefixes that end with `kubernetes.io` and `k8s.io` because they are reserved for Kubernetes core components.
Prefixes that end with `gitlab.com` are also reserved.
A valid annotation value is a string.
For more information about `annotations`, see
[Annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/).
### `labels`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Use this setting to attach arbitrary identifying metadata to the Kubernetes objects.
The default value is `{}`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
labels:
"example.com/key": "value"
```
A label key is a string made of two parts:
- Optional. A prefix. The prefix must be 253 characters or less, and contain period-separated DNS labels. The prefix must end with a slash (`/`).
- A name. The name must be 63 characters or less and contain only alphanumeric characters, dashes (`-`), underscores (`_`), and periods (`.`). The name must begin and end with an alphanumeric character.
You shouldn't use prefixes that end with `kubernetes.io` and `k8s.io` because they are reserved for Kubernetes core components.
Prefixes that end with `gitlab.com` are also reserved.
A valid label value:
- Contains 63 characters or less. The value can be empty.
- Begins and ends with an alphanumeric character.
- Can contain dashes (`-`), underscores (`_`), and periods (`.`).
For more information about `labels`, see
[Labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/).
### `max_active_hours_before_stop`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14910) in GitLab 17.6.
{{< /history >}}
This setting automatically stops the agent's workspaces after they have been active for the specified
number of hours. An active state is any non-stopped or non-terminated state.
The timer for this setting starts when you create the workspace, and is reset every time you
restart the workspace.
It also applies even if the workspace is in an error or failure state.
The default value is `36`, or one and a half days. This avoids stopping the workspace during
the user's typical working hours.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
max_active_hours_before_stop: 60
```
A valid value:
- Is an integer.
- Is greater than or equal to `1`.
- Is less than or equal to `8760` (one year).
- `max_active_hours_before_stop` + `max_stopped_hours_before_termination` must be less than or equal to `8760`.
The automatic stop is only triggered on a full reconciliation, which happens every hour.
This means that the workspace might be active for up to one hour longer than the configured value.
### `max_stopped_hours_before_termination`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14910) in GitLab 17.6.
{{< /history >}}
Use this setting to automatically terminate the agent's workspaces after they have been in the stopped
state for the specified number of hours.
The default value is `722`, or approximately one month.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
max_stopped_hours_before_termination: 4332
```
A valid value:
- Is an integer.
- Is greater than or equal to `1`.
- Is less than or equal to `8760` (one year).
- `max_active_hours_before_stop` + `max_stopped_hours_before_termination` must be less than or equal to `8760`.
The automatic termination is only triggered on a full reconciliation, which happens every hour.
This means that the workspace might stop for up to one hour longer than the configured value.
### `shared_namespace`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/12327) in GitLab 18.0.
{{< /history >}}
Use this setting to specify a shared Kubernetes namespace for all workspaces.
The default value is `""`, which creates each new workspace in its own separate Kubernetes namespace.
When you specify a value, all workspaces exist in that Kubernetes namespace instead of individual namespaces.
Setting a value for `shared_namespace` imposes restrictions on the acceptable values for [`image_pull_secrets`](#image_pull_secrets) and [`max_resources_per_workspace`](#max_resources_per_workspace).
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
shared_namespace: "example-shared-namespace"
```
A valid value:
- Contains at most 63 characters.
- Contains only lowercase alphanumeric characters or '-'.
- Starts with an alphanumeric character.
- Ends with an alphanumeric character.
For more information about Kubernetes namespaces, see
[Namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/).
## Complete example configuration
The following configuration is a complete, example configuration.
It includes all available settings in the [configuration reference](#configuration-reference):
```yaml
remote_development:
enabled: true
dns_zone: workspaces.dev.test
gitlab_workspaces_proxy:
namespace: "gitlab-workspaces"
network_policy:
enabled: true
egress:
- allow: "0.0.0.0/0"
except:
- "10.0.0.0/8"
- "172.16.0.0/12"
- "192.168.0.0/16"
default_resources_per_workspace_container:
requests:
cpu: "0.5"
memory: "512Mi"
limits:
cpu: "1"
memory: "1Gi"
max_resources_per_workspace:
requests:
cpu: "1"
memory: "1Gi"
limits:
cpu: "2"
memory: "4Gi"
workspaces_quota: 10
workspaces_per_user_quota: 3
use_kubernetes_user_namespaces: false
default_runtime_class: "standard"
allow_privilege_escalation: false
image_pull_secrets:
- name: "registry-secret"
namespace: "default"
annotations:
environment: "production"
team: "engineering"
labels:
app: "workspace"
tier: "development"
max_active_hours_before_stop: 60
max_stopped_hours_before_termination: 4332
shared_namespace: ""
```
|
---
stage: Create
group: Remote Development
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Configure the GitLab agent for Kubernetes to support workspaces.
title: Workspace settings
breadcrumbs:
- doc
- user
- workspace
---
Workspace settings configure how the GitLab agent for Kubernetes manages remote development environments
in
your Kubernetes cluster. These settings control:
- Resource allocation
- Security
- Networking
- Lifecycle management
## Set up a basic workspace configuration
To set up a basic workspace configuration:
1. Open your configuration YAML file.
1. Add these minimum required settings:
```yaml
remote_development:
enabled: true
dns_zone: "<workspaces.example.dev>"
```
1. Commit the changes.
If your workspace configuration is not working, see [Troubleshooting workspaces](workspaces_troubleshooting.md).
{{< alert type="note" >}}
If a setting has an invalid value, it's not possible to update any setting until you fix that value.
Updating any of these settings, except `enabled`, does not affect existing workspaces.
{{< /alert >}}
## Configuration reference
| Setting | Description | Format | Default value | Required |
|-------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-------------------------------------------------------------|-----------------------------------------|----------|
| [`enabled`](#enabled) | Indicates whether remote development is enabled for the GitLab agent for Kubernetes. | Boolean | `false` | Yes |
| [`dns_zone`](#dns_zone) | DNS zone where workspaces are available. | String. Valid DNS format. | None | Yes |
| [`gitlab_workspaces_proxy`](#gitlab_workspaces_proxy) | Namespace where [`gitlab-workspaces-proxy`](set_up_gitlab_agent_and_proxies.md) is installed. | String. Valid Kubernetes namespace name. | `gitlab-workspaces` | No |
| [`network_policy`](#network_policy) | Firewall rules for workspaces. | Object containing `enabled` and `egress` fields. | See [`network_policy`](#network_policy) | No |
| [`default_resources_per_workspace_container`](#default_resources_per_workspace_container) | Default requests and limits for CPU and memory per workspace container. | Object with `requests` and `limits` for CPU and memory. | `{}` | No |
| [`max_resources_per_workspace`](#max_resources_per_workspace) | Maximum requests and limits for CPU and memory per workspace. | Object with `requests` and `limits` for CPU and memory | `{}` | No |
| [`workspaces_quota`](#workspaces_quota) | Maximum number of workspaces for the GitLab agent for Kubernetes. | Integer | `-1` | No |
| [`workspaces_per_user_quota`](#workspaces_per_user_quota) | Maximum number of workspaces per user. | Integer | `-1` | No |
| [`use_kubernetes_user_namespaces`](#use_kubernetes_user_namespaces) | Indicates whether to use user namespaces in Kubernetes. | Boolean: `true` or `false` | `false` | No |
| [`default_runtime_class`](#default_runtime_class) | Default Kubernetes `RuntimeClass`. | String. Valid `RuntimeClass` name. | `""` | No |
| [`allow_privilege_escalation`](#allow_privilege_escalation) | Allow privilege escalation. | Boolean | `false` | No |
| [`image_pull_secrets`](#image_pull_secrets) | Existing Kubernetes secrets to pull private images for workspaces. | Array of objects with `name` and `namespace` fields. | `[]` | No |
| [`annotations`](#annotations) | Annotations to apply to Kubernetes objects. | Map of key-value pairs. Valid Kubernetes annotation format. | `{}` | No |
| [`labels`](#labels) | Labels to apply to Kubernetes objects. | Map of key-value pairs. Valid Kubernetes label format | `{}` | No |
| [`max_active_hours_before_stop`](#max_active_hours_before_stop) | Maximum number of hours a workspace can be active before it is stopped. | Integer | `36` | No |
| [`max_stopped_hours_before_termination`](#max_stopped_hours_before_termination) | Maximum number of hours a workspace can be stopped before it is terminated. | Integer | `744` | No |
| [`shared_namespace`](#shared_namespace) | Indicates whether to use a shared Kubernetes namespace. | String | `""` | No |
### `enabled`
Use this setting to define whether:
- The GitLab agent for Kubernetes can communicate with the GitLab instance.
- You can [create a workspace](configuration.md#create-a-workspace) with the GitLab agent for Kubernetes.
The default value is `false`.
To enable remote development in the agent configuration, set `enabled` to `true`:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
enabled: true
```
{{< alert type="note" >}}
If `enabled` is set to `false` for an agent that has active or stopped workspaces,
those workspaces become orphaned and unusable.
Before you disable remote development on an agent:
- Ensure all associated workspaces are no longer needed.
- Manually delete any running workspaces to remove them from the Kubernetes cluster.
{{< /alert >}}
### `dns_zone`
Use this setting to define the DNS zone of the URL where workspaces are available.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
dns_zone: "<workspaces.example.dev>"
```
### `gitlab_workspaces_proxy`
Use this setting to define the namespace where
[`gitlab-workspaces-proxy`](set_up_gitlab_agent_and_proxies.md) is installed.
The default value for `gitlab_workspaces_proxy.namespace` is `gitlab-workspaces`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
gitlab_workspaces_proxy:
namespace: "<custom-gitlab-workspaces-proxy-namespace>"
```
### `network_policy`
Use this setting to define the network policy for each workspace.
This setting controls network traffic for workspaces.
The default value is:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
network_policy:
enabled: true
egress:
- allow: "0.0.0.0/0"
except:
- "10.0.0.0/8"
- "172.16.0.0/12"
- "192.168.0.0/16"
```
In this configuration:
- The network policy is generated for each workspace because `enabled` is `true`.
- The egress rules allow all traffic to the internet (`0.0.0.0/0`) except to the
IP CIDR ranges `10.0.0.0/8`, `172.16.0.0/12`, and `192.168.0.0/16`.
The behavior of the network policy depends on the Kubernetes network plugin.
For more information, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/services-networking/network-policies/).
#### `network_policy.enabled`
Use this setting to define whether the network policy is generated for each workspace.
The default value for `network_policy.enabled` is `true`.
#### `network_policy.egress`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11629) in GitLab 16.7.
{{< /history >}}
Use this setting to define a list of IP CIDR ranges to allow as egress destinations from a workspace.
Define egress rules when:
- The GitLab instance is on a private IP range.
- The workspace must access a cloud resource on a private IP range.
Each element of the list defines an `allow` attribute with an optional `except` attribute.
`allow` defines an IP range to allow traffic from.
`except` lists IP ranges to exclude from the `allow` range.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
network_policy:
egress:
- allow: "0.0.0.0/0"
except:
- "10.0.0.0/8"
- "172.16.0.0/12"
- "192.168.0.0/16"
- allow: "172.16.123.1/32"
```
In this example, traffic from the workspace is allowed if:
- The destination IP is any range except `10.0.0.0/8`, `172.16.0.0/12`, or `192.168.0.0/16`.
- The destination IP is `172.16.123.1/32`.
### `default_resources_per_workspace_container`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11625) in GitLab 16.8.
{{< /history >}}
Use this setting to define the default [requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits)
for CPU and memory per workspace container.
Any resources you define in your [devfile](_index.md#devfile) override this setting.
For `default_resources_per_workspace_container`, `requests` and `limits` are required.
For more information about possible CPU and memory values, see [Resource units in Kubernetes](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes).
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
default_resources_per_workspace_container:
requests:
cpu: "0.5"
memory: "512Mi"
limits:
cpu: "1"
memory: "1Gi"
```
### `max_resources_per_workspace`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11625) in GitLab 16.8.
{{< /history >}}
Use this setting to define the maximum [requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits)
for CPU and memory per workspace.
For `max_resources_per_workspace`, `requests` and `limits` are required.
For more information about possible CPU and memory values, see:
- [Resource units in Kubernetes](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes)
- [Resource quotas](https://kubernetes.io/docs/concepts/policy/resource-quotas/)
Workspaces fail when they exceed the values you set for `requests` and `limits`.
{{< alert type="note" >}}
If [`shared_namespace`](#shared_namespace) is set, `max_resources_per_workspace` must be an
empty hash. Users can create a Kubernetes [Resource quota](https://kubernetes.io/docs/concepts/policy/resource-quotas/)
in the `shared_namespace` to achieve the same result as specifying this value here.
{{< /alert >}}
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
max_resources_per_workspace:
requests:
cpu: "1"
memory: "1Gi"
limits:
cpu: "2"
memory: "2Gi"
```
The maximum resources you define must include any resources required for init containers
to perform bootstrapping operations such as cloning the project repository.
### `workspaces_quota`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11586) in GitLab 16.9.
{{< /history >}}
Use this setting to set the maximum number of workspaces for the GitLab agent for Kubernetes.
You cannot create new workspaces for an agent when:
- The number of workspaces for the agent has reached the defined `workspaces_quota`.
- `workspaces_quota` is set to `0`.
If `workspaces_quota` is set to a value below the number of non-terminated workspaces
for an agent, the agent's workspaces are not terminated automatically.
The default value is `-1` (unlimited).
Possible values are greater than or equal to `-1`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
workspaces_quota: 10
```
### `workspaces_per_user_quota`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11586) in GitLab 16.9.
{{< /history >}}
Use this setting to set the maximum number of workspaces per user.
You cannot create new workspaces for a user when:
- The number of workspaces for the user has reached the defined `workspaces_per_user_quota`.
- `workspaces_per_user_quota` is set to `0`.
If `workspaces_per_user_quota` is set to a value below the number of non-terminated workspaces
for a user, the user's workspaces are not terminated automatically.
The default value is `-1` (unlimited).
Possible values are greater than or equal to `-1`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
workspaces_per_user_quota: 3
```
### `use_kubernetes_user_namespaces`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Use this setting to specify whether to use the user namespaces feature in Kubernetes.
[User namespaces](https://kubernetes.io/docs/concepts/workloads/pods/user-namespaces/) isolate the user
running inside the container from the user on the host.
The default value is `false`. Before you set the value to `true`, ensure your Kubernetes cluster supports user namespaces.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
use_kubernetes_user_namespaces: true
```
For more information about `use_kubernetes_user_namespaces`, see
[user namespaces](https://kubernetes.io/docs/concepts/workloads/pods/user-namespaces/).
### `default_runtime_class`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Use this setting to select the container runtime configuration used to run the containers in the workspace.
The default value is `""`, which denotes the absence of a value.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
default_runtime_class: "example-runtime-class-name"
```
A valid value:
- Contains 253 characters or less.
- Contains only lowercase letters, numbers, `-`, or `.`.
- Starts with an alphanumeric character
- Ends with an alphanumeric character.
For more information about `default_runtime_class`, see
[Runtime Class](https://kubernetes.io/docs/concepts/containers/runtime-class/).
### `allow_privilege_escalation`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Use this setting to control whether a process can gain more privileges than its parent process.
This setting directly controls whether the [`no_new_privs`](https://www.kernel.org/doc/Documentation/prctl/no_new_privs.txt)
flag gets set on the container process.
The default value is `false`. The value can be set to `true` only if either:
- [`default_runtime_class`](#default_runtime_class) is set to a non-empty value.
- [`use_kubernetes_user_namespaces`](#use_kubernetes_user_namespaces) is set to `true`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
default_runtime_class: "example-runtime-class-name"
allow_privilege_escalation: true
```
For more information about `allow_privilege_escalation`, see
[Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/).
### `image_pull_secrets`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14664) in GitLab 17.6.
{{< /history >}}
Use this setting to specify existing Kubernetes secrets of the type `kubernetes.io/dockercfg`
or `kubernetes.io/dockerconfigjson` required by workspaces to pull private images.
The default value is `[]`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
image_pull_secrets:
- name: "image-pull-secret-name"
namespace: "image-pull-secret-namespace"
```
In this example, the secret `image-pull-secret-name` from the namespace
`image-pull-secret-namespace` is synced to the namespace of the workspace.
For `image_pull_secrets`, the `name` and `namespace` attributes are required.
The name of the secret must be unique.
If [`shared_namespace`](#shared_namespace) is set, the namespace of the secret must be the same as the `shared_namespace`.
If the secret you've specified does not exist in the Kubernetes cluster, the secret is ignored.
When you delete or update the secret, the secret is deleted or updated
in all the namespaces of the workspaces where the secret is referenced.
### `annotations`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Use this setting to attach arbitrary non-identifying metadata to the Kubernetes objects.
The default value is `{}`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
annotations:
"example.com/key": "value"
```
A valid annotation key is a string made of two parts:
- Optional. A prefix. The prefix must be 253 characters or less, and contain period-separated DNS labels. The prefix must end with a slash (`/`).
- A name. The name must be 63 characters or less and contain only alphanumeric characters, dashes (`-`), underscores (`_`), and periods (`.`). The name must begin and end with an alphanumeric character.
You shouldn't use prefixes that end with `kubernetes.io` and `k8s.io` because they are reserved for Kubernetes core components.
Prefixes that end with `gitlab.com` are also reserved.
A valid annotation value is a string.
For more information about `annotations`, see
[Annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/).
### `labels`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Use this setting to attach arbitrary identifying metadata to the Kubernetes objects.
The default value is `{}`.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
labels:
"example.com/key": "value"
```
A label key is a string made of two parts:
- Optional. A prefix. The prefix must be 253 characters or less, and contain period-separated DNS labels. The prefix must end with a slash (`/`).
- A name. The name must be 63 characters or less and contain only alphanumeric characters, dashes (`-`), underscores (`_`), and periods (`.`). The name must begin and end with an alphanumeric character.
You shouldn't use prefixes that end with `kubernetes.io` and `k8s.io` because they are reserved for Kubernetes core components.
Prefixes that end with `gitlab.com` are also reserved.
A valid label value:
- Contains 63 characters or less. The value can be empty.
- Begins and ends with an alphanumeric character.
- Can contain dashes (`-`), underscores (`_`), and periods (`.`).
For more information about `labels`, see
[Labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/).
### `max_active_hours_before_stop`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14910) in GitLab 17.6.
{{< /history >}}
This setting automatically stops the agent's workspaces after they have been active for the specified
number of hours. An active state is any non-stopped or non-terminated state.
The timer for this setting starts when you create the workspace, and is reset every time you
restart the workspace.
It also applies even if the workspace is in an error or failure state.
The default value is `36`, or one and a half days. This avoids stopping the workspace during
the user's typical working hours.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
max_active_hours_before_stop: 60
```
A valid value:
- Is an integer.
- Is greater than or equal to `1`.
- Is less than or equal to `8760` (one year).
- `max_active_hours_before_stop` + `max_stopped_hours_before_termination` must be less than or equal to `8760`.
The automatic stop is only triggered on a full reconciliation, which happens every hour.
This means that the workspace might be active for up to one hour longer than the configured value.
### `max_stopped_hours_before_termination`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14910) in GitLab 17.6.
{{< /history >}}
Use this setting to automatically terminate the agent's workspaces after they have been in the stopped
state for the specified number of hours.
The default value is `722`, or approximately one month.
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
max_stopped_hours_before_termination: 4332
```
A valid value:
- Is an integer.
- Is greater than or equal to `1`.
- Is less than or equal to `8760` (one year).
- `max_active_hours_before_stop` + `max_stopped_hours_before_termination` must be less than or equal to `8760`.
The automatic termination is only triggered on a full reconciliation, which happens every hour.
This means that the workspace might stop for up to one hour longer than the configured value.
### `shared_namespace`
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/12327) in GitLab 18.0.
{{< /history >}}
Use this setting to specify a shared Kubernetes namespace for all workspaces.
The default value is `""`, which creates each new workspace in its own separate Kubernetes namespace.
When you specify a value, all workspaces exist in that Kubernetes namespace instead of individual namespaces.
Setting a value for `shared_namespace` imposes restrictions on the acceptable values for [`image_pull_secrets`](#image_pull_secrets) and [`max_resources_per_workspace`](#max_resources_per_workspace).
Example configuration:
```yaml
remote_development:
# NOTE: This is a partial example.
# Some required fields are not included.
shared_namespace: "example-shared-namespace"
```
A valid value:
- Contains at most 63 characters.
- Contains only lowercase alphanumeric characters or '-'.
- Starts with an alphanumeric character.
- Ends with an alphanumeric character.
For more information about Kubernetes namespaces, see
[Namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/).
## Complete example configuration
The following configuration is a complete, example configuration.
It includes all available settings in the [configuration reference](#configuration-reference):
```yaml
remote_development:
enabled: true
dns_zone: workspaces.dev.test
gitlab_workspaces_proxy:
namespace: "gitlab-workspaces"
network_policy:
enabled: true
egress:
- allow: "0.0.0.0/0"
except:
- "10.0.0.0/8"
- "172.16.0.0/12"
- "192.168.0.0/16"
default_resources_per_workspace_container:
requests:
cpu: "0.5"
memory: "512Mi"
limits:
cpu: "1"
memory: "1Gi"
max_resources_per_workspace:
requests:
cpu: "1"
memory: "1Gi"
limits:
cpu: "2"
memory: "4Gi"
workspaces_quota: 10
workspaces_per_user_quota: 3
use_kubernetes_user_namespaces: false
default_runtime_class: "standard"
allow_privilege_escalation: false
image_pull_secrets:
- name: "registry-secret"
namespace: "default"
annotations:
environment: "production"
team: "engineering"
labels:
app: "workspace"
tier: "development"
max_active_hours_before_stop: 60
max_stopped_hours_before_termination: 4332
shared_namespace: ""
```
|
https://docs.gitlab.com/user/configuration
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/configuration.md
|
2025-08-13
|
doc/user/workspace
|
[
"doc",
"user",
"workspace"
] |
configuration.md
|
Create
|
Remote Development
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Configure workspaces
|
Configure your GitLab workspaces to manage your GitLab development environments.
|
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Feature flag `remote_development_feature_flag` [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/391543) in GitLab 16.0.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136744) in GitLab 16.7. Feature flag `remote_development_feature_flag` removed.
{{< /history >}}
You can use [workspaces](_index.md) to create and manage isolated development environments for your GitLab projects.
Each workspace includes its own set of dependencies, libraries, and tools,
which you can customize to meet the specific needs of each project.
## Set up workspace infrastructure
Before you [create a workspace](#create-a-workspace), you must set up your infrastructure only once.
To set up infrastructure for workspaces, regardless of cloud provider, you must:
1. Set up a Kubernetes cluster that the [GitLab agent for Kubernetes](../clusters/agent/_index.md) supports.
See the [supported Kubernetes versions](../clusters/agent/_index.md#supported-kubernetes-versions-for-gitlab-features).
1. Ensure autoscaling for the Kubernetes cluster is enabled.
1. In the Kubernetes cluster:
1. Verify that a [default storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/)
is defined so that volumes can be dynamically provisioned for each workspace.
1. Complete all steps in the [Tutorial: Set up the GitLab agent for Kubernetes](set_up_gitlab_agent_and_proxies.md).
1. Optional. [Build and run containers in a workspace](#build-and-run-containers-in-a-workspace).
1. Optional. [Configure support for private container registries](#configure-support-for-private-container-registries).
1. Optional. [Configure sudo access for a workspace](#configure-sudo-access-for-a-workspace).
If you use AWS, you can use our OpenTofu tutorial. For more information, see
[Tutorial: Set up workspaces infrastructure on AWS](set_up_infrastructure.md).
## Create a workspace
{{< history >}}
- **Time before automatic termination** [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120168) in GitLab 16.0
- Support for private projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124273) in GitLab 16.4.
- **Git reference** and **Devfile location** [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/392382) in GitLab 16.10.
- **Time before automatic termination** [renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/392382) to **Workspace automatically terminates after** in GitLab 16.10.
- **Variables** [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/463514) in GitLab 17.1.
- **Workspace automatically terminates after** [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166065) in GitLab 17.6.
- **Workspace can be created from Merge Request page** [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/187320) in GitLab 18.0.
{{< /history >}}
{{< alert type="warning" >}}
Create a workspace only from trusted projects.
{{< /alert >}}
Prerequisites:
- You must [set up workspace infrastructure](#set-up-workspace-infrastructure).
- You must have at least the Developer role for the workspace and agent projects.
{{< tabs >}}
{{< tab title="From a project" >}}
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Edit > New workspace**.
1. From the **Cluster agent** dropdown list, select a cluster agent owned by the group the project belongs to.
1. From the **Git reference** dropdown list, select the branch, tag, or commit hash
GitLab uses to create the workspace. By default, this is the branch you're viewing.
1. From the **Devfile** dropdown list, select one of the following:
- [GitLab default devfile](_index.md#gitlab-default-devfile).
- [Custom devfile](_index.md#custom-devfile).
1. In **Variables**, enter the keys and values of the environment variables you want to inject into the workspace.
To add a new variable, select **Add variable**.
1. Select **Create workspace**.
{{< /tab >}}
{{< tab title="From a merge request" >}}
1. On the left sidebar, select **Search or go to** and find your project.
1. On the left sidebar, select **Code > Merge requests**.
1. Select the merge request you want to create a workspace for.
1. Select **Code > Open in Workspace**.
1. From the **Cluster agent** dropdown list, select a cluster agent owned by the group the project belongs to.
1. From the **Git reference** dropdown list, select the branch, tag, or commit hash
GitLab uses to create the workspace. By default, this is the source branch of the merge request.
1. From the **Devfile** dropdown list, select one of the following:
- [GitLab default devfile](_index.md#gitlab-default-devfile).
- [Custom devfile](_index.md#custom-devfile).
1. In **Variables**, enter the keys and values of the environment variables you want to inject into the workspace.
To add a new variable, select **Add variable**.
1. Select **Create workspace**.
{{< /tab >}}
{{< /tabs >}}
The workspace might take a few minutes to start.
To open the workspace, under **Preview**, select the workspace.
You also have access to the terminal and can install any necessary dependencies.
### Monitor workspace startup progress
When you start a workspace, you can monitor the progress of initialization tasks and `postStart`
events by checking the workspace logs. For more information, see [Workspace logs directory](_index.md#workspace-logs-directory).
## Platform compatibility
The platform requirements for workspaces depend on your development needs.
For basic workspace functionality, workspaces run on any `linux/amd64` Kubernetes cluster that supports
the GitLab agent for Kubernetes, regardless of the underlying operating system.
To choose a method that fits your platform requirements, see [Configure sudo access for a workspace](#configure-sudo-access-for-a-workspace).
## Build and run containers in a workspace
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Development environments often require building and running containers to manage and use dependencies
during runtime.
To build and run containers in a workspace, see [configure sudo access for a workspace with Sysbox](#with-sysbox).
## Configure support for private container registries
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14664) in GitLab 17.6.
{{< /history >}}
To use images from private container registries:
1. Create an [image pull secret in Kubernetes](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/).
1. Add the `name` and `namespace` of this secret to the [GitLab agent for Kubernetes configuration](gitlab_agent_configuration.md).
For more information, see [`image_pull_secrets`](settings.md#image_pull_secrets).
## Configure sudo access for a workspace
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Development environments often require sudo permissions to install, configure, and use dependencies
during runtime. Choose the method that fits your platform requirements:
| Method | Platform requirements | Usage |
|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|
| [Sysbox](#with-sysbox) | For up-to-date information, see the [Sysbox distribution compatibility matrix](https://github.com/nestybox/sysbox/blob/master/docs/distro-compat.md). | Improves container isolation and enables containers to run the same workloads as virtual machines. |
| [Kata Containers](#with-kata-containers) | For up-to-date information, see the [Kata Containers installation guides](https://github.com/kata-containers/kata-containers/tree/main/docs/install). | Lightweight VMs perform like containers but provide enhanced workload isolation and security. |
| [User namespaces](#with-user-namespaces) | Kubernetes version 1.33 or later have the user namespaces enabled behind a Kubernetes feature gate which is enabled by default. For up-to-date information, see the [Kubernetes Feature Gates](https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/). | No additional runtime installation required. Isolates container users from host users for improved security. |
Prerequisites:
- Your container images must support [arbitrary user IDs](_index.md#arbitrary-user-ids).
Even with sudo access configured, container images used in a [devfile](_index.md#devfile)
cannot run with a user ID of `0`.
### With Sysbox
[Sysbox](https://github.com/nestybox/sysbox) is a container runtime that improves container isolation
and enables containers to run the same workloads as virtual machines.
To configure sudo access with Sysbox:
1. In your Kubernetes cluster, [install Sysbox](https://github.com/nestybox/sysbox#installation).
1. Configure the GitLab agent for Kubernetes:
- Set the default runtime class. In [`default_runtime_class`](settings.md#default_runtime_class),
enter the runtime class for Sysbox. For example, `sysbox-runc`.
- Enable privilege escalation.
Set [`allow_privilege_escalation`](settings.md#allow_privilege_escalation) to `true`.
- Configure the annotations required by Sysbox. Set [`annotations`](settings.md#annotations) to
`{"io.kubernetes.cri-o.userns-mode": "auto:size=65536"}`.
### With Kata Containers
[Kata Containers](https://github.com/kata-containers/kata-containers) is a standard implementation
of lightweight virtual machines that perform like containers but provide the workload isolation and
security of virtual machines.
To configure sudo access with Kata Containers:
1. In your Kubernetes cluster, [install Kata Containers](https://github.com/kata-containers/kata-containers/tree/main/docs/install).
1. Configure the GitLab agent for Kubernetes:
- Set the default runtime class. In [`default_runtime_class`](settings.md#default_runtime_class),
enter the runtime class for Kata Containers. For example, `kata-qemu`.
- Enable privilege escalation.
Set [`allow_privilege_escalation`](settings.md#allow_privilege_escalation) to `true`.
### With user namespaces
[User namespaces](https://kubernetes.io/docs/concepts/workloads/pods/user-namespaces/) isolate
container users from host users.
To configure sudo access with user namespaces:
1. In your Kubernetes cluster, [configure user namespaces](https://kubernetes.io/blog/2024/04/22/userns-beta/).
1. Configure the GitLab agent for Kubernetes:
- Set [`use_kubernetes_user_namespaces`](settings.md#use_kubernetes_user_namespaces) to `true`.
- Set [`allow_privilege_escalation`](settings.md#allow_privilege_escalation) to `true`.
## Connect to a workspace with SSH
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10478) in GitLab 16.3.
{{< /history >}}
Prerequisites:
- You must enable SSH access for the images specified in your [devfile](_index.md#devfile).
For more information, see [update your workspace container image](#update-your-workspace-container-image).
- You must configure a TCP load balancer that points to the GitLab workspaces proxy.
For more information, see [update your DNS records](set_up_gitlab_agent_and_proxies.md#update-your-dns-records).
To connect to a workspace with an SSH client:
1. Get the external IP address of your `gitlab-workspaces-proxy-ssh` service:
```shell
kubectl -n gitlab-workspaces get service gitlab-workspaces-proxy-ssh
```
1. Get the name of the workspace:
1. On the left sidebar, select **Search or go to**.
1. Select **Your work**.
1. Select **Workspaces**.
1. Copy the name of the workspace you want to connect to.
1. Run this command:
```shell
ssh <workspace_name>@<ssh_proxy_IP_address>
```
1. For the password, enter your personal access token with at least the `read_api` scope.
When you connect to `gitlab-workspaces-proxy` through the TCP load balancer,
`gitlab-workspaces-proxy` examines the username (workspace name) and interacts with GitLab to verify:
- The personal access token
- User access to the workspace
### Update your workspace container image
To update your runtime images for SSH connections:
1. Install [`sshd`](https://man.openbsd.org/sshd.8) in your runtime images.
1. Create a user named `gitlab-workspaces` to allow access to your container without a password.
```Dockerfile
FROM golang:1.20.5-bullseye
# Install `openssh-server` and other dependencies
RUN apt update \
&& apt upgrade -y \
&& apt install openssh-server sudo curl git wget software-properties-common apt-transport-https --yes \
&& rm -rf /var/lib/apt/lists/*
# Permit empty passwords
RUN sed -i 's/nullok_secure/nullok/' /etc/pam.d/common-auth
RUN echo "PermitEmptyPasswords yes" >> /etc/ssh/sshd_config
# Generate a workspace host key
RUN ssh-keygen -A
RUN chmod 775 /etc/ssh/ssh_host_rsa_key && \
chmod 775 /etc/ssh/ssh_host_ecdsa_key && \
chmod 775 /etc/ssh/ssh_host_ed25519_key
# Create a `gitlab-workspaces` user
RUN useradd -l -u 5001 -G sudo -md /home/gitlab-workspaces -s /bin/bash gitlab-workspaces
RUN passwd -d gitlab-workspaces
ENV HOME=/home/gitlab-workspaces
WORKDIR $HOME
RUN mkdir -p /home/gitlab-workspaces && chgrp -R 0 /home && chmod -R g=u /etc/passwd /etc/group /home
# Allow sign-in access to `/etc/shadow`
RUN chmod 775 /etc/shadow
USER gitlab-workspaces
```
## Related topics
- [Tutorial: Set up the GitLab agent for Kubernetes](set_up_gitlab_agent_and_proxies.md)
- [Workspace settings](settings.md)
- [Workspace configuration](configuration.md)
- [Troubleshooting Workspaces](workspaces_troubleshooting.md)
- [Quickstart guide for GitLab remote development workspaces](https://go.gitlab.com/AVKFvy)
- [Set up your infrastructure for on-demand, cloud-based development environments in GitLab](https://go.gitlab.com/dp75xo)
|
---
stage: Create
group: Remote Development
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Configure your GitLab workspaces to manage your GitLab development environments.
title: Configure workspaces
breadcrumbs:
- doc
- user
- workspace
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Feature flag `remote_development_feature_flag` [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/391543) in GitLab 16.0.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136744) in GitLab 16.7. Feature flag `remote_development_feature_flag` removed.
{{< /history >}}
You can use [workspaces](_index.md) to create and manage isolated development environments for your GitLab projects.
Each workspace includes its own set of dependencies, libraries, and tools,
which you can customize to meet the specific needs of each project.
## Set up workspace infrastructure
Before you [create a workspace](#create-a-workspace), you must set up your infrastructure only once.
To set up infrastructure for workspaces, regardless of cloud provider, you must:
1. Set up a Kubernetes cluster that the [GitLab agent for Kubernetes](../clusters/agent/_index.md) supports.
See the [supported Kubernetes versions](../clusters/agent/_index.md#supported-kubernetes-versions-for-gitlab-features).
1. Ensure autoscaling for the Kubernetes cluster is enabled.
1. In the Kubernetes cluster:
1. Verify that a [default storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/)
is defined so that volumes can be dynamically provisioned for each workspace.
1. Complete all steps in the [Tutorial: Set up the GitLab agent for Kubernetes](set_up_gitlab_agent_and_proxies.md).
1. Optional. [Build and run containers in a workspace](#build-and-run-containers-in-a-workspace).
1. Optional. [Configure support for private container registries](#configure-support-for-private-container-registries).
1. Optional. [Configure sudo access for a workspace](#configure-sudo-access-for-a-workspace).
If you use AWS, you can use our OpenTofu tutorial. For more information, see
[Tutorial: Set up workspaces infrastructure on AWS](set_up_infrastructure.md).
## Create a workspace
{{< history >}}
- **Time before automatic termination** [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120168) in GitLab 16.0
- Support for private projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124273) in GitLab 16.4.
- **Git reference** and **Devfile location** [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/392382) in GitLab 16.10.
- **Time before automatic termination** [renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/392382) to **Workspace automatically terminates after** in GitLab 16.10.
- **Variables** [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/463514) in GitLab 17.1.
- **Workspace automatically terminates after** [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166065) in GitLab 17.6.
- **Workspace can be created from Merge Request page** [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/187320) in GitLab 18.0.
{{< /history >}}
{{< alert type="warning" >}}
Create a workspace only from trusted projects.
{{< /alert >}}
Prerequisites:
- You must [set up workspace infrastructure](#set-up-workspace-infrastructure).
- You must have at least the Developer role for the workspace and agent projects.
{{< tabs >}}
{{< tab title="From a project" >}}
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Edit > New workspace**.
1. From the **Cluster agent** dropdown list, select a cluster agent owned by the group the project belongs to.
1. From the **Git reference** dropdown list, select the branch, tag, or commit hash
GitLab uses to create the workspace. By default, this is the branch you're viewing.
1. From the **Devfile** dropdown list, select one of the following:
- [GitLab default devfile](_index.md#gitlab-default-devfile).
- [Custom devfile](_index.md#custom-devfile).
1. In **Variables**, enter the keys and values of the environment variables you want to inject into the workspace.
To add a new variable, select **Add variable**.
1. Select **Create workspace**.
{{< /tab >}}
{{< tab title="From a merge request" >}}
1. On the left sidebar, select **Search or go to** and find your project.
1. On the left sidebar, select **Code > Merge requests**.
1. Select the merge request you want to create a workspace for.
1. Select **Code > Open in Workspace**.
1. From the **Cluster agent** dropdown list, select a cluster agent owned by the group the project belongs to.
1. From the **Git reference** dropdown list, select the branch, tag, or commit hash
GitLab uses to create the workspace. By default, this is the source branch of the merge request.
1. From the **Devfile** dropdown list, select one of the following:
- [GitLab default devfile](_index.md#gitlab-default-devfile).
- [Custom devfile](_index.md#custom-devfile).
1. In **Variables**, enter the keys and values of the environment variables you want to inject into the workspace.
To add a new variable, select **Add variable**.
1. Select **Create workspace**.
{{< /tab >}}
{{< /tabs >}}
The workspace might take a few minutes to start.
To open the workspace, under **Preview**, select the workspace.
You also have access to the terminal and can install any necessary dependencies.
### Monitor workspace startup progress
When you start a workspace, you can monitor the progress of initialization tasks and `postStart`
events by checking the workspace logs. For more information, see [Workspace logs directory](_index.md#workspace-logs-directory).
## Platform compatibility
The platform requirements for workspaces depend on your development needs.
For basic workspace functionality, workspaces run on any `linux/amd64` Kubernetes cluster that supports
the GitLab agent for Kubernetes, regardless of the underlying operating system.
To choose a method that fits your platform requirements, see [Configure sudo access for a workspace](#configure-sudo-access-for-a-workspace).
## Build and run containers in a workspace
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Development environments often require building and running containers to manage and use dependencies
during runtime.
To build and run containers in a workspace, see [configure sudo access for a workspace with Sysbox](#with-sysbox).
## Configure support for private container registries
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14664) in GitLab 17.6.
{{< /history >}}
To use images from private container registries:
1. Create an [image pull secret in Kubernetes](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/).
1. Add the `name` and `namespace` of this secret to the [GitLab agent for Kubernetes configuration](gitlab_agent_configuration.md).
For more information, see [`image_pull_secrets`](settings.md#image_pull_secrets).
## Configure sudo access for a workspace
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13983) in GitLab 17.4.
{{< /history >}}
Development environments often require sudo permissions to install, configure, and use dependencies
during runtime. Choose the method that fits your platform requirements:
| Method | Platform requirements | Usage |
|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|
| [Sysbox](#with-sysbox) | For up-to-date information, see the [Sysbox distribution compatibility matrix](https://github.com/nestybox/sysbox/blob/master/docs/distro-compat.md). | Improves container isolation and enables containers to run the same workloads as virtual machines. |
| [Kata Containers](#with-kata-containers) | For up-to-date information, see the [Kata Containers installation guides](https://github.com/kata-containers/kata-containers/tree/main/docs/install). | Lightweight VMs perform like containers but provide enhanced workload isolation and security. |
| [User namespaces](#with-user-namespaces) | Kubernetes version 1.33 or later have the user namespaces enabled behind a Kubernetes feature gate which is enabled by default. For up-to-date information, see the [Kubernetes Feature Gates](https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/). | No additional runtime installation required. Isolates container users from host users for improved security. |
Prerequisites:
- Your container images must support [arbitrary user IDs](_index.md#arbitrary-user-ids).
Even with sudo access configured, container images used in a [devfile](_index.md#devfile)
cannot run with a user ID of `0`.
### With Sysbox
[Sysbox](https://github.com/nestybox/sysbox) is a container runtime that improves container isolation
and enables containers to run the same workloads as virtual machines.
To configure sudo access with Sysbox:
1. In your Kubernetes cluster, [install Sysbox](https://github.com/nestybox/sysbox#installation).
1. Configure the GitLab agent for Kubernetes:
- Set the default runtime class. In [`default_runtime_class`](settings.md#default_runtime_class),
enter the runtime class for Sysbox. For example, `sysbox-runc`.
- Enable privilege escalation.
Set [`allow_privilege_escalation`](settings.md#allow_privilege_escalation) to `true`.
- Configure the annotations required by Sysbox. Set [`annotations`](settings.md#annotations) to
`{"io.kubernetes.cri-o.userns-mode": "auto:size=65536"}`.
### With Kata Containers
[Kata Containers](https://github.com/kata-containers/kata-containers) is a standard implementation
of lightweight virtual machines that perform like containers but provide the workload isolation and
security of virtual machines.
To configure sudo access with Kata Containers:
1. In your Kubernetes cluster, [install Kata Containers](https://github.com/kata-containers/kata-containers/tree/main/docs/install).
1. Configure the GitLab agent for Kubernetes:
- Set the default runtime class. In [`default_runtime_class`](settings.md#default_runtime_class),
enter the runtime class for Kata Containers. For example, `kata-qemu`.
- Enable privilege escalation.
Set [`allow_privilege_escalation`](settings.md#allow_privilege_escalation) to `true`.
### With user namespaces
[User namespaces](https://kubernetes.io/docs/concepts/workloads/pods/user-namespaces/) isolate
container users from host users.
To configure sudo access with user namespaces:
1. In your Kubernetes cluster, [configure user namespaces](https://kubernetes.io/blog/2024/04/22/userns-beta/).
1. Configure the GitLab agent for Kubernetes:
- Set [`use_kubernetes_user_namespaces`](settings.md#use_kubernetes_user_namespaces) to `true`.
- Set [`allow_privilege_escalation`](settings.md#allow_privilege_escalation) to `true`.
## Connect to a workspace with SSH
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10478) in GitLab 16.3.
{{< /history >}}
Prerequisites:
- You must enable SSH access for the images specified in your [devfile](_index.md#devfile).
For more information, see [update your workspace container image](#update-your-workspace-container-image).
- You must configure a TCP load balancer that points to the GitLab workspaces proxy.
For more information, see [update your DNS records](set_up_gitlab_agent_and_proxies.md#update-your-dns-records).
To connect to a workspace with an SSH client:
1. Get the external IP address of your `gitlab-workspaces-proxy-ssh` service:
```shell
kubectl -n gitlab-workspaces get service gitlab-workspaces-proxy-ssh
```
1. Get the name of the workspace:
1. On the left sidebar, select **Search or go to**.
1. Select **Your work**.
1. Select **Workspaces**.
1. Copy the name of the workspace you want to connect to.
1. Run this command:
```shell
ssh <workspace_name>@<ssh_proxy_IP_address>
```
1. For the password, enter your personal access token with at least the `read_api` scope.
When you connect to `gitlab-workspaces-proxy` through the TCP load balancer,
`gitlab-workspaces-proxy` examines the username (workspace name) and interacts with GitLab to verify:
- The personal access token
- User access to the workspace
### Update your workspace container image
To update your runtime images for SSH connections:
1. Install [`sshd`](https://man.openbsd.org/sshd.8) in your runtime images.
1. Create a user named `gitlab-workspaces` to allow access to your container without a password.
```Dockerfile
FROM golang:1.20.5-bullseye
# Install `openssh-server` and other dependencies
RUN apt update \
&& apt upgrade -y \
&& apt install openssh-server sudo curl git wget software-properties-common apt-transport-https --yes \
&& rm -rf /var/lib/apt/lists/*
# Permit empty passwords
RUN sed -i 's/nullok_secure/nullok/' /etc/pam.d/common-auth
RUN echo "PermitEmptyPasswords yes" >> /etc/ssh/sshd_config
# Generate a workspace host key
RUN ssh-keygen -A
RUN chmod 775 /etc/ssh/ssh_host_rsa_key && \
chmod 775 /etc/ssh/ssh_host_ecdsa_key && \
chmod 775 /etc/ssh/ssh_host_ed25519_key
# Create a `gitlab-workspaces` user
RUN useradd -l -u 5001 -G sudo -md /home/gitlab-workspaces -s /bin/bash gitlab-workspaces
RUN passwd -d gitlab-workspaces
ENV HOME=/home/gitlab-workspaces
WORKDIR $HOME
RUN mkdir -p /home/gitlab-workspaces && chgrp -R 0 /home && chmod -R g=u /etc/passwd /etc/group /home
# Allow sign-in access to `/etc/shadow`
RUN chmod 775 /etc/shadow
USER gitlab-workspaces
```
## Related topics
- [Tutorial: Set up the GitLab agent for Kubernetes](set_up_gitlab_agent_and_proxies.md)
- [Workspace settings](settings.md)
- [Workspace configuration](configuration.md)
- [Troubleshooting Workspaces](workspaces_troubleshooting.md)
- [Quickstart guide for GitLab remote development workspaces](https://go.gitlab.com/AVKFvy)
- [Set up your infrastructure for on-demand, cloud-based development environments in GitLab](https://go.gitlab.com/dp75xo)
|
https://docs.gitlab.com/user/workspaces_troubleshooting
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/workspaces_troubleshooting.md
|
2025-08-13
|
doc/user/workspace
|
[
"doc",
"user",
"workspace"
] |
workspaces_troubleshooting.md
|
Create
|
Remote Development
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Troubleshooting workspaces
|
Create a GitLab workspaces proxy to authenticate and authorize workspaces in your cluster.
|
When working with GitLab workspaces, you might encounter the following issues.
## Error: `Failed to renew lease`
When creating a workspace, you might encounter the following error message in the agent's log:
```plaintext
{"level":"info","time":"2023-01-01T00:00:00.000Z","msg":"failed to renew lease gitlab-agent-remote-dev-dev/agent-123XX-lock: timed out waiting for the condition\n","agent_id":XXXX}
```
The error is because of a known issue in the GitLab agent for Kubernetes.
This error occurs when an agent instance cannot renew its leadership lease, causing leader-only modules like `remote_development` to shut down.
To resolve this issue:
1. Restart the agent instance.
1. If the issue persists, check your Kubernetes cluster's health and connectivity.
## Error: `No agents available to create workspaces`
When you create a workspace in a project, you might get the following error:
```plaintext
No agents available to create workspaces. Please consult Workspaces documentation for troubleshooting.
```
This error can occur for several reasons. Work through the following troubleshooting steps.
### Check permissions
1. Ensure you have at least the Developer role for both the workspace project and agent project.
1. Verify the agent is allowed in an ancestor group of your workspace project.
For more information, see [allow an agent](gitlab_agent_configuration.md#allow-a-cluster-agent-for-workspaces-in-a-group).
### Check agent configuration
Verify the `remote_development` module is enabled in your agent configuration:
```yaml
remote_development:
enabled: true
```
If the `remote_development` module is disabled for the GitLab agent for Kubernetes,
set [`enabled`](settings.md#enabled) to `true`.
### Check agent name mismatch
Ensure the agent name you created in the [Create a GitLab Agent for Kubernetes token](set_up_infrastructure.md#create-a-gitlab-agent-for-kubernetes-token) step matches the folder name in
`.gitlab/agents/FOLDER_NAME/`.
If the names are different, rename the folder to match the agent name exactly.
### Check agent connection status
Verify the agent is connected to GitLab:
1. Go to your group.
1. Select **Operate** > **Kubernetes clusters**.
1. Verify if **Connection status** is **Connected**. If not connected, check the agent logs:
```shell
kubectl logs -f -l app=gitlab-agent -n gitlab-workspaces
```
## Error: `unsupported scheme in GitLab Kubernetes Agent Server address`
This error occurs when the Kubernetes Agent Server (KAS) address is missing the required protocol
scheme.
To resolve this issue:
1. Add the `wss://` prefix to your `TF_VAR_kas_address` variable. For example: `wss://kas.gitlab.com`.
1. Update your configuration and redeploy the agent.
## Error: `redirect URI included is not valid`
When accessing a workspace, you might encounter an OAuth error about an invalid redirect URI.
This error can occur for the following reasons:
- OAuth application is not configured correctly. To resolve this issue:
1. Verify your OAuth application redirect URI in GitLab matches your domain.
1. Update the OAuth application redirect URI. For example: `https://YOUR_DOMAIN/auth/callback`.
- Workspaces proxy is using outdated OAuth credentials. to resolve this issue:
1. Verify the proxy is using the latest OAuth credentials.
1. Restart the workspaces proxy:
```shell
kubectl rollout restart deployment -n gitlab-workspaces gitlab-workspaces-proxy
```
## Error: `Workspace does not exist`
You might get an error in VS Code that states
```plaintext
Workspace does not exist
Please select another workspace to open.
```
This issue occurs when the workspace starts successfully, but the expected project directory is
missing because the Git clone operation failed. Git clone operations fail due to network issues,
infrastructure problems, or revoked repository permissions.
To resolve this issue:
1. When prompted to select another workspace in the error dialog, select **Cancel**.
1. From the VS Code menu, select **File** > **Open Folder**.
1. Go to the `/projects` directory and select **OK**.
1. In the **EXPLORER** panel, check for a directory with the same name as your project.
- If the directory is missing, the Git clone operation failed completely.
- If the directory exists but is empty, the clone operation started but didn't complete.
1. Open a terminal. From the menu, select **Terminal** > **New Terminal**.
1. Go to the workspace logs directory:
```shell
cd /tmp/workspace-logs/
```
1. Check the logs for error output that might indicate why Git clone failed:
```shell
less poststart-stderr.log
```
1. Resolve the identified issue and restart your workspace.
If the issue persists, create a new workspace with a working container image that includes Git.
## Debug `postStart` events
When your custom `postStart` events fail or don't behave as expected, you can use the workspace
logs directory to debug the issues.
Common `postStart` debugging scenarios and their resolutions:
- `Command not found`: Check `poststart-stderr.log` for errors indicating
missing dependencies in your container image.
- `Permission denied`: Check for permission errors in `poststart-stderr.log` that might
require adjusting file permissions or user configuration.
- `Network issues`: Check for connection timeouts or DNS resolution failures when your
`postStart` events download dependencies or access external resources.
- `Long-running commands`: If `postStart` events hang, check `poststart-stdout.log`
to see if commands are still running or if they completed successfully.
To check the `postStart` command execution logs:
1. Open a terminal in your workspace.
1. Go to the workspace logs directory:
```shell
cd /tmp/workspace-logs/
```
1. View the log files:
```shell
# Monitor postStart execution output in real-time
tail -f poststart-stdout.log
# Check postStart errors
cat poststart-stderr.log
# Check VS Code server startup
cat start-vscode.log
```
1. Check for errors:
```shell
# Search for error messages across all logs
grep -i error *.log
# Search for specific command output
grep "your-command-name" poststart-stdout.log
```
1. Resolve the identified issues and restart your workspace.
For more information, see [Workspace logs directory](_index.md#workspace-logs-directory) and
[Available log files](_index.md#available-log-files).
<!--- Other suggested topics:
## DNS configuration
## Workspace stops unexpectedly
## Workspace creation fails due to quotas
## Network connectivity
## SSH connection failures
### Network policy restrictions
-->
|
---
stage: Create
group: Remote Development
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Create a GitLab workspaces proxy to authenticate and authorize workspaces
in your cluster.
title: Troubleshooting workspaces
breadcrumbs:
- doc
- user
- workspace
---
When working with GitLab workspaces, you might encounter the following issues.
## Error: `Failed to renew lease`
When creating a workspace, you might encounter the following error message in the agent's log:
```plaintext
{"level":"info","time":"2023-01-01T00:00:00.000Z","msg":"failed to renew lease gitlab-agent-remote-dev-dev/agent-123XX-lock: timed out waiting for the condition\n","agent_id":XXXX}
```
The error is because of a known issue in the GitLab agent for Kubernetes.
This error occurs when an agent instance cannot renew its leadership lease, causing leader-only modules like `remote_development` to shut down.
To resolve this issue:
1. Restart the agent instance.
1. If the issue persists, check your Kubernetes cluster's health and connectivity.
## Error: `No agents available to create workspaces`
When you create a workspace in a project, you might get the following error:
```plaintext
No agents available to create workspaces. Please consult Workspaces documentation for troubleshooting.
```
This error can occur for several reasons. Work through the following troubleshooting steps.
### Check permissions
1. Ensure you have at least the Developer role for both the workspace project and agent project.
1. Verify the agent is allowed in an ancestor group of your workspace project.
For more information, see [allow an agent](gitlab_agent_configuration.md#allow-a-cluster-agent-for-workspaces-in-a-group).
### Check agent configuration
Verify the `remote_development` module is enabled in your agent configuration:
```yaml
remote_development:
enabled: true
```
If the `remote_development` module is disabled for the GitLab agent for Kubernetes,
set [`enabled`](settings.md#enabled) to `true`.
### Check agent name mismatch
Ensure the agent name you created in the [Create a GitLab Agent for Kubernetes token](set_up_infrastructure.md#create-a-gitlab-agent-for-kubernetes-token) step matches the folder name in
`.gitlab/agents/FOLDER_NAME/`.
If the names are different, rename the folder to match the agent name exactly.
### Check agent connection status
Verify the agent is connected to GitLab:
1. Go to your group.
1. Select **Operate** > **Kubernetes clusters**.
1. Verify if **Connection status** is **Connected**. If not connected, check the agent logs:
```shell
kubectl logs -f -l app=gitlab-agent -n gitlab-workspaces
```
## Error: `unsupported scheme in GitLab Kubernetes Agent Server address`
This error occurs when the Kubernetes Agent Server (KAS) address is missing the required protocol
scheme.
To resolve this issue:
1. Add the `wss://` prefix to your `TF_VAR_kas_address` variable. For example: `wss://kas.gitlab.com`.
1. Update your configuration and redeploy the agent.
## Error: `redirect URI included is not valid`
When accessing a workspace, you might encounter an OAuth error about an invalid redirect URI.
This error can occur for the following reasons:
- OAuth application is not configured correctly. To resolve this issue:
1. Verify your OAuth application redirect URI in GitLab matches your domain.
1. Update the OAuth application redirect URI. For example: `https://YOUR_DOMAIN/auth/callback`.
- Workspaces proxy is using outdated OAuth credentials. to resolve this issue:
1. Verify the proxy is using the latest OAuth credentials.
1. Restart the workspaces proxy:
```shell
kubectl rollout restart deployment -n gitlab-workspaces gitlab-workspaces-proxy
```
## Error: `Workspace does not exist`
You might get an error in VS Code that states
```plaintext
Workspace does not exist
Please select another workspace to open.
```
This issue occurs when the workspace starts successfully, but the expected project directory is
missing because the Git clone operation failed. Git clone operations fail due to network issues,
infrastructure problems, or revoked repository permissions.
To resolve this issue:
1. When prompted to select another workspace in the error dialog, select **Cancel**.
1. From the VS Code menu, select **File** > **Open Folder**.
1. Go to the `/projects` directory and select **OK**.
1. In the **EXPLORER** panel, check for a directory with the same name as your project.
- If the directory is missing, the Git clone operation failed completely.
- If the directory exists but is empty, the clone operation started but didn't complete.
1. Open a terminal. From the menu, select **Terminal** > **New Terminal**.
1. Go to the workspace logs directory:
```shell
cd /tmp/workspace-logs/
```
1. Check the logs for error output that might indicate why Git clone failed:
```shell
less poststart-stderr.log
```
1. Resolve the identified issue and restart your workspace.
If the issue persists, create a new workspace with a working container image that includes Git.
## Debug `postStart` events
When your custom `postStart` events fail or don't behave as expected, you can use the workspace
logs directory to debug the issues.
Common `postStart` debugging scenarios and their resolutions:
- `Command not found`: Check `poststart-stderr.log` for errors indicating
missing dependencies in your container image.
- `Permission denied`: Check for permission errors in `poststart-stderr.log` that might
require adjusting file permissions or user configuration.
- `Network issues`: Check for connection timeouts or DNS resolution failures when your
`postStart` events download dependencies or access external resources.
- `Long-running commands`: If `postStart` events hang, check `poststart-stdout.log`
to see if commands are still running or if they completed successfully.
To check the `postStart` command execution logs:
1. Open a terminal in your workspace.
1. Go to the workspace logs directory:
```shell
cd /tmp/workspace-logs/
```
1. View the log files:
```shell
# Monitor postStart execution output in real-time
tail -f poststart-stdout.log
# Check postStart errors
cat poststart-stderr.log
# Check VS Code server startup
cat start-vscode.log
```
1. Check for errors:
```shell
# Search for error messages across all logs
grep -i error *.log
# Search for specific command output
grep "your-command-name" poststart-stdout.log
```
1. Resolve the identified issues and restart your workspace.
For more information, see [Workspace logs directory](_index.md#workspace-logs-directory) and
[Available log files](_index.md#available-log-files).
<!--- Other suggested topics:
## DNS configuration
## Workspace stops unexpectedly
## Workspace creation fails due to quotas
## Network connectivity
## SSH connection failures
### Network policy restrictions
-->
|
https://docs.gitlab.com/user/gitlab_agent_configuration
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/gitlab_agent_configuration.md
|
2025-08-13
|
doc/user/workspace
|
[
"doc",
"user",
"workspace"
] |
gitlab_agent_configuration.md
|
Create
|
Remote Development
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
GitLab agent for Kubernetes configuration
|
Configure the GitLab agent for Kubernetes to support your workspace.
|
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Feature flag `remote_development_feature_flag` [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/391543) in GitLab 16.0.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136744) in GitLab 16.7. Feature flag `remote_development_feature_flag` removed.
{{< /history >}}
When you [set up workspace infrastructure](configuration.md#set-up-workspace-infrastructure),
you must configure a GitLab agent for Kubernetes to support workspaces. This guide assumes that a GitLab
agent is already installed in the Kubernetes cluster.
Prerequisites:
- You must complete the setup steps in [Tutorial: Set up the GitLab agent for Kubernetes](set_up_gitlab_agent_and_proxies.md).
- The agent configuration must have the `remote_development` module enabled, and the required fields of this module must be correctly set.
{{< alert type="note" >}}
If you disable the `remote_development` module on an agent that has active workspaces,
those workspaces become unusable. For more information, see
[workspace settings](settings.md#enabled).
{{< /alert >}}
- The agent must be allowed in a group for the purpose of creating workspaces. During workspace creation, users can select allowed agents that are associated with any parent group of the workspace project.
- The workspace creator must have the Developer role to the project of the agent.
## Agent authorization in a group for creating workspaces
{{< history >}}
- New authorization strategy [introduced](https://gitlab.com/groups/gitlab-org/-/epics/14025) in GitLab 17.2.
{{< /history >}}
The new authorization strategy replaces the [legacy authorization strategy](#legacy-agent-authorization-strategy).
Group owners and administrators can control which cluster agents host workspaces in their group.
For example, if the path to your workspace project is `top-level-group/subgroup-1/subgroup-2/workspace-project`, you can use any configured agent for either `top-level-group`, `subgroup-1` or `subgroup-2` group.
```mermaid
%%{init: {'theme':'neutral'}}%%
graph TD;
classDef active fill:lightgreen, stroke:#green, color:green, stroke-width:1px;
topGroup[Top-Level Group, allowed Agent 1]
subgroup1[Subgroup 1, allowed Agent 2]
subgroup2[Subgroup 2, allowed Agent 3]
wp(Workspace Project, Agent 1, 2 & 3 all available)
topGroup --> subgroup1
subgroup1 --> subgroup2
subgroup2 --> wp
class wp active;
```
If you allow a cluster agent for a specific group, for example, `subgroup-1`,
it is available to create workspaces in all projects under that group.
Consider the scope of the allowed group carefully, as it determines where the cluster agent can
host workspaces.
## Allow a cluster agent for workspaces in a group
Prerequisites:
- You must [set up workspace infrastructure](configuration.md#set-up-workspace-infrastructure).
- You must have administrator access to the instance or the Owner role for the group.
To allow a cluster agent for workspaces in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. On the left sidebar, select **Settings** > **Workspaces**.
1. In the **Group agents** section, select the **All agents** tab.
1. From the list of available agents, find the agent with status **Blocked**, and select **Allow**.
1. On the confirmation dialog, select **Allow agent**.
GitLab updates the status of the selected agent to **Allowed**, and displays the agent in the **Allowed agents** tab.
## Remove an allowed cluster agent for workspaces in a group
Prerequisites:
- You must [set up workspace infrastructure](configuration.md#set-up-workspace-infrastructure).
- You must have administrator access to the instance or the Owner role for the group.
To remove an allowed cluster agent from a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. On the left sidebar, select **Settings** > **Workspaces**.
1. In the **Group agents** section, select the **Allowed agents** tab.
1. From the list of allowed agents, find the agent you want to remove, and select **Block**.
1. On the confirmation dialog, select **Block agent**.
GitLab updates the status of the selected agent to **Blocked**, and removes the agent from the **Allowed agents** tab.
{{< alert type="note" >}}
Removing an allowed cluster agent from a group does not immediately stop running workspaces using
the agent. Running workspaces stop when they are automatically terminated or manually stopped.
{{< /alert >}}
## Allow a cluster agent for workspaces on the instance
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/548951) in GitLab 18.2.
{{< /history >}}
Prerequisites:
- You must [set up workspace infrastructure](configuration.md#set-up-workspace-infrastructure).
- You must have agents with [remote development enabled](settings.md#enabled).
- You must have administrator access to the instance.
To allow a cluster agent for workspaces on the instance:
1. On the left sidebar, at the bottom, select **Admin**.
1. On the left sidebar, select **Settings > General**.
1. Expand **Available agents for workspaces**.
1. From the list of agents with workspaces enabled, find the agent you want to allow, and select the
availability toggle.
## Remove an allowed cluster agent for workspaces on the instance
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/548951) in GitLab 18.2.
{{< /history >}}
Prerequisites:
- You must have administrator access to the instance.
To remove an allowed cluster agent from the instance:
1. On the left sidebar, at the bottom, select **Admin**.
1. On the left sidebar, select **Settings > General**.
1. Expand **Available agents for workspaces**.
1. From the list of allowed agents, find the agent you want to remove, and clear the availability toggle.
{{< alert type="note" >}}
Removing an allowed cluster agent from an instance does not immediately stop running workspaces using
the agent. Running workspaces stop when they are automatically terminated or manually stopped.
{{< /alert >}}
## Legacy agent authorization strategy
In GitLab 17.1 and earlier, the availability of an agent in a group was not a prerequisite for
creating workspaces.
You can use any agent in the top-level group of a workspace project to create a workspace,
if both of the following are true:
- The remote development module is enabled.
- You have at least the Developer role for the top-level group.
For example, if the path to your workspace project is `top-level-group/subgroup-1/subgroup-2/workspace-project`,
you can use any configured agent in `top-level-group` and in any of its subgroups.
## Configuring user access with remote development
You can configure the `user_access` module to access the connected Kubernetes cluster with your GitLab credentials.
This module is configured and runs independently of the `remote_development` module.
Be careful when configuring both `user_access` and `remote_development` in the same agent.
The `remote_development` clusters manage user credentials (such as personal access tokens) as Kubernetes Secrets.
Any misconfiguration in `user_access` might cause this private data to be accessible over the Kubernetes API.
For more information about configuring `user_access`, see
[Configure Kubernetes access](../clusters/agent/user_access.md#configure-kubernetes-access).
## Related topics
- [Tutorial: Set up the GitLab for Kubernetes](set_up_gitlab_agent_and_proxies.md)
- [Workspace settings](settings.md)
- [Workspace configuration](configuration.md)
- [Troubleshooting Workspaces](workspaces_troubleshooting.md)
|
---
stage: Create
group: Remote Development
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Configure the GitLab agent for Kubernetes to support your workspace.
title: GitLab agent for Kubernetes configuration
breadcrumbs:
- doc
- user
- workspace
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Feature flag `remote_development_feature_flag` [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/391543) in GitLab 16.0.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136744) in GitLab 16.7. Feature flag `remote_development_feature_flag` removed.
{{< /history >}}
When you [set up workspace infrastructure](configuration.md#set-up-workspace-infrastructure),
you must configure a GitLab agent for Kubernetes to support workspaces. This guide assumes that a GitLab
agent is already installed in the Kubernetes cluster.
Prerequisites:
- You must complete the setup steps in [Tutorial: Set up the GitLab agent for Kubernetes](set_up_gitlab_agent_and_proxies.md).
- The agent configuration must have the `remote_development` module enabled, and the required fields of this module must be correctly set.
{{< alert type="note" >}}
If you disable the `remote_development` module on an agent that has active workspaces,
those workspaces become unusable. For more information, see
[workspace settings](settings.md#enabled).
{{< /alert >}}
- The agent must be allowed in a group for the purpose of creating workspaces. During workspace creation, users can select allowed agents that are associated with any parent group of the workspace project.
- The workspace creator must have the Developer role to the project of the agent.
## Agent authorization in a group for creating workspaces
{{< history >}}
- New authorization strategy [introduced](https://gitlab.com/groups/gitlab-org/-/epics/14025) in GitLab 17.2.
{{< /history >}}
The new authorization strategy replaces the [legacy authorization strategy](#legacy-agent-authorization-strategy).
Group owners and administrators can control which cluster agents host workspaces in their group.
For example, if the path to your workspace project is `top-level-group/subgroup-1/subgroup-2/workspace-project`, you can use any configured agent for either `top-level-group`, `subgroup-1` or `subgroup-2` group.
```mermaid
%%{init: {'theme':'neutral'}}%%
graph TD;
classDef active fill:lightgreen, stroke:#green, color:green, stroke-width:1px;
topGroup[Top-Level Group, allowed Agent 1]
subgroup1[Subgroup 1, allowed Agent 2]
subgroup2[Subgroup 2, allowed Agent 3]
wp(Workspace Project, Agent 1, 2 & 3 all available)
topGroup --> subgroup1
subgroup1 --> subgroup2
subgroup2 --> wp
class wp active;
```
If you allow a cluster agent for a specific group, for example, `subgroup-1`,
it is available to create workspaces in all projects under that group.
Consider the scope of the allowed group carefully, as it determines where the cluster agent can
host workspaces.
## Allow a cluster agent for workspaces in a group
Prerequisites:
- You must [set up workspace infrastructure](configuration.md#set-up-workspace-infrastructure).
- You must have administrator access to the instance or the Owner role for the group.
To allow a cluster agent for workspaces in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. On the left sidebar, select **Settings** > **Workspaces**.
1. In the **Group agents** section, select the **All agents** tab.
1. From the list of available agents, find the agent with status **Blocked**, and select **Allow**.
1. On the confirmation dialog, select **Allow agent**.
GitLab updates the status of the selected agent to **Allowed**, and displays the agent in the **Allowed agents** tab.
## Remove an allowed cluster agent for workspaces in a group
Prerequisites:
- You must [set up workspace infrastructure](configuration.md#set-up-workspace-infrastructure).
- You must have administrator access to the instance or the Owner role for the group.
To remove an allowed cluster agent from a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. On the left sidebar, select **Settings** > **Workspaces**.
1. In the **Group agents** section, select the **Allowed agents** tab.
1. From the list of allowed agents, find the agent you want to remove, and select **Block**.
1. On the confirmation dialog, select **Block agent**.
GitLab updates the status of the selected agent to **Blocked**, and removes the agent from the **Allowed agents** tab.
{{< alert type="note" >}}
Removing an allowed cluster agent from a group does not immediately stop running workspaces using
the agent. Running workspaces stop when they are automatically terminated or manually stopped.
{{< /alert >}}
## Allow a cluster agent for workspaces on the instance
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/548951) in GitLab 18.2.
{{< /history >}}
Prerequisites:
- You must [set up workspace infrastructure](configuration.md#set-up-workspace-infrastructure).
- You must have agents with [remote development enabled](settings.md#enabled).
- You must have administrator access to the instance.
To allow a cluster agent for workspaces on the instance:
1. On the left sidebar, at the bottom, select **Admin**.
1. On the left sidebar, select **Settings > General**.
1. Expand **Available agents for workspaces**.
1. From the list of agents with workspaces enabled, find the agent you want to allow, and select the
availability toggle.
## Remove an allowed cluster agent for workspaces on the instance
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/548951) in GitLab 18.2.
{{< /history >}}
Prerequisites:
- You must have administrator access to the instance.
To remove an allowed cluster agent from the instance:
1. On the left sidebar, at the bottom, select **Admin**.
1. On the left sidebar, select **Settings > General**.
1. Expand **Available agents for workspaces**.
1. From the list of allowed agents, find the agent you want to remove, and clear the availability toggle.
{{< alert type="note" >}}
Removing an allowed cluster agent from an instance does not immediately stop running workspaces using
the agent. Running workspaces stop when they are automatically terminated or manually stopped.
{{< /alert >}}
## Legacy agent authorization strategy
In GitLab 17.1 and earlier, the availability of an agent in a group was not a prerequisite for
creating workspaces.
You can use any agent in the top-level group of a workspace project to create a workspace,
if both of the following are true:
- The remote development module is enabled.
- You have at least the Developer role for the top-level group.
For example, if the path to your workspace project is `top-level-group/subgroup-1/subgroup-2/workspace-project`,
you can use any configured agent in `top-level-group` and in any of its subgroups.
## Configuring user access with remote development
You can configure the `user_access` module to access the connected Kubernetes cluster with your GitLab credentials.
This module is configured and runs independently of the `remote_development` module.
Be careful when configuring both `user_access` and `remote_development` in the same agent.
The `remote_development` clusters manage user credentials (such as personal access tokens) as Kubernetes Secrets.
Any misconfiguration in `user_access` might cause this private data to be accessible over the Kubernetes API.
For more information about configuring `user_access`, see
[Configure Kubernetes access](../clusters/agent/user_access.md#configure-kubernetes-access).
## Related topics
- [Tutorial: Set up the GitLab for Kubernetes](set_up_gitlab_agent_and_proxies.md)
- [Workspace settings](settings.md)
- [Workspace configuration](configuration.md)
- [Troubleshooting Workspaces](workspaces_troubleshooting.md)
|
https://docs.gitlab.com/user/set_up_gitlab_agent_and_proxies
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/set_up_gitlab_agent_and_proxies.md
|
2025-08-13
|
doc/user/workspace
|
[
"doc",
"user",
"workspace"
] |
set_up_gitlab_agent_and_proxies.md
|
Create
|
Remote Development
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Tutorial: Set up the GitLab agent for Kubernetes
|
Create a GitLab workspaces proxy to authenticate and authorize workspaces in your cluster.
|
<!-- vale gitlab_base.FutureTense = NO -->
This tutorial shows you how to:
- Set up the [GitLab agent for Kubernetes](../clusters/agent/_index.md)
so users can create and manage workspaces in a project.
- Set up the GitLab workspaces proxy to authenticate and authorize [workspaces](_index.md)
in your cluster.
{{< alert type="note" >}}
You must complete the setup steps in this tutorial before you can configure a GitLab agent for Kubernetes
to support workspaces.
After completing the tutorial, use the [GitLab agent for Kubernetes configuration](gitlab_agent_configuration.md)
to configure your agent.
{{< /alert >}}
## Before you begin
Before starting this tutorial, you must have:
- Administrator access to your GitLab instance or the Owner role for your group.
- A running Kubernetes cluster.
- `helm` 3.11.0 or later and `kubectl` on your local machine.
- Access to configure a wildcard domain in your DNS provider.
For example, `*.workspaces.example.dev` is required for workspace access.
For this tutorial, the following hierarchy is used:
```mermaid
%%{init: {'theme':'neutral'}}%%
graph TD;
classDef active fill:lightgreen, stroke:#green, color:green, stroke-width:1px;
topGroup[Top-level group]
subGroup[Subgroup]
workspaceProject[Workspace project]
agentProject[Agent project]
workspaceAgent[Workspace agent]
topGroup --> subGroup
subGroup --> workspaceProject
subGroup --> agentProject
agentProject -.- workspaceAgent
class workspaceProject active;
```
## Install an Ingress controller
Install an [Ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) of your choice in your Kubernetes cluster to route external traffic to your workspaces. The Ingress controller must support WebSockets. The following example uses the [Ingress NGINX controller](https://github.com/kubernetes/ingress-nginx).
1. In your Kubernetes cluster, install the Ingress controller.
```shell
helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
helm repo update
helm install ingress-nginx ingress-nginx/ingress-nginx \
--namespace gitlab-ingress-controller \
--create-namespace
```
1. Get the External IP address of the Load Balancer. You will need this when updating the
[DNS records](#update-your-dns-records).
```shell
kubectl get svc -n gitlab-ingress-controller ingress-nginx-controller
```
## Install the GitLab agent for Kubernetes
Install the [GitLab agent for Kubernetes](../clusters/agent/_index.md#kubernetes-integration-glossary) in your
Kubernetes cluster to connect your cluster to GitLab:
1. Complete one of the installation options in [Installing the agent for Kubernetes](../clusters/agent/install/_index.md).
1. Note the `agentName` you configured. It's required when you configure the agent for workspaces.
## Install the GitLab agent server for Kubernetes
The GitLab agent server for Kubernetes (KAS) is the component that communicates with the agent in your cluster.
- On GitLab.com, the agent server is available at `wss://kas.gitlab.com` by default.
- On GitLab Self-Managed, an administrator must
[set up the Kubernetes agent server (KAS)](../../administration/clusters/kas.md).
It's then available at `wss://gitlab.example.com/-/kubernetes-agent/`.
## Configure the GitLab agent for Kubernetes
To configure the `remote_development` module in the agent project:
1. On the left sidebar, select **Search or go to** and find your project.
1. In your project, create a `.gitlab/agents/<agentName>/config.yaml` file.
`agentName` is the name of the agent you configured when you set up workspace infrastructure.
1. In `config.yaml`, use the following configuration for workspace settings:
```yaml
remote_development:
enabled: true
dns_zone: "<workspaces.example.dev>" # DNS zone of the URL where workspaces are available
```
For a full list of configuration options, see the workspace [configuration reference](settings.md#configuration-reference).
{{< alert type="note" >}}
The GitLab agent for Kubernetes is configured in one project, but you can use it in other project workspaces.
A separate agent is not required for each project.
The configured agent is not visible until you
[allow the agent in your group](#allow-the-gitlab-agent-for-kubernetes-in-your-group).
{{< /alert >}}
## Allow the GitLab agent for Kubernetes in your group
When you allow an agent in a group, the group, its subgroups, and all projects in those groups can
use that agent.
{{< alert type="note" >}}
Only one agent is required. You can create workspaces from all projects in a group with the same agent.
{{< /alert >}}
To allow your GitLab agent for Kubernetes in a group and make it available to all projects in that group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings** > **Workspaces**.
1. In the **Group agents** section, select the **All agents** tab.
1. For the GitLab agent for Kubernetes, select **Allow**.
1. On the confirmation dialog, select **Allow agent**.
## Grant workspace permissions
Grant users with at least the Developer role for the workspace and agent projects
the necessary permissions to create and manage workspaces. You can:
- [Add users to a project](../project/members/_index.md#add-users-to-a-project)
- [Add users to a group](../group/_index.md#add-users-to-a-group)
## Generate TLS certificates
A wildcard domain is required for workspace access because each workspace gets its own subdomain.
You must generate TLS certificates for:
- The domain `gitlab-workspaces-proxy` listens on (`GITLAB_WORKSPACES_PROXY_DOMAIN`).
- The wildcard domain where workspaces are available (`GITLAB_WORKSPACES_WILDCARD_DOMAIN`).
For example, if your base domain is `workspaces.example.dev`:
- The `GITLAB_WORKSPACES_PROXY_DOMAIN` is `workspaces.example.dev`.
- The `GITLAB_WORKSPACES_WILDCARD_DOMAIN` is `*.workspaces.example.dev`.
- Individual workspaces are available at URLs like `workspace-1.workspaces.example.dev`.
You can generate certificates from any certificate authority.
If [`cert-manager`](https://cert-manager.io/docs/) is configured for your Kubernetes cluster,
you can use it to create and renew TLS certificates automatically.
To generate certificates manually:
1. Install [Certbot](https://certbot.eff.org/) to enable HTTPS:
```shell
brew install certbot
```
1. Generate Let's Encrypt certificates with ACME DNS and create `TXT` records in your DNS provider:
```shell
export EMAIL="YOUR_EMAIL@example.dev"
export GITLAB_WORKSPACES_PROXY_DOMAIN="workspaces.example.dev"
export GITLAB_WORKSPACES_WILDCARD_DOMAIN="*.workspaces.example.dev"
certbot -d "${GITLAB_WORKSPACES_PROXY_DOMAIN}" \
-m "${EMAIL}" \
--config-dir ~/.certbot/config \
--logs-dir ~/.certbot/logs \
--work-dir ~/.certbot/work \
--manual \
--preferred-challenges dns certonly
certbot -d "${GITLAB_WORKSPACES_WILDCARD_DOMAIN}" \
-m "${EMAIL}" \
--config-dir ~/.certbot/config \
--logs-dir ~/.certbot/logs \
--work-dir ~/.certbot/work \
--manual \
--preferred-challenges dns certonly
```
1. Set the following environment variables with the certificate directories from the output:
```shell
export WORKSPACES_DOMAIN_CERT="${HOME}/.certbot/config/live/${GITLAB_WORKSPACES_PROXY_DOMAIN}/fullchain.pem"
export WORKSPACES_DOMAIN_KEY="${HOME}/.certbot/config/live/${GITLAB_WORKSPACES_PROXY_DOMAIN}/privkey.pem"
export WILDCARD_DOMAIN_CERT="${HOME}/.certbot/config/live/${GITLAB_WORKSPACES_PROXY_DOMAIN}-0001/fullchain.pem"
export WILDCARD_DOMAIN_KEY="${HOME}/.certbot/config/live/${GITLAB_WORKSPACES_PROXY_DOMAIN}-0001/privkey.pem"
```
Depending on your environment, the `certbot` command might save the certificate and key on a different path.
To get the exact path, run:
```shell
certbot certificates \
--config-dir ~/.certbot/config \
--logs-dir ~/.certbot/logs \
--work-dir ~/.certbot/work
```
{{< alert type="note" >}}
You must renew your certificates when they expire.
For example, Let's Encrypt certificates expire after three months.
To automatically renew certificates, see [`cert-manager`](https://cert-manager.io/docs/).
{{< /alert >}}
## Register a GitLab OAuth application
To register an OAuth application on your GitLab instance:
1. [Create an OAuth application](../../integration/oauth_provider.md) in GitLab. You can create a:
- User-owned application
- Group-owned application
- Instance-wide application from the Admin area
1. Set the redirect URI to `https://${GITLAB_WORKSPACES_PROXY_DOMAIN}/auth/callback`.
1. Ensure the **Confidential** checkbox is selected. It should be selected by default.
1. If you create an instance-wide application, also select the **Trusted** checkbox.
1. Set the scopes to `api`, `read_user`, `openid`, and `profile`.
1. Export your configuration values:
```shell
export GITLAB_URL="https://gitlab.com"
export CLIENT_ID="your_application_id"
export CLIENT_SECRET="your_application_secret"
export REDIRECT_URI="https://${GITLAB_WORKSPACES_PROXY_DOMAIN}/auth/callback"
export SIGNING_KEY="make_up_a_random_key_consisting_of_letters_numbers_and_special_chars"
```
1. Store the client ID and generated secret securely, for example, in 1Password.
## Generate an SSH host key
To generate an RSA key:
```shell
ssh-keygen -f ssh-host-key -N '' -t rsa
export SSH_HOST_KEY=$(pwd)/ssh-host-key
```
As an alternative, you can also generate an ECDSA key.
## Create Kubernetes secrets
To create Kubernetes secrets:
```shell
kubectl create namespace gitlab-workspaces
kubectl create secret generic gitlab-workspaces-proxy-config \
--namespace="gitlab-workspaces" \
--from-literal="auth.client_id=${CLIENT_ID}" \
--from-literal="auth.client_secret=${CLIENT_SECRET}" \
--from-literal="auth.host=${GITLAB_URL}" \
--from-literal="auth.redirect_uri=${REDIRECT_URI}" \
--from-literal="auth.signing_key=${SIGNING_KEY}" \
--from-literal="ssh.host_key=$(cat ${SSH_HOST_KEY})"
kubectl create secret tls gitlab-workspace-proxy-tls \
--namespace="gitlab-workspaces" \
--cert="${WORKSPACES_DOMAIN_CERT}" \
--key="${WORKSPACES_DOMAIN_KEY}"
kubectl create secret tls gitlab-workspace-proxy-wildcard-tls \
--namespace="gitlab-workspaces" \
--cert="${WILDCARD_DOMAIN_CERT}" \
--key="${WILDCARD_DOMAIN_KEY}"
```
## Install the GitLab workspaces proxy Helm chart
To install the Helm chart for the GitLab workspaces proxy:
1. Add the `helm` repository:
```shell
helm repo add gitlab-workspaces-proxy \
https://gitlab.com/api/v4/projects/gitlab-org%2fworkspaces%2fgitlab-workspaces-proxy/packages/helm/devel
```
For Helm chart 0.1.13 and earlier, use the following command:
```shell
helm repo add gitlab-workspaces-proxy \
https://gitlab.com/api/v4/projects/gitlab-org%2fremote-development%2fgitlab-workspaces-proxy/packages/helm/devel
```
1. Install and upgrade the chart:
{{< alert type="warning" >}}
Chart versions 0.1.20 and earlier contain a security vulnerability that sets cookies on a wildcard domain.
You should upgrade to chart version 0.1.21 or later. For more information, see the
[vulnerability fix](https://gitlab.com/gitlab-org/workspaces/gitlab-workspaces-proxy/-/merge_requests/34).
{{< /alert >}}
{{< alert type="note" >}}
Before chart version 0.1.16, the Helm chart installation created secrets automatically.
If you're upgrading from a version earlier than 0.1.16,
[create the required Kubernetes secrets](#create-kubernetes-secrets) before running the upgrade command.
{{< /alert >}}
```shell
helm repo update
helm upgrade --install gitlab-workspaces-proxy \
gitlab-workspaces-proxy/gitlab-workspaces-proxy \
--version=0.1.22 \
--namespace="gitlab-workspaces" \
--set="ingress.enabled=true" \
--set="ingress.hosts[0].host=${GITLAB_WORKSPACES_PROXY_DOMAIN}" \
--set="ingress.hosts[0].paths[0].path=/" \
--set="ingress.hosts[0].paths[0].pathType=ImplementationSpecific" \
--set="ingress.hosts[1].host=${GITLAB_WORKSPACES_WILDCARD_DOMAIN}" \
--set="ingress.hosts[1].paths[0].path=/" \
--set="ingress.hosts[1].paths[0].pathType=ImplementationSpecific" \
--set="ingress.tls[0].hosts[0]=${GITLAB_WORKSPACES_PROXY_DOMAIN}" \
--set="ingress.tls[0].secretName=gitlab-workspace-proxy-tls" \
--set="ingress.tls[1].hosts[0]=${GITLAB_WORKSPACES_WILDCARD_DOMAIN}" \
--set="ingress.tls[1].secretName=gitlab-workspace-proxy-wildcard-tls" \
--set="ingress.className=nginx"
```
If you're using a different Ingress class, modify the `ingress.className` parameter.
## Verify your setup
1. Verify the Ingress configuration for the `gitlab-workspaces` namespace:
```shell
kubectl -n gitlab-workspaces get ingress
```
1. Verify the pods are running:
```shell
kubectl -n gitlab-workspaces get pods
```
## Update your DNS records
To update your DNS records:
1. Point `${GITLAB_WORKSPACES_PROXY_DOMAIN}` and `${GITLAB_WORKSPACES_WILDCARD_DOMAIN}`
to the load balancer external IP address exposed by the [Ingress controller](#install-an-ingress-controller).
1. Check if `gitlab-workspaces-proxy` is accessible:
```shell
curl --verbose --location ${GITLAB_WORKSPACES_PROXY_DOMAIN}
```
This command returns a `400 Bad Request` error until you create a workspace.
1. From another terminal, check the proxy logs::
```shell
kubectl -n gitlab-workspaces logs -f -l app.kubernetes.io/name=gitlab-workspaces-proxy
```
This command returns a `could not find upstream workspace upstream not found` error until you create a workspace.
## Update the GitLab agent for Kubernetes configuration
If you deploy the Helm chart for the proxy to a namespace other than `gitlab-workspaces`,
update your [GitLab agent for Kubernetes configuration](gitlab_agent_configuration.md):
```yaml
remote_development:
gitlab_workspaces_proxy:
namespace: "<custom-gitlab-workspaces-proxy-namespace>"
```
## Related topics
- [Configure workspaces](configuration.md)
- [GitLab agent for Kubernetes configuration](gitlab_agent_configuration.md)
|
---
stage: Create
group: Remote Development
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Create a GitLab workspaces proxy to authenticate and authorize workspaces
in your cluster.
title: 'Tutorial: Set up the GitLab agent for Kubernetes'
breadcrumbs:
- doc
- user
- workspace
---
<!-- vale gitlab_base.FutureTense = NO -->
This tutorial shows you how to:
- Set up the [GitLab agent for Kubernetes](../clusters/agent/_index.md)
so users can create and manage workspaces in a project.
- Set up the GitLab workspaces proxy to authenticate and authorize [workspaces](_index.md)
in your cluster.
{{< alert type="note" >}}
You must complete the setup steps in this tutorial before you can configure a GitLab agent for Kubernetes
to support workspaces.
After completing the tutorial, use the [GitLab agent for Kubernetes configuration](gitlab_agent_configuration.md)
to configure your agent.
{{< /alert >}}
## Before you begin
Before starting this tutorial, you must have:
- Administrator access to your GitLab instance or the Owner role for your group.
- A running Kubernetes cluster.
- `helm` 3.11.0 or later and `kubectl` on your local machine.
- Access to configure a wildcard domain in your DNS provider.
For example, `*.workspaces.example.dev` is required for workspace access.
For this tutorial, the following hierarchy is used:
```mermaid
%%{init: {'theme':'neutral'}}%%
graph TD;
classDef active fill:lightgreen, stroke:#green, color:green, stroke-width:1px;
topGroup[Top-level group]
subGroup[Subgroup]
workspaceProject[Workspace project]
agentProject[Agent project]
workspaceAgent[Workspace agent]
topGroup --> subGroup
subGroup --> workspaceProject
subGroup --> agentProject
agentProject -.- workspaceAgent
class workspaceProject active;
```
## Install an Ingress controller
Install an [Ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) of your choice in your Kubernetes cluster to route external traffic to your workspaces. The Ingress controller must support WebSockets. The following example uses the [Ingress NGINX controller](https://github.com/kubernetes/ingress-nginx).
1. In your Kubernetes cluster, install the Ingress controller.
```shell
helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
helm repo update
helm install ingress-nginx ingress-nginx/ingress-nginx \
--namespace gitlab-ingress-controller \
--create-namespace
```
1. Get the External IP address of the Load Balancer. You will need this when updating the
[DNS records](#update-your-dns-records).
```shell
kubectl get svc -n gitlab-ingress-controller ingress-nginx-controller
```
## Install the GitLab agent for Kubernetes
Install the [GitLab agent for Kubernetes](../clusters/agent/_index.md#kubernetes-integration-glossary) in your
Kubernetes cluster to connect your cluster to GitLab:
1. Complete one of the installation options in [Installing the agent for Kubernetes](../clusters/agent/install/_index.md).
1. Note the `agentName` you configured. It's required when you configure the agent for workspaces.
## Install the GitLab agent server for Kubernetes
The GitLab agent server for Kubernetes (KAS) is the component that communicates with the agent in your cluster.
- On GitLab.com, the agent server is available at `wss://kas.gitlab.com` by default.
- On GitLab Self-Managed, an administrator must
[set up the Kubernetes agent server (KAS)](../../administration/clusters/kas.md).
It's then available at `wss://gitlab.example.com/-/kubernetes-agent/`.
## Configure the GitLab agent for Kubernetes
To configure the `remote_development` module in the agent project:
1. On the left sidebar, select **Search or go to** and find your project.
1. In your project, create a `.gitlab/agents/<agentName>/config.yaml` file.
`agentName` is the name of the agent you configured when you set up workspace infrastructure.
1. In `config.yaml`, use the following configuration for workspace settings:
```yaml
remote_development:
enabled: true
dns_zone: "<workspaces.example.dev>" # DNS zone of the URL where workspaces are available
```
For a full list of configuration options, see the workspace [configuration reference](settings.md#configuration-reference).
{{< alert type="note" >}}
The GitLab agent for Kubernetes is configured in one project, but you can use it in other project workspaces.
A separate agent is not required for each project.
The configured agent is not visible until you
[allow the agent in your group](#allow-the-gitlab-agent-for-kubernetes-in-your-group).
{{< /alert >}}
## Allow the GitLab agent for Kubernetes in your group
When you allow an agent in a group, the group, its subgroups, and all projects in those groups can
use that agent.
{{< alert type="note" >}}
Only one agent is required. You can create workspaces from all projects in a group with the same agent.
{{< /alert >}}
To allow your GitLab agent for Kubernetes in a group and make it available to all projects in that group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings** > **Workspaces**.
1. In the **Group agents** section, select the **All agents** tab.
1. For the GitLab agent for Kubernetes, select **Allow**.
1. On the confirmation dialog, select **Allow agent**.
## Grant workspace permissions
Grant users with at least the Developer role for the workspace and agent projects
the necessary permissions to create and manage workspaces. You can:
- [Add users to a project](../project/members/_index.md#add-users-to-a-project)
- [Add users to a group](../group/_index.md#add-users-to-a-group)
## Generate TLS certificates
A wildcard domain is required for workspace access because each workspace gets its own subdomain.
You must generate TLS certificates for:
- The domain `gitlab-workspaces-proxy` listens on (`GITLAB_WORKSPACES_PROXY_DOMAIN`).
- The wildcard domain where workspaces are available (`GITLAB_WORKSPACES_WILDCARD_DOMAIN`).
For example, if your base domain is `workspaces.example.dev`:
- The `GITLAB_WORKSPACES_PROXY_DOMAIN` is `workspaces.example.dev`.
- The `GITLAB_WORKSPACES_WILDCARD_DOMAIN` is `*.workspaces.example.dev`.
- Individual workspaces are available at URLs like `workspace-1.workspaces.example.dev`.
You can generate certificates from any certificate authority.
If [`cert-manager`](https://cert-manager.io/docs/) is configured for your Kubernetes cluster,
you can use it to create and renew TLS certificates automatically.
To generate certificates manually:
1. Install [Certbot](https://certbot.eff.org/) to enable HTTPS:
```shell
brew install certbot
```
1. Generate Let's Encrypt certificates with ACME DNS and create `TXT` records in your DNS provider:
```shell
export EMAIL="YOUR_EMAIL@example.dev"
export GITLAB_WORKSPACES_PROXY_DOMAIN="workspaces.example.dev"
export GITLAB_WORKSPACES_WILDCARD_DOMAIN="*.workspaces.example.dev"
certbot -d "${GITLAB_WORKSPACES_PROXY_DOMAIN}" \
-m "${EMAIL}" \
--config-dir ~/.certbot/config \
--logs-dir ~/.certbot/logs \
--work-dir ~/.certbot/work \
--manual \
--preferred-challenges dns certonly
certbot -d "${GITLAB_WORKSPACES_WILDCARD_DOMAIN}" \
-m "${EMAIL}" \
--config-dir ~/.certbot/config \
--logs-dir ~/.certbot/logs \
--work-dir ~/.certbot/work \
--manual \
--preferred-challenges dns certonly
```
1. Set the following environment variables with the certificate directories from the output:
```shell
export WORKSPACES_DOMAIN_CERT="${HOME}/.certbot/config/live/${GITLAB_WORKSPACES_PROXY_DOMAIN}/fullchain.pem"
export WORKSPACES_DOMAIN_KEY="${HOME}/.certbot/config/live/${GITLAB_WORKSPACES_PROXY_DOMAIN}/privkey.pem"
export WILDCARD_DOMAIN_CERT="${HOME}/.certbot/config/live/${GITLAB_WORKSPACES_PROXY_DOMAIN}-0001/fullchain.pem"
export WILDCARD_DOMAIN_KEY="${HOME}/.certbot/config/live/${GITLAB_WORKSPACES_PROXY_DOMAIN}-0001/privkey.pem"
```
Depending on your environment, the `certbot` command might save the certificate and key on a different path.
To get the exact path, run:
```shell
certbot certificates \
--config-dir ~/.certbot/config \
--logs-dir ~/.certbot/logs \
--work-dir ~/.certbot/work
```
{{< alert type="note" >}}
You must renew your certificates when they expire.
For example, Let's Encrypt certificates expire after three months.
To automatically renew certificates, see [`cert-manager`](https://cert-manager.io/docs/).
{{< /alert >}}
## Register a GitLab OAuth application
To register an OAuth application on your GitLab instance:
1. [Create an OAuth application](../../integration/oauth_provider.md) in GitLab. You can create a:
- User-owned application
- Group-owned application
- Instance-wide application from the Admin area
1. Set the redirect URI to `https://${GITLAB_WORKSPACES_PROXY_DOMAIN}/auth/callback`.
1. Ensure the **Confidential** checkbox is selected. It should be selected by default.
1. If you create an instance-wide application, also select the **Trusted** checkbox.
1. Set the scopes to `api`, `read_user`, `openid`, and `profile`.
1. Export your configuration values:
```shell
export GITLAB_URL="https://gitlab.com"
export CLIENT_ID="your_application_id"
export CLIENT_SECRET="your_application_secret"
export REDIRECT_URI="https://${GITLAB_WORKSPACES_PROXY_DOMAIN}/auth/callback"
export SIGNING_KEY="make_up_a_random_key_consisting_of_letters_numbers_and_special_chars"
```
1. Store the client ID and generated secret securely, for example, in 1Password.
## Generate an SSH host key
To generate an RSA key:
```shell
ssh-keygen -f ssh-host-key -N '' -t rsa
export SSH_HOST_KEY=$(pwd)/ssh-host-key
```
As an alternative, you can also generate an ECDSA key.
## Create Kubernetes secrets
To create Kubernetes secrets:
```shell
kubectl create namespace gitlab-workspaces
kubectl create secret generic gitlab-workspaces-proxy-config \
--namespace="gitlab-workspaces" \
--from-literal="auth.client_id=${CLIENT_ID}" \
--from-literal="auth.client_secret=${CLIENT_SECRET}" \
--from-literal="auth.host=${GITLAB_URL}" \
--from-literal="auth.redirect_uri=${REDIRECT_URI}" \
--from-literal="auth.signing_key=${SIGNING_KEY}" \
--from-literal="ssh.host_key=$(cat ${SSH_HOST_KEY})"
kubectl create secret tls gitlab-workspace-proxy-tls \
--namespace="gitlab-workspaces" \
--cert="${WORKSPACES_DOMAIN_CERT}" \
--key="${WORKSPACES_DOMAIN_KEY}"
kubectl create secret tls gitlab-workspace-proxy-wildcard-tls \
--namespace="gitlab-workspaces" \
--cert="${WILDCARD_DOMAIN_CERT}" \
--key="${WILDCARD_DOMAIN_KEY}"
```
## Install the GitLab workspaces proxy Helm chart
To install the Helm chart for the GitLab workspaces proxy:
1. Add the `helm` repository:
```shell
helm repo add gitlab-workspaces-proxy \
https://gitlab.com/api/v4/projects/gitlab-org%2fworkspaces%2fgitlab-workspaces-proxy/packages/helm/devel
```
For Helm chart 0.1.13 and earlier, use the following command:
```shell
helm repo add gitlab-workspaces-proxy \
https://gitlab.com/api/v4/projects/gitlab-org%2fremote-development%2fgitlab-workspaces-proxy/packages/helm/devel
```
1. Install and upgrade the chart:
{{< alert type="warning" >}}
Chart versions 0.1.20 and earlier contain a security vulnerability that sets cookies on a wildcard domain.
You should upgrade to chart version 0.1.21 or later. For more information, see the
[vulnerability fix](https://gitlab.com/gitlab-org/workspaces/gitlab-workspaces-proxy/-/merge_requests/34).
{{< /alert >}}
{{< alert type="note" >}}
Before chart version 0.1.16, the Helm chart installation created secrets automatically.
If you're upgrading from a version earlier than 0.1.16,
[create the required Kubernetes secrets](#create-kubernetes-secrets) before running the upgrade command.
{{< /alert >}}
```shell
helm repo update
helm upgrade --install gitlab-workspaces-proxy \
gitlab-workspaces-proxy/gitlab-workspaces-proxy \
--version=0.1.22 \
--namespace="gitlab-workspaces" \
--set="ingress.enabled=true" \
--set="ingress.hosts[0].host=${GITLAB_WORKSPACES_PROXY_DOMAIN}" \
--set="ingress.hosts[0].paths[0].path=/" \
--set="ingress.hosts[0].paths[0].pathType=ImplementationSpecific" \
--set="ingress.hosts[1].host=${GITLAB_WORKSPACES_WILDCARD_DOMAIN}" \
--set="ingress.hosts[1].paths[0].path=/" \
--set="ingress.hosts[1].paths[0].pathType=ImplementationSpecific" \
--set="ingress.tls[0].hosts[0]=${GITLAB_WORKSPACES_PROXY_DOMAIN}" \
--set="ingress.tls[0].secretName=gitlab-workspace-proxy-tls" \
--set="ingress.tls[1].hosts[0]=${GITLAB_WORKSPACES_WILDCARD_DOMAIN}" \
--set="ingress.tls[1].secretName=gitlab-workspace-proxy-wildcard-tls" \
--set="ingress.className=nginx"
```
If you're using a different Ingress class, modify the `ingress.className` parameter.
## Verify your setup
1. Verify the Ingress configuration for the `gitlab-workspaces` namespace:
```shell
kubectl -n gitlab-workspaces get ingress
```
1. Verify the pods are running:
```shell
kubectl -n gitlab-workspaces get pods
```
## Update your DNS records
To update your DNS records:
1. Point `${GITLAB_WORKSPACES_PROXY_DOMAIN}` and `${GITLAB_WORKSPACES_WILDCARD_DOMAIN}`
to the load balancer external IP address exposed by the [Ingress controller](#install-an-ingress-controller).
1. Check if `gitlab-workspaces-proxy` is accessible:
```shell
curl --verbose --location ${GITLAB_WORKSPACES_PROXY_DOMAIN}
```
This command returns a `400 Bad Request` error until you create a workspace.
1. From another terminal, check the proxy logs::
```shell
kubectl -n gitlab-workspaces logs -f -l app.kubernetes.io/name=gitlab-workspaces-proxy
```
This command returns a `could not find upstream workspace upstream not found` error until you create a workspace.
## Update the GitLab agent for Kubernetes configuration
If you deploy the Helm chart for the proxy to a namespace other than `gitlab-workspaces`,
update your [GitLab agent for Kubernetes configuration](gitlab_agent_configuration.md):
```yaml
remote_development:
gitlab_workspaces_proxy:
namespace: "<custom-gitlab-workspaces-proxy-namespace>"
```
## Related topics
- [Configure workspaces](configuration.md)
- [GitLab agent for Kubernetes configuration](gitlab_agent_configuration.md)
|
https://docs.gitlab.com/user/search
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/_index.md
|
2025-08-13
|
doc/user/search
|
[
"doc",
"user",
"search"
] |
_index.md
|
AI-powered
|
Global Search
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Searching in GitLab
|
Basic, advanced, exact, search scope, and commit SHA search.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Find what you need in a growing codebase or expanding organization.
Save time by looking up specific code, issues, merge requests, and other content across your projects.
Choose from three types of search to match your needs: **basic search**,
[**advanced search**](advanced_search.md), and [**exact code search**](exact_code_search.md).
For code search, GitLab uses these types in this order:
- **Exact code search**: where you can use exact match and regular expression modes.
- **Advanced search**: when exact code search is not available.
- **Basic search**: when exact code search and advanced search are not available
or when you search against a non-default branch.
This type does not support group or global search.
## Available scopes
Scopes describe the type of data you're searching.
The following scopes are available for basic search:
| Scope | Global <sup>1</sup> | Group | Project |
|----------------|:-------------------------------------------:|:-------------------------------------------:|:-------:|
| Code | {{< icon name="dash-circle" >}} No | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes |
| Comments | {{< icon name="dash-circle" >}} No | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes |
| Commits | {{< icon name="dash-circle" >}} No | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes |
| Epics | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="dash-circle" >}} No |
| Issues | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Merge requests | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Milestones | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Projects | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="dash-circle" >}} No |
| Users | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Wikis | {{< icon name="dash-circle" >}} No | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes |
**Footnotes**:
1. An administrator can [disable global search scopes](#disable-global-search-scopes).
## Specify a search type
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/161999) in GitLab 17.4.
{{< /history >}}
To specify a search type, set the `search_type` URL parameter as follows:
- `search_type=zoekt` for [exact code search](exact_code_search.md)
- `search_type=advanced` for [advanced search](advanced_search.md)
- `search_type=basic` for basic search
`search_type` replaces the deprecated `basic_search` parameter.
For more information, see [issue 477333](https://gitlab.com/gitlab-org/gitlab/-/issues/477333).
## Restrict search access
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- Restricting global search to authenticated users [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/41041) in GitLab 13.4 [with a flag](../../administration/feature_flags/_index.md) named `block_anonymous_global_searches`. Disabled by default.
- Allowing search for unauthenticated users [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/138975) in GitLab 16.7 [with a flag](../../administration/feature_flags/_index.md) named `allow_anonymous_searches`. Enabled by default.
- Restricting global search to authenticated users [generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/186727) in GitLab 17.11. Feature flag `block_anonymous_global_searches` removed.
- Allowing search for unauthenticated users [generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/190090) in GitLab 18.0. Feature flag `allow_anonymous_searches` removed.
{{< /history >}}
Prerequisites:
- You must have administrator access to the instance.
By default, requests to `/search` and global search are available for unauthenticated users.
To restrict `/search` to authenticated users only, do one of the following:
- [Restrict visibility levels](../../administration/settings/visibility_and_access_controls.md#restrict-visibility-levels)
for the project or group.
- Restrict access in the **Admin** area:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > Search**.
1. Expand **Advanced search**.
1. Clear the **Allow unauthenticated users to use search** checkbox.
1. Select **Save changes**.
To restrict global search to authenticated users only:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > Search**.
1. Expand **Visibility and access controls**
1. Select the **Restrict global search to authenticated users only** checkbox.
1. Select **Save changes**.
## Disable global search scopes
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/179688) in GitLab 17.9.
{{< /history >}}
Prerequisites:
- You must have administrator access to the instance.
To improve the performance of your instance's global search,
you can disable one or more search scopes.
All global search scopes are enabled by default on GitLab Self-Managed instances.
To disable one or more global search scopes:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > Search**.
1. Expand **Visibility and access controls**.
1. Clear the checkboxes for the scopes you want to disable.
1. Select **Save changes**.
## Global search validation
{{< history >}}
- Support for partial matches in issue search [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71913) in GitLab 14.9 [with a flag](../../administration/feature_flags/_index.md) named `issues_full_text_search`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124703) in GitLab 16.2. Feature flag `issues_full_text_search` removed.
{{< /history >}}
Global search ignores and logs as abusive any search that includes:
- Fewer than two characters
- A term longer than 100 characters (URL search terms must not exceed 200 characters)
- A stop word only (for example, `the`, `and`, or `if`)
- An unknown `scope`
- `group_id` or `project_id` that is not completely numeric
- `repository_ref` or `project_ref` with special characters not allowed by [Git refname](https://git-scm.com/docs/git-check-ref-format)
Global search only flags with an error any search that includes more than:
- 4096 characters
- 64 terms
Partial matches are not supported in issue search.
For example, when you search issues for `play`, the query does not return issues that contain `display`.
However, the query matches all possible variations of the string (for example, `plays`).
## Autocomplete suggestions
{{< history >}}
- Showing only users from authorized projects and groups [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/442091) in GitLab 17.10 [with flags](../../administration/feature_flags/_index.md) named `users_search_scoped_to_authorized_namespaces_advanced_search`, `users_search_scoped_to_authorized_namespaces_basic_search`, and `users_search_scoped_to_authorized_namespaces_basic_search_by_ids`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/185577) in GitLab 17.11. Feature flags `users_search_scoped_to_authorized_namespaces_advanced_search`, `users_search_scoped_to_authorized_namespaces_basic_search`, and `users_search_scoped_to_authorized_namespaces_basic_search_by_ids` removed.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by feature flags.
For more information, see the history.
{{< /alert >}}
As you type in the search box, autocomplete suggestions are displayed for:
- [Projects](#search-for-a-project-by-full-path) and groups
- Users from authorized projects and groups
- Help pages
- Project features (for example, milestones)
- Settings (for example, user settings)
- Recently viewed merge requests
- Recently viewed issues and epics
- [GitLab Flavored Markdown references](../markdown.md#gitlab-specific-references) for issues in a project
## Search in all GitLab
To search in all GitLab:
1. On the left sidebar, select **Search or go to**.
1. Type your search query. You must type at least two characters.
1. Press <kbd>Enter</kbd> to search, or select from the list.
The results are displayed. To filter the results, on the left sidebar, select a filter.
## Search in a project
To search in a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Search or go to** again and type the string you want to search for.
1. Press <kbd>Enter</kbd> to search, or select from the list.
The results are displayed. To filter the results, on the left sidebar, select a filter.
## Search for a project by full path
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108906) in GitLab 15.9 [with a flag](../../administration/feature_flags/_index.md) named `full_path_project_search`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114932) in GitLab 15.11. Feature flag `full_path_project_search` removed.
{{< /history >}}
You can search for a project by entering its full path (including the namespace it belongs to) in the search box.
As you type the project path, [autocomplete suggestions](#autocomplete-suggestions) are displayed.
For example:
- `gitlab-org/gitlab` searches for the `gitlab` project in the `gitlab-org` namespace.
- `gitlab-org/` displays autocomplete suggestions for projects that belong to the `gitlab-org` namespace.
## Include archived projects in search results
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121981) in GitLab 16.1 [with a flag](../../administration/feature_flags/_index.md) named `search_projects_hide_archived` for project search. Disabled by default.
- [Generally available](https://gitlab.com/groups/gitlab-org/-/epics/10957) in GitLab 16.6 for all search scopes.
{{< /history >}}
By default, archived projects are excluded from search results.
To include archived projects in search results:
1. On the search page, on the left sidebar, select the **Include archived** checkbox.
1. On the left sidebar, select **Apply**.
## Search for code
To search for code in a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Search or go to** again and type the code you want to search for.
1. Press <kbd>Enter</kbd> to search, or select from the list.
Code search shows only the first result in the file.
To search for code in all GitLab, ask your administrator to enable [advanced search](advanced_search.md).
### View Git blame from code search
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327052) in GitLab 14.7.
{{< /history >}}
After you find search results, you can view who made the last change to the line
where the results were found.
1. From the code search result, hover over the line number.
1. On the left, select **View blame**.
### Filter code search results by language
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342651) in GitLab 15.10.
{{< /history >}}
To filter code search results by one or more languages:
1. On the code search page, on the left sidebar, select one or more languages.
1. On the left sidebar, select **Apply**.
## Search for a commit SHA
To search for a commit SHA:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Search or go to** again and type the commit SHA you want to search for.
1. Press <kbd>Enter</kbd> to search, or select from the list.
If a single result is returned, GitLab redirects to the commit result
and gives you the option to return to the search results page.
|
---
stage: AI-powered
group: Global Search
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Searching in GitLab
description: Basic, advanced, exact, search scope, and commit SHA search.
breadcrumbs:
- doc
- user
- search
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Find what you need in a growing codebase or expanding organization.
Save time by looking up specific code, issues, merge requests, and other content across your projects.
Choose from three types of search to match your needs: **basic search**,
[**advanced search**](advanced_search.md), and [**exact code search**](exact_code_search.md).
For code search, GitLab uses these types in this order:
- **Exact code search**: where you can use exact match and regular expression modes.
- **Advanced search**: when exact code search is not available.
- **Basic search**: when exact code search and advanced search are not available
or when you search against a non-default branch.
This type does not support group or global search.
## Available scopes
Scopes describe the type of data you're searching.
The following scopes are available for basic search:
| Scope | Global <sup>1</sup> | Group | Project |
|----------------|:-------------------------------------------:|:-------------------------------------------:|:-------:|
| Code | {{< icon name="dash-circle" >}} No | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes |
| Comments | {{< icon name="dash-circle" >}} No | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes |
| Commits | {{< icon name="dash-circle" >}} No | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes |
| Epics | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="dash-circle" >}} No |
| Issues | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Merge requests | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Milestones | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Projects | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="dash-circle" >}} No |
| Users | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Wikis | {{< icon name="dash-circle" >}} No | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes |
**Footnotes**:
1. An administrator can [disable global search scopes](#disable-global-search-scopes).
## Specify a search type
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/161999) in GitLab 17.4.
{{< /history >}}
To specify a search type, set the `search_type` URL parameter as follows:
- `search_type=zoekt` for [exact code search](exact_code_search.md)
- `search_type=advanced` for [advanced search](advanced_search.md)
- `search_type=basic` for basic search
`search_type` replaces the deprecated `basic_search` parameter.
For more information, see [issue 477333](https://gitlab.com/gitlab-org/gitlab/-/issues/477333).
## Restrict search access
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- Restricting global search to authenticated users [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/41041) in GitLab 13.4 [with a flag](../../administration/feature_flags/_index.md) named `block_anonymous_global_searches`. Disabled by default.
- Allowing search for unauthenticated users [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/138975) in GitLab 16.7 [with a flag](../../administration/feature_flags/_index.md) named `allow_anonymous_searches`. Enabled by default.
- Restricting global search to authenticated users [generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/186727) in GitLab 17.11. Feature flag `block_anonymous_global_searches` removed.
- Allowing search for unauthenticated users [generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/190090) in GitLab 18.0. Feature flag `allow_anonymous_searches` removed.
{{< /history >}}
Prerequisites:
- You must have administrator access to the instance.
By default, requests to `/search` and global search are available for unauthenticated users.
To restrict `/search` to authenticated users only, do one of the following:
- [Restrict visibility levels](../../administration/settings/visibility_and_access_controls.md#restrict-visibility-levels)
for the project or group.
- Restrict access in the **Admin** area:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > Search**.
1. Expand **Advanced search**.
1. Clear the **Allow unauthenticated users to use search** checkbox.
1. Select **Save changes**.
To restrict global search to authenticated users only:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > Search**.
1. Expand **Visibility and access controls**
1. Select the **Restrict global search to authenticated users only** checkbox.
1. Select **Save changes**.
## Disable global search scopes
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/179688) in GitLab 17.9.
{{< /history >}}
Prerequisites:
- You must have administrator access to the instance.
To improve the performance of your instance's global search,
you can disable one or more search scopes.
All global search scopes are enabled by default on GitLab Self-Managed instances.
To disable one or more global search scopes:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > Search**.
1. Expand **Visibility and access controls**.
1. Clear the checkboxes for the scopes you want to disable.
1. Select **Save changes**.
## Global search validation
{{< history >}}
- Support for partial matches in issue search [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71913) in GitLab 14.9 [with a flag](../../administration/feature_flags/_index.md) named `issues_full_text_search`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124703) in GitLab 16.2. Feature flag `issues_full_text_search` removed.
{{< /history >}}
Global search ignores and logs as abusive any search that includes:
- Fewer than two characters
- A term longer than 100 characters (URL search terms must not exceed 200 characters)
- A stop word only (for example, `the`, `and`, or `if`)
- An unknown `scope`
- `group_id` or `project_id` that is not completely numeric
- `repository_ref` or `project_ref` with special characters not allowed by [Git refname](https://git-scm.com/docs/git-check-ref-format)
Global search only flags with an error any search that includes more than:
- 4096 characters
- 64 terms
Partial matches are not supported in issue search.
For example, when you search issues for `play`, the query does not return issues that contain `display`.
However, the query matches all possible variations of the string (for example, `plays`).
## Autocomplete suggestions
{{< history >}}
- Showing only users from authorized projects and groups [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/442091) in GitLab 17.10 [with flags](../../administration/feature_flags/_index.md) named `users_search_scoped_to_authorized_namespaces_advanced_search`, `users_search_scoped_to_authorized_namespaces_basic_search`, and `users_search_scoped_to_authorized_namespaces_basic_search_by_ids`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/185577) in GitLab 17.11. Feature flags `users_search_scoped_to_authorized_namespaces_advanced_search`, `users_search_scoped_to_authorized_namespaces_basic_search`, and `users_search_scoped_to_authorized_namespaces_basic_search_by_ids` removed.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by feature flags.
For more information, see the history.
{{< /alert >}}
As you type in the search box, autocomplete suggestions are displayed for:
- [Projects](#search-for-a-project-by-full-path) and groups
- Users from authorized projects and groups
- Help pages
- Project features (for example, milestones)
- Settings (for example, user settings)
- Recently viewed merge requests
- Recently viewed issues and epics
- [GitLab Flavored Markdown references](../markdown.md#gitlab-specific-references) for issues in a project
## Search in all GitLab
To search in all GitLab:
1. On the left sidebar, select **Search or go to**.
1. Type your search query. You must type at least two characters.
1. Press <kbd>Enter</kbd> to search, or select from the list.
The results are displayed. To filter the results, on the left sidebar, select a filter.
## Search in a project
To search in a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Search or go to** again and type the string you want to search for.
1. Press <kbd>Enter</kbd> to search, or select from the list.
The results are displayed. To filter the results, on the left sidebar, select a filter.
## Search for a project by full path
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108906) in GitLab 15.9 [with a flag](../../administration/feature_flags/_index.md) named `full_path_project_search`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114932) in GitLab 15.11. Feature flag `full_path_project_search` removed.
{{< /history >}}
You can search for a project by entering its full path (including the namespace it belongs to) in the search box.
As you type the project path, [autocomplete suggestions](#autocomplete-suggestions) are displayed.
For example:
- `gitlab-org/gitlab` searches for the `gitlab` project in the `gitlab-org` namespace.
- `gitlab-org/` displays autocomplete suggestions for projects that belong to the `gitlab-org` namespace.
## Include archived projects in search results
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121981) in GitLab 16.1 [with a flag](../../administration/feature_flags/_index.md) named `search_projects_hide_archived` for project search. Disabled by default.
- [Generally available](https://gitlab.com/groups/gitlab-org/-/epics/10957) in GitLab 16.6 for all search scopes.
{{< /history >}}
By default, archived projects are excluded from search results.
To include archived projects in search results:
1. On the search page, on the left sidebar, select the **Include archived** checkbox.
1. On the left sidebar, select **Apply**.
## Search for code
To search for code in a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Search or go to** again and type the code you want to search for.
1. Press <kbd>Enter</kbd> to search, or select from the list.
Code search shows only the first result in the file.
To search for code in all GitLab, ask your administrator to enable [advanced search](advanced_search.md).
### View Git blame from code search
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327052) in GitLab 14.7.
{{< /history >}}
After you find search results, you can view who made the last change to the line
where the results were found.
1. From the code search result, hover over the line number.
1. On the left, select **View blame**.
### Filter code search results by language
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342651) in GitLab 15.10.
{{< /history >}}
To filter code search results by one or more languages:
1. On the code search page, on the left sidebar, select one or more languages.
1. On the left sidebar, select **Apply**.
## Search for a commit SHA
To search for a commit SHA:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Search or go to** again and type the commit SHA you want to search for.
1. Press <kbd>Enter</kbd> to search, or select from the list.
If a single result is returned, GitLab redirects to the commit result
and gives you the option to return to the search results page.
|
https://docs.gitlab.com/user/exact_code_search
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/exact_code_search.md
|
2025-08-13
|
doc/user/search
|
[
"doc",
"user",
"search"
] |
exact_code_search.md
|
AI-powered
|
Global Search
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Exact code search
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed
- Status: Beta
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105049) as a [beta](../../policy/development_stages_support.md#beta) in GitLab 15.9 [with flags](../../administration/feature_flags/_index.md) named `index_code_with_zoekt` and `search_code_with_zoekt`. Disabled by default.
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/388519) in GitLab 16.6.
- Feature flags `index_code_with_zoekt` and `search_code_with_zoekt` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148378) in GitLab 17.1.
{{< /history >}}
{{< alert type="warning" >}}
This feature is in [beta](../../policy/development_stages_support.md#beta) and subject to change without notice.
For more information, see [epic 9404](https://gitlab.com/groups/gitlab-org/-/epics/9404).
To provide feedback on this feature, leave a comment on
[issue 420920](https://gitlab.com/gitlab-org/gitlab/-/issues/420920).
{{< /alert >}}
With exact code search, you can use exact match and regular expression modes
to search for code in all GitLab or in a specific project.
Exact code search is powered by [Zoekt](https://github.com/sourcegraph/zoekt)
and is used by default in groups where the feature is enabled.
## Use exact code search
Prerequisites:
- Exact code search must be enabled:
- For [GitLab.com](../../subscriptions/gitlab_com/_index.md),
exact code search is enabled by default in paid subscriptions.
- For [GitLab Self-Managed](../../subscriptions/self_managed/_index.md), an administrator must
[install Zoekt](../../integration/exact_code_search/zoekt.md#install-zoekt) and
[enable exact code search](../../integration/exact_code_search/zoekt.md#enable-exact-code-search).
To use exact code search:
1. On the left sidebar, select **Search or go to**.
1. In the search box, enter your search term.
1. On the left sidebar, select **Code**.
You can also use exact code search in a project or group.
## Available scopes
Scopes describe the type of data you're searching.
The following scopes are available for exact code search:
| Scope | Global <sup>1</sup> <sup>2</sup> | Group | Project |
|-------|:----------------------------------:|:-------------------------------------------:|:-------:|
| Code | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
**Footnotes**:
1. An administrator can [disable global search scopes](_index.md#disable-global-search-scopes).
On GitLab Self-Managed, an administrator can enable global search
with the [`zoekt_cross_namespace_search`](exact_code_search.md#global-code-search) feature flag.
1. On GitLab.com, global search is not enabled.
## Zoekt search API
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/143666) in GitLab 16.9 [with a flag](../../administration/feature_flags/_index.md) named `zoekt_search_api`. Enabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.
{{< /alert >}}
With the Zoekt search API, you can use the [search API](../../api/search.md) for exact code search.
If you want to use [advanced search](advanced_search.md) or basic search instead, see
[specify a search type](_index.md#specify-a-search-type).
By default, the Zoekt search API is disabled on GitLab.com to avoid breaking changes.
To request access to this feature, contact GitLab.
## Global code search
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/147077) in GitLab 16.11 [with a flag](../../administration/feature_flags/_index.md) named `zoekt_cross_namespace_search`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.
{{< /alert >}}
Use this feature to search code across the entire GitLab instance.
Global code search does not perform well on large GitLab instances.
When this feature is enabled for instances with more than 20,000 projects, your search might time out.
## Search modes
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/434417) in GitLab 16.8 [with a flag](../../administration/feature_flags/_index.md) named `zoekt_exact_search`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/436457) in GitLab 17.3. Feature flag `zoekt_exact_search` removed.
{{< /history >}}
GitLab has two search modes:
- **Exact match mode**: returns results that exactly match the query.
- **Regular expression mode**: supports regular and boolean expressions.
The exact match mode is used by default.
To switch to the regular expression mode, to the right of the search box,
select **Use regular expression** ({{< icon name="regular-expression" >}}).
### Syntax
<!-- Remember to also update the table in `doc/drawers/exact_code_search_syntax.md` -->
This table shows some example queries for exact match and regular expression modes.
| Query | Exact match mode | Regular expression mode |
| -------------------- | ------------------------------------------------------- | ----------------------- |
| `"foo"` | `"foo"` | `foo` |
| `foo file:^doc/` | `foo` in directories that start with `/doc` | `foo` in directories that start with `/doc` |
| `"class foo"` | `"class foo"` | `class foo` |
| `class foo` | `class foo` | `class` and `foo` |
| `foo or bar` | `foo or bar` | `foo` or `bar` |
| `class Foo` | `class Foo` (case-sensitive) | `class` (case-insensitive) and `Foo` (case-sensitive) |
| `class Foo case:yes` | `class Foo` (case-sensitive) | `class` and `Foo` (both case-sensitive) |
| `foo -bar` | `foo -bar` | `foo` but not `bar` |
| `foo file:js` | `foo` in files with names that contain `js` | `foo` in files with names that contain `js` |
| `foo -file:test` | `foo` in files with names that do not contain `test` | `foo` in files with names that do not contain `test` |
| `foo lang:ruby` | `foo` in Ruby source code | `foo` in Ruby source code |
| `foo file:\.js$` | `foo` in files with names that end with `.js` | `foo` in files with names that end with `.js` |
| `foo.*bar` | `foo.*bar` (literal) | `foo.*bar` (regular expression) |
| `sym:foo` | `foo` in symbols like class, method, and variable names | `foo` in symbols like class, method, and variable names |
## Known issues
- You can search only files smaller than 1 MB with less than `20_000` trigrams.
For more information, see [issue 455073](https://gitlab.com/gitlab-org/gitlab/-/issues/455073).
- You can use exact code search only on the default branch of a project.
For more information, see [issue 403307](https://gitlab.com/gitlab-org/gitlab/-/issues/403307).
- Multiple matches on a single line are counted as one result.
For more information, see [issue 514526](https://gitlab.com/gitlab-org/gitlab/-/issues/514526).
- If you encounter results where newlines are not displayed correctly,
you must update `gitlab-zoekt` to version 1.5.0 or later.
For more information, see [issue 516937](https://gitlab.com/gitlab-org/gitlab/-/issues/516937).
|
---
stage: AI-powered
group: Global Search
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Exact code search
breadcrumbs:
- doc
- user
- search
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed
- Status: Beta
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105049) as a [beta](../../policy/development_stages_support.md#beta) in GitLab 15.9 [with flags](../../administration/feature_flags/_index.md) named `index_code_with_zoekt` and `search_code_with_zoekt`. Disabled by default.
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/388519) in GitLab 16.6.
- Feature flags `index_code_with_zoekt` and `search_code_with_zoekt` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148378) in GitLab 17.1.
{{< /history >}}
{{< alert type="warning" >}}
This feature is in [beta](../../policy/development_stages_support.md#beta) and subject to change without notice.
For more information, see [epic 9404](https://gitlab.com/groups/gitlab-org/-/epics/9404).
To provide feedback on this feature, leave a comment on
[issue 420920](https://gitlab.com/gitlab-org/gitlab/-/issues/420920).
{{< /alert >}}
With exact code search, you can use exact match and regular expression modes
to search for code in all GitLab or in a specific project.
Exact code search is powered by [Zoekt](https://github.com/sourcegraph/zoekt)
and is used by default in groups where the feature is enabled.
## Use exact code search
Prerequisites:
- Exact code search must be enabled:
- For [GitLab.com](../../subscriptions/gitlab_com/_index.md),
exact code search is enabled by default in paid subscriptions.
- For [GitLab Self-Managed](../../subscriptions/self_managed/_index.md), an administrator must
[install Zoekt](../../integration/exact_code_search/zoekt.md#install-zoekt) and
[enable exact code search](../../integration/exact_code_search/zoekt.md#enable-exact-code-search).
To use exact code search:
1. On the left sidebar, select **Search or go to**.
1. In the search box, enter your search term.
1. On the left sidebar, select **Code**.
You can also use exact code search in a project or group.
## Available scopes
Scopes describe the type of data you're searching.
The following scopes are available for exact code search:
| Scope | Global <sup>1</sup> <sup>2</sup> | Group | Project |
|-------|:----------------------------------:|:-------------------------------------------:|:-------:|
| Code | {{< icon name="dash-circle" >}} No | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
**Footnotes**:
1. An administrator can [disable global search scopes](_index.md#disable-global-search-scopes).
On GitLab Self-Managed, an administrator can enable global search
with the [`zoekt_cross_namespace_search`](exact_code_search.md#global-code-search) feature flag.
1. On GitLab.com, global search is not enabled.
## Zoekt search API
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/143666) in GitLab 16.9 [with a flag](../../administration/feature_flags/_index.md) named `zoekt_search_api`. Enabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.
{{< /alert >}}
With the Zoekt search API, you can use the [search API](../../api/search.md) for exact code search.
If you want to use [advanced search](advanced_search.md) or basic search instead, see
[specify a search type](_index.md#specify-a-search-type).
By default, the Zoekt search API is disabled on GitLab.com to avoid breaking changes.
To request access to this feature, contact GitLab.
## Global code search
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/147077) in GitLab 16.11 [with a flag](../../administration/feature_flags/_index.md) named `zoekt_cross_namespace_search`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.
{{< /alert >}}
Use this feature to search code across the entire GitLab instance.
Global code search does not perform well on large GitLab instances.
When this feature is enabled for instances with more than 20,000 projects, your search might time out.
## Search modes
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/434417) in GitLab 16.8 [with a flag](../../administration/feature_flags/_index.md) named `zoekt_exact_search`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/436457) in GitLab 17.3. Feature flag `zoekt_exact_search` removed.
{{< /history >}}
GitLab has two search modes:
- **Exact match mode**: returns results that exactly match the query.
- **Regular expression mode**: supports regular and boolean expressions.
The exact match mode is used by default.
To switch to the regular expression mode, to the right of the search box,
select **Use regular expression** ({{< icon name="regular-expression" >}}).
### Syntax
<!-- Remember to also update the table in `doc/drawers/exact_code_search_syntax.md` -->
This table shows some example queries for exact match and regular expression modes.
| Query | Exact match mode | Regular expression mode |
| -------------------- | ------------------------------------------------------- | ----------------------- |
| `"foo"` | `"foo"` | `foo` |
| `foo file:^doc/` | `foo` in directories that start with `/doc` | `foo` in directories that start with `/doc` |
| `"class foo"` | `"class foo"` | `class foo` |
| `class foo` | `class foo` | `class` and `foo` |
| `foo or bar` | `foo or bar` | `foo` or `bar` |
| `class Foo` | `class Foo` (case-sensitive) | `class` (case-insensitive) and `Foo` (case-sensitive) |
| `class Foo case:yes` | `class Foo` (case-sensitive) | `class` and `Foo` (both case-sensitive) |
| `foo -bar` | `foo -bar` | `foo` but not `bar` |
| `foo file:js` | `foo` in files with names that contain `js` | `foo` in files with names that contain `js` |
| `foo -file:test` | `foo` in files with names that do not contain `test` | `foo` in files with names that do not contain `test` |
| `foo lang:ruby` | `foo` in Ruby source code | `foo` in Ruby source code |
| `foo file:\.js$` | `foo` in files with names that end with `.js` | `foo` in files with names that end with `.js` |
| `foo.*bar` | `foo.*bar` (literal) | `foo.*bar` (regular expression) |
| `sym:foo` | `foo` in symbols like class, method, and variable names | `foo` in symbols like class, method, and variable names |
## Known issues
- You can search only files smaller than 1 MB with less than `20_000` trigrams.
For more information, see [issue 455073](https://gitlab.com/gitlab-org/gitlab/-/issues/455073).
- You can use exact code search only on the default branch of a project.
For more information, see [issue 403307](https://gitlab.com/gitlab-org/gitlab/-/issues/403307).
- Multiple matches on a single line are counted as one result.
For more information, see [issue 514526](https://gitlab.com/gitlab-org/gitlab/-/issues/514526).
- If you encounter results where newlines are not displayed correctly,
you must update `gitlab-zoekt` to version 1.5.0 or later.
For more information, see [issue 516937](https://gitlab.com/gitlab-org/gitlab/-/issues/516937).
|
https://docs.gitlab.com/user/command_palette
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/command_palette.md
|
2025-08-13
|
doc/user/search
|
[
"doc",
"user",
"search"
] |
command_palette.md
|
Growth
|
Engagement
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Command palette
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Introduced in GitLab 16.2 [with a flag](../../administration/feature_flags/_index.md) named `command_palette`. Enabled by default.
- Feature flag `command_palette` removed in GitLab 16.4.
{{< /history >}}
You can use command palette to narrow down the scope of your search or to
find an object more quickly.
## Open the command palette
To open the command palette:
1. On the left sidebar, select **Search or go to** or use the <kbd>/</kbd> key to enable.
1. Type one of the special characters:
- <kbd>></kbd> - Create a new object or find a menu item.
- <kbd>@</kbd> - Search for a user.
- <kbd>:</kbd> - Search for a project.
- <kbd>~</kbd> - Search for project files in the default repository branch.
|
---
stage: Growth
group: Engagement
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Command palette
breadcrumbs:
- doc
- user
- search
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Introduced in GitLab 16.2 [with a flag](../../administration/feature_flags/_index.md) named `command_palette`. Enabled by default.
- Feature flag `command_palette` removed in GitLab 16.4.
{{< /history >}}
You can use command palette to narrow down the scope of your search or to
find an object more quickly.
## Open the command palette
To open the command palette:
1. On the left sidebar, select **Search or go to** or use the <kbd>/</kbd> key to enable.
1. Type one of the special characters:
- <kbd>></kbd> - Create a new object or find a menu item.
- <kbd>@</kbd> - Search for a user.
- <kbd>:</kbd> - Search for a project.
- <kbd>~</kbd> - Search for project files in the default repository branch.
|
https://docs.gitlab.com/user/advanced_search
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/advanced_search.md
|
2025-08-13
|
doc/user/search
|
[
"doc",
"user",
"search"
] |
advanced_search.md
|
AI-powered
|
Global Search
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Advanced search
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Moved to GitLab Premium in 13.9.
{{< /history >}}
Use advanced search to find exactly what you need across your entire GitLab instance.
With advanced search:
- Identify code patterns across all projects to refactor shared components more efficiently.
- Locate security vulnerabilities across your entire organization's codebase and dependencies using [advanced vulnerability management](../application_security/vulnerability_report/_index.md#advanced-vulnerability-management).
- Track usage of deprecated functions or libraries throughout all repositories.
- Find discussions buried in issues, merge requests, or comments.
- Discover existing solutions instead of reinventing functionality that already exists.
Advanced search works in projects, issues, merge requests, milestones,
users, epics, code, comments, commits, and wikis.
## Use advanced search
Prerequisites:
- Advanced search must be enabled:
- For [GitLab.com](../../subscriptions/gitlab_com/_index.md) and [GitLab Dedicated](../../subscriptions/gitlab_dedicated/_index.md),
advanced search is enabled by default in paid subscriptions.
- For [GitLab Self-Managed](../../subscriptions/self_managed/_index.md), an administrator must
[enable advanced search](../../integration/advanced_search/elasticsearch.md#enable-advanced-search).
To use advanced search:
1. On the left sidebar, select **Search or go to**.
1. In the search box, enter your search term.
You can also use advanced search in a project or group.
## Available scopes
Scopes describe the type of data you're searching.
The following scopes are available for advanced search:
| Scope | Global <sup>1</sup> <sup>2</sup> | Group | Project |
|----------------|:-------------------------------------------:|:-------------------------------------------:|:-------:|
| Code | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Comments | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Commits | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Epics | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="dash-circle" >}} No |
| Issues | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Merge requests | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Milestones | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Projects | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="dash-circle" >}} No |
| Users | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Wikis | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
**Footnotes**:
1. An administrator can [disable global search scopes](_index.md#disable-global-search-scopes).
On GitLab Self-Managed, global search is not available when limited indexing is enabled by default.
An administrator can [enable global search for limited indexing](../../integration/advanced_search/elasticsearch.md#indexed-namespaces).
1. On GitLab.com, global search is not enabled for code, commits, and wikis.
## Syntax
<!-- Remember to also update the tables in `doc/drawers/advanced_search_syntax.md` -->
{{< history >}}
- Refining user search [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388409) in GitLab 15.10.
{{< /history >}}
Advanced search uses [`simple_query_string`](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html),
which supports both exact and fuzzy queries.
When you search for a user, the [`fuzzy`](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html) query is used by default.
You can refine user search with `simple_query_string`.
| Syntax | Description | Example |
|---------------------|------------------|---------|
| `"` | Exact search | [`"gem sidekiq"`](https://gitlab.com/search?group_id=9970&project_id=278964&scope=blobs&search=%22gem+sidekiq%22) |
| `~` | Fuzzy search | [`J~ Doe`](https://gitlab.com/search?scope=users&search=j%7E+doe) |
| `\|` | Or | [`display \| banner`](https://gitlab.com/search?group_id=9970&project_id=278964&scope=blobs&search=display+%7C+banner) |
| `+` | And | [`display +banner`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=display+%2Bbanner&snippets=) |
| `-` | Exclude | [`display -banner`](https://gitlab.com/search?group_id=9970&project_id=278964&scope=blobs&search=display+-banner) |
| `*` | Partial | [`bug error 50*`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=bug+error+50%2A&snippets=) |
| ` \ ` | Escape | [`\*md`](https://gitlab.com/search?snippets=&scope=blobs&repository_ref=&search=%5C*md&group_id=9970&project_id=278964) |
| `#` | Issue ID | [`#23456`](https://gitlab.com/search?snippets=&scope=issues&repository_ref=&search=%2323456&group_id=9970&project_id=278964) |
| `!` | Merge request ID | [`!23456`](https://gitlab.com/search?snippets=&scope=merge_requests&repository_ref=&search=%2123456&group_id=9970&project_id=278964) |
### Code search
| Syntax | Description | Example |
|--------------|-------------------------------------------------|---------|
| `filename:` | Filename | [`filename:*spec.rb`](https://gitlab.com/search?snippets=&scope=blobs&repository_ref=&search=filename%3A*spec.rb&group_id=9970&project_id=278964) |
| `path:` | Repository location (full or partial matches) | [`path:spec/workers/`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=path%3Aspec%2Fworkers&snippets=) |
| `extension:` | File extension without `.` (exact matches only) | [`extension:js`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=extension%3Ajs&snippets=) |
| `blob:` | Git object ID (exact matches only) | [`blob:998707*`](https://gitlab.com/search?snippets=false&scope=blobs&repository_ref=&search=blob%3A998707*&group_id=9970) |
### Examples
<!-- markdownlint-disable MD044 -->
| Query | Description |
|----------------------------------------------------|-------------|
| [`rails -filename:gemfile.lock`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=rails+-filename%3Agemfile.lock&snippets=) | Returns `rails` in all files except the `gemfile.lock` file. |
| [`RSpec.describe Resolvers -*builder`](https://gitlab.com/search?group_id=9970&project_id=278964&scope=blobs&search=RSpec.describe+Resolvers+-*builder) | Returns `RSpec.describe Resolvers` that does not start with `builder`. |
| [`bug \| (display +banner)`](https://gitlab.com/search?snippets=&scope=issues&repository_ref=&search=bug+%7C+%28display+%2Bbanner%29&group_id=9970&project_id=278964) | Returns `bug` or both `display` and `banner`. |
| [`helper -extension:yml -extension:js`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=helper+-extension%3Ayml+-extension%3Ajs&snippets=) | Returns `helper` in all files except files with a `.yml` or `.js` extension. |
| [`helper path:lib/git`](https://gitlab.com/search?group_id=9970&project_id=278964&scope=blobs&search=helper+path%3Alib%2Fgit) | Returns `helper` in all files with a `lib/git*` path (for example, `spec/lib/gitlab`). |
<!-- markdownlint-enable MD044 -->
## Known issues
- You can search only files smaller than 1 MB.
For more information, see [issue 195764](https://gitlab.com/gitlab-org/gitlab/-/issues/195764).
For GitLab Self-Managed, an administrator can
[configure the **Maximum file size indexed** setting](../../integration/advanced_search/elasticsearch.md#advanced-search-configuration).
- You can use advanced search only on the default branch of a project.
For more information, see [issue 229966](https://gitlab.com/gitlab-org/gitlab/-/issues/229966).
- The search query must not contain any of the following characters:
```plaintext
. , : ; / ` ' = ? $ & ^ | < > ( ) { } [ ] @
```
For more information, see [issue 325234](https://gitlab.com/gitlab-org/gitlab/-/issues/325234).
- Search results show only the first match in a file.
For more information, see [issue 668](https://gitlab.com/gitlab-org/gitlab/-/issues/668).
|
---
stage: AI-powered
group: Global Search
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Advanced search
breadcrumbs:
- doc
- user
- search
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Moved to GitLab Premium in 13.9.
{{< /history >}}
Use advanced search to find exactly what you need across your entire GitLab instance.
With advanced search:
- Identify code patterns across all projects to refactor shared components more efficiently.
- Locate security vulnerabilities across your entire organization's codebase and dependencies using [advanced vulnerability management](../application_security/vulnerability_report/_index.md#advanced-vulnerability-management).
- Track usage of deprecated functions or libraries throughout all repositories.
- Find discussions buried in issues, merge requests, or comments.
- Discover existing solutions instead of reinventing functionality that already exists.
Advanced search works in projects, issues, merge requests, milestones,
users, epics, code, comments, commits, and wikis.
## Use advanced search
Prerequisites:
- Advanced search must be enabled:
- For [GitLab.com](../../subscriptions/gitlab_com/_index.md) and [GitLab Dedicated](../../subscriptions/gitlab_dedicated/_index.md),
advanced search is enabled by default in paid subscriptions.
- For [GitLab Self-Managed](../../subscriptions/self_managed/_index.md), an administrator must
[enable advanced search](../../integration/advanced_search/elasticsearch.md#enable-advanced-search).
To use advanced search:
1. On the left sidebar, select **Search or go to**.
1. In the search box, enter your search term.
You can also use advanced search in a project or group.
## Available scopes
Scopes describe the type of data you're searching.
The following scopes are available for advanced search:
| Scope | Global <sup>1</sup> <sup>2</sup> | Group | Project |
|----------------|:-------------------------------------------:|:-------------------------------------------:|:-------:|
| Code | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Comments | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Commits | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Epics | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="dash-circle" >}} No |
| Issues | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Merge requests | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Milestones | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Projects | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="dash-circle" >}} No |
| Users | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
| Wikis | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes | {{< icon name="check-circle-filled" >}} Yes |
**Footnotes**:
1. An administrator can [disable global search scopes](_index.md#disable-global-search-scopes).
On GitLab Self-Managed, global search is not available when limited indexing is enabled by default.
An administrator can [enable global search for limited indexing](../../integration/advanced_search/elasticsearch.md#indexed-namespaces).
1. On GitLab.com, global search is not enabled for code, commits, and wikis.
## Syntax
<!-- Remember to also update the tables in `doc/drawers/advanced_search_syntax.md` -->
{{< history >}}
- Refining user search [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388409) in GitLab 15.10.
{{< /history >}}
Advanced search uses [`simple_query_string`](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html),
which supports both exact and fuzzy queries.
When you search for a user, the [`fuzzy`](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html) query is used by default.
You can refine user search with `simple_query_string`.
| Syntax | Description | Example |
|---------------------|------------------|---------|
| `"` | Exact search | [`"gem sidekiq"`](https://gitlab.com/search?group_id=9970&project_id=278964&scope=blobs&search=%22gem+sidekiq%22) |
| `~` | Fuzzy search | [`J~ Doe`](https://gitlab.com/search?scope=users&search=j%7E+doe) |
| `\|` | Or | [`display \| banner`](https://gitlab.com/search?group_id=9970&project_id=278964&scope=blobs&search=display+%7C+banner) |
| `+` | And | [`display +banner`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=display+%2Bbanner&snippets=) |
| `-` | Exclude | [`display -banner`](https://gitlab.com/search?group_id=9970&project_id=278964&scope=blobs&search=display+-banner) |
| `*` | Partial | [`bug error 50*`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=bug+error+50%2A&snippets=) |
| ` \ ` | Escape | [`\*md`](https://gitlab.com/search?snippets=&scope=blobs&repository_ref=&search=%5C*md&group_id=9970&project_id=278964) |
| `#` | Issue ID | [`#23456`](https://gitlab.com/search?snippets=&scope=issues&repository_ref=&search=%2323456&group_id=9970&project_id=278964) |
| `!` | Merge request ID | [`!23456`](https://gitlab.com/search?snippets=&scope=merge_requests&repository_ref=&search=%2123456&group_id=9970&project_id=278964) |
### Code search
| Syntax | Description | Example |
|--------------|-------------------------------------------------|---------|
| `filename:` | Filename | [`filename:*spec.rb`](https://gitlab.com/search?snippets=&scope=blobs&repository_ref=&search=filename%3A*spec.rb&group_id=9970&project_id=278964) |
| `path:` | Repository location (full or partial matches) | [`path:spec/workers/`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=path%3Aspec%2Fworkers&snippets=) |
| `extension:` | File extension without `.` (exact matches only) | [`extension:js`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=extension%3Ajs&snippets=) |
| `blob:` | Git object ID (exact matches only) | [`blob:998707*`](https://gitlab.com/search?snippets=false&scope=blobs&repository_ref=&search=blob%3A998707*&group_id=9970) |
### Examples
<!-- markdownlint-disable MD044 -->
| Query | Description |
|----------------------------------------------------|-------------|
| [`rails -filename:gemfile.lock`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=rails+-filename%3Agemfile.lock&snippets=) | Returns `rails` in all files except the `gemfile.lock` file. |
| [`RSpec.describe Resolvers -*builder`](https://gitlab.com/search?group_id=9970&project_id=278964&scope=blobs&search=RSpec.describe+Resolvers+-*builder) | Returns `RSpec.describe Resolvers` that does not start with `builder`. |
| [`bug \| (display +banner)`](https://gitlab.com/search?snippets=&scope=issues&repository_ref=&search=bug+%7C+%28display+%2Bbanner%29&group_id=9970&project_id=278964) | Returns `bug` or both `display` and `banner`. |
| [`helper -extension:yml -extension:js`](https://gitlab.com/search?group_id=9970&project_id=278964&repository_ref=&scope=blobs&search=helper+-extension%3Ayml+-extension%3Ajs&snippets=) | Returns `helper` in all files except files with a `.yml` or `.js` extension. |
| [`helper path:lib/git`](https://gitlab.com/search?group_id=9970&project_id=278964&scope=blobs&search=helper+path%3Alib%2Fgit) | Returns `helper` in all files with a `lib/git*` path (for example, `spec/lib/gitlab`). |
<!-- markdownlint-enable MD044 -->
## Known issues
- You can search only files smaller than 1 MB.
For more information, see [issue 195764](https://gitlab.com/gitlab-org/gitlab/-/issues/195764).
For GitLab Self-Managed, an administrator can
[configure the **Maximum file size indexed** setting](../../integration/advanced_search/elasticsearch.md#advanced-search-configuration).
- You can use advanced search only on the default branch of a project.
For more information, see [issue 229966](https://gitlab.com/gitlab-org/gitlab/-/issues/229966).
- The search query must not contain any of the following characters:
```plaintext
. , : ; / ` ' = ? $ & ^ | < > ( ) { } [ ] @
```
For more information, see [issue 325234](https://gitlab.com/gitlab-org/gitlab/-/issues/325234).
- Search results show only the first match in a file.
For more information, see [issue 668](https://gitlab.com/gitlab-org/gitlab/-/issues/668).
|
https://docs.gitlab.com/user/fields
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/fields.md
|
2025-08-13
|
doc/user/glql
|
[
"doc",
"user",
"glql"
] |
fields.md
|
Plan
|
Knowledge
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
GLQL fields
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14767) in GitLab 17.4 [with a flag](../../administration/feature_flags/_index.md) named `glql_integration`. Disabled by default.
- Enabled on GitLab.com in GitLab 17.4 for a subset of groups and projects.
- Promoted to [beta](../../policy/development_stages_support.md#beta) status in GitLab 17.10.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/476990) from experiment to beta in GitLab 17.10.
- Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated in GitLab 17.10.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/554870) in GitLab 18.3. Feature flag `glql_integration` removed.
{{< /history >}}
With GitLab Query Language (GLQL), fields are used to:
- Filter the results returned from a [GLQL query](_index.md#query-syntax).
- Control the details displayed in an [embedded view](_index.md#presentation-syntax).
- Sort the results displayed in an embedded view.
You use fields in three embedded view parameters:
- **`query`** - Set conditions to determine which items to retrieve
- **`fields`** - Specify which columns and details appear in your view
- **`sort`** - Order items by specific criteria
The following sections describe the available fields for each component.
## Fields inside query
In an embedded view, the `query` parameter can be used to include one or more expressions of the
format `<field> <operator> <value>`. Multiple expressions are joined with `and`,
for example, `group = "gitlab-org" and author = currentUser()`.
Prerequisites:
- Querying epics is available in the Premium and Ultimate tier.
The table below provides an overview of all available query fields and their specifications:
| Field | Name (and alias) | Operators | Supported for |
| --------------------------------------- | -------------------------------------------- | ------------------------- | ------------- |
| [Approved by user](#approved-by-user) | `approver`, `approvedBy`, `approvers` | `=`, `!=` | Merge requests |
| [Assignees](#assignees) | `assignee`, `assignees` | `=`, `in`, `!=` | Issues, epics, merge requests |
| [Author](#author) | `author` | `=`, `in`, `!=` | Issues, epics, merge requests |
| [Cadence](#cadence) | `cadence` | `=`, `in` | Issues |
| [Closed at](#closed-at) | `closed`, `closedAt` | `=`, `>`, `<`, `>=`, `<=` | Issues, epics |
| [Confidential](#confidential) | `confidential` | `=`, `!=` | Issues, epics |
| [Created at](#created-at) | `created`, `createdAt`, `opened`, `openedAt` | `=`, `>`, `<`, `>=`, `<=` | Issues, epics, merge requests |
| [Custom field](#custom-field) | `customField("Field name")` | `=` | Issues, epics |
| [Deployed at](#deployed-at) | `deployed`, `deployedAt` | `=`, `>`, `<`, `>=`, `<=` | Merge requests |
| [Draft](#draft) | `draft` | `=`, `!=` | Merge requests |
| [Due date](#due-date) | `due`, `dueDate` | `=`, `>`, `<`, `>=`, `<=` | Issues, epics |
| [Environment](#environment) | `environment` | `=` | Merge requests |
| [Epic](#epic) | `epic` | `=`, `!=` | Issues |
| [Group](#group) | `group` | `=` | Issues, epics, merge requests |
| [Health status](#health-status) | `health`, `healthStatus` | `=`, `!=` | Issues, epics |
| [ID](#id) | `id` | `=`, `in` | Issues, epics, merge requests |
| [Include subgroups](#include-subgroups) | `includeSubgroups` | `=`, `!=` | Issues, epics, merge requests |
| [Iteration](#iteration) | `iteration` | `=`, `in`, `!=` | Issues |
| [Labels](#labels) | `label`, `labels` | `=`, `in`, `!=` | Issues, epics, merge requests |
| [Merged at](#merged-at) | `merged`, `mergedAt` | `=`, `>`, `<`, `>=`, `<=` | Merge requests |
| [Merged by user](#merged-by-user) | `merger`, `mergedBy` | `=` | Merge requests |
| [Milestone](#milestone) | `milestone` | `=`, `in`, `!=` | Issues, epics, merge requests |
| [My reaction emoji](#my-reaction-emoji) | `myReaction`, `myReactionEmoji` | `=`, `!=` | Issues, epics, merge requests |
| [Project](#project) | `project` | `=` | Issues, merge requests |
| [Reviewers](#reviewers) | `reviewer`, `reviewers`, `reviewedBy` | `=`, `!=` | Merge requests |
| [Source branch](#source-branch) | `sourceBranch` | `=`, `in`, `!=` | Merge requests |
| [State](#state) | `state` | `=` | Issues, epics, merge requests |
| [Status](#status) | `status` | `=` | Issues |
| [Subscribed](#subscribed) | `subscribed` | `=`, `!=` | Issues, epics, merge requests |
| [Target branch](#target-branch) | `targetBranch` | `=`, `in`, `!=` | Merge requests |
| [Type](#type) | `type` | `=`, `in` | Issues, epics, merge requests |
| [Updated at](#updated-at) | `updated`, `updatedAt` | `=`, `>`, `<`, `>=`, `<=` | Issues, epics, merge requests |
| [Weight](#weight) | `weight` | `=`, `!=` | Issues |
### Approved by user
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Aliases `approvedBy` and `approvers` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Support for `Nullable` values [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/221) in GitLab 18.3.
{{< /history >}}
**Description**: Query merge requests by one or more users who approved the merge request.
**Allowed value types**:
- `String`
- `User` (for example, `@username`)
- `List` (containing `String` or `User` values)
- `Nullable` (either of `null`, `none`, or `any`)
**Examples**:
- List all merge requests approved by current user and `@johndoe`
```plaintext
type = MergeRequest and approver = (currentUser(), @johndoe)
```
- List all merge requests that are not yet approved
```plaintext
type = MergeRequest and approver = none
```
### Assignees
{{< history >}}
- Alias `assignees` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Support for querying epics by assignees [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by one or more users who are assigned to them.
**Allowed value types**:
- `String`
- `User` (for example, `@username`)
- `List` (containing `String` or `User` values)
- `Nullable` (either of `null`, `none`, or `any`)
**Additional details**:
- `List` values and the `in` operator are not supported for `MergeRequest` types.
**Examples**:
- List all issues where assignee is `@johndoe`:
```plaintext
assignee = @johndoe
```
- List all issues where assignees are both `@johndoe` and `@janedoe`:
```plaintext
assignee = (@johndoe, @janedoe)
```
- List all issues where assignees are either of `@johndoe` or `@janedoe`:
```plaintext
assignee in (@johndoe, @janedoe)
```
- List all issues where assignee is neither of `@johndoe` or `@janedoe`:
```plaintext
assignee != (@johndoe, @janedoe)
```
- List all merge requests where assignee is `@johndoe`:
```plaintext
type = MergeRequest and assignee = @johndoe
```
### Author
{{< history >}}
- Support for querying epics by author [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
- Support for `in` operator [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/221) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by their author.
**Allowed value types**:
- `String`
- `User` (for example, `@username`)
- `List` (containing `String` or `User` values)
**Additional details:**
- The `in` operator is not supported for `MergeRequest` types.
**Examples**:
- List all issues where author is `@johndoe`:
```plaintext
author = @johndoe
```
- List all epics where author is either `@johndoe` or `@janedoe`:
```plaintext
type = Epic and author in (@johndoe, @janedoe)
```
- List all merge requests where author is `@johndoe`:
```plaintext
type = MergeRequest and author = @johndoe
```
### Cadence
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-haskell/-/issues/74) in GitLab 17.6.
{{< /history >}}
**Description**: Query issues by the [cadence](../group/iterations/_index.md#iteration-cadences) that the issue's iteration is a part of.
**Allowed value types**:
- `Number` (only positive integers)
- `List` (containing `Number` values)
- `Nullable` (either of `none`, or `any`)
**Additional details**:
- Because an issue can have only one iteration, the `=` operator cannot be used with `List` type for the `cadence` field.
**Examples**:
- List all issues with iteration that are a part of cadence ID `123456`:
```plaintext
cadence = 123456
```
- List all issues with iterations that are a part of any cadences `123` or `456`:
```plaintext
cadence in (123, 456)
```
### Closed at
{{< history >}}
- Alias `closedAt` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
- Support for querying epics by closed date [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues or epics by the date when they were closed.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all issues closed since yesterday:
```plaintext
closed > -1d
```
- List all issues closed today:
```plaintext
closed = today()
```
- List all issues closed in the month of February 2023:
```plaintext
closed > 2023-02-01 and closed < 2023-02-28
```
### Confidential
{{< history >}}
- Support for querying epics by their confidentiality [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues or epics by their visibility to project members.
**Allowed value types**:
- `Boolean` (either of `true` or `false`)
**Additional details**:
- Confidential issues queried using GLQL are only visible to people who have permission to view them.
**Examples**:
- List all confidential issues:
```plaintext
confidential = true
```
- List all issues that are not confidential:
```plaintext
confidential = false
```
### Created at
{{< history >}}
- Aliases `createdAt`, `opened`, and `openedAt` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
- Support for querying epics by creation date [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by the date when they were created.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all issues that were created in the last week:
```plaintext
created > -1w
```
- List all issues created today:
```plaintext
created = today()
```
- List all issues created in the month of January 2025 that are still open:
```plaintext
created > 2025-01-01 and created < 2025-01-31 and state = opened
```
### Custom field
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/233) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues or epics by [custom fields](../work_items/custom_fields.md).
**Allowed value types**:
- `String` (for single-select custom fields)
- `List` (of `String`, for multi-select custom fields)
**Additional details**:
- Custom field names and values are not case-sensitive.
**Examples**
- List all issues where the single-select "Subscription" custom field is set to "Free":
```plaintext
customField("Subscription") = "Free"
```
- List all issues where the single-select "Subscription" and "Team" custom fields are set to
"Free" and "Engineering" respectively:
```plaintext
customField("Subscription") = "Free" and customField("Team") = "Engineering"
```
- List all issues where the multi-select "Category" custom field is set to "Markdown" and "Text Editors":
```plaintext
customField("Category") = ("Markdown", "Text Editors")
```
Alternatively:
```plaintext
customField("Category") = "Markdown" and customField("Category") = "Text Editors"
```
### Deployed at
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Alias `deployedAt` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
{{< /history >}}
**Description**: Query merge requests by the date when they were deployed.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all merge requests that have been deployed in the past week:
```plaintext
type = MergeRequest and deployed > -1w
```
- List all merge requests that have been deployed in the month of January 2025:
```plaintext
type = MergeRequest and deployed > 2025-01-01 and deployed < 2025-01-31
```
### Draft
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
{{< /history >}}
**Description**: Query merge requests by their draft status.
**Allowed value types**:
- `Boolean` (either of `true` or `false`)
**Examples**:
- List all draft merge requests:
```plaintext
type = MergeRequest and draft = true
```
- List all merge requests that are not in draft state:
```plaintext
type = MergeRequest and draft = false
```
### Due date
{{< history >}}
- Alias `dueDate` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
- Support for querying epics by due date [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues or epics by the date when they are due.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all issues due in a week:
```plaintext
due < 1w
```
- List all issues that were overdue as of January 1, 2025:
```plaintext
due < 2025-01-01
```
- List all issues that are due today (but not due yesterday or tomorrow):
```plaintext
due = today()
```
- List all issues that have been overdue in the last 1 month:
```plaintext
due > -1m and due < today()
```
### Environment
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
{{< /history >}}
**Description**: Query merge requests by the environment to which they have been deployed.
**Allowed value types**: `String`
**Examples**:
- List all merge requests that have been deployed to environment `production`:
```plaintext
environment = "production"
```
### Epic
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/issues/30) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues by their parent epic ID or reference.
**Allowed value types**:
- `Number` (epic ID)
- `String` (containing an epic reference like `&123`)
- `Epic` (for example, `&123`, `gitlab-org&123`)
**Examples**:
- List all issues that have epic `&123` as their parent in project `gitlab-org/gitlab`:
```plaintext
project = "gitlab-org/gitlab" and epic = &123
```
- List all issues that have epic `gitlab-com&123` as their parent in project `gitlab-org/gitlab`:
```plaintext
project = "gitlab-org/gitlab" and epic = gitlab-com&123
```
### Group
**Description**: Query issues, epics, or merge requests within all projects in a given group.
**Allowed value types**: `String`
**Additional details**:
- Only one group can be queried at a time.
- The `group` cannot be used together with the `project` field.
- If omitted when using inside an embedded view in a group object (like an epic), `group` is assumed to
be the current group.
- Using the `group` field queries all objects in that group, all its subgroups, and child projects.
- By default, issues or merge requests are searched in all descendant projects across all subgroups.
To query only the direct child projects of the group, set the [`includeSubgroups` field](#include-subgroups) to `false`.
**Examples**:
- List all issues in the `gitlab-org` group and any of its subgroups:
```plaintext
group = "gitlab-org"
```
- List all Tasks in the `gitlab-org` group and any of its subgroups:
```plaintext
group = "gitlab-org" and type = Task
```
### Health status
{{< details >}}
- Tier: Ultimate
{{< /details >}}
{{< history >}}
- Alias `healthStatus` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Support for querying epics by health status [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues or epics by their health status.
**Allowed value types**:
- `StringEnum` (one of `"needs attention"`, `"at risk"` or `"on track"`)
- `Nullable` (either of `null`, `none`, or `any`)
**Examples**:
- List all issues that don't have a health status set:
```plaintext
health = any
```
- List all issues where the health status is "needs attention":
```plaintext
health = "needs attention"
```
### ID
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/92) in GitLab 17.8.
- Support for querying epics by ID [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by their IDs.
**Allowed value types**:
- `Number` (only positive integers)
- `List` (containing `Number` values)
**Examples**:
- List issue with ID `123`:
```plaintext
id = 123
```
- List issues with IDs `1`, `2`, or `3`:
```plaintext
id in (1, 2, 3)
```
- List all merge requests with IDs `1`, `2`, or `3`:
```plaintext
type = MergeRequest and id in (1, 2, 3)
```
### Include subgroups
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/106) in GitLab 17.10.
- Support for this field to be used with epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests within the entire hierarchy of a group.
**Allowed value types**:
- `Boolean` (either of `true` or `false`)
**Additional details**:
- This field can only be used with the `group` field.
- The value of this field defaults to `false`.
**Examples**:
- List issues in any project that is a direct child of the `gitlab-org` group:
```plaintext
group = "gitlab-org" and includeSubgroups = false
```
- List issues in any project within the entire hierarchy of the `gitlab-org` group:
```plaintext
group = "gitlab-org" and includeSubgroups = true
```
### Iteration
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-haskell/-/issues/74) in GitLab 17.6.
- Support for iteration value types [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/79) in GitLab 17.8.
{{< /history >}}
**Description**: Query issues by their associated [iteration](../group/iterations/_index.md).
**Allowed value types**:
- `Number` (only positive integers)
- `Iteration` (for example, `*iteration:123456`)
- `List` (containing `Number` or `Iteration` values)
- `Enum` (only `current` is supported)
- `Nullable` (either of `none`, or `any`)
**Additional details**:
- Because an issue can have only one iteration, the `=` operator cannot be used with `List` type for the `iteration` field.
- The `in` operator is not supported for `MergeRequest` types.
**Examples**:
- List all issues with iteration ID `123456` (using a number in the query):
```plaintext
iteration = 123456
```
- List all issues that are a part of iterations `123` or `456` (using numbers):
```plaintext
iteration in (123, 456)
```
- List all issues with iteration ID `123456` (using iteration syntax):
```plaintext
iteration = *iteration:123456
```
- List all issues that are a part of iterations `123` or `456` (using iteration syntax):
```plaintext
iteration in (*iteration:123, *iteration:456)
```
- List all issues in the current iteration
```plaintext
iteration = current
```
### Labels
{{< history >}}
- Support for label value types [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/79) in GitLab 17.8.
- Alias `labels` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Support for querying epics by labels [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by their associated labels.
**Allowed value types**:
- `String`
- `Label` (for example, `~bug`, `~"team::planning"`)
- `List` (containing `String` or `Label` values)
- `Nullable` (either of `none`, or `any`)
**Additional details**:
- Scoped labels, or labels containing spaces must be wrapped in quotes.
- The `in` operator is not supported for `MergeRequest` types.
**Examples**:
- List all issues with label `~bug`:
```plaintext
label = ~bug
```
- List all issues not having label `~"workflow::in progress"`:
```plaintext
label != ~"workflow::in progress"
```
- List all issues with labels `~bug` and `~"team::planning"`:
```plaintext
label = (~bug, ~"team::planning")
```
- List all issues with labels `~bug` or `~feature`:
```plaintext
label in (~bug, ~feature)
```
- List all issues where the labels include neither of `~bug` or `~feature`:
```plaintext
label != (~bug, ~feature)
```
- List all issues where none of the scoped labels apply, with scope `workflow::`:
```plaintext
label != ~"workflow::*"
```
- List all merge requests with labels `~bug` and `~"team::planning"`
```plaintext
type = MergeRequest and label = (~bug, ~"team::planning")
```
### Merged at
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Alias `mergedAt` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
{{< /history >}}
**Description**: Query merge requests by the date when they were merged.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all merge requests that have been merged in the last 6 months:
```plaintext
type = MergeRequest and merged > -6m
```
- List all merge requests that have been merged in the month of January 2025:
```plaintext
type = MergeRequest and merged > 2025-01-01 and merged < 2025-01-31
```
### Merged by user
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Alias `mergedBy` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
{{< /history >}}
**Description**: Query merge requests by the user that merged the merge request.
**Allowed value types**:
- `String`
- `User` (for example, `@username`)
**Examples**:
- List all merge requests merged by the current user:
```plaintext
type = MergeRequest and merger = currentUser()
```
### Milestone
{{< history >}}
- Support for milestone value types [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/77) in GitLab 17.8.
- Support for querying epics by milestone [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by their associated milestone.
**Allowed value types**:
- `String`
- `Milestone` (for example, `%Backlog`, `%"Awaiting Further Demand"`)
- `List` (containing `String` or `Milestone` values)
- `Nullable` (either of `none`, or `any`)
**Additional details**:
- Milestones containing spaces must be wrapped in quotes (`"`).
- Because an issue can have only one milestone, the `=` operator cannot be used with `List` type for the `milestone` field.
- The `in` operator is not supported for `MergeRequest` and `Epic` types.
- The `Epic` type does not support wildcard milestone filters like `none` or `any`.
**Examples**:
- List all issues with milestone `%Backlog`:
```plaintext
milestone = %Backlog
```
- List all issues with milestones `%17.7` or `%17.8`:
```plaintext
milestone in (%17.7, %17.8)
```
- List all issues in an upcoming milestone:
```plaintext
milestone = upcoming
```
- List all issues in a current milestone:
```plaintext
milestone = started
```
- List all issues where the milestone is neither of `%17.7` or `%17.8`:
```plaintext
milestone != (%17.7, %17.8)
```
### My reaction emoji
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/223) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by the current user's [emoji reaction](../emoji_reactions.md) on it.
**Allowed value types**: `String`
**Examples**:
- List all issues where the current user reacted with the thumbs-up emoji:
```plaintext
myReaction = "thumbsup"
```
- List all merge requests where the current user did not react with the thumbs-down emoji:
```plaintext
type = MergeRequest and myReaction != "thumbsdown"
```
### Project
**Description**: Query issues or merge requests within a particular project.
**Allowed value types**: `String`
**Additional details**:
- Only one project can be queried at a time.
- The `project` field cannot be used together with the `group` field.
- If omitted when using inside an embedded view, `project` is assumed to be the current project.
**Examples**:
- List all issues and work items in the `gitlab-org/gitlab` project:
```plaintext
project = "gitlab-org/gitlab"
```
### Reviewers
{{< history >}}
- Aliases `reviewers` and `reviewedBy` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
{{< /history >}}
**Description**: Query merge requests that were reviewed by one or more users.
**Allowed value types**:
- `String`
- `User` (for example, `@username`)
- `Nullable` (either of `null`, `none`, or `any`)
**Examples**:
- List all merge requests reviewed by current user:
```plaintext
type = MergeRequest and reviewer = currentUser()
```
### Source branch
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197407) in GitLab 18.2.
{{< /history >}}
**Description:** Query merge requests by their source branch.
**Allowed value types:** `String`, `List`
**Additional details**:
- `List` values are only supported with the `in` and `!=` operators.
**Examples**:
- List all merge requests from a specific branch:
```plaintext
type = MergeRequest and sourceBranch = "feature/new-feature"
```
- List all merge requests from multiple branches:
```plaintext
type = MergeRequest and sourceBranch in ("main", "develop")
```
- List all merge requests that are not from a specific branch:
```plaintext
type = MergeRequest and sourceBranch != "main"
```
### State
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/96) in GitLab 17.8.
- Support for querying epics by state [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by state.
**Allowed value types**:
- `Enum`
- For issue and work item types, one of `opened`, `closed`, or `all`
- For `MergeRequest` types, one of `opened`, `closed`, `merged`, or `all`
**Additional details**:
- The `state` field does not support the `!=` operator.
**Examples**:
- List all closed issues:
```plaintext
state = closed
```
- List all open issues:
```plaintext
state = opened
```
- List all issues regardless of their state (also the default):
```plaintext
state = all
```
- List all merged merge requests:
```plaintext
type = MergeRequest and state = merged
```
### Status
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197407) in GitLab 18.2.
{{< /history >}}
**Description:** Query issues by their status.
**Allowed value types:** `String`
**Examples**:
- List all issues with status "To do":
```plaintext
status = "To do"
```
### Subscribed
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/223) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by whether the current user has
[set notifications](../profile/notifications.md)
on or off.
**Allowed value types**: `Boolean`
**Examples**:
- List all open issues where the current user has set notifications on:
```plaintext
state = opened and subscribed = true
```
- List all merge requests where the current user has set notifications off:
```plaintext
type = MergeRequest and subscribed = false
```
### Target branch
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197407) in GitLab 18.2.
{{< /history >}}
**Description:** Query merge requests by their target branch.
**Allowed value types:** `String`, `List`
**Additional details**:
- `List` values are only supported with the `in` and `!=` operators.
**Examples**:
- List all merge requests targeting a specific branch:
```plaintext
type = MergeRequest and targetBranch = "feature/new-feature"
```
- List all merge requests targeting multiple branches:
```plaintext
type = MergeRequest and targetBranch in ("main", "develop")
```
- List all merge requests that are not targeting a specific branch:
```plaintext
type = MergeRequest and targetBranch != "main"
```
### Type
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Support for querying epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: The type of object to query: issues, epics, or merge requests.
**Allowed value types**:
- `Enum`, one of:
- `Issue`
- `Incident`
- `Epic`
- `TestCase`
- `Requirement`
- `Task`
- `Ticket`
- `Objective`
- `KeyResult`
- `MergeRequest`
- `List` (containing one or more `enum` values)
**Additional details**:
- If omitted when used inside an embedded view, the default `type` is `Issue`.
- `type = Epic` queries can only be used together with the [group](#group) field.
- The `in` operator cannot be used to combine `Epic` and `MergeRequest` types with other types
in the same query.
**Examples**:
- List incidents:
```plaintext
type = incident
```
- List issues and tasks:
```plaintext
type in (Issue, Task)
```
- List all merge requests assigned to the current user:
```plaintext
type = MergeRequest and assignee = currentUser()
```
- List all epics authored by the current user in the group `gitlab-org`
```plaintext
group = "gitlab-org" and type = Epic and author = currentUser()
```
### Updated at
{{< history >}}
- Alias `updatedAt` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
- Support for querying epics by last updated [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by when they were last updated.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all issues that haven't been edited in the last 1 month:
```plaintext
updated < -1m
```
- List all issues that were edited today:
```plaintext
updated = today()
```
- List all open MRs that haven't been edited in the last 1 week:
```plaintext
type = MergeRequest and state = opened and updated < -1w
```
### Weight
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
**Description**: Query issues by their weight.
**Allowed value types**:
- `Number` (only positive integers or 0)
- `Nullable` (either of `null`, `none`, or `any`)
**Additional details**:
- Comparison operators `<` and `>` cannot be used.
**Examples**:
- List all issues with weight 5:
```plaintext
weight = 5
```
- List all issues with weight not 5:
```plaintext
weight != 5
```
## Fields in embedded views
{{< history >}}
- Field `iteration` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-haskell/-/issues/74) in GitLab 17.6.
- Support for merge requests [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Field `lastComment` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/512154) in GitLab 17.11.
- Support for epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
- Fields `status`, `sourceBranch`, `targetBranch`, `sourceProject`, and `targetProject` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197407) in GitLab 18.2.
- Fields `health`, and `type` in epics [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
- Field `subscribed` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/223) in GitLab 18.3.
{{< /history >}}
In embedded views, the `fields` view parameter is a comma-separated list of fields, or field functions that
can be used to indicate what fields to include in the rendered embedded view,
for example, `fields: title, state, health, epic, milestone, weight, updated`.
| Field | Name or alias | Objects supported | Description |
| ---------------- | ------------------------------------- | ----------------------------- | ----------- |
| Approved by user | `approver`, `approvers`, `approvedBy` | Merge requests | Display users who approved the merge request |
| Assignees | `assignee`, `assignees` | Issues, merge requests | Display users assigned to the object |
| Author | `author` | Issues, epics, merge requests | Display the author of the object |
| Closed at | `closed`, `closedAt` | Issues, epics, merge requests | Display time since the object was closed |
| Confidential | `confidential` | Issues, epics | Display `Yes` or `No` indicating whether the object is confidential |
| Created at | `created`, `createdAt` | Issues, epics, merge requests | Display time since the object was created |
| Deployed at | `deployed`, `deployedAt` | Merge requests | Display time since the merge request was deployed |
| Description | `description` | Issues, epics, merge requests | Display the description of the object |
| Draft | `draft` | Merge requests | Display `Yes` or `No` indicating whether the merge request is in draft state |
| Due date | `due`, `dueDate` | Issues, epics | Display time until the object is due |
| Epic | `epic` | Issues | Display a link to the epic for the issue. Available in the Premium and Ultimate tier |
| Health status | `health`, `healthStatus` | Issues, epics | Display a badge indicating the health status of the object. Available in the Ultimate tier |
| ID | `id` | Issues, epics, merge requests | Display the ID of the object |
| Iteration | `iteration` | Issues | Display the iteration associated with the object. Available in the Premium and Ultimate tier |
| Labels | `label`, `labels` | Issues, epics, merge requests | Display labels associated with the object. Can accept parameters to filter specific labels, for example `labels("workflow::*", "backend")` |
| Last comment | `lastComment` | Issues, epics, merge requests | Display the last comment made on the object |
| Merged at | `merged`, `mergedAt` | Merge requests | Display time since the merge request was merged |
| Milestone | `milestone` | Issues, epics, merge requests | Display the milestone associated with the object |
| Reviewers | `reviewer`, `reviewers` | Merge requests | Display users assigned to review the merge request |
| Source branch | `sourceBranch` | Merge requests | Display the source branch of the merge request |
| Source project | `sourceProject` | Merge requests | Display the source project of the merge request |
| Start date | `start`, `startDate` | Epics | Display the start date of the epic |
| State | `state` | Issues, epics, merge requests | Display a badge indicating the state of the object. For issues and epics, values are `Open` or `Closed`. For merge requests, values are `Open`, `Closed`, or `Merged` |
| Status | `status` | Issues | Display a badge indicating the status of the issue. For example, "To do" or "Complete". Available in the Premium and Ultimate tiers. |
| Subscribed | `subscribed` | Issues, epics, merge requests | Display `Yes` or `No` indicating whether the current user is subscribed to the object or not |
| Target branch | `targetBranch` | Merge requests | Display the target branch of the merge request |
| Target project | `targetProject` | Merge requests | Display the target project of the merge request |
| Title | `title` | Issues, epics, merge requests | Display the title of the object |
| Type | `type` | Issues, epics | Display the work item type, for example `Issue`, `Task`, or `Objective` |
| Updated at | `updated`, `updatedAt` | Issues, epics, merge requests | Display time since the object was last updated |
| Weight | `weight` | Issues | Display the weight of the object. Available in the Premium and Ultimate tiers. |
## Fields to sort embedded views by
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/178) in GitLab 18.2.
- Support for sorting epics by health status [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
{{< /history >}}
In embedded views, the `sort` view parameter is a field name followed by
a sort order (`asc` or `desc`) that sorts the results by the specified
field and order.
| Field | Name (and alias) | Supported for | Description |
|---------------|--------------------------|-------------------------------|-------------------------------------------------|
| Closed at | `closed`, `closedAt` | Issues, epics, merge requests | Sort by closed date |
| Created | `created`, `createdAt` | Issues, epics, merge requests | Sort by created date |
| Due date | `due`, `dueDate` | Issues, epics | Sort by due date |
| Health status | `health`, `healthStatus` | Issues, epics | Sort by health status |
| Merged at | `merged`, `mergedAt` | Merge requests | Sort by merge date |
| Milestone | `milestone` | Issues, merge requests | Sort by milestone due date |
| Popularity | `popularity` | Issues, epics, merge requests | Sort by the number of thumbs up emoji reactions |
| Start date | `start`, `startDate` | Epics | Sort by start date |
| Title | `title` | Issues, epics, merge requests | Sort by title |
| Updated at | `updated`, `updatedAt` | Issues, epics, merge requests | Sort by last updated date |
| Weight | `weight` | Issues | Sort by weight |
**Examples**:
- List all issues in the `gitlab-org/gitlab` project sorted by title. Display columns
`state`, `title`, and `updated`.
````yaml
```glql
display: table
fields: state, title, updated
sort: title asc
query: project = "gitlab-org/gitlab" and type = Issue
```
````
- List all merge requests in the `gitlab-org` group assigned to the
authenticated user sorted by the merge date (latest first). Display columns
`title`, `reviewer`, and `merged`.
````yaml
```glql
display: table
fields: title, reviewer, merged
sort: merged desc
query: group = "gitlab-org" and type = MergeRequest and state = merged and author = currentUser()
limit: 10
```
````
- List all epics in the `gitlab-org` group sorted by the start date (oldest
first). Display columns `title`, `state`, and `startDate`.
````yaml
```glql
display: table
fields: title, state, startDate
sort: startDate asc
query: group = "gitlab-org" and type = Epic
```
````
- List all issues in the `gitlab-org` group with an assigned weight sorted by
the weight (highest first). Display columns `title`, `weight`, and `health`.
````yaml
```glql
display: table
fields: title, weight, health
sort: weight desc
query: group = "gitlab-org" and weight = any
```
````
- List all issues in the `gitlab-org` group due up to a week from today sorted by the due
date (earliest first). Display columns `title`, `duedate`, and `assignee`.
````yaml
```glql
display: table
fields: title, dueDate, assignee
sort: dueDate asc
query: group = "gitlab-org" and due >= today() and due <= 1w
```
````
## Troubleshooting
### Query timeout errors
You might encounter these error messages:
```plaintext
Embedded view timed out. Add more filters to reduce the number of results.
```
```plaintext
Query temporarily blocked due to repeated timeouts. Please try again later or try narrowing your search scope.
```
These errors occur when your query takes too long to execute.
Large result sets and broad searches can cause timeouts.
To resolve this issue, add filters to limit your search scope:
- Add time range filters to limit results to a specific period, by using date fields like `created`, `updated`, or `closed`.
For example:
````yaml
```glql
display: table
fields: title, labels, created
query: group = "gitlab-org" and label = "group::knowledge" and created > "2025-01-01" and created < "2025-03-01"
```
````
- Filter by recent updates to focus on active items:
````yaml
```glql
display: table
fields: title, labels, updated
query: group = "gitlab-org" and label = "group::knowledge" and updated > -3m
```
````
- Use project-specific queries instead of group-wide searches when possible:
````yaml
```glql
display: table
fields: title, state, assignee
query: project = "gitlab-org/gitlab" and state = opened and updated > -1m
```
````
|
---
stage: Plan
group: Knowledge
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GLQL fields
breadcrumbs:
- doc
- user
- glql
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14767) in GitLab 17.4 [with a flag](../../administration/feature_flags/_index.md) named `glql_integration`. Disabled by default.
- Enabled on GitLab.com in GitLab 17.4 for a subset of groups and projects.
- Promoted to [beta](../../policy/development_stages_support.md#beta) status in GitLab 17.10.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/476990) from experiment to beta in GitLab 17.10.
- Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated in GitLab 17.10.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/554870) in GitLab 18.3. Feature flag `glql_integration` removed.
{{< /history >}}
With GitLab Query Language (GLQL), fields are used to:
- Filter the results returned from a [GLQL query](_index.md#query-syntax).
- Control the details displayed in an [embedded view](_index.md#presentation-syntax).
- Sort the results displayed in an embedded view.
You use fields in three embedded view parameters:
- **`query`** - Set conditions to determine which items to retrieve
- **`fields`** - Specify which columns and details appear in your view
- **`sort`** - Order items by specific criteria
The following sections describe the available fields for each component.
## Fields inside query
In an embedded view, the `query` parameter can be used to include one or more expressions of the
format `<field> <operator> <value>`. Multiple expressions are joined with `and`,
for example, `group = "gitlab-org" and author = currentUser()`.
Prerequisites:
- Querying epics is available in the Premium and Ultimate tier.
The table below provides an overview of all available query fields and their specifications:
| Field | Name (and alias) | Operators | Supported for |
| --------------------------------------- | -------------------------------------------- | ------------------------- | ------------- |
| [Approved by user](#approved-by-user) | `approver`, `approvedBy`, `approvers` | `=`, `!=` | Merge requests |
| [Assignees](#assignees) | `assignee`, `assignees` | `=`, `in`, `!=` | Issues, epics, merge requests |
| [Author](#author) | `author` | `=`, `in`, `!=` | Issues, epics, merge requests |
| [Cadence](#cadence) | `cadence` | `=`, `in` | Issues |
| [Closed at](#closed-at) | `closed`, `closedAt` | `=`, `>`, `<`, `>=`, `<=` | Issues, epics |
| [Confidential](#confidential) | `confidential` | `=`, `!=` | Issues, epics |
| [Created at](#created-at) | `created`, `createdAt`, `opened`, `openedAt` | `=`, `>`, `<`, `>=`, `<=` | Issues, epics, merge requests |
| [Custom field](#custom-field) | `customField("Field name")` | `=` | Issues, epics |
| [Deployed at](#deployed-at) | `deployed`, `deployedAt` | `=`, `>`, `<`, `>=`, `<=` | Merge requests |
| [Draft](#draft) | `draft` | `=`, `!=` | Merge requests |
| [Due date](#due-date) | `due`, `dueDate` | `=`, `>`, `<`, `>=`, `<=` | Issues, epics |
| [Environment](#environment) | `environment` | `=` | Merge requests |
| [Epic](#epic) | `epic` | `=`, `!=` | Issues |
| [Group](#group) | `group` | `=` | Issues, epics, merge requests |
| [Health status](#health-status) | `health`, `healthStatus` | `=`, `!=` | Issues, epics |
| [ID](#id) | `id` | `=`, `in` | Issues, epics, merge requests |
| [Include subgroups](#include-subgroups) | `includeSubgroups` | `=`, `!=` | Issues, epics, merge requests |
| [Iteration](#iteration) | `iteration` | `=`, `in`, `!=` | Issues |
| [Labels](#labels) | `label`, `labels` | `=`, `in`, `!=` | Issues, epics, merge requests |
| [Merged at](#merged-at) | `merged`, `mergedAt` | `=`, `>`, `<`, `>=`, `<=` | Merge requests |
| [Merged by user](#merged-by-user) | `merger`, `mergedBy` | `=` | Merge requests |
| [Milestone](#milestone) | `milestone` | `=`, `in`, `!=` | Issues, epics, merge requests |
| [My reaction emoji](#my-reaction-emoji) | `myReaction`, `myReactionEmoji` | `=`, `!=` | Issues, epics, merge requests |
| [Project](#project) | `project` | `=` | Issues, merge requests |
| [Reviewers](#reviewers) | `reviewer`, `reviewers`, `reviewedBy` | `=`, `!=` | Merge requests |
| [Source branch](#source-branch) | `sourceBranch` | `=`, `in`, `!=` | Merge requests |
| [State](#state) | `state` | `=` | Issues, epics, merge requests |
| [Status](#status) | `status` | `=` | Issues |
| [Subscribed](#subscribed) | `subscribed` | `=`, `!=` | Issues, epics, merge requests |
| [Target branch](#target-branch) | `targetBranch` | `=`, `in`, `!=` | Merge requests |
| [Type](#type) | `type` | `=`, `in` | Issues, epics, merge requests |
| [Updated at](#updated-at) | `updated`, `updatedAt` | `=`, `>`, `<`, `>=`, `<=` | Issues, epics, merge requests |
| [Weight](#weight) | `weight` | `=`, `!=` | Issues |
### Approved by user
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Aliases `approvedBy` and `approvers` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Support for `Nullable` values [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/221) in GitLab 18.3.
{{< /history >}}
**Description**: Query merge requests by one or more users who approved the merge request.
**Allowed value types**:
- `String`
- `User` (for example, `@username`)
- `List` (containing `String` or `User` values)
- `Nullable` (either of `null`, `none`, or `any`)
**Examples**:
- List all merge requests approved by current user and `@johndoe`
```plaintext
type = MergeRequest and approver = (currentUser(), @johndoe)
```
- List all merge requests that are not yet approved
```plaintext
type = MergeRequest and approver = none
```
### Assignees
{{< history >}}
- Alias `assignees` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Support for querying epics by assignees [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by one or more users who are assigned to them.
**Allowed value types**:
- `String`
- `User` (for example, `@username`)
- `List` (containing `String` or `User` values)
- `Nullable` (either of `null`, `none`, or `any`)
**Additional details**:
- `List` values and the `in` operator are not supported for `MergeRequest` types.
**Examples**:
- List all issues where assignee is `@johndoe`:
```plaintext
assignee = @johndoe
```
- List all issues where assignees are both `@johndoe` and `@janedoe`:
```plaintext
assignee = (@johndoe, @janedoe)
```
- List all issues where assignees are either of `@johndoe` or `@janedoe`:
```plaintext
assignee in (@johndoe, @janedoe)
```
- List all issues where assignee is neither of `@johndoe` or `@janedoe`:
```plaintext
assignee != (@johndoe, @janedoe)
```
- List all merge requests where assignee is `@johndoe`:
```plaintext
type = MergeRequest and assignee = @johndoe
```
### Author
{{< history >}}
- Support for querying epics by author [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
- Support for `in` operator [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/221) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by their author.
**Allowed value types**:
- `String`
- `User` (for example, `@username`)
- `List` (containing `String` or `User` values)
**Additional details:**
- The `in` operator is not supported for `MergeRequest` types.
**Examples**:
- List all issues where author is `@johndoe`:
```plaintext
author = @johndoe
```
- List all epics where author is either `@johndoe` or `@janedoe`:
```plaintext
type = Epic and author in (@johndoe, @janedoe)
```
- List all merge requests where author is `@johndoe`:
```plaintext
type = MergeRequest and author = @johndoe
```
### Cadence
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-haskell/-/issues/74) in GitLab 17.6.
{{< /history >}}
**Description**: Query issues by the [cadence](../group/iterations/_index.md#iteration-cadences) that the issue's iteration is a part of.
**Allowed value types**:
- `Number` (only positive integers)
- `List` (containing `Number` values)
- `Nullable` (either of `none`, or `any`)
**Additional details**:
- Because an issue can have only one iteration, the `=` operator cannot be used with `List` type for the `cadence` field.
**Examples**:
- List all issues with iteration that are a part of cadence ID `123456`:
```plaintext
cadence = 123456
```
- List all issues with iterations that are a part of any cadences `123` or `456`:
```plaintext
cadence in (123, 456)
```
### Closed at
{{< history >}}
- Alias `closedAt` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
- Support for querying epics by closed date [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues or epics by the date when they were closed.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all issues closed since yesterday:
```plaintext
closed > -1d
```
- List all issues closed today:
```plaintext
closed = today()
```
- List all issues closed in the month of February 2023:
```plaintext
closed > 2023-02-01 and closed < 2023-02-28
```
### Confidential
{{< history >}}
- Support for querying epics by their confidentiality [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues or epics by their visibility to project members.
**Allowed value types**:
- `Boolean` (either of `true` or `false`)
**Additional details**:
- Confidential issues queried using GLQL are only visible to people who have permission to view them.
**Examples**:
- List all confidential issues:
```plaintext
confidential = true
```
- List all issues that are not confidential:
```plaintext
confidential = false
```
### Created at
{{< history >}}
- Aliases `createdAt`, `opened`, and `openedAt` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
- Support for querying epics by creation date [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by the date when they were created.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all issues that were created in the last week:
```plaintext
created > -1w
```
- List all issues created today:
```plaintext
created = today()
```
- List all issues created in the month of January 2025 that are still open:
```plaintext
created > 2025-01-01 and created < 2025-01-31 and state = opened
```
### Custom field
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/233) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues or epics by [custom fields](../work_items/custom_fields.md).
**Allowed value types**:
- `String` (for single-select custom fields)
- `List` (of `String`, for multi-select custom fields)
**Additional details**:
- Custom field names and values are not case-sensitive.
**Examples**
- List all issues where the single-select "Subscription" custom field is set to "Free":
```plaintext
customField("Subscription") = "Free"
```
- List all issues where the single-select "Subscription" and "Team" custom fields are set to
"Free" and "Engineering" respectively:
```plaintext
customField("Subscription") = "Free" and customField("Team") = "Engineering"
```
- List all issues where the multi-select "Category" custom field is set to "Markdown" and "Text Editors":
```plaintext
customField("Category") = ("Markdown", "Text Editors")
```
Alternatively:
```plaintext
customField("Category") = "Markdown" and customField("Category") = "Text Editors"
```
### Deployed at
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Alias `deployedAt` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
{{< /history >}}
**Description**: Query merge requests by the date when they were deployed.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all merge requests that have been deployed in the past week:
```plaintext
type = MergeRequest and deployed > -1w
```
- List all merge requests that have been deployed in the month of January 2025:
```plaintext
type = MergeRequest and deployed > 2025-01-01 and deployed < 2025-01-31
```
### Draft
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
{{< /history >}}
**Description**: Query merge requests by their draft status.
**Allowed value types**:
- `Boolean` (either of `true` or `false`)
**Examples**:
- List all draft merge requests:
```plaintext
type = MergeRequest and draft = true
```
- List all merge requests that are not in draft state:
```plaintext
type = MergeRequest and draft = false
```
### Due date
{{< history >}}
- Alias `dueDate` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
- Support for querying epics by due date [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues or epics by the date when they are due.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all issues due in a week:
```plaintext
due < 1w
```
- List all issues that were overdue as of January 1, 2025:
```plaintext
due < 2025-01-01
```
- List all issues that are due today (but not due yesterday or tomorrow):
```plaintext
due = today()
```
- List all issues that have been overdue in the last 1 month:
```plaintext
due > -1m and due < today()
```
### Environment
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
{{< /history >}}
**Description**: Query merge requests by the environment to which they have been deployed.
**Allowed value types**: `String`
**Examples**:
- List all merge requests that have been deployed to environment `production`:
```plaintext
environment = "production"
```
### Epic
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/issues/30) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues by their parent epic ID or reference.
**Allowed value types**:
- `Number` (epic ID)
- `String` (containing an epic reference like `&123`)
- `Epic` (for example, `&123`, `gitlab-org&123`)
**Examples**:
- List all issues that have epic `&123` as their parent in project `gitlab-org/gitlab`:
```plaintext
project = "gitlab-org/gitlab" and epic = &123
```
- List all issues that have epic `gitlab-com&123` as their parent in project `gitlab-org/gitlab`:
```plaintext
project = "gitlab-org/gitlab" and epic = gitlab-com&123
```
### Group
**Description**: Query issues, epics, or merge requests within all projects in a given group.
**Allowed value types**: `String`
**Additional details**:
- Only one group can be queried at a time.
- The `group` cannot be used together with the `project` field.
- If omitted when using inside an embedded view in a group object (like an epic), `group` is assumed to
be the current group.
- Using the `group` field queries all objects in that group, all its subgroups, and child projects.
- By default, issues or merge requests are searched in all descendant projects across all subgroups.
To query only the direct child projects of the group, set the [`includeSubgroups` field](#include-subgroups) to `false`.
**Examples**:
- List all issues in the `gitlab-org` group and any of its subgroups:
```plaintext
group = "gitlab-org"
```
- List all Tasks in the `gitlab-org` group and any of its subgroups:
```plaintext
group = "gitlab-org" and type = Task
```
### Health status
{{< details >}}
- Tier: Ultimate
{{< /details >}}
{{< history >}}
- Alias `healthStatus` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Support for querying epics by health status [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues or epics by their health status.
**Allowed value types**:
- `StringEnum` (one of `"needs attention"`, `"at risk"` or `"on track"`)
- `Nullable` (either of `null`, `none`, or `any`)
**Examples**:
- List all issues that don't have a health status set:
```plaintext
health = any
```
- List all issues where the health status is "needs attention":
```plaintext
health = "needs attention"
```
### ID
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/92) in GitLab 17.8.
- Support for querying epics by ID [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by their IDs.
**Allowed value types**:
- `Number` (only positive integers)
- `List` (containing `Number` values)
**Examples**:
- List issue with ID `123`:
```plaintext
id = 123
```
- List issues with IDs `1`, `2`, or `3`:
```plaintext
id in (1, 2, 3)
```
- List all merge requests with IDs `1`, `2`, or `3`:
```plaintext
type = MergeRequest and id in (1, 2, 3)
```
### Include subgroups
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/106) in GitLab 17.10.
- Support for this field to be used with epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests within the entire hierarchy of a group.
**Allowed value types**:
- `Boolean` (either of `true` or `false`)
**Additional details**:
- This field can only be used with the `group` field.
- The value of this field defaults to `false`.
**Examples**:
- List issues in any project that is a direct child of the `gitlab-org` group:
```plaintext
group = "gitlab-org" and includeSubgroups = false
```
- List issues in any project within the entire hierarchy of the `gitlab-org` group:
```plaintext
group = "gitlab-org" and includeSubgroups = true
```
### Iteration
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-haskell/-/issues/74) in GitLab 17.6.
- Support for iteration value types [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/79) in GitLab 17.8.
{{< /history >}}
**Description**: Query issues by their associated [iteration](../group/iterations/_index.md).
**Allowed value types**:
- `Number` (only positive integers)
- `Iteration` (for example, `*iteration:123456`)
- `List` (containing `Number` or `Iteration` values)
- `Enum` (only `current` is supported)
- `Nullable` (either of `none`, or `any`)
**Additional details**:
- Because an issue can have only one iteration, the `=` operator cannot be used with `List` type for the `iteration` field.
- The `in` operator is not supported for `MergeRequest` types.
**Examples**:
- List all issues with iteration ID `123456` (using a number in the query):
```plaintext
iteration = 123456
```
- List all issues that are a part of iterations `123` or `456` (using numbers):
```plaintext
iteration in (123, 456)
```
- List all issues with iteration ID `123456` (using iteration syntax):
```plaintext
iteration = *iteration:123456
```
- List all issues that are a part of iterations `123` or `456` (using iteration syntax):
```plaintext
iteration in (*iteration:123, *iteration:456)
```
- List all issues in the current iteration
```plaintext
iteration = current
```
### Labels
{{< history >}}
- Support for label value types [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/79) in GitLab 17.8.
- Alias `labels` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Support for querying epics by labels [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by their associated labels.
**Allowed value types**:
- `String`
- `Label` (for example, `~bug`, `~"team::planning"`)
- `List` (containing `String` or `Label` values)
- `Nullable` (either of `none`, or `any`)
**Additional details**:
- Scoped labels, or labels containing spaces must be wrapped in quotes.
- The `in` operator is not supported for `MergeRequest` types.
**Examples**:
- List all issues with label `~bug`:
```plaintext
label = ~bug
```
- List all issues not having label `~"workflow::in progress"`:
```plaintext
label != ~"workflow::in progress"
```
- List all issues with labels `~bug` and `~"team::planning"`:
```plaintext
label = (~bug, ~"team::planning")
```
- List all issues with labels `~bug` or `~feature`:
```plaintext
label in (~bug, ~feature)
```
- List all issues where the labels include neither of `~bug` or `~feature`:
```plaintext
label != (~bug, ~feature)
```
- List all issues where none of the scoped labels apply, with scope `workflow::`:
```plaintext
label != ~"workflow::*"
```
- List all merge requests with labels `~bug` and `~"team::planning"`
```plaintext
type = MergeRequest and label = (~bug, ~"team::planning")
```
### Merged at
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Alias `mergedAt` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
{{< /history >}}
**Description**: Query merge requests by the date when they were merged.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all merge requests that have been merged in the last 6 months:
```plaintext
type = MergeRequest and merged > -6m
```
- List all merge requests that have been merged in the month of January 2025:
```plaintext
type = MergeRequest and merged > 2025-01-01 and merged < 2025-01-31
```
### Merged by user
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Alias `mergedBy` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
{{< /history >}}
**Description**: Query merge requests by the user that merged the merge request.
**Allowed value types**:
- `String`
- `User` (for example, `@username`)
**Examples**:
- List all merge requests merged by the current user:
```plaintext
type = MergeRequest and merger = currentUser()
```
### Milestone
{{< history >}}
- Support for milestone value types [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/77) in GitLab 17.8.
- Support for querying epics by milestone [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by their associated milestone.
**Allowed value types**:
- `String`
- `Milestone` (for example, `%Backlog`, `%"Awaiting Further Demand"`)
- `List` (containing `String` or `Milestone` values)
- `Nullable` (either of `none`, or `any`)
**Additional details**:
- Milestones containing spaces must be wrapped in quotes (`"`).
- Because an issue can have only one milestone, the `=` operator cannot be used with `List` type for the `milestone` field.
- The `in` operator is not supported for `MergeRequest` and `Epic` types.
- The `Epic` type does not support wildcard milestone filters like `none` or `any`.
**Examples**:
- List all issues with milestone `%Backlog`:
```plaintext
milestone = %Backlog
```
- List all issues with milestones `%17.7` or `%17.8`:
```plaintext
milestone in (%17.7, %17.8)
```
- List all issues in an upcoming milestone:
```plaintext
milestone = upcoming
```
- List all issues in a current milestone:
```plaintext
milestone = started
```
- List all issues where the milestone is neither of `%17.7` or `%17.8`:
```plaintext
milestone != (%17.7, %17.8)
```
### My reaction emoji
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/223) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by the current user's [emoji reaction](../emoji_reactions.md) on it.
**Allowed value types**: `String`
**Examples**:
- List all issues where the current user reacted with the thumbs-up emoji:
```plaintext
myReaction = "thumbsup"
```
- List all merge requests where the current user did not react with the thumbs-down emoji:
```plaintext
type = MergeRequest and myReaction != "thumbsdown"
```
### Project
**Description**: Query issues or merge requests within a particular project.
**Allowed value types**: `String`
**Additional details**:
- Only one project can be queried at a time.
- The `project` field cannot be used together with the `group` field.
- If omitted when using inside an embedded view, `project` is assumed to be the current project.
**Examples**:
- List all issues and work items in the `gitlab-org/gitlab` project:
```plaintext
project = "gitlab-org/gitlab"
```
### Reviewers
{{< history >}}
- Aliases `reviewers` and `reviewedBy` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
{{< /history >}}
**Description**: Query merge requests that were reviewed by one or more users.
**Allowed value types**:
- `String`
- `User` (for example, `@username`)
- `Nullable` (either of `null`, `none`, or `any`)
**Examples**:
- List all merge requests reviewed by current user:
```plaintext
type = MergeRequest and reviewer = currentUser()
```
### Source branch
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197407) in GitLab 18.2.
{{< /history >}}
**Description:** Query merge requests by their source branch.
**Allowed value types:** `String`, `List`
**Additional details**:
- `List` values are only supported with the `in` and `!=` operators.
**Examples**:
- List all merge requests from a specific branch:
```plaintext
type = MergeRequest and sourceBranch = "feature/new-feature"
```
- List all merge requests from multiple branches:
```plaintext
type = MergeRequest and sourceBranch in ("main", "develop")
```
- List all merge requests that are not from a specific branch:
```plaintext
type = MergeRequest and sourceBranch != "main"
```
### State
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/96) in GitLab 17.8.
- Support for querying epics by state [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by state.
**Allowed value types**:
- `Enum`
- For issue and work item types, one of `opened`, `closed`, or `all`
- For `MergeRequest` types, one of `opened`, `closed`, `merged`, or `all`
**Additional details**:
- The `state` field does not support the `!=` operator.
**Examples**:
- List all closed issues:
```plaintext
state = closed
```
- List all open issues:
```plaintext
state = opened
```
- List all issues regardless of their state (also the default):
```plaintext
state = all
```
- List all merged merge requests:
```plaintext
type = MergeRequest and state = merged
```
### Status
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197407) in GitLab 18.2.
{{< /history >}}
**Description:** Query issues by their status.
**Allowed value types:** `String`
**Examples**:
- List all issues with status "To do":
```plaintext
status = "To do"
```
### Subscribed
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/223) in GitLab 18.3.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by whether the current user has
[set notifications](../profile/notifications.md)
on or off.
**Allowed value types**: `Boolean`
**Examples**:
- List all open issues where the current user has set notifications on:
```plaintext
state = opened and subscribed = true
```
- List all merge requests where the current user has set notifications off:
```plaintext
type = MergeRequest and subscribed = false
```
### Target branch
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197407) in GitLab 18.2.
{{< /history >}}
**Description:** Query merge requests by their target branch.
**Allowed value types:** `String`, `List`
**Additional details**:
- `List` values are only supported with the `in` and `!=` operators.
**Examples**:
- List all merge requests targeting a specific branch:
```plaintext
type = MergeRequest and targetBranch = "feature/new-feature"
```
- List all merge requests targeting multiple branches:
```plaintext
type = MergeRequest and targetBranch in ("main", "develop")
```
- List all merge requests that are not targeting a specific branch:
```plaintext
type = MergeRequest and targetBranch != "main"
```
### Type
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Support for querying epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: The type of object to query: issues, epics, or merge requests.
**Allowed value types**:
- `Enum`, one of:
- `Issue`
- `Incident`
- `Epic`
- `TestCase`
- `Requirement`
- `Task`
- `Ticket`
- `Objective`
- `KeyResult`
- `MergeRequest`
- `List` (containing one or more `enum` values)
**Additional details**:
- If omitted when used inside an embedded view, the default `type` is `Issue`.
- `type = Epic` queries can only be used together with the [group](#group) field.
- The `in` operator cannot be used to combine `Epic` and `MergeRequest` types with other types
in the same query.
**Examples**:
- List incidents:
```plaintext
type = incident
```
- List issues and tasks:
```plaintext
type in (Issue, Task)
```
- List all merge requests assigned to the current user:
```plaintext
type = MergeRequest and assignee = currentUser()
```
- List all epics authored by the current user in the group `gitlab-org`
```plaintext
group = "gitlab-org" and type = Epic and author = currentUser()
```
### Updated at
{{< history >}}
- Alias `updatedAt` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/137) in GitLab 18.0.
- Operators `>=` and `<=` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/work_items/58) in GitLab 18.0.
- Support for querying epics by last updated [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
{{< /history >}}
**Description**: Query issues, epics, or merge requests by when they were last updated.
**Allowed value types**:
- `AbsoluteDate` (in the format `YYYY-MM-DD`)
- `RelativeDate` (in the format `<sign><digit><unit>`, where sign is `+`, `-`, or omitted,
digit is an integer, and `unit` is one of `d` (days), `w` (weeks), `m` (months) or `y` (years))
**Additional details**:
- For the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
- `>=` and `<=` operators are inclusive of the dates being queried, whereas `>` and `<` are not.
**Examples**:
- List all issues that haven't been edited in the last 1 month:
```plaintext
updated < -1m
```
- List all issues that were edited today:
```plaintext
updated = today()
```
- List all open MRs that haven't been edited in the last 1 week:
```plaintext
type = MergeRequest and state = opened and updated < -1w
```
### Weight
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
**Description**: Query issues by their weight.
**Allowed value types**:
- `Number` (only positive integers or 0)
- `Nullable` (either of `null`, `none`, or `any`)
**Additional details**:
- Comparison operators `<` and `>` cannot be used.
**Examples**:
- List all issues with weight 5:
```plaintext
weight = 5
```
- List all issues with weight not 5:
```plaintext
weight != 5
```
## Fields in embedded views
{{< history >}}
- Field `iteration` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-haskell/-/issues/74) in GitLab 17.6.
- Support for merge requests [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/491246) in GitLab 17.8.
- Field `lastComment` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/512154) in GitLab 17.11.
- Support for epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192680) in GitLab 18.1.
- Fields `status`, `sourceBranch`, `targetBranch`, `sourceProject`, and `targetProject` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197407) in GitLab 18.2.
- Fields `health`, and `type` in epics [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
- Field `subscribed` [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/223) in GitLab 18.3.
{{< /history >}}
In embedded views, the `fields` view parameter is a comma-separated list of fields, or field functions that
can be used to indicate what fields to include in the rendered embedded view,
for example, `fields: title, state, health, epic, milestone, weight, updated`.
| Field | Name or alias | Objects supported | Description |
| ---------------- | ------------------------------------- | ----------------------------- | ----------- |
| Approved by user | `approver`, `approvers`, `approvedBy` | Merge requests | Display users who approved the merge request |
| Assignees | `assignee`, `assignees` | Issues, merge requests | Display users assigned to the object |
| Author | `author` | Issues, epics, merge requests | Display the author of the object |
| Closed at | `closed`, `closedAt` | Issues, epics, merge requests | Display time since the object was closed |
| Confidential | `confidential` | Issues, epics | Display `Yes` or `No` indicating whether the object is confidential |
| Created at | `created`, `createdAt` | Issues, epics, merge requests | Display time since the object was created |
| Deployed at | `deployed`, `deployedAt` | Merge requests | Display time since the merge request was deployed |
| Description | `description` | Issues, epics, merge requests | Display the description of the object |
| Draft | `draft` | Merge requests | Display `Yes` or `No` indicating whether the merge request is in draft state |
| Due date | `due`, `dueDate` | Issues, epics | Display time until the object is due |
| Epic | `epic` | Issues | Display a link to the epic for the issue. Available in the Premium and Ultimate tier |
| Health status | `health`, `healthStatus` | Issues, epics | Display a badge indicating the health status of the object. Available in the Ultimate tier |
| ID | `id` | Issues, epics, merge requests | Display the ID of the object |
| Iteration | `iteration` | Issues | Display the iteration associated with the object. Available in the Premium and Ultimate tier |
| Labels | `label`, `labels` | Issues, epics, merge requests | Display labels associated with the object. Can accept parameters to filter specific labels, for example `labels("workflow::*", "backend")` |
| Last comment | `lastComment` | Issues, epics, merge requests | Display the last comment made on the object |
| Merged at | `merged`, `mergedAt` | Merge requests | Display time since the merge request was merged |
| Milestone | `milestone` | Issues, epics, merge requests | Display the milestone associated with the object |
| Reviewers | `reviewer`, `reviewers` | Merge requests | Display users assigned to review the merge request |
| Source branch | `sourceBranch` | Merge requests | Display the source branch of the merge request |
| Source project | `sourceProject` | Merge requests | Display the source project of the merge request |
| Start date | `start`, `startDate` | Epics | Display the start date of the epic |
| State | `state` | Issues, epics, merge requests | Display a badge indicating the state of the object. For issues and epics, values are `Open` or `Closed`. For merge requests, values are `Open`, `Closed`, or `Merged` |
| Status | `status` | Issues | Display a badge indicating the status of the issue. For example, "To do" or "Complete". Available in the Premium and Ultimate tiers. |
| Subscribed | `subscribed` | Issues, epics, merge requests | Display `Yes` or `No` indicating whether the current user is subscribed to the object or not |
| Target branch | `targetBranch` | Merge requests | Display the target branch of the merge request |
| Target project | `targetProject` | Merge requests | Display the target project of the merge request |
| Title | `title` | Issues, epics, merge requests | Display the title of the object |
| Type | `type` | Issues, epics | Display the work item type, for example `Issue`, `Task`, or `Objective` |
| Updated at | `updated`, `updatedAt` | Issues, epics, merge requests | Display time since the object was last updated |
| Weight | `weight` | Issues | Display the weight of the object. Available in the Premium and Ultimate tiers. |
## Fields to sort embedded views by
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/178) in GitLab 18.2.
- Support for sorting epics by health status [introduced](https://gitlab.com/gitlab-org/gitlab-query-language/glql-rust/-/merge_requests/222) in GitLab 18.3.
{{< /history >}}
In embedded views, the `sort` view parameter is a field name followed by
a sort order (`asc` or `desc`) that sorts the results by the specified
field and order.
| Field | Name (and alias) | Supported for | Description |
|---------------|--------------------------|-------------------------------|-------------------------------------------------|
| Closed at | `closed`, `closedAt` | Issues, epics, merge requests | Sort by closed date |
| Created | `created`, `createdAt` | Issues, epics, merge requests | Sort by created date |
| Due date | `due`, `dueDate` | Issues, epics | Sort by due date |
| Health status | `health`, `healthStatus` | Issues, epics | Sort by health status |
| Merged at | `merged`, `mergedAt` | Merge requests | Sort by merge date |
| Milestone | `milestone` | Issues, merge requests | Sort by milestone due date |
| Popularity | `popularity` | Issues, epics, merge requests | Sort by the number of thumbs up emoji reactions |
| Start date | `start`, `startDate` | Epics | Sort by start date |
| Title | `title` | Issues, epics, merge requests | Sort by title |
| Updated at | `updated`, `updatedAt` | Issues, epics, merge requests | Sort by last updated date |
| Weight | `weight` | Issues | Sort by weight |
**Examples**:
- List all issues in the `gitlab-org/gitlab` project sorted by title. Display columns
`state`, `title`, and `updated`.
````yaml
```glql
display: table
fields: state, title, updated
sort: title asc
query: project = "gitlab-org/gitlab" and type = Issue
```
````
- List all merge requests in the `gitlab-org` group assigned to the
authenticated user sorted by the merge date (latest first). Display columns
`title`, `reviewer`, and `merged`.
````yaml
```glql
display: table
fields: title, reviewer, merged
sort: merged desc
query: group = "gitlab-org" and type = MergeRequest and state = merged and author = currentUser()
limit: 10
```
````
- List all epics in the `gitlab-org` group sorted by the start date (oldest
first). Display columns `title`, `state`, and `startDate`.
````yaml
```glql
display: table
fields: title, state, startDate
sort: startDate asc
query: group = "gitlab-org" and type = Epic
```
````
- List all issues in the `gitlab-org` group with an assigned weight sorted by
the weight (highest first). Display columns `title`, `weight`, and `health`.
````yaml
```glql
display: table
fields: title, weight, health
sort: weight desc
query: group = "gitlab-org" and weight = any
```
````
- List all issues in the `gitlab-org` group due up to a week from today sorted by the due
date (earliest first). Display columns `title`, `duedate`, and `assignee`.
````yaml
```glql
display: table
fields: title, dueDate, assignee
sort: dueDate asc
query: group = "gitlab-org" and due >= today() and due <= 1w
```
````
## Troubleshooting
### Query timeout errors
You might encounter these error messages:
```plaintext
Embedded view timed out. Add more filters to reduce the number of results.
```
```plaintext
Query temporarily blocked due to repeated timeouts. Please try again later or try narrowing your search scope.
```
These errors occur when your query takes too long to execute.
Large result sets and broad searches can cause timeouts.
To resolve this issue, add filters to limit your search scope:
- Add time range filters to limit results to a specific period, by using date fields like `created`, `updated`, or `closed`.
For example:
````yaml
```glql
display: table
fields: title, labels, created
query: group = "gitlab-org" and label = "group::knowledge" and created > "2025-01-01" and created < "2025-03-01"
```
````
- Filter by recent updates to focus on active items:
````yaml
```glql
display: table
fields: title, labels, updated
query: group = "gitlab-org" and label = "group::knowledge" and updated > -3m
```
````
- Use project-specific queries instead of group-wide searches when possible:
````yaml
```glql
display: table
fields: title, state, assignee
query: project = "gitlab-org/gitlab" and state = opened and updated > -1m
```
````
|
https://docs.gitlab.com/user/functions
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/functions.md
|
2025-08-13
|
doc/user/glql
|
[
"doc",
"user",
"glql"
] |
functions.md
|
Plan
|
Knowledge
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
GLQL functions
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14767) in GitLab 17.4 [with a flag](../../administration/feature_flags/_index.md) named `glql_integration`. Disabled by default.
- Enabled on GitLab.com in GitLab 17.4 for a subset of groups and projects.
- Promoted to [beta](../../policy/development_stages_support.md#beta) status in GitLab 17.10.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/476990) from experiment to beta in GitLab 17.10.
- Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated in GitLab 17.10.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/554870) in GitLab 18.3. Feature flag `glql_integration` removed.
{{< /history >}}
Use functions with [GitLab Query Language (GLQL)](_index.md) to create dynamic queries.
## Functions inside query
To make a query context-specific, use functions inside a [query](_index.md#query-syntax), for example,
by filtering by a current user or a date.
### Current user
**Function name**: `currentUser`
**Parameters**: None
**Syntax**: `currentUser()`
**Description**: Evaluates to the current authenticated user.
**Additional details**:
- Using this function in a query makes the query fail for users who are not authenticated.
**Examples**:
- List all issues where the current authenticated user is the assignee:
```plaintext
assignee = currentUser()
```
- List all merge requests where the current authenticated user is the assignee but not the author:
```plaintext
type = MergeRequest and assignee = currentUser() and author != currentUser()
```
### Today
**Function name**: `today`
**Parameters**: None
**Syntax**: `today()`
**Description**: Evaluates to today's date at 00:00 in the user's time zone.
**Additional details**:
- When used with the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
**Examples**:
- List all issues created today:
```plaintext
created = today()
```
- List all merge requests merged today:
```plaintext
type = MergeRequest and merged = today()
```
## Functions in embedded views
To derive a new column from an existing field of an [embedded view](_index.md#embedded-views), include
functions in the `fields` parameter.
### Extract labels into a new column
**Function name**: `labels`
**Parameters**: One or more `String` values
**Syntax**: `labels("field1", "field2")`
**Description**:
The `labels` function takes one or more label name string values as parameter,
and creates a filtered column with only those labels on issues.
The function also works as an extractor, so if a label has been extracted, it no longer shows up
in the regular `labels` column, if you choose to display that column as well.
**Additional details**:
- By default, this function looks for an exact match to the label name.
A wildcard character (`*`) in the string to match any character.
- A minimum of 1 and maximum of 100 label names can be passed to the `labels` function.
- Label names passed to this function are case-insensitive. For example, `Deliverable` and `deliverable` are equivalent.
**Examples**:
- Include all `workflow` scoped labels in the column:
```plaintext
labels("workflow::*")
```
- Include labels `Deliverable`, `Stretch`, and `Spike`:
```plaintext
labels("Deliverable", "Stretch", "Spike")
```
- Include all labels like `backend`, `frontend`, and others that end with `end`:
```plaintext
labels("*end")
```
To include the `labels` function in an embedded view:
````markdown
```glql
display: list
fields: title, health, due, labels("workflow::*"), labels
limit: 5
query: project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```
````
|
---
stage: Plan
group: Knowledge
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GLQL functions
breadcrumbs:
- doc
- user
- glql
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14767) in GitLab 17.4 [with a flag](../../administration/feature_flags/_index.md) named `glql_integration`. Disabled by default.
- Enabled on GitLab.com in GitLab 17.4 for a subset of groups and projects.
- Promoted to [beta](../../policy/development_stages_support.md#beta) status in GitLab 17.10.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/476990) from experiment to beta in GitLab 17.10.
- Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated in GitLab 17.10.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/554870) in GitLab 18.3. Feature flag `glql_integration` removed.
{{< /history >}}
Use functions with [GitLab Query Language (GLQL)](_index.md) to create dynamic queries.
## Functions inside query
To make a query context-specific, use functions inside a [query](_index.md#query-syntax), for example,
by filtering by a current user or a date.
### Current user
**Function name**: `currentUser`
**Parameters**: None
**Syntax**: `currentUser()`
**Description**: Evaluates to the current authenticated user.
**Additional details**:
- Using this function in a query makes the query fail for users who are not authenticated.
**Examples**:
- List all issues where the current authenticated user is the assignee:
```plaintext
assignee = currentUser()
```
- List all merge requests where the current authenticated user is the assignee but not the author:
```plaintext
type = MergeRequest and assignee = currentUser() and author != currentUser()
```
### Today
**Function name**: `today`
**Parameters**: None
**Syntax**: `today()`
**Description**: Evaluates to today's date at 00:00 in the user's time zone.
**Additional details**:
- When used with the `=` operator, the time range is considered from 00:00 to 23:59 in the user's time zone.
**Examples**:
- List all issues created today:
```plaintext
created = today()
```
- List all merge requests merged today:
```plaintext
type = MergeRequest and merged = today()
```
## Functions in embedded views
To derive a new column from an existing field of an [embedded view](_index.md#embedded-views), include
functions in the `fields` parameter.
### Extract labels into a new column
**Function name**: `labels`
**Parameters**: One or more `String` values
**Syntax**: `labels("field1", "field2")`
**Description**:
The `labels` function takes one or more label name string values as parameter,
and creates a filtered column with only those labels on issues.
The function also works as an extractor, so if a label has been extracted, it no longer shows up
in the regular `labels` column, if you choose to display that column as well.
**Additional details**:
- By default, this function looks for an exact match to the label name.
A wildcard character (`*`) in the string to match any character.
- A minimum of 1 and maximum of 100 label names can be passed to the `labels` function.
- Label names passed to this function are case-insensitive. For example, `Deliverable` and `deliverable` are equivalent.
**Examples**:
- Include all `workflow` scoped labels in the column:
```plaintext
labels("workflow::*")
```
- Include labels `Deliverable`, `Stretch`, and `Spike`:
```plaintext
labels("Deliverable", "Stretch", "Spike")
```
- Include all labels like `backend`, `frontend`, and others that end with `end`:
```plaintext
labels("*end")
```
To include the `labels` function in an embedded view:
````markdown
```glql
display: list
fields: title, health, due, labels("workflow::*"), labels
limit: 5
query: project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```
````
|
https://docs.gitlab.com/user/glql
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/_index.md
|
2025-08-13
|
doc/user/glql
|
[
"doc",
"user",
"glql"
] |
_index.md
|
Plan
|
Knowledge
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
GitLab Query Language (GLQL)
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14767) in GitLab 17.4 [with a flag](../../administration/feature_flags/_index.md) named `glql_integration`. Disabled by default.
- Enabled on GitLab.com in GitLab 17.4 for a subset of groups and projects.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/476990) from experiment to beta in GitLab 17.10.
- Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated in GitLab 17.10.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/554870) in GitLab 18.3. Feature flag `glql_integration` removed.
{{< /history >}}
GitLab Query Language (GLQL) is an attempt to create a single query language for all of GitLab.
Use it to filter and embed content from anywhere in the platform, using familiar syntax.
Embed queries in Markdown code blocks.
An embedded view is the rendered output of a GLQL source code block.
Share your feedback in the [GLQL beta feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/509791).
## Query syntax
The query syntax consists primarily of logical expressions. These expressions follow the
syntax of `<field> <operator> <value> and ...`.
### Fields
Field names can have values like `assignee`, `author`, `label`, and `milestone`.
A `type` field can be used to filter a query by the object type, like `Issue`, `MergeRequest`,
or work item types like `Task` or `Objective`.
For a full list of supported fields, supported operators, and value types, see [GLQL fields](fields.md).
### Operators
**Comparison operators**:
| GLQL operator | Description | Equivalent in search |
|---------------|-----------------------------------------|------------------------|
| `=` | Equals / Includes all in list | `is` (equal to) |
| `!=` | Doesn't equal / Isn't contained in list | `is not` (equal to) |
| `in` | Contained in list | `or` / `is one of` |
| `>` | Greater than | {{< icon name="dotted-circle" >}} No |
| `<` | Less than | {{< icon name="dotted-circle" >}} No |
| `>=` | Greater than or equal to | {{< icon name="dotted-circle" >}} No |
| `<=` | Less than or equal to | {{< icon name="dotted-circle" >}} No |
**Logical operators**: Only `and` is supported.
`or` is indirectly supported for some fields by using the `in` comparison operator.
### Values
Values can include:
- Strings
- Numbers
- Relative dates (like `-1d`, `2w`, `-6m`, or `1y`)
- Absolute dates (in `YYYY-MM-DD` format, like `2025-01-01`)
- Functions (like `currentUser()` for user fields or `today()` for dates)
- Enum values (like `upcoming` or `started` for milestones)
- Booleans (`true` or `false`)
- Nullable values (like `null`, `none`, or `any`)
- GitLab references (like `~label` for a label, `%Backlog` for a milestone, or `@username` for a user)
- Lists containing any of the previous values (surrounded by parenthesis: `()` and delimited by commas: `,`)
## Embedded views
An embedded view is the output of a GLQL source code block in Markdown. The source includes YAML
attributes that describe how to display the GLQL query results, along with the query.
### Supported areas
Embedded views can be displayed in the following areas:
- Group and project wikis
- Descriptions and comments of:
- Epics
- Issues
- Merge requests
- Work items (tasks, OKRs, or epics)
### Syntax
The syntax of an embedded view's source is a superset of YAML that consists of:
- The `query` parameter: Expressions joined together with a logical operator, such as `and`.
- Parameters related to the presentation layer, like `display`, `limit`, or `fields`, `title`, and `description`
represented as YAML.
A view is defined in Markdown as a code block, similar to other code blocks like Mermaid.
For example:
- Display a table of first 5 open issues assigned to the authenticated user in `gitlab-org/gitlab`.
- Display columns `title`, `state`, `health`, `description`, `epic`, `milestone`, `weight`, and `updated`.
````yaml
```glql
display: table
title: GLQL table 🎉
description: This view lists my open issues
fields: title, state, health, epic, milestone, weight, updated
limit: 5
query: project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```
````
This source should render a table like the one below:
#### Presentation syntax
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/508956) in GitLab 17.7: Configuring the presentation layer using YAML front matter is deprecated.
- `title` and `description` parameters [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/183709) in GitLab 17.10.
- Sorting and pagination [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/502701) in GitLab 18.2.
- `collapsed` parameter [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197824) in GitLab 18.3.
{{< /history >}}
Aside from the `query` parameter, you can configure presentation details for your view using some
more optional parameters.
Supported parameters:
| Parameter | Default | Description |
| ------------- | --------------------------------------------- | ----------- |
| `collapsed` | `false` | Whether to collapse or expand the view. |
| `description` | None | An optional description to display below the title. |
| `display` | `table` | How to display the data. Supported options: `table`, `list`, or `orderedList`. |
| `fields` | `title` | A comma-separated list of [fields](fields.md#fields-in-embedded-views) to include in the view. |
| `limit` | `100` | How many items to display on the first page. The maximum value is `100`. |
| `sort` | `updated desc` | The [field to sort the data by](fields.md#fields-to-sort-embedded-views-by) followed by a sort order (`asc` or `desc`). |
| `title` | `Embedded table view` or `Embedded list view` | A title displayed at the top of the embedded view. |
For example, to display the first five issues assigned to the current user in the `gitlab-org/gitlab`
project as a list, sorted by due date (earliest first) and displaying the `title`, `health`, and `due` fields:
````yaml
```glql
display: list
fields: title, health, due
limit: 5
sort: due asc
query: project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```
````
#### Pagination
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/502701) in GitLab 18.2.
{{< /history >}}
Embedded views display the first page of results by default.
The `limit` parameter controls the number of items shown.
To load the next page, in the last row, select **Load more**.
#### Field functions
To create dynamically generated columns, use functions in the `fields` parameters in views.
For a full list, see [Functions in embedded views](functions.md#functions-in-embedded-views).
#### Custom field aliases
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/535558) in GitLab 18.0.
{{< /history >}}
To rename a table view's column to a custom value, use the `AS` syntax keyword to alias fields.
````yaml
```glql
display: list
fields: title, labels("workflow::*") AS "Workflow", labels("priority::*") AS "Priority"
limit: 5
query: project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```
````
This source displays a view with columns `Title`, `Workflow` and `Priority`.
### View actions
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/184788) in GitLab 17.11.
- **Reload** action [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/537310) in GitLab 18.0.
{{< /history >}}
When a view appears on a page, use the **View actions** ({{< icon name="ellipsis_v" >}}) dropdown to take
an action on it.
Supported actions:
| Action | Description |
| ------------- | -------------------------------------------------------------- |
| View source | View the source of the view. |
| Copy source | Copy the source of the view to clipboard. |
| Copy contents | Copy the table or list contents to clipboard. |
| Reload | Reload this view. |
|
---
stage: Plan
group: Knowledge
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab Query Language (GLQL)
breadcrumbs:
- doc
- user
- glql
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/14767) in GitLab 17.4 [with a flag](../../administration/feature_flags/_index.md) named `glql_integration`. Disabled by default.
- Enabled on GitLab.com in GitLab 17.4 for a subset of groups and projects.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/476990) from experiment to beta in GitLab 17.10.
- Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated in GitLab 17.10.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/554870) in GitLab 18.3. Feature flag `glql_integration` removed.
{{< /history >}}
GitLab Query Language (GLQL) is an attempt to create a single query language for all of GitLab.
Use it to filter and embed content from anywhere in the platform, using familiar syntax.
Embed queries in Markdown code blocks.
An embedded view is the rendered output of a GLQL source code block.
Share your feedback in the [GLQL beta feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/509791).
## Query syntax
The query syntax consists primarily of logical expressions. These expressions follow the
syntax of `<field> <operator> <value> and ...`.
### Fields
Field names can have values like `assignee`, `author`, `label`, and `milestone`.
A `type` field can be used to filter a query by the object type, like `Issue`, `MergeRequest`,
or work item types like `Task` or `Objective`.
For a full list of supported fields, supported operators, and value types, see [GLQL fields](fields.md).
### Operators
**Comparison operators**:
| GLQL operator | Description | Equivalent in search |
|---------------|-----------------------------------------|------------------------|
| `=` | Equals / Includes all in list | `is` (equal to) |
| `!=` | Doesn't equal / Isn't contained in list | `is not` (equal to) |
| `in` | Contained in list | `or` / `is one of` |
| `>` | Greater than | {{< icon name="dotted-circle" >}} No |
| `<` | Less than | {{< icon name="dotted-circle" >}} No |
| `>=` | Greater than or equal to | {{< icon name="dotted-circle" >}} No |
| `<=` | Less than or equal to | {{< icon name="dotted-circle" >}} No |
**Logical operators**: Only `and` is supported.
`or` is indirectly supported for some fields by using the `in` comparison operator.
### Values
Values can include:
- Strings
- Numbers
- Relative dates (like `-1d`, `2w`, `-6m`, or `1y`)
- Absolute dates (in `YYYY-MM-DD` format, like `2025-01-01`)
- Functions (like `currentUser()` for user fields or `today()` for dates)
- Enum values (like `upcoming` or `started` for milestones)
- Booleans (`true` or `false`)
- Nullable values (like `null`, `none`, or `any`)
- GitLab references (like `~label` for a label, `%Backlog` for a milestone, or `@username` for a user)
- Lists containing any of the previous values (surrounded by parenthesis: `()` and delimited by commas: `,`)
## Embedded views
An embedded view is the output of a GLQL source code block in Markdown. The source includes YAML
attributes that describe how to display the GLQL query results, along with the query.
### Supported areas
Embedded views can be displayed in the following areas:
- Group and project wikis
- Descriptions and comments of:
- Epics
- Issues
- Merge requests
- Work items (tasks, OKRs, or epics)
### Syntax
The syntax of an embedded view's source is a superset of YAML that consists of:
- The `query` parameter: Expressions joined together with a logical operator, such as `and`.
- Parameters related to the presentation layer, like `display`, `limit`, or `fields`, `title`, and `description`
represented as YAML.
A view is defined in Markdown as a code block, similar to other code blocks like Mermaid.
For example:
- Display a table of first 5 open issues assigned to the authenticated user in `gitlab-org/gitlab`.
- Display columns `title`, `state`, `health`, `description`, `epic`, `milestone`, `weight`, and `updated`.
````yaml
```glql
display: table
title: GLQL table 🎉
description: This view lists my open issues
fields: title, state, health, epic, milestone, weight, updated
limit: 5
query: project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```
````
This source should render a table like the one below:
#### Presentation syntax
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/508956) in GitLab 17.7: Configuring the presentation layer using YAML front matter is deprecated.
- `title` and `description` parameters [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/183709) in GitLab 17.10.
- Sorting and pagination [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/502701) in GitLab 18.2.
- `collapsed` parameter [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197824) in GitLab 18.3.
{{< /history >}}
Aside from the `query` parameter, you can configure presentation details for your view using some
more optional parameters.
Supported parameters:
| Parameter | Default | Description |
| ------------- | --------------------------------------------- | ----------- |
| `collapsed` | `false` | Whether to collapse or expand the view. |
| `description` | None | An optional description to display below the title. |
| `display` | `table` | How to display the data. Supported options: `table`, `list`, or `orderedList`. |
| `fields` | `title` | A comma-separated list of [fields](fields.md#fields-in-embedded-views) to include in the view. |
| `limit` | `100` | How many items to display on the first page. The maximum value is `100`. |
| `sort` | `updated desc` | The [field to sort the data by](fields.md#fields-to-sort-embedded-views-by) followed by a sort order (`asc` or `desc`). |
| `title` | `Embedded table view` or `Embedded list view` | A title displayed at the top of the embedded view. |
For example, to display the first five issues assigned to the current user in the `gitlab-org/gitlab`
project as a list, sorted by due date (earliest first) and displaying the `title`, `health`, and `due` fields:
````yaml
```glql
display: list
fields: title, health, due
limit: 5
sort: due asc
query: project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```
````
#### Pagination
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/502701) in GitLab 18.2.
{{< /history >}}
Embedded views display the first page of results by default.
The `limit` parameter controls the number of items shown.
To load the next page, in the last row, select **Load more**.
#### Field functions
To create dynamically generated columns, use functions in the `fields` parameters in views.
For a full list, see [Functions in embedded views](functions.md#functions-in-embedded-views).
#### Custom field aliases
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/535558) in GitLab 18.0.
{{< /history >}}
To rename a table view's column to a custom value, use the `AS` syntax keyword to alias fields.
````yaml
```glql
display: list
fields: title, labels("workflow::*") AS "Workflow", labels("priority::*") AS "Priority"
limit: 5
query: project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```
````
This source displays a view with columns `Title`, `Workflow` and `Priority`.
### View actions
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/184788) in GitLab 17.11.
- **Reload** action [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/537310) in GitLab 18.0.
{{< /history >}}
When a view appears on a page, use the **View actions** ({{< icon name="ellipsis_v" >}}) dropdown to take
an action on it.
Supported actions:
| Action | Description |
| ------------- | -------------------------------------------------------------- |
| View source | View the source of the view. |
| Copy source | Copy the source of the view to clipboard. |
| Copy contents | Copy the table or list contents to clipboard. |
| Reload | Reload this view. |
|
https://docs.gitlab.com/user/instance/clusters
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/instance/_index.md
|
2025-08-13
|
doc/user/instance/clusters
|
[
"doc",
"user",
"instance",
"clusters"
] |
_index.md
|
none
|
unassigned
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Instance Kubernetes clusters (certificate-based) (deprecated)
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. To connect clusters to GitLab,
use the [GitLab agent for Kubernetes](../../clusters/agent/_index.md).
{{< /alert >}}
Similar to Kubernetes clusters for [projects](../../project/clusters/_index.md)
and [groups](../../group/clusters/_index.md), instance Kubernetes clusters enable
you to connect a Kubernetes cluster to the GitLab instance, and use the same cluster
across multiple projects.
To view Kubernetes clusters for your instance:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Kubernetes**.
## Cluster precedence
GitLab tries to match clusters in the following order:
- Project clusters.
- Group clusters.
- Instance clusters.
To be selected, the cluster must be enabled and
match the [environment selector](../../../ci/environments/_index.md#limit-the-environment-scope-of-a-cicd-variable).
## Cluster environments
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
For a consolidated view of which CI [environments](../../../ci/environments/_index.md)
are deployed to the Kubernetes cluster, see the documentation for
[cluster environments](../../clusters/environments.md).
## More information
For information on integrating GitLab and Kubernetes, see
[Kubernetes clusters](../../infrastructure/clusters/_index.md).
|
---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Instance Kubernetes clusters (certificate-based) (deprecated)
breadcrumbs:
- doc
- user
- instance
- clusters
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. To connect clusters to GitLab,
use the [GitLab agent for Kubernetes](../../clusters/agent/_index.md).
{{< /alert >}}
Similar to Kubernetes clusters for [projects](../../project/clusters/_index.md)
and [groups](../../group/clusters/_index.md), instance Kubernetes clusters enable
you to connect a Kubernetes cluster to the GitLab instance, and use the same cluster
across multiple projects.
To view Kubernetes clusters for your instance:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Kubernetes**.
## Cluster precedence
GitLab tries to match clusters in the following order:
- Project clusters.
- Group clusters.
- Instance clusters.
To be selected, the cluster must be enabled and
match the [environment selector](../../../ci/environments/_index.md#limit-the-environment-scope-of-a-cicd-variable).
## Cluster environments
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
For a consolidated view of which CI [environments](../../../ci/environments/_index.md)
are deployed to the Kubernetes cluster, see the documentation for
[cluster environments](../../clusters/environments.md).
## More information
For information on integrating GitLab and Kubernetes, see
[Kubernetes clusters](../../infrastructure/clusters/_index.md).
|
https://docs.gitlab.com/user/compliance
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/_index.md
|
2025-08-13
|
doc/user/compliance
|
[
"doc",
"user",
"compliance"
] |
_index.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Compliance features for users
|
Compliance features.
|
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
GitLab compliance features for users ensure your GitLab groups and projects meets common compliance standards.
## Compliant workflow automation
It is important for compliance teams to be confident that their controls and
requirements are set up correctly, but also that they stay set up correctly.
One way of doing this is manually checking settings periodically, but this is
error prone and time consuming. A better approach is to use single-source-of-truth
settings and automation to ensure that whatever a compliance team has configured,
stays configured and working correctly. These features can help you automate
compliance:
| Feature | Instances | Groups | Projects | Description |
|:-----------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------|:-------------------------------------|:-------------------------------------|:------------|
| [Compliance frameworks](compliance_frameworks/_index.md) | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | Describe the type of compliance requirements projects must follow. |
| [Compliance pipelines](compliance_pipelines.md) | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | Define a pipeline configuration to run for any projects with a given compliance framework. |
| [Merge request approval policy approval settings](../application_security/policies/merge_request_approval_policies.md#approval_settings) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Enforce a merge request approval policy enforcing multiple approvers and override various project settings in all enforced groups or projects across your GitLab instance or group. |
## Audit management
An important part of any compliance program is being able to go back and understand
what happened, when it happened, and who was responsible. You can use this in audit
situations as well as for understanding the root cause of issues when they occur.
It is helpful to have both low-level, raw lists of audit data as well as high-level,
summary lists of audit data. Between these two, compliance teams can quickly
identify if problems exist and then drill down into the specifics of those issues.
These features can help provide visibility into GitLab and audit what is happening:
| Feature | Instances | Groups | Projects | Description |
|:--------------------------------------------------|:-------------------------------------|:-------------------------------------|:-------------------------------------|:------------|
| [Audit events](audit_events.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | To maintain the integrity of your code, audit events give administrators the ability to view any modifications made in the GitLab server in an advanced audit events system, so you can control, analyze, and track every change. |
| [Audit reports](audit_events.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Create and access reports based on the audit events that have occurred. Use pre-built GitLab reports or the API to build your own. |
| [Audit event streaming](audit_event_streaming.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Stream GitLab audit events to an HTTP endpoint or third party service, such as AWS S3 or GCP Logging. |
| [Compliance center](compliance_center/_index.md) | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Quickly get visibility into the compliance posture of your organization through compliance standards adherence reporting and violations reports. Manage your groups compliance frameworks centrally. |
## Policy management
Organizations have unique policy requirements, either due to organizational
standards or mandates from regulatory bodies. The following features help you
define rules and policies to adhere to workflow requirements, separation of duties,
and secure supply chain best practices:
| Feature | Instances | Groups | Projects | Description |
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------|:-------------------------------------|:-------------------------------------|:------------|
| [Granular user roles<br/>and flexible permissions](../permissions.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Manage access and permissions with five different user roles and settings for external users. Set permissions according to people's role, rather than either read or write access to a repository. Don't share the source code with people that only need access to the issue tracker. |
| [Merge request approvals](../project/merge_requests/approvals/_index.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Configure approvals required for merge requests. |
| [Push rules](../project/repository/push_rules.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Control pushes to your repositories. |
| Separation of duties using<br/>[protected branches](../project/repository/branches/protected.md#require-code-owner-approval) and<br/>[custom CI/CD configuration paths](../../ci/pipelines/settings.md#specify-a-custom-cicd-configuration-file) | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | Leverage the GitLab cross-project YAML configurations to define deployers of code and developers of code. See how to use this setup to define these roles in the [Separation of Duties deploy project](https://gitlab.com/guided-explorations/separation-of-duties-deploy/blob/master/README.md) and the [Separation of Duties project](https://gitlab.com/guided-explorations/separation-of-duties/blob/master/README.md). |
| [Security policies](../application_security/policies/_index.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Configure customizable policies that require merge request approval based on policy rules, or enforce security scanners to execute in project pipelines for compliance requirements. Policies can be enforced granularly against specific projects, or all projects in a group or subgroup. |
## Other compliance features
These features can also help with compliance requirements:
| Feature | Instances | Groups | Projects | Description |
|:-------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------|:-------------------------------------|:-------------------------------------|:------------|
| [External Status Checks](../project/merge_requests/status_checks.md) | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | Interface with third-party systems you already use during development to ensure you remain compliant. |
| [License approval policies](license_approval_policies.md) | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | Search dependencies for their licenses. This lets you determine if the licenses of your project's dependencies are compatible with your project's license. |
| [Lock project membership to group](../group/access_and_permissions.md#prevent-members-from-being-added-to-projects-in-a-group) | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | Group owners can prevent new members from being added to projects in a group. |
## Related topics
- [Software Compliance with GitLab](https://about.gitlab.com/solutions/compliance/)
- [Secure GitLab](../../security/_index.md)
- [Compliance features for administrators](../../administration/compliance/compliance_features.md)
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Compliance features for users
description: Compliance features.
breadcrumbs:
- doc
- user
- compliance
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
GitLab compliance features for users ensure your GitLab groups and projects meets common compliance standards.
## Compliant workflow automation
It is important for compliance teams to be confident that their controls and
requirements are set up correctly, but also that they stay set up correctly.
One way of doing this is manually checking settings periodically, but this is
error prone and time consuming. A better approach is to use single-source-of-truth
settings and automation to ensure that whatever a compliance team has configured,
stays configured and working correctly. These features can help you automate
compliance:
| Feature | Instances | Groups | Projects | Description |
|:-----------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------|:-------------------------------------|:-------------------------------------|:------------|
| [Compliance frameworks](compliance_frameworks/_index.md) | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | Describe the type of compliance requirements projects must follow. |
| [Compliance pipelines](compliance_pipelines.md) | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | Define a pipeline configuration to run for any projects with a given compliance framework. |
| [Merge request approval policy approval settings](../application_security/policies/merge_request_approval_policies.md#approval_settings) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Enforce a merge request approval policy enforcing multiple approvers and override various project settings in all enforced groups or projects across your GitLab instance or group. |
## Audit management
An important part of any compliance program is being able to go back and understand
what happened, when it happened, and who was responsible. You can use this in audit
situations as well as for understanding the root cause of issues when they occur.
It is helpful to have both low-level, raw lists of audit data as well as high-level,
summary lists of audit data. Between these two, compliance teams can quickly
identify if problems exist and then drill down into the specifics of those issues.
These features can help provide visibility into GitLab and audit what is happening:
| Feature | Instances | Groups | Projects | Description |
|:--------------------------------------------------|:-------------------------------------|:-------------------------------------|:-------------------------------------|:------------|
| [Audit events](audit_events.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | To maintain the integrity of your code, audit events give administrators the ability to view any modifications made in the GitLab server in an advanced audit events system, so you can control, analyze, and track every change. |
| [Audit reports](audit_events.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Create and access reports based on the audit events that have occurred. Use pre-built GitLab reports or the API to build your own. |
| [Audit event streaming](audit_event_streaming.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Stream GitLab audit events to an HTTP endpoint or third party service, such as AWS S3 or GCP Logging. |
| [Compliance center](compliance_center/_index.md) | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Quickly get visibility into the compliance posture of your organization through compliance standards adherence reporting and violations reports. Manage your groups compliance frameworks centrally. |
## Policy management
Organizations have unique policy requirements, either due to organizational
standards or mandates from regulatory bodies. The following features help you
define rules and policies to adhere to workflow requirements, separation of duties,
and secure supply chain best practices:
| Feature | Instances | Groups | Projects | Description |
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------|:-------------------------------------|:-------------------------------------|:------------|
| [Granular user roles<br/>and flexible permissions](../permissions.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Manage access and permissions with five different user roles and settings for external users. Set permissions according to people's role, rather than either read or write access to a repository. Don't share the source code with people that only need access to the issue tracker. |
| [Merge request approvals](../project/merge_requests/approvals/_index.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Configure approvals required for merge requests. |
| [Push rules](../project/repository/push_rules.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Control pushes to your repositories. |
| Separation of duties using<br/>[protected branches](../project/repository/branches/protected.md#require-code-owner-approval) and<br/>[custom CI/CD configuration paths](../../ci/pipelines/settings.md#specify-a-custom-cicd-configuration-file) | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | Leverage the GitLab cross-project YAML configurations to define deployers of code and developers of code. See how to use this setup to define these roles in the [Separation of Duties deploy project](https://gitlab.com/guided-explorations/separation-of-duties-deploy/blob/master/README.md) and the [Separation of Duties project](https://gitlab.com/guided-explorations/separation-of-duties/blob/master/README.md). |
| [Security policies](../application_security/policies/_index.md) | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | Configure customizable policies that require merge request approval based on policy rules, or enforce security scanners to execute in project pipelines for compliance requirements. Policies can be enforced granularly against specific projects, or all projects in a group or subgroup. |
## Other compliance features
These features can also help with compliance requirements:
| Feature | Instances | Groups | Projects | Description |
|:-------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------|:-------------------------------------|:-------------------------------------|:------------|
| [External Status Checks](../project/merge_requests/status_checks.md) | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | Interface with third-party systems you already use during development to ensure you remain compliant. |
| [License approval policies](license_approval_policies.md) | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | Search dependencies for their licenses. This lets you determine if the licenses of your project's dependencies are compatible with your project's license. |
| [Lock project membership to group](../group/access_and_permissions.md#prevent-members-from-being-added-to-projects-in-a-group) | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | Group owners can prevent new members from being added to projects in a group. |
## Related topics
- [Software Compliance with GitLab](https://about.gitlab.com/solutions/compliance/)
- [Secure GitLab](../../security/_index.md)
- [Compliance features for administrators](../../administration/compliance/compliance_features.md)
|
https://docs.gitlab.com/user/license_approval_policies
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/license_approval_policies.md
|
2025-08-13
|
doc/user/compliance
|
[
"doc",
"user",
"compliance"
] |
license_approval_policies.md
|
Security Risk Management
|
Security Policies
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
License approval policies
|
Understand how to specify criteria using license approval policy for approval of a merge request before it can be merged. Applies to protected target branches only.
|
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8092) in GitLab 15.9 [with a flag](../../administration/feature_flags/_index.md) named `license_scanning_policies`.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/397644) in GitLab 15.11. Feature flag `license_scanning_policies` removed.
{{< /history >}}
Use license approval policies to specify criteria that determines when approval is required before a merge request can be merged.
{{< alert type="note" >}}
License approval policies are applicable to [protected](../project/repository/branches/protected.md) target branches only.
{{< /alert >}}
The following video provides an overview of these policies.
<div class="video-fallback">
See the video: <a href="https://www.youtube.com/watch?v=34qBQ9t8qO8">Overview of GitLab License Approval Policies</a>.
</div>
<figure class="video-container">
<iframe src="https://www.youtube-nocookie.com/embed/34qBQ9t8qO8" frameborder="0" allowfullscreen> </iframe>
</figure>
## Prerequisites to creating a new license approval policy
License approval policies rely on the output of a dependency scanning job to verify that requirements have been met. If dependency scanning has not been properly configured, and therefore no dependency scanning jobs ran related to an open MR, the policy has no data with which to verify the requirements. When security policies are missing data for evaluation, by default they fail closed and assume the merge request could contain vulnerabilities. You can opt out of the default behavior with the `fallback_behavior` property and set policies to fail open. A policy that fails open has all invalid and unenforceable rules unblocked.
To ensure enforcement of your policies, you should enable dependency scanning on your target development projects. You can achieve this a few different ways:
- Create a [scan execution policy](../application_security/policies/scan_execution_policies.md) that enforces Dependency Scanning to run in all target development projects.
- Work with your development teams to configure [dependency scanning](../application_security/dependency_scanning/_index.md) in each of their projects' `.gitlab-ci.yml` files or enable it by using the [Security Configuration panel](../application_security/detect/security_configuration.md).
License approval policies require license information from [GitLab-supported packages](license_scanning_of_cyclonedx_files/_index.md#supported-languages-and-package-managers).
## Create a new license approval policy
Create a license approval policy to enforce license compliance.
To create a license approval policy:
1. [Link a security policy project](../application_security/policies/enforcement/security_policy_projects.md#link-to-a-security-policy-project) to your development group, subgroup, or project (the Owner role is required).
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Secure > Policies**.
1. Create a new [Merge request approval Policy](../application_security/policies/merge_request_approval_policies.md).
1. In your policy rule, select **License scanning**.
## Criteria defining which licenses require approval
The following types of criteria can be used to determine which licenses are "approved" or "denied" and require approval.
- When any license in a list of explicitly prohibited licenses is detected.
- When any license is detected except for licenses that have been explicitly listed as acceptable.
## Criteria to compare licenses detected in the merge request branch to licenses in the default branch
The following types of criteria can be used to determine whether or not approval is required based on the licenses that exist in the default branch:
- Denied licenses can be configured to only require approval if the denied license is part of a dependency that does not already exist in the default branch.
- Denied licenses can be configured to require approval if the denied license exists in any component that already exists in the default branch.
If a license is found that violates the license approval policy, it blocks the merge request and instructs the developer to remove it. Note, the merge request is not able to be merged until the `denied` license is removed unless an eligible approver for the License Approval Policy approves the merge request.
## Troubleshooting
### The License Compliance widget is stuck in a loading state
A loading spinner is displayed in the following scenarios:
- While the pipeline is in progress.
- If the pipeline is complete, but still parsing the results in the background.
- If the license scanning job is complete, but the pipeline is still running.
The License Compliance widget polls every few seconds for updated results. When the pipeline is complete, the first poll after pipeline completion triggers the parsing of the results. This can take a few seconds depending on the size of the generated report.
The final state is when a successful pipeline run has been completed, parsed, and the licenses displayed in the widget.
### License approval policies block merge requests due to `unknown` licenses
License approval policies may block merge requests due to `unknown` licenses in certain scenarios. This can happen in
any of the following situations:
- The dependency scanning job fails to identify a license for a particular component.
- A new or uncommon license is used that is not recognized by the scanning tool.
- The license information is missing or incomplete in the component's metadata.
To address this issue:
1. Review the **Licenses** tab in the pipeline page to identify which components have `unknown` licenses or review `out-of-policy` licenses generated by the GitLab Security Bot.
1. Manually investigate these components to determine their actual licenses.
1. If the licenses cannot be determined or are not acceptable, consider removing or replacing the affected components.
If you need to temporarily allow merging with `unknown` licenses:
1. Edit your license approval policy.
1. Add `unknown` to the list of allowed licenses.
1. After addressing the issue, remember to remove `unknown` from the allowed licenses list to maintain proper license compliance.
We are planning enhancements to allow for excluding licenses only for specific packages in [epic 10203](https://gitlab.com/groups/gitlab-org/-/epics/10203).
Always consult with your legal team when dealing with license compliance issues, especially when handling `unknown` licenses.
|
---
stage: Security Risk Management
group: Security Policies
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: License approval policies
description: Understand how to specify criteria using license approval policy for
approval of a merge request before it can be merged. Applies to protected target
branches only.
breadcrumbs:
- doc
- user
- compliance
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8092) in GitLab 15.9 [with a flag](../../administration/feature_flags/_index.md) named `license_scanning_policies`.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/397644) in GitLab 15.11. Feature flag `license_scanning_policies` removed.
{{< /history >}}
Use license approval policies to specify criteria that determines when approval is required before a merge request can be merged.
{{< alert type="note" >}}
License approval policies are applicable to [protected](../project/repository/branches/protected.md) target branches only.
{{< /alert >}}
The following video provides an overview of these policies.
<div class="video-fallback">
See the video: <a href="https://www.youtube.com/watch?v=34qBQ9t8qO8">Overview of GitLab License Approval Policies</a>.
</div>
<figure class="video-container">
<iframe src="https://www.youtube-nocookie.com/embed/34qBQ9t8qO8" frameborder="0" allowfullscreen> </iframe>
</figure>
## Prerequisites to creating a new license approval policy
License approval policies rely on the output of a dependency scanning job to verify that requirements have been met. If dependency scanning has not been properly configured, and therefore no dependency scanning jobs ran related to an open MR, the policy has no data with which to verify the requirements. When security policies are missing data for evaluation, by default they fail closed and assume the merge request could contain vulnerabilities. You can opt out of the default behavior with the `fallback_behavior` property and set policies to fail open. A policy that fails open has all invalid and unenforceable rules unblocked.
To ensure enforcement of your policies, you should enable dependency scanning on your target development projects. You can achieve this a few different ways:
- Create a [scan execution policy](../application_security/policies/scan_execution_policies.md) that enforces Dependency Scanning to run in all target development projects.
- Work with your development teams to configure [dependency scanning](../application_security/dependency_scanning/_index.md) in each of their projects' `.gitlab-ci.yml` files or enable it by using the [Security Configuration panel](../application_security/detect/security_configuration.md).
License approval policies require license information from [GitLab-supported packages](license_scanning_of_cyclonedx_files/_index.md#supported-languages-and-package-managers).
## Create a new license approval policy
Create a license approval policy to enforce license compliance.
To create a license approval policy:
1. [Link a security policy project](../application_security/policies/enforcement/security_policy_projects.md#link-to-a-security-policy-project) to your development group, subgroup, or project (the Owner role is required).
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Secure > Policies**.
1. Create a new [Merge request approval Policy](../application_security/policies/merge_request_approval_policies.md).
1. In your policy rule, select **License scanning**.
## Criteria defining which licenses require approval
The following types of criteria can be used to determine which licenses are "approved" or "denied" and require approval.
- When any license in a list of explicitly prohibited licenses is detected.
- When any license is detected except for licenses that have been explicitly listed as acceptable.
## Criteria to compare licenses detected in the merge request branch to licenses in the default branch
The following types of criteria can be used to determine whether or not approval is required based on the licenses that exist in the default branch:
- Denied licenses can be configured to only require approval if the denied license is part of a dependency that does not already exist in the default branch.
- Denied licenses can be configured to require approval if the denied license exists in any component that already exists in the default branch.
If a license is found that violates the license approval policy, it blocks the merge request and instructs the developer to remove it. Note, the merge request is not able to be merged until the `denied` license is removed unless an eligible approver for the License Approval Policy approves the merge request.
## Troubleshooting
### The License Compliance widget is stuck in a loading state
A loading spinner is displayed in the following scenarios:
- While the pipeline is in progress.
- If the pipeline is complete, but still parsing the results in the background.
- If the license scanning job is complete, but the pipeline is still running.
The License Compliance widget polls every few seconds for updated results. When the pipeline is complete, the first poll after pipeline completion triggers the parsing of the results. This can take a few seconds depending on the size of the generated report.
The final state is when a successful pipeline run has been completed, parsed, and the licenses displayed in the widget.
### License approval policies block merge requests due to `unknown` licenses
License approval policies may block merge requests due to `unknown` licenses in certain scenarios. This can happen in
any of the following situations:
- The dependency scanning job fails to identify a license for a particular component.
- A new or uncommon license is used that is not recognized by the scanning tool.
- The license information is missing or incomplete in the component's metadata.
To address this issue:
1. Review the **Licenses** tab in the pipeline page to identify which components have `unknown` licenses or review `out-of-policy` licenses generated by the GitLab Security Bot.
1. Manually investigate these components to determine their actual licenses.
1. If the licenses cannot be determined or are not acceptable, consider removing or replacing the affected components.
If you need to temporarily allow merging with `unknown` licenses:
1. Edit your license approval policy.
1. Add `unknown` to the list of allowed licenses.
1. After addressing the issue, remember to remove `unknown` from the allowed licenses list to maintain proper license compliance.
We are planning enhancements to allow for excluding licenses only for specific packages in [epic 10203](https://gitlab.com/groups/gitlab-org/-/epics/10203).
Always consult with your legal team when dealing with license compliance issues, especially when handling `unknown` licenses.
|
https://docs.gitlab.com/user/audit_event_schema
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/audit_event_schema.md
|
2025-08-13
|
doc/user/compliance
|
[
"doc",
"user",
"compliance"
] |
audit_event_schema.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Audit event schema and examples
| null |
## Audit event schema
{{< history >}}
- Documentation for an audit event streaming schema was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358149) in GitLab 15.3.
{{< /history >}}
Audit events have a predictable schema in the body of the response.
| Field | Description | Notes | Streaming Only Field |
|------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| `author_id` | User ID of the user who triggered the event | | {{< icon name="dotted-circle" >}} No |
| `author_name` | Human-readable name of the author that triggered the event | Helpful when the author no longer exists | {{< icon name="check-circle" >}} Yes |
| `created_at` | Timestamp when event was triggered | | {{< icon name="dotted-circle" >}} No |
| `details` | JSON object containing additional metadata | Has no defined schema but often contains additional information about an event | {{< icon name="dotted-circle" >}} No |
| `entity_id` | ID of the audit event's entity | | {{< icon name="dotted-circle" >}} No |
| `entity_path` | Full path of the entity affected by the auditable event | | {{< icon name="check-circle" >}} Yes |
| `entity_type` | String representation of the type of entity | Acceptable values include `User`, `Group`, and `Key`. This list is not exhaustive | {{< icon name="dotted-circle" >}} No |
| `event_type` | String representation of the type of audit event | | {{< icon name="check-circle" >}} Yes |
| `id` | Unique identifier for the audit event | Can be used for deduplication if required | {{< icon name="dotted-circle" >}} No |
| `ip_address` | IP address of the host used to trigger the event | | {{< icon name="check-circle" >}} Yes |
| `target_details` | Additional details about the target | | {{< icon name="check-circle" >}} Yes |
| `target_id` | ID of the audit event's target | | {{< icon name="check-circle" >}} Yes |
| `target_type` | String representation of the target's type | | {{< icon name="check-circle" >}} Yes |
### Audit event JSON schema
```json
{
"properties": {
"id": {
"type": "string"
},
"author_id": {
"type": "integer"
},
"author_name": {
"type": "string"
},
"details": {},
"ip_address": {
"type": "string"
},
"entity_id": {
"type": "integer"
},
"entity_path": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"event_type": {
"type": "string"
},
"target_id": {
"type": "integer"
},
"target_type": {
"type": "string"
},
"target_details": {
"type": "string"
},
},
"type": "object"
}
```
### Headers
{{< history >}}
- `X-Gitlab-Audit-Event-Type` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86881) in GitLab 15.0.
{{< /history >}}
Headers are formatted as follows:
```plaintext
POST /logs HTTP/1.1
Host: <DESTINATION_HOST>
Content-Type: application/x-www-form-urlencoded
X-Gitlab-Event-Streaming-Token: <DESTINATION_TOKEN>
X-Gitlab-Audit-Event-Type: repository_git_operation
```
## Example: audit event streaming on Git operations
Streaming audit events can be sent when authenticated users push, pull, or clone a project's remote Git repositories:
- [Using SSH](../ssh.md).
- Using HTTP or HTTPS.
- Using **Download** ({{< icon name="download" >}}) in GitLab UI.
Audit events are not captured for users that are not signed in. For example, when downloading a public project.
### Example: audit event payloads for Git over SSH events with deploy key
Fetch:
```json
{
"id": "1",
"author_id": -3,
"entity_id": 29,
"entity_type": "Project",
"details": {
"author_name": "deploy-key-name",
"author_class": "DeployKey",
"target_id": 29,
"target_type": "Project",
"target_details": "example-project",
"custom_message": {
"protocol": "ssh",
"action": "git-upload-pack"
},
"ip_address": "127.0.0.1",
"entity_path": "example-group/example-project"
},
"ip_address": "127.0.0.1",
"author_name": "deploy-key-name",
"entity_path": "example-group/example-project",
"target_details": "example-project",
"created_at": "2022-07-26T05:43:53.662Z",
"target_type": "Project",
"target_id": 29,
"event_type": "repository_git_operation"
}
```
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Audit event schema and examples
breadcrumbs:
- doc
- user
- compliance
---
## Audit event schema
{{< history >}}
- Documentation for an audit event streaming schema was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358149) in GitLab 15.3.
{{< /history >}}
Audit events have a predictable schema in the body of the response.
| Field | Description | Notes | Streaming Only Field |
|------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| `author_id` | User ID of the user who triggered the event | | {{< icon name="dotted-circle" >}} No |
| `author_name` | Human-readable name of the author that triggered the event | Helpful when the author no longer exists | {{< icon name="check-circle" >}} Yes |
| `created_at` | Timestamp when event was triggered | | {{< icon name="dotted-circle" >}} No |
| `details` | JSON object containing additional metadata | Has no defined schema but often contains additional information about an event | {{< icon name="dotted-circle" >}} No |
| `entity_id` | ID of the audit event's entity | | {{< icon name="dotted-circle" >}} No |
| `entity_path` | Full path of the entity affected by the auditable event | | {{< icon name="check-circle" >}} Yes |
| `entity_type` | String representation of the type of entity | Acceptable values include `User`, `Group`, and `Key`. This list is not exhaustive | {{< icon name="dotted-circle" >}} No |
| `event_type` | String representation of the type of audit event | | {{< icon name="check-circle" >}} Yes |
| `id` | Unique identifier for the audit event | Can be used for deduplication if required | {{< icon name="dotted-circle" >}} No |
| `ip_address` | IP address of the host used to trigger the event | | {{< icon name="check-circle" >}} Yes |
| `target_details` | Additional details about the target | | {{< icon name="check-circle" >}} Yes |
| `target_id` | ID of the audit event's target | | {{< icon name="check-circle" >}} Yes |
| `target_type` | String representation of the target's type | | {{< icon name="check-circle" >}} Yes |
### Audit event JSON schema
```json
{
"properties": {
"id": {
"type": "string"
},
"author_id": {
"type": "integer"
},
"author_name": {
"type": "string"
},
"details": {},
"ip_address": {
"type": "string"
},
"entity_id": {
"type": "integer"
},
"entity_path": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"event_type": {
"type": "string"
},
"target_id": {
"type": "integer"
},
"target_type": {
"type": "string"
},
"target_details": {
"type": "string"
},
},
"type": "object"
}
```
### Headers
{{< history >}}
- `X-Gitlab-Audit-Event-Type` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86881) in GitLab 15.0.
{{< /history >}}
Headers are formatted as follows:
```plaintext
POST /logs HTTP/1.1
Host: <DESTINATION_HOST>
Content-Type: application/x-www-form-urlencoded
X-Gitlab-Event-Streaming-Token: <DESTINATION_TOKEN>
X-Gitlab-Audit-Event-Type: repository_git_operation
```
## Example: audit event streaming on Git operations
Streaming audit events can be sent when authenticated users push, pull, or clone a project's remote Git repositories:
- [Using SSH](../ssh.md).
- Using HTTP or HTTPS.
- Using **Download** ({{< icon name="download" >}}) in GitLab UI.
Audit events are not captured for users that are not signed in. For example, when downloading a public project.
### Example: audit event payloads for Git over SSH events with deploy key
Fetch:
```json
{
"id": "1",
"author_id": -3,
"entity_id": 29,
"entity_type": "Project",
"details": {
"author_name": "deploy-key-name",
"author_class": "DeployKey",
"target_id": 29,
"target_type": "Project",
"target_details": "example-project",
"custom_message": {
"protocol": "ssh",
"action": "git-upload-pack"
},
"ip_address": "127.0.0.1",
"entity_path": "example-group/example-project"
},
"ip_address": "127.0.0.1",
"author_name": "deploy-key-name",
"entity_path": "example-group/example-project",
"target_details": "example-project",
"created_at": "2022-07-26T05:43:53.662Z",
"target_type": "Project",
"target_id": 29,
"event_type": "repository_git_operation"
}
```
|
https://docs.gitlab.com/user/audit_event_streaming
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/audit_event_streaming.md
|
2025-08-13
|
doc/user/compliance
|
[
"doc",
"user",
"compliance"
] |
audit_event_streaming.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Audit event streaming for top-level groups
| null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Subgroup events recording](https://gitlab.com/gitlab-org/gitlab/-/issues/366878) fixed in GitLab 15.2.
- Custom HTTP headers UI [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/361630) in GitLab 15.2 [with a flag](../feature_flags.md) named `custom_headers_streaming_audit_events_ui`. Disabled by default.
- Custom HTTP headers UI [made generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/365259) in GitLab 15.3. [Feature flag `custom_headers_streaming_audit_events_ui`](https://gitlab.com/gitlab-org/gitlab/-/issues/365259) removed.
- [Improved user experience](https://gitlab.com/gitlab-org/gitlab/-/issues/367963) in GitLab 15.3.
- HTTP destination **Name** field [added](https://gitlab.com/gitlab-org/gitlab/-/issues/411357) in GitLab 16.3.
- Functionality for the **Active** checkbox [added](https://gitlab.com/gitlab-org/gitlab/-/issues/415268) in GitLab 16.5.
{{< /history >}}
With audit event streaming for top-level groups, group owners can:
- Set a streaming destination for a top-level group to receive all audit events about the group, subgroups, and projects
as structured JSON.
- Manage their audit logs in third-party systems. Any service that can receive structured JSON data can be used as the
streaming destination.
Each streaming destination:
- Can have up to 20 custom HTTP headers included with each streamed event.
- For GitLab.com, must allow traffic from the [GitLab.com IP address range](../gitlab_com/_index.md#ip-range).
GitLab can stream a single event more than once to the same destination. Use the `id` key in the payload to deduplicate
incoming data.
Audit events are sent using the POST request method protocol supported by HTTP.
{{< alert type="warning" >}}
Streaming destinations receive **all** audit event data, which could include sensitive information. Make sure you trust
the streaming destination.
{{< /alert >}}
## HTTP destinations
Prerequisites:
- For better security, you should use an SSL certificate on the destination URL.
Manage HTTP streaming destinations for top-level groups.
### Add a new HTTP destination
Add a new HTTP streaming destination to a top-level group.
Prerequisites:
- Owner role for a top-level group.
To add streaming destinations to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select **Add streaming destination** and select **HTTP endpoint** to show the section for adding destinations.
1. In the **Name** and **Destination URL** fields, add a destination name and URL.
1. Optional. Locate the **Custom HTTP headers** table.
1. To make the header active, select the **Active** checkbox. The header will be sent with the audit event.
1. Select **Add header** to create a new name and value pair. Enter as many name and value pairs as required. You can add up to
20 headers per streaming destination.
1. After all headers have been filled out, select **Add** to add the new streaming destination.
### Update an HTTP destination
Prerequisites:
- Owner role for a group.
To update a streaming destination's name:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. In the **Name** fields, add a destination name to update.
1. Select **Save** to update the streaming destination.
To update a streaming destination's custom HTTP headers:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Locate the **Custom HTTP headers** table.
1. Locate the header that you wish to update.
1. To make the header active, select the **Active** checkbox. The header will be sent with the audit event.
1. Select **Add header** to create a new name and value pair. Enter as many name and value pairs as required. You can add up to
20 headers per streaming destination.
1. Select **Save** to update the streaming destination.
### Verify event authenticity
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/360814) in GitLab 15.2.
{{< /history >}}
Each streaming destination has a unique verification token (`verificationToken`) that can be used to verify the authenticity of the event. This
token is either specified by the Owner or generated automatically when the event destination is created and cannot be changed.
The `verificationToken` parameter can only be set by using the [GraphQL API](../../api/graphql/audit_event_streaming_groups.md#add-a-new-streaming-destination).
Each streamed event contains the verification token in the `X-Gitlab-Event-Streaming-Token` HTTP header that can be verified against
the destination's value when listing streaming destinations.
Prerequisites:
- Owner role for a group.
To list streaming destinations and see the verification tokens:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Locate the **Verification token** input.
### Update event filters
{{< history >}}
- Event type filtering in the UI with a defined list of audit event types [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413581) in GitLab 16.1.
{{< /history >}}
When this feature is enabled for a group, you can permit users to filter streamed audit events per destination.
If the feature is enabled with no filters, the destination receives all audit events.
A streaming destination that has an event type filter set has a **filtered** ({{< icon name="filter" >}}) label.
To update a streaming destination's event filters:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Locate the **Filter by audit event type** dropdown list.
1. Select the dropdown list and select or clear the required event types.
1. Select **Save** to update the event filters.
### Update namespace filters
{{< history >}}
- Namespace filtering in the UI [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390133) in GitLab 16.7.
{{< /history >}}
When this feature is enabled for a group, you can permit users to filter streamed audit events per destination.
If the feature is enabled with no filters, the destination receives all audit events.
A streaming destination that has a namespace filter set has a **filtered** ({{< icon name="filter" >}}) label.
To update a streaming destination's namespace filters:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Locate the **Filter by groups or projects** dropdown list.
1. Select the dropdown list and select or clear the required namespaces.
1. Select **Save** to update the namespace filter.
### Override default content type header
By default, streaming destinations use a `content-type` header of `application/x-www-form-urlencoded`. However, you
might want to set the `content-type` header to something else. For example, `application/json`.
To override the `content-type` header default value for a top-level group streaming destination, use either:
- The [GitLab UI](#update-an-http-destination).
- The [GraphQL API](../../api/graphql/audit_event_streaming_groups.md#update-streaming-destinations).
## Google Cloud Logging destinations
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124384) in GitLab 16.2.
{{< /history >}}
Manage Google Cloud Logging destinations for top-level groups.
### Prerequisites
Before setting up Google Cloud Logging streaming audit events, you must:
1. Enable [Cloud Logging API](https://console.cloud.google.com/marketplace/product/google/logging.googleapis.com) on your Google Cloud project.
1. Create a service account for Google Cloud with the appropriate credentials and permissions. This account is used to configure audit log streaming authentication.
For more information, see [Creating and managing service accounts in the Google Cloud documentation](https://cloud.google.com/iam/docs/service-accounts-create#creating).
1. Enable the **Logs Writer** role for the service account to enable logging on Google Cloud. For more information, see [Access control with IAM](https://cloud.google.com/logging/docs/access-control#logging.logWriter).
1. Create a JSON key for the service account. For more information, see [Creating a service account key](https://cloud.google.com/iam/docs/keys-create-delete#creating).
### Add a new Google Cloud Logging destination
Prerequisites:
- Owner role for a top-level group.
To add Google Cloud Logging streaming destinations to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select **Add streaming destination** and select **Google Cloud Logging** to show the section for adding destinations.
1. Enter a random string to use as a name for the new destination.
1. Enter the Google project ID, Google client email, and Google private key from previously-created Google Cloud service account key to add to the new destination.
1. Enter a random string to use as a log ID for the new destination. You can use this later to filter log results in Google Cloud.
1. Select **Add** to add the new streaming destination.
### Update a Google Cloud Logging destination
{{< history >}}
- Button to add private key [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/419675) in GitLab 16.3.
{{< /history >}}
Prerequisites:
- Owner role for a top-level group.
To update Google Cloud Logging streaming destinations to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the Google Cloud Logging stream to expand.
1. Enter a random string to use as a name for the destination.
1. Enter the Google project ID and Google client email from previously-created Google Cloud service account key to update the destination.
1. Enter a random string to update the log ID for the destination. You can use this later to filter log results in Google Cloud.
1. Select **Add a new private key** and enter a Google private key to update the private key.
1. Select **Save** to update the streaming destination.
## AWS S3 destinations
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132603) in GitLab 16.6 [with a flag](../feature_flags.md) named `allow_streaming_audit_events_to_amazon_s3`. Enabled by default.
- [Feature flag `allow_streaming_audit_events_to_amazon_s3`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137391) removed in GitLab 16.7.
{{< /history >}}
Manage AWS S3 destinations for top-level groups.
### Prerequisites
Before setting up AWS S3 streaming audit events, you must:
1. Create a access key for AWS with the appropriate credentials and permissions. This account is used to configure audit log streaming authentication.
For more information, see [Managing access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html?icmpid=docs_iam_console#Using_CreateAccessKey).
1. Create a AWS S3 bucket. This bucket is used to store audit log streaming data. For more information, see [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html)
### Add a new AWS S3 destination
Prerequisites:
- Owner role for a top-level group.
To add AWS S3 streaming destinations to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select **Add streaming destination** and select **AWS S3** to show the section for adding destinations.
1. Enter a random string to use as a name for the new destination.
1. Enter the **Access Key ID**, **Secret Access Key**, **Bucket Name**, and **AWS Region** from previously-created AWS
access key and bucket to add to the new destination.
1. Select **Add** to add the new streaming destination.
### Update an AWS S3 destination
Prerequisites:
- Owner role for a top-level group.
To update an AWS S3 streaming destination to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the AWS S3 stream to expand.
1. Enter a random string to use as a name for the destination.
1. To update the destination, enter the **Access Key ID**, **Secret Access Key**, **Bucket Name**, and **AWS Region**
from previously-created AWS access key and bucket.
1. To update the Secret Access Key, select **Add a new Secret Access Key** and enter a AWS Secret Access Key.
1. Select **Save**.
## List streaming destinations
Prerequisites:
- Owner role for a top-level group.
To list streaming destinations for a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
## Activate or deactivate streaming destinations
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/537096) in GitLab 18.2.
{{< /history >}}
You can temporarily deactivate audit event streaming to a destination without deleting the destination configuration. When a streaming destination is deactivated:
- Audit events stop streaming to that destination immediately.
- The destination configuration is preserved.
- You can reactivate the destination at any time.
- Other active destinations continue to receive events.
### Deactivate a streaming destination
Prerequisites:
- Owner role for a top-level group.
To deactivate a streaming destination:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Clear the **Active** checkbox.
1. Select **Save**.
The destination stops receiving audit events.
### Activate a streaming destination
To reactivate a previously deactivated streaming destination:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Select the **Active** checkbox.
1. Select **Save**.
The destination resumes receiving audit events immediately.
## Delete streaming destinations
Delete streaming destinations for a top-level group. When the last destination is successfully deleted, streaming is
disabled for the top-level group.
Prerequisites:
- Owner role for a top-level group.
To delete streaming destinations to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Select **Delete destination**.
1. To confirm, select **Delete destination**.
### Delete only custom HTTP headers
Prerequisites:
- Owner role for a top-level group.
To delete only the custom HTTP headers for a streaming destination:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Locate the **Custom HTTP headers** table.
1. Locate the header that you wish to remove.
1. To the right of the header, select **Delete** ({{< icon name="remove" >}}).
1. Select **Save**.
## Related topics
- [Audit event streaming for instances](../../administration/compliance/audit_event_streaming.md)
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Audit event streaming for top-level groups
breadcrumbs:
- doc
- user
- compliance
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Subgroup events recording](https://gitlab.com/gitlab-org/gitlab/-/issues/366878) fixed in GitLab 15.2.
- Custom HTTP headers UI [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/361630) in GitLab 15.2 [with a flag](../feature_flags.md) named `custom_headers_streaming_audit_events_ui`. Disabled by default.
- Custom HTTP headers UI [made generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/365259) in GitLab 15.3. [Feature flag `custom_headers_streaming_audit_events_ui`](https://gitlab.com/gitlab-org/gitlab/-/issues/365259) removed.
- [Improved user experience](https://gitlab.com/gitlab-org/gitlab/-/issues/367963) in GitLab 15.3.
- HTTP destination **Name** field [added](https://gitlab.com/gitlab-org/gitlab/-/issues/411357) in GitLab 16.3.
- Functionality for the **Active** checkbox [added](https://gitlab.com/gitlab-org/gitlab/-/issues/415268) in GitLab 16.5.
{{< /history >}}
With audit event streaming for top-level groups, group owners can:
- Set a streaming destination for a top-level group to receive all audit events about the group, subgroups, and projects
as structured JSON.
- Manage their audit logs in third-party systems. Any service that can receive structured JSON data can be used as the
streaming destination.
Each streaming destination:
- Can have up to 20 custom HTTP headers included with each streamed event.
- For GitLab.com, must allow traffic from the [GitLab.com IP address range](../gitlab_com/_index.md#ip-range).
GitLab can stream a single event more than once to the same destination. Use the `id` key in the payload to deduplicate
incoming data.
Audit events are sent using the POST request method protocol supported by HTTP.
{{< alert type="warning" >}}
Streaming destinations receive **all** audit event data, which could include sensitive information. Make sure you trust
the streaming destination.
{{< /alert >}}
## HTTP destinations
Prerequisites:
- For better security, you should use an SSL certificate on the destination URL.
Manage HTTP streaming destinations for top-level groups.
### Add a new HTTP destination
Add a new HTTP streaming destination to a top-level group.
Prerequisites:
- Owner role for a top-level group.
To add streaming destinations to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select **Add streaming destination** and select **HTTP endpoint** to show the section for adding destinations.
1. In the **Name** and **Destination URL** fields, add a destination name and URL.
1. Optional. Locate the **Custom HTTP headers** table.
1. To make the header active, select the **Active** checkbox. The header will be sent with the audit event.
1. Select **Add header** to create a new name and value pair. Enter as many name and value pairs as required. You can add up to
20 headers per streaming destination.
1. After all headers have been filled out, select **Add** to add the new streaming destination.
### Update an HTTP destination
Prerequisites:
- Owner role for a group.
To update a streaming destination's name:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. In the **Name** fields, add a destination name to update.
1. Select **Save** to update the streaming destination.
To update a streaming destination's custom HTTP headers:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Locate the **Custom HTTP headers** table.
1. Locate the header that you wish to update.
1. To make the header active, select the **Active** checkbox. The header will be sent with the audit event.
1. Select **Add header** to create a new name and value pair. Enter as many name and value pairs as required. You can add up to
20 headers per streaming destination.
1. Select **Save** to update the streaming destination.
### Verify event authenticity
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/360814) in GitLab 15.2.
{{< /history >}}
Each streaming destination has a unique verification token (`verificationToken`) that can be used to verify the authenticity of the event. This
token is either specified by the Owner or generated automatically when the event destination is created and cannot be changed.
The `verificationToken` parameter can only be set by using the [GraphQL API](../../api/graphql/audit_event_streaming_groups.md#add-a-new-streaming-destination).
Each streamed event contains the verification token in the `X-Gitlab-Event-Streaming-Token` HTTP header that can be verified against
the destination's value when listing streaming destinations.
Prerequisites:
- Owner role for a group.
To list streaming destinations and see the verification tokens:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Locate the **Verification token** input.
### Update event filters
{{< history >}}
- Event type filtering in the UI with a defined list of audit event types [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413581) in GitLab 16.1.
{{< /history >}}
When this feature is enabled for a group, you can permit users to filter streamed audit events per destination.
If the feature is enabled with no filters, the destination receives all audit events.
A streaming destination that has an event type filter set has a **filtered** ({{< icon name="filter" >}}) label.
To update a streaming destination's event filters:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Locate the **Filter by audit event type** dropdown list.
1. Select the dropdown list and select or clear the required event types.
1. Select **Save** to update the event filters.
### Update namespace filters
{{< history >}}
- Namespace filtering in the UI [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390133) in GitLab 16.7.
{{< /history >}}
When this feature is enabled for a group, you can permit users to filter streamed audit events per destination.
If the feature is enabled with no filters, the destination receives all audit events.
A streaming destination that has a namespace filter set has a **filtered** ({{< icon name="filter" >}}) label.
To update a streaming destination's namespace filters:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Locate the **Filter by groups or projects** dropdown list.
1. Select the dropdown list and select or clear the required namespaces.
1. Select **Save** to update the namespace filter.
### Override default content type header
By default, streaming destinations use a `content-type` header of `application/x-www-form-urlencoded`. However, you
might want to set the `content-type` header to something else. For example, `application/json`.
To override the `content-type` header default value for a top-level group streaming destination, use either:
- The [GitLab UI](#update-an-http-destination).
- The [GraphQL API](../../api/graphql/audit_event_streaming_groups.md#update-streaming-destinations).
## Google Cloud Logging destinations
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124384) in GitLab 16.2.
{{< /history >}}
Manage Google Cloud Logging destinations for top-level groups.
### Prerequisites
Before setting up Google Cloud Logging streaming audit events, you must:
1. Enable [Cloud Logging API](https://console.cloud.google.com/marketplace/product/google/logging.googleapis.com) on your Google Cloud project.
1. Create a service account for Google Cloud with the appropriate credentials and permissions. This account is used to configure audit log streaming authentication.
For more information, see [Creating and managing service accounts in the Google Cloud documentation](https://cloud.google.com/iam/docs/service-accounts-create#creating).
1. Enable the **Logs Writer** role for the service account to enable logging on Google Cloud. For more information, see [Access control with IAM](https://cloud.google.com/logging/docs/access-control#logging.logWriter).
1. Create a JSON key for the service account. For more information, see [Creating a service account key](https://cloud.google.com/iam/docs/keys-create-delete#creating).
### Add a new Google Cloud Logging destination
Prerequisites:
- Owner role for a top-level group.
To add Google Cloud Logging streaming destinations to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select **Add streaming destination** and select **Google Cloud Logging** to show the section for adding destinations.
1. Enter a random string to use as a name for the new destination.
1. Enter the Google project ID, Google client email, and Google private key from previously-created Google Cloud service account key to add to the new destination.
1. Enter a random string to use as a log ID for the new destination. You can use this later to filter log results in Google Cloud.
1. Select **Add** to add the new streaming destination.
### Update a Google Cloud Logging destination
{{< history >}}
- Button to add private key [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/419675) in GitLab 16.3.
{{< /history >}}
Prerequisites:
- Owner role for a top-level group.
To update Google Cloud Logging streaming destinations to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the Google Cloud Logging stream to expand.
1. Enter a random string to use as a name for the destination.
1. Enter the Google project ID and Google client email from previously-created Google Cloud service account key to update the destination.
1. Enter a random string to update the log ID for the destination. You can use this later to filter log results in Google Cloud.
1. Select **Add a new private key** and enter a Google private key to update the private key.
1. Select **Save** to update the streaming destination.
## AWS S3 destinations
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132603) in GitLab 16.6 [with a flag](../feature_flags.md) named `allow_streaming_audit_events_to_amazon_s3`. Enabled by default.
- [Feature flag `allow_streaming_audit_events_to_amazon_s3`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137391) removed in GitLab 16.7.
{{< /history >}}
Manage AWS S3 destinations for top-level groups.
### Prerequisites
Before setting up AWS S3 streaming audit events, you must:
1. Create a access key for AWS with the appropriate credentials and permissions. This account is used to configure audit log streaming authentication.
For more information, see [Managing access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html?icmpid=docs_iam_console#Using_CreateAccessKey).
1. Create a AWS S3 bucket. This bucket is used to store audit log streaming data. For more information, see [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html)
### Add a new AWS S3 destination
Prerequisites:
- Owner role for a top-level group.
To add AWS S3 streaming destinations to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select **Add streaming destination** and select **AWS S3** to show the section for adding destinations.
1. Enter a random string to use as a name for the new destination.
1. Enter the **Access Key ID**, **Secret Access Key**, **Bucket Name**, and **AWS Region** from previously-created AWS
access key and bucket to add to the new destination.
1. Select **Add** to add the new streaming destination.
### Update an AWS S3 destination
Prerequisites:
- Owner role for a top-level group.
To update an AWS S3 streaming destination to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the AWS S3 stream to expand.
1. Enter a random string to use as a name for the destination.
1. To update the destination, enter the **Access Key ID**, **Secret Access Key**, **Bucket Name**, and **AWS Region**
from previously-created AWS access key and bucket.
1. To update the Secret Access Key, select **Add a new Secret Access Key** and enter a AWS Secret Access Key.
1. Select **Save**.
## List streaming destinations
Prerequisites:
- Owner role for a top-level group.
To list streaming destinations for a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
## Activate or deactivate streaming destinations
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/537096) in GitLab 18.2.
{{< /history >}}
You can temporarily deactivate audit event streaming to a destination without deleting the destination configuration. When a streaming destination is deactivated:
- Audit events stop streaming to that destination immediately.
- The destination configuration is preserved.
- You can reactivate the destination at any time.
- Other active destinations continue to receive events.
### Deactivate a streaming destination
Prerequisites:
- Owner role for a top-level group.
To deactivate a streaming destination:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Clear the **Active** checkbox.
1. Select **Save**.
The destination stops receiving audit events.
### Activate a streaming destination
To reactivate a previously deactivated streaming destination:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Select the **Active** checkbox.
1. Select **Save**.
The destination resumes receiving audit events immediately.
## Delete streaming destinations
Delete streaming destinations for a top-level group. When the last destination is successfully deleted, streaming is
disabled for the top-level group.
Prerequisites:
- Owner role for a top-level group.
To delete streaming destinations to a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Select **Delete destination**.
1. To confirm, select **Delete destination**.
### Delete only custom HTTP headers
Prerequisites:
- Owner role for a top-level group.
To delete only the custom HTTP headers for a streaming destination:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. On the main area, select the **Streams** tab.
1. Select the stream to expand.
1. Locate the **Custom HTTP headers** table.
1. Locate the header that you wish to remove.
1. To the right of the header, select **Delete** ({{< icon name="remove" >}}).
1. Select **Save**.
## Related topics
- [Audit event streaming for instances](../../administration/compliance/audit_event_streaming.md)
|
https://docs.gitlab.com/user/compliance_pipelines
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance_pipelines.md
|
2025-08-13
|
doc/user/compliance
|
[
"doc",
"user",
"compliance"
] |
compliance_pipelines.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Compliance pipelines (deprecated)
|
Compliance pipelines (deprecated in 17.3, planned to be removed in 19.0) enables centralized CI/CD control for labeled projects. Replaced by pipeline execution policies.
|
<!--- start_remove The following content will be removed on remove_date: '2025-08-15' -->
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159841) in GitLab 17.3
and is planned for removal in 19.0. Use [pipeline execution policy type](../application_security/policies/pipeline_execution_policies.md) instead.
This change is a breaking change. For more information, see the [migration guide](#pipeline-execution-policies-migration).
{{< /alert >}}
Group owners can configure a compliance pipeline in a project separate to other projects. By default, the compliance
pipeline configuration (for example, `.compliance-gitlab-ci.yml`) is run instead of the pipeline configuration (for example, `.gitlab-ci.yml`) of labeled
projects.
However, the compliance pipeline configuration can reference the `.gitlab-ci.yml` file of the labeled projects so that:
- The compliance pipeline can also run jobs of labeled project pipelines. This allows for centralized control of
pipeline configuration.
- Jobs and variables defined in the compliance pipeline can't be changed by variables in the labeled project's
`.gitlab-ci.yml` file.
{{< alert type="note" >}}
Because of a [known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/414004), project pipelines must be included first at the top of compliance pipeline configuration
to prevent projects overriding settings downstream.
{{< /alert >}}
For more information, see:
- [Example configuration](#example-configuration) for help configuring a compliance pipeline that runs jobs from
labeled project pipeline configuration.
- The [Create a compliance pipeline](../../tutorials/compliance_pipeline/_index.md) tutorial.
## Pipeline execution policies migration
To consolidate and simplify scan and pipeline enforcement, we have introduced pipeline execution policies. We deprecated
compliance pipelines in GitLab 17.3 and will remove compliance pipelines in GitLab 19.0.
Pipeline execution policies extend a project's `.gitlab-ci.yml` file with the configuration provided in separate YAML file
(for example, `pipeline-execution.yml`) linked in the pipeline execution policy.
By default, when creating a new compliance framework, you are directed to use the pipeline execution policy type instead
of compliance pipelines.
Existing compliance pipelines must be migrated. Customers should migrate from compliance pipelines to the new
[pipeline execution policy type](../application_security/policies/pipeline_execution_policies.md) as soon as possible.
### Migrate an existing compliance framework
To migrate an existing compliance framework to use the pipeline execution policy type:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. [Edit](compliance_frameworks/_index.md#create-edit-or-delete-a-compliance-framework) the existing compliance framework.
1. In the banner than appears, select **Migrate pipeline to a policy** to create a new policy in the security policies.
1. Edit the compliance framework again to remove the compliance pipeline.
For more information, see [Security policy project](../application_security/policies/enforcement/security_policy_projects.md).
If you receive a `Pipeline execution policy error: Job names must be unique` error during the migration, see the
[relevant troubleshooting information](#error-job-names-must-be-unique).
## Effect on labeled projects
Users have no way of knowing that a compliance pipeline has been configured and might be confused why their own
pipelines are not running at all, or include jobs that they did not define themselves.
When authoring pipelines on a labeled project, there is no indication that a compliance pipeline has been configured.
The only marker at the project level is the compliance framework label itself, but the label does not say whether the
framework has a compliance pipeline configured or not.
Therefore, communicate with project users about compliance pipeline configuration to reduce uncertainty and confusion.
### Multiple compliance frameworks
You can [apply to a single project](compliance_frameworks/_index.md#apply-a-compliance-framework-to-a-project) multiple compliance frameworks with compliance pipelines configured.
In this case, only the first compliance framework applied to a project has its compliance pipeline included in the project pipeline.
To ensure that the correct compliance pipeline is included in a project:
1. Remove all compliance frameworks from the project.
1. Apply the compliance framework with the correct compliance pipeline to the project.
1. Apply additional compliance frameworks to the project.
## Configure a compliance pipeline
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383209) in GitLab 15.11, compliance frameworks moved to compliance center.
{{< /history >}}
To configure a compliance pipeline:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure** > **Compliance Center**.
1. Select **Frameworks** section.
1. Select **New framework** section, add information of compliance framework including path to the compliance framework configuration. Use the
`path/file.y[a]ml@group-name/project-name` format. For example:
- `.compliance-ci.yml@gitlab-org/gitlab`.
- `.compliance-ci.yaml@gitlab-org/gitlab`.
This configuration is inherited by projects where the compliance framework label is
[applied](../project/working_with_projects.md#add-a-compliance-framework-to-a-project). In projects with the applied compliance
framework label, the compliance pipeline configuration is run instead of the labeled project's own pipeline configuration.
The user running the pipeline in the labeled project must at least have the Reporter role on the compliance project.
When used to enforce scan execution, this feature has some overlap with
[scan execution policies](../application_security/policies/scan_execution_policies.md). We have not
[unified the user experience for these two features](https://gitlab.com/groups/gitlab-org/-/epics/7312). For details on
the similarities and differences between these features, see [Scan execution policy compared to compliance framework](../application_security/detect/security_configuration.md#scan-execution-policy-compared-to-compliance-framework).
### Example configuration
The following example `.compliance-gitlab-ci.yml` includes the `include` keyword to ensure labeled project pipeline
configuration is also executed.
```yaml
include: # Execute individual project's configuration (if project contains .gitlab-ci.yml)
- project: '$CI_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_SHA' # Must be defined or MR pipelines always use the use default branch
rules:
- if: $CI_PROJECT_PATH != "my-group/project-1" # Must run on projects other than the one hosting this configuration.
# Allows compliance team to control the ordering and interweaving of stages/jobs.
# Stages without jobs defined will remain hidden.
stages:
- pre-compliance
- build
- test
- pre-deploy-compliance
- deploy
- post-compliance
variables: # Can be overridden by setting a job-specific variable in project's local .gitlab-ci.yml
FOO: sast
sast: # None of these attributes can be overridden by a project's local .gitlab-ci.yml
variables:
FOO: sast
image: ruby:2.6
stage: pre-compliance
rules:
- if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"
when: never
- when: always # or when: on_success
allow_failure: false
before_script:
- "# No before scripts."
script:
- echo "running $FOO"
after_script:
- "# No after scripts."
sanity check:
image: ruby:2.6
stage: pre-deploy-compliance
rules:
- if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"
when: never
- when: always # or when: on_success
allow_failure: false
before_script:
- "# No before scripts."
script:
- echo "running $FOO"
after_script:
- "# No after scripts."
audit trail:
image: ruby:2.7
stage: post-compliance
rules:
- if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"
when: never
- when: always # or when: on_success
allow_failure: false
before_script:
- "# No before scripts."
script:
- echo "running $FOO"
after_script:
- "# No after scripts."
```
The `rules` configuration in the `include` definition avoids circular inclusion in case the compliance pipeline must be able to run in the host project itself.
You can leave it out if your compliance pipeline only ever runs in labeled projects.
#### Compliance pipelines and custom pipeline configuration hosted externally
The previous example assumes that all projects host their pipeline configuration in the same project.
If any projects use [configuration hosted externally](../../ci/pipelines/settings.md#specify-a-custom-cicd-configuration-file),
the example configuration does not work. See [issue 393960](https://gitlab.com/gitlab-org/gitlab/-/issues/393960)
for more details.
With projects that use externally hosted configuration, you can try the this workaround:
- The `include` section in the example compliance pipeline configuration must be adjusted.
For example, using [`include:rules`](../../ci/yaml/includes.md#use-rules-with-include):
```yaml
include:
# If the custom path variables are defined, include the project's external config file.
- project: '$PROTECTED_PIPELINE_CI_PROJECT_PATH'
file: '$PROTECTED_PIPELINE_CI_CONFIG_PATH'
ref: '$PROTECTED_PIPELINE_CI_REF'
rules:
- if: $PROTECTED_PIPELINE_CI_PROJECT_PATH && $PROTECTED_PIPELINE_CI_CONFIG_PATH && $PROTECTED_PIPELINE_CI_REF
# If any custom path variable is not defined, include the project's internal config file as normal.
- project: '$CI_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_SHA'
rules:
- if: $PROTECTED_PIPELINE_CI_PROJECT_PATH == null || $PROTECTED_PIPELINE_CI_CONFIG_PATH == null || $PROTECTED_PIPELINE_CI_REF == null
```
- [CI/CD variables](../../ci/variables/_index.md) must be added to projects with external
pipeline configuration. In this example:
- `PROTECTED_PIPELINE_CI_PROJECT_PATH`: The path to the project hosting the configuration file, for example `group/subgroup/project`.
- `PROTECTED_PIPELINE_CI_CONFIG_PATH`: The path to the configuration file in the project, for example `path/to/.gitlab-ci.yml`.
- `PROTECTED_PIPELINE_CI_REF`: The ref to use when retrieving the configuration file, for example `main`.
#### Compliance pipelines in merge requests originating in project forks
When a merge request originates in a fork, the branch to be merged usually only exists in the fork.
When creating such a merge request against a project with compliance pipelines, the previous snippet fails with a
`Project <project-name> reference <branch-name> does not exist!` error message.
This error occurs because in the context of the target project, `$CI_COMMIT_REF_NAME` evaluates to a non-existing
branch name.
To get the correct context, use `$CI_MERGE_REQUEST_SOURCE_PROJECT_PATH` instead of `$CI_PROJECT_PATH`.
This variable is only available in
[merge request pipelines](../../ci/pipelines/merge_request_pipelines.md).
For example, for a configuration that supports both merge request pipelines originating in project forks and branch pipelines,
you need to [combine both `include` directives with `rules:if`](../../ci/yaml/includes.md#use-rules-with-include):
```yaml
include: # Execute individual project's configuration (if project contains .gitlab-ci.yml)
- project: '$CI_MERGE_REQUEST_SOURCE_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_REF_NAME'
rules:
- if: $CI_PIPELINE_SOURCE == 'merge_request_event'
- project: '$CI_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_REF_NAME'
rules:
- if: $CI_PIPELINE_SOURCE != 'merge_request_event'
```
#### Compliance pipelines in projects with no configuration file
The [example configuration](#example-configuration) assumes that all projects contain
a pipeline configuration file (`.gitlab-ci.yml` by default). However, in projects
with no configuration file (and therefore no pipelines by default), the compliance pipeline
fails because the file specified in `include:project` is required.
To only include a configuration file if it exists in a target project, use
[`rules:exists:project`](../../ci/yaml/_index.md#rulesexistsproject):
```yaml
include: # Execute individual project's configuration
- project: '$CI_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_SHA'
rules:
- exists:
paths:
- '$CI_CONFIG_PATH'
project: '$CI_PROJECT_PATH'
ref: '$CI_COMMIT_SHA'
```
In this example, a configuration file is only included if it exists for the given `ref`
in the project in `exists:project: $CI_PROJECT_PATH'`.
If `exists:project` is not specified in the compliance pipeline configuration, it searches for files in the project
in which the `include` is defined. In compliance pipelines, the `include` from the previous example
is defined in the project hosting the compliance pipeline configuration file, not the project
running the pipeline.
## Ensure compliance jobs are always run
Compliance pipelines [use GitLab CI/CD](../../ci/_index.md) to give you an incredible amount of flexibility
for defining any sort of compliance jobs you like. Depending on your goals, these jobs
can be configured to be:
- Modified by users.
- Non-modifiable.
Generally, if a value in a compliance job:
- Is set, it cannot be changed or overridden by project-level configurations.
- Is not set, a project-level configuration may be set.
Either might be wanted or not depending on your use case.
The following are a few best practices for ensuring that these jobs are always run exactly
as you define them and that downstream, project-level pipeline configurations
cannot change them:
- Add [a `rules:when:always` block](../../ci/yaml/_index.md#when) to each of your compliance jobs. This ensures they are
non-modifiable and are always run.
- Explicitly set any [variables](../../ci/yaml/_index.md#variables) the job references. This:
- Ensures that project-level pipeline configurations do not set them and alter their
behavior. For example, see `before_script` and `after_script` configuration in the [example configuration](#example-configuration).
- Includes any jobs that drive the logic of your job.
- Explicitly set the [container image](../../ci/yaml/_index.md#image) to run the job in. This ensures that your script
steps execute in the correct environment.
- Explicitly set any relevant GitLab pre-defined [job keywords](../../ci/yaml/_index.md#job-keywords).
This ensures that your job uses the settings you intend and that they are not overridden by
project-level pipelines.
## Troubleshooting
### Compliance jobs are overwritten by target repository
If you use the `extends` statement in a compliance pipeline configuration, compliance jobs are overwritten by the target repository job. For example,
you could have the following `.compliance-gitlab-ci.yml` configuration:
```yaml
"compliance job":
extends:
- .compliance_template
stage: build
.compliance_template:
script:
- echo "take compliance action"
```
You could also have the following `.gitlab-ci.yml` configuration:
```yaml
"compliance job":
stage: test
script:
- echo "overwriting compliance action"
```
This configuration results in the target repository pipeline overwriting the compliance pipeline, and you get the following message:
`overwriting compliance action`.
To avoid overwriting a compliance job, don't use the `extends` keyword in compliance pipeline configuration. For example,
you could have the following `.compliance-gitlab-ci.yml` configuration:
```yaml
"compliance job":
stage: build
script:
- echo "take compliance action"
```
You could also have the following `.gitlab-ci.yml` configuration:
```yaml
"compliance job":
stage: test
script:
- echo "overwriting compliance action"
```
This configuration doesn't overwrite the compliance pipeline and you get the following message:
`take compliance action`.
### Prefilled variables are not shown
Because of a [known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/382857),
compliance pipelines in GitLab 15.3 and later can prevent
[prefilled variables](../../ci/pipelines/_index.md#prefill-variables-in-manual-pipelines)
from appearing when manually starting a pipeline.
To workaround this issue, use `ref: '$CI_COMMIT_SHA'` instead of `ref: '$CI_COMMIT_REF_NAME'`
in the `include:` statement that executes the individual project's configuration.
The [example configuration](#example-configuration) has been updated with this change:
```yaml
include:
- project: '$CI_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_SHA'
```
### Error: `Job names must be unique`
To configure a compliance pipeline, the [example configuration](#example-configuration) recommends including the
individual project configuration with `include.project`.
The configuration can lead to an error when running the projects pipeline: `Pipeline execution policy error: Job names must be unique`.
This error occurs because the pipeline execution policy includes the project's `.gitlab-ci.yml` and tries to insert the
jobs when the jobs have already been declared in the pipeline.
To resolve this error, remove `include.project` from the separate YAML file linked in the pipeline execution policy.
<!--- end_remove -->
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Compliance pipelines (deprecated)
description: Compliance pipelines (deprecated in 17.3, planned to be removed in 19.0)
enables centralized CI/CD control for labeled projects. Replaced by pipeline execution
policies.
breadcrumbs:
- doc
- user
- compliance
---
<!--- start_remove The following content will be removed on remove_date: '2025-08-15' -->
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159841) in GitLab 17.3
and is planned for removal in 19.0. Use [pipeline execution policy type](../application_security/policies/pipeline_execution_policies.md) instead.
This change is a breaking change. For more information, see the [migration guide](#pipeline-execution-policies-migration).
{{< /alert >}}
Group owners can configure a compliance pipeline in a project separate to other projects. By default, the compliance
pipeline configuration (for example, `.compliance-gitlab-ci.yml`) is run instead of the pipeline configuration (for example, `.gitlab-ci.yml`) of labeled
projects.
However, the compliance pipeline configuration can reference the `.gitlab-ci.yml` file of the labeled projects so that:
- The compliance pipeline can also run jobs of labeled project pipelines. This allows for centralized control of
pipeline configuration.
- Jobs and variables defined in the compliance pipeline can't be changed by variables in the labeled project's
`.gitlab-ci.yml` file.
{{< alert type="note" >}}
Because of a [known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/414004), project pipelines must be included first at the top of compliance pipeline configuration
to prevent projects overriding settings downstream.
{{< /alert >}}
For more information, see:
- [Example configuration](#example-configuration) for help configuring a compliance pipeline that runs jobs from
labeled project pipeline configuration.
- The [Create a compliance pipeline](../../tutorials/compliance_pipeline/_index.md) tutorial.
## Pipeline execution policies migration
To consolidate and simplify scan and pipeline enforcement, we have introduced pipeline execution policies. We deprecated
compliance pipelines in GitLab 17.3 and will remove compliance pipelines in GitLab 19.0.
Pipeline execution policies extend a project's `.gitlab-ci.yml` file with the configuration provided in separate YAML file
(for example, `pipeline-execution.yml`) linked in the pipeline execution policy.
By default, when creating a new compliance framework, you are directed to use the pipeline execution policy type instead
of compliance pipelines.
Existing compliance pipelines must be migrated. Customers should migrate from compliance pipelines to the new
[pipeline execution policy type](../application_security/policies/pipeline_execution_policies.md) as soon as possible.
### Migrate an existing compliance framework
To migrate an existing compliance framework to use the pipeline execution policy type:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. [Edit](compliance_frameworks/_index.md#create-edit-or-delete-a-compliance-framework) the existing compliance framework.
1. In the banner than appears, select **Migrate pipeline to a policy** to create a new policy in the security policies.
1. Edit the compliance framework again to remove the compliance pipeline.
For more information, see [Security policy project](../application_security/policies/enforcement/security_policy_projects.md).
If you receive a `Pipeline execution policy error: Job names must be unique` error during the migration, see the
[relevant troubleshooting information](#error-job-names-must-be-unique).
## Effect on labeled projects
Users have no way of knowing that a compliance pipeline has been configured and might be confused why their own
pipelines are not running at all, or include jobs that they did not define themselves.
When authoring pipelines on a labeled project, there is no indication that a compliance pipeline has been configured.
The only marker at the project level is the compliance framework label itself, but the label does not say whether the
framework has a compliance pipeline configured or not.
Therefore, communicate with project users about compliance pipeline configuration to reduce uncertainty and confusion.
### Multiple compliance frameworks
You can [apply to a single project](compliance_frameworks/_index.md#apply-a-compliance-framework-to-a-project) multiple compliance frameworks with compliance pipelines configured.
In this case, only the first compliance framework applied to a project has its compliance pipeline included in the project pipeline.
To ensure that the correct compliance pipeline is included in a project:
1. Remove all compliance frameworks from the project.
1. Apply the compliance framework with the correct compliance pipeline to the project.
1. Apply additional compliance frameworks to the project.
## Configure a compliance pipeline
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383209) in GitLab 15.11, compliance frameworks moved to compliance center.
{{< /history >}}
To configure a compliance pipeline:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure** > **Compliance Center**.
1. Select **Frameworks** section.
1. Select **New framework** section, add information of compliance framework including path to the compliance framework configuration. Use the
`path/file.y[a]ml@group-name/project-name` format. For example:
- `.compliance-ci.yml@gitlab-org/gitlab`.
- `.compliance-ci.yaml@gitlab-org/gitlab`.
This configuration is inherited by projects where the compliance framework label is
[applied](../project/working_with_projects.md#add-a-compliance-framework-to-a-project). In projects with the applied compliance
framework label, the compliance pipeline configuration is run instead of the labeled project's own pipeline configuration.
The user running the pipeline in the labeled project must at least have the Reporter role on the compliance project.
When used to enforce scan execution, this feature has some overlap with
[scan execution policies](../application_security/policies/scan_execution_policies.md). We have not
[unified the user experience for these two features](https://gitlab.com/groups/gitlab-org/-/epics/7312). For details on
the similarities and differences between these features, see [Scan execution policy compared to compliance framework](../application_security/detect/security_configuration.md#scan-execution-policy-compared-to-compliance-framework).
### Example configuration
The following example `.compliance-gitlab-ci.yml` includes the `include` keyword to ensure labeled project pipeline
configuration is also executed.
```yaml
include: # Execute individual project's configuration (if project contains .gitlab-ci.yml)
- project: '$CI_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_SHA' # Must be defined or MR pipelines always use the use default branch
rules:
- if: $CI_PROJECT_PATH != "my-group/project-1" # Must run on projects other than the one hosting this configuration.
# Allows compliance team to control the ordering and interweaving of stages/jobs.
# Stages without jobs defined will remain hidden.
stages:
- pre-compliance
- build
- test
- pre-deploy-compliance
- deploy
- post-compliance
variables: # Can be overridden by setting a job-specific variable in project's local .gitlab-ci.yml
FOO: sast
sast: # None of these attributes can be overridden by a project's local .gitlab-ci.yml
variables:
FOO: sast
image: ruby:2.6
stage: pre-compliance
rules:
- if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"
when: never
- when: always # or when: on_success
allow_failure: false
before_script:
- "# No before scripts."
script:
- echo "running $FOO"
after_script:
- "# No after scripts."
sanity check:
image: ruby:2.6
stage: pre-deploy-compliance
rules:
- if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"
when: never
- when: always # or when: on_success
allow_failure: false
before_script:
- "# No before scripts."
script:
- echo "running $FOO"
after_script:
- "# No after scripts."
audit trail:
image: ruby:2.7
stage: post-compliance
rules:
- if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"
when: never
- when: always # or when: on_success
allow_failure: false
before_script:
- "# No before scripts."
script:
- echo "running $FOO"
after_script:
- "# No after scripts."
```
The `rules` configuration in the `include` definition avoids circular inclusion in case the compliance pipeline must be able to run in the host project itself.
You can leave it out if your compliance pipeline only ever runs in labeled projects.
#### Compliance pipelines and custom pipeline configuration hosted externally
The previous example assumes that all projects host their pipeline configuration in the same project.
If any projects use [configuration hosted externally](../../ci/pipelines/settings.md#specify-a-custom-cicd-configuration-file),
the example configuration does not work. See [issue 393960](https://gitlab.com/gitlab-org/gitlab/-/issues/393960)
for more details.
With projects that use externally hosted configuration, you can try the this workaround:
- The `include` section in the example compliance pipeline configuration must be adjusted.
For example, using [`include:rules`](../../ci/yaml/includes.md#use-rules-with-include):
```yaml
include:
# If the custom path variables are defined, include the project's external config file.
- project: '$PROTECTED_PIPELINE_CI_PROJECT_PATH'
file: '$PROTECTED_PIPELINE_CI_CONFIG_PATH'
ref: '$PROTECTED_PIPELINE_CI_REF'
rules:
- if: $PROTECTED_PIPELINE_CI_PROJECT_PATH && $PROTECTED_PIPELINE_CI_CONFIG_PATH && $PROTECTED_PIPELINE_CI_REF
# If any custom path variable is not defined, include the project's internal config file as normal.
- project: '$CI_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_SHA'
rules:
- if: $PROTECTED_PIPELINE_CI_PROJECT_PATH == null || $PROTECTED_PIPELINE_CI_CONFIG_PATH == null || $PROTECTED_PIPELINE_CI_REF == null
```
- [CI/CD variables](../../ci/variables/_index.md) must be added to projects with external
pipeline configuration. In this example:
- `PROTECTED_PIPELINE_CI_PROJECT_PATH`: The path to the project hosting the configuration file, for example `group/subgroup/project`.
- `PROTECTED_PIPELINE_CI_CONFIG_PATH`: The path to the configuration file in the project, for example `path/to/.gitlab-ci.yml`.
- `PROTECTED_PIPELINE_CI_REF`: The ref to use when retrieving the configuration file, for example `main`.
#### Compliance pipelines in merge requests originating in project forks
When a merge request originates in a fork, the branch to be merged usually only exists in the fork.
When creating such a merge request against a project with compliance pipelines, the previous snippet fails with a
`Project <project-name> reference <branch-name> does not exist!` error message.
This error occurs because in the context of the target project, `$CI_COMMIT_REF_NAME` evaluates to a non-existing
branch name.
To get the correct context, use `$CI_MERGE_REQUEST_SOURCE_PROJECT_PATH` instead of `$CI_PROJECT_PATH`.
This variable is only available in
[merge request pipelines](../../ci/pipelines/merge_request_pipelines.md).
For example, for a configuration that supports both merge request pipelines originating in project forks and branch pipelines,
you need to [combine both `include` directives with `rules:if`](../../ci/yaml/includes.md#use-rules-with-include):
```yaml
include: # Execute individual project's configuration (if project contains .gitlab-ci.yml)
- project: '$CI_MERGE_REQUEST_SOURCE_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_REF_NAME'
rules:
- if: $CI_PIPELINE_SOURCE == 'merge_request_event'
- project: '$CI_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_REF_NAME'
rules:
- if: $CI_PIPELINE_SOURCE != 'merge_request_event'
```
#### Compliance pipelines in projects with no configuration file
The [example configuration](#example-configuration) assumes that all projects contain
a pipeline configuration file (`.gitlab-ci.yml` by default). However, in projects
with no configuration file (and therefore no pipelines by default), the compliance pipeline
fails because the file specified in `include:project` is required.
To only include a configuration file if it exists in a target project, use
[`rules:exists:project`](../../ci/yaml/_index.md#rulesexistsproject):
```yaml
include: # Execute individual project's configuration
- project: '$CI_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_SHA'
rules:
- exists:
paths:
- '$CI_CONFIG_PATH'
project: '$CI_PROJECT_PATH'
ref: '$CI_COMMIT_SHA'
```
In this example, a configuration file is only included if it exists for the given `ref`
in the project in `exists:project: $CI_PROJECT_PATH'`.
If `exists:project` is not specified in the compliance pipeline configuration, it searches for files in the project
in which the `include` is defined. In compliance pipelines, the `include` from the previous example
is defined in the project hosting the compliance pipeline configuration file, not the project
running the pipeline.
## Ensure compliance jobs are always run
Compliance pipelines [use GitLab CI/CD](../../ci/_index.md) to give you an incredible amount of flexibility
for defining any sort of compliance jobs you like. Depending on your goals, these jobs
can be configured to be:
- Modified by users.
- Non-modifiable.
Generally, if a value in a compliance job:
- Is set, it cannot be changed or overridden by project-level configurations.
- Is not set, a project-level configuration may be set.
Either might be wanted or not depending on your use case.
The following are a few best practices for ensuring that these jobs are always run exactly
as you define them and that downstream, project-level pipeline configurations
cannot change them:
- Add [a `rules:when:always` block](../../ci/yaml/_index.md#when) to each of your compliance jobs. This ensures they are
non-modifiable and are always run.
- Explicitly set any [variables](../../ci/yaml/_index.md#variables) the job references. This:
- Ensures that project-level pipeline configurations do not set them and alter their
behavior. For example, see `before_script` and `after_script` configuration in the [example configuration](#example-configuration).
- Includes any jobs that drive the logic of your job.
- Explicitly set the [container image](../../ci/yaml/_index.md#image) to run the job in. This ensures that your script
steps execute in the correct environment.
- Explicitly set any relevant GitLab pre-defined [job keywords](../../ci/yaml/_index.md#job-keywords).
This ensures that your job uses the settings you intend and that they are not overridden by
project-level pipelines.
## Troubleshooting
### Compliance jobs are overwritten by target repository
If you use the `extends` statement in a compliance pipeline configuration, compliance jobs are overwritten by the target repository job. For example,
you could have the following `.compliance-gitlab-ci.yml` configuration:
```yaml
"compliance job":
extends:
- .compliance_template
stage: build
.compliance_template:
script:
- echo "take compliance action"
```
You could also have the following `.gitlab-ci.yml` configuration:
```yaml
"compliance job":
stage: test
script:
- echo "overwriting compliance action"
```
This configuration results in the target repository pipeline overwriting the compliance pipeline, and you get the following message:
`overwriting compliance action`.
To avoid overwriting a compliance job, don't use the `extends` keyword in compliance pipeline configuration. For example,
you could have the following `.compliance-gitlab-ci.yml` configuration:
```yaml
"compliance job":
stage: build
script:
- echo "take compliance action"
```
You could also have the following `.gitlab-ci.yml` configuration:
```yaml
"compliance job":
stage: test
script:
- echo "overwriting compliance action"
```
This configuration doesn't overwrite the compliance pipeline and you get the following message:
`take compliance action`.
### Prefilled variables are not shown
Because of a [known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/382857),
compliance pipelines in GitLab 15.3 and later can prevent
[prefilled variables](../../ci/pipelines/_index.md#prefill-variables-in-manual-pipelines)
from appearing when manually starting a pipeline.
To workaround this issue, use `ref: '$CI_COMMIT_SHA'` instead of `ref: '$CI_COMMIT_REF_NAME'`
in the `include:` statement that executes the individual project's configuration.
The [example configuration](#example-configuration) has been updated with this change:
```yaml
include:
- project: '$CI_PROJECT_PATH'
file: '$CI_CONFIG_PATH'
ref: '$CI_COMMIT_SHA'
```
### Error: `Job names must be unique`
To configure a compliance pipeline, the [example configuration](#example-configuration) recommends including the
individual project configuration with `include.project`.
The configuration can lead to an error when running the projects pipeline: `Pipeline execution policy error: Job names must be unique`.
This error occurs because the pipeline execution policy includes the project's `.gitlab-ci.yml` and tries to insert the
jobs when the jobs have already been declared in the pipeline.
To resolve this error, remove `include.project` from the separate YAML file linked in the pipeline execution policy.
<!--- end_remove -->
|
https://docs.gitlab.com/user/audit_event_types
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/audit_event_types.md
|
2025-08-13
|
doc/user/compliance
|
[
"doc",
"user",
"compliance"
] |
audit_event_types.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Audit event types
| null |
<!--
This documentation is auto generated by a Rake task.
Please do not edit this file directly. To update this file, run:
bundle exec rake gitlab:audit_event_types:compile_docs
To make changes to the output of the Rake task,
edit `tooling/audit_events/docs/templates/audit_event_types.md.erb`.
-->
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/172757) in GitLab 17.7, all audit events can be streamed.
{{< /history >}}
Audit event types are used to filter streamed audit events:
- [For instances](../../administration/compliance/audit_event_streaming.md#update-event-filters).
- [For top-level groups](audit_event_streaming.md#update-event-filters)
Every audit event is associated with an event type. Audit event types can allow:
- Most audit events to be saved to the database. Available in the Premium and Ultimate tier. You can retrieve
audit events associated with these types by using the audit events dashboard or the
[audit events API](../../api/audit_events.md).
- All audit events to be streamed to external destinations. Available in the Ultimate tier. You can stream audit events
associated with these types to external destinations if a destination is set.
An audit event type's scope limits the availability of the audit event type to either:
- [Project, group, or user](audit_events.md) audit events.
- [Instance](../../administration/compliance/audit_event_reports.md) audit events.
## Available audit event types
Audit event types belong to the following product categories.
### Ai framework
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`duo_features_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/145509) | GitLab Duo Features enabled setting on group or project changed | {{< icon name="check-circle" >}} Yes | GitLab [16.10](https://gitlab.com/gitlab-org/gitlab/-/issues/442485) | Group, Project |
| [`q_onbarding_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/175501) | Amazon Q instance settings changed | {{< icon name="check-circle" >}} Yes | GitLab [17.8](https://gitlab.com/gitlab-org/gitlab/-/issues/508250) | Instance |
### Audit events
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`amazon_s3_configuration_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132443) | Amazon S3 configuration for audit events streaming is created | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/423229) | Group |
| [`amazon_s3_configuration_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/133695) | Amazon S3 configuration for audit events streaming is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/423229) | Group |
| [`amazon_s3_configuration_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/133691) | Amazon S3 configuration for audit events streaming is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/423229) | Group |
| [`audit_events_streaming_headers_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92068) | A streaming header for audit events is created | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/366350) | Group |
| [`audit_events_streaming_headers_destroy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92068) | A streaming header for audit events is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/366350) | Group |
| [`audit_events_streaming_instance_headers_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125870) | A streaming header for instance level external audit event destination is created | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/417433) | Instance |
| [`audit_events_streaming_instance_headers_destroy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127228) | A streaming header for instance level external audit event destination is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/417433) | Instance |
| [`audit_events_streaming_instance_headers_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127228) | A streaming header for instance level external audit event destination is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/417433) | Instance |
| [`create_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74632) | An external audit event destination is created | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/344664) | Group |
| [`create_http_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136047) | A namespace filter for an external audit event destination for a top-level group is created | {{< icon name="check-circle" >}} Yes | GitLab [16.6](https://gitlab.com/gitlab-org/gitlab/-/issues/424176) | Group |
| [`create_instance_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123882) | An external audit event destination for an instance is created | {{< icon name="check-circle" >}} Yes | GitLab [16.2](https://gitlab.com/gitlab-org/gitlab/-/issues/404730) | Instance |
| [`created_group_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/147888) | An external audit event destination for a top-level group is created | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436610) | Group |
| [`created_group_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/150712) | A namespace filter for an external audit event destination for a top-level group is created | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/436612) | Group |
| [`created_instance_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148383) | An external audit event destination for an instance is created | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436615) | Instance |
| [`created_instance_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/153156) | A namespace filter for an external audit event destination for an instance is created | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/436613) | Instance |
| [`delete_http_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136302) | A namespace filter for an external audit event destination for a top-level group is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/424177) | Group |
| [`deleted_group_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148738) | An external audit event destination for a top-level group is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436610) | Group |
| [`deleted_group_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/150712) | A namespace filter for an external audit event destination for a top-level group is deleted | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/436612) | Group |
| [`deleted_instance_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/14910) | An external audit event destination for a GitLab instance is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436615) | Instance |
| [`deleted_instance_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/153156) | A namespace filter for an external audit event destination for a GitLab instance is deleted | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/436613) | Instance |
| [`destroy_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74632) | An external audit event destination is deleted | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/344664) | Group |
| [`destroy_instance_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125846) | An instance level external audit event destination is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.2](https://gitlab.com/gitlab-org/gitlab/-/issues/404730) | Instance |
| [`event_type_filters_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113081) | A new audit events streaming event type filter is created | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/344848) | Group |
| [`event_type_filters_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113489) | An audit events streaming event type filter is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/344848) | Group |
| [`google_cloud_logging_configuration_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122025) | Google Cloud Logging configuration is created | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/409422) | Group |
| [`google_cloud_logging_configuration_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122025) | Google Cloud Logging configuration is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/409422) | Group |
| [`google_cloud_logging_configuration_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122025) | Google Cloud Logging configuration is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/409422) | Group |
| [`instance_amazon_s3_configuration_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137651) | Instance Amazon S3 configuration for audit events streaming is created | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/423235) | Instance |
| [`instance_amazon_s3_configuration_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/138318) | Instance-level Amazon S3 configuration for audit events streaming is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/423235) | Instance |
| [`instance_amazon_s3_configuration_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/138310) | Instance-level Amazon S3 configuration for audit events streaming is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/423235) | Instance |
| [`instance_google_cloud_logging_configuration_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130663) | Instance-level Google Cloud Logging configuration is created | {{< icon name="check-circle" >}} Yes | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/423038) | Instance |
| [`instance_google_cloud_logging_configuration_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131752) | Instance-level Google Cloud Logging configuration is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/423040) | Instance |
| [`instance_google_cloud_logging_configuration_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131790) | Instance-level Google Cloud Logging configuration is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/423039) | Instance |
| [`update_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74632) | An external audit event destination is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/344664) | Group |
| [`update_instance_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125846) | An instance level external audit event destination is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.2](https://gitlab.com/gitlab-org/gitlab/-/issues/404730) | Instance |
| [`updated_group_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148388) | An external audit event destination for a top-level group is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436610) | Group |
| [`updated_instance_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/149104) | An external audit event destination for a GitLab instance is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436615) | Instance |
### Authorization
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`oauth_application_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194557) | User creates an OAuth application | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/550321) | User |
| [`secure_ci_job_token_policies_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/170930) | Permissions are updated for a CI_JOB_TOKEN scope | {{< icon name="check-circle" >}} Yes | GitLab [17.6](https://gitlab.com/gitlab-org/gitlab/-/issues/495144) | Project |
| [`user_authorized_oauth_application`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/179187) | User authorized an OAuth application | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/514152) | User |
### Build artifacts
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`job_artifact_downloaded`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129608) | A user downloads a job artifact from a project | {{< icon name="dotted-circle" >}} No | GitLab [16.8](https://gitlab.com/gitlab-org/gitlab/-/issues/250663) | Project |
### Ci variables
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`variable_viewed_api`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197385) | A CI/CD variable is accessed with the API | {{< icon name="dotted-circle" >}} No | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/555960) | Project, Group |
### Code review
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`delete_merge_request`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96773) | A merge request is successfully deleted | {{< icon name="dotted-circle" >}} No | GitLab [15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/370487) | Project |
| [`group_merge_request_approval_setting_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/87880) | Merge request approval settings are added to a group | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/356152) | Group |
### Code review workflow
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`merge_request_approval_operation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92983) | A merge request is approved | {{< icon name="dotted-circle" >}} No | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/10869) | Project |
| [`merge_request_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120927) | A merge request is closed using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`merge_request_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120927) | A merge request is created using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`merge_request_invalid_approver_rules`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/100496) | An invalid rule when merge request is approved | {{< icon name="check-circle" >}} Yes | GitLab [15.5](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/100496) | Project |
| [`merge_request_merged_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120927) | A merge request is merged using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`merge_request_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120927) | A merge request is reopened using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`project_merge_method_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/83922) | A project's merge request method is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.10](https://gitlab.com/gitlab-org/gitlab/-/issues/301124) | Project |
| [`project_merge_requests_author_approval_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's MR author approval setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`project_merge_requests_disable_committers_approval_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's setting for disabling committers approval on merge requests is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369277) | Project |
| [`project_merge_requests_template_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | A merge request template for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/355805) | Project |
| [`project_only_allow_merge_if_all_discussions_are_resolved_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's setting for allowing merge only when all discussions are resolved is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369286) | Project |
| [`project_only_allow_merge_if_pipeline_succeeds_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's only allow merge if pipeline succeeds setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`project_remove_source_branch_after_merge_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/83922) | A project has its setting to remove branches after merges updated | {{< icon name="check-circle" >}} Yes | GitLab [14.10](https://gitlab.com/gitlab-org/gitlab/-/issues/301124) | Project |
| [`project_require_password_to_approve_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's setting for requiring a user's password for approval of merge request is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369280) | Project |
| [`project_reset_approvals_on_push_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66234) | A project has its setting on whether approvals are reset on a push is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.2](https://gitlab.com/gitlab-org/gitlab/-/issues/336211) | Project |
| [`project_resolve_outdated_diff_discussions_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's resolve outdated diff discussions setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`show_diff_preview_in_email_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Email notification to include diff preview is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group, Project |
| [`selective_code_owner_removals_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148743) | Selective code owner removal is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/327562) | Project |
### Code suggestions
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_suggestion_commit_message_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/83922) | A project has its suggested commit message updated | {{< icon name="check-circle" >}} Yes | GitLab [14.10](https://gitlab.com/gitlab-org/gitlab/-/issues/301124) | Project |
### Compliance management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`add_gpg_key`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111744) | A GPG key is added | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373961) | User |
| [`allow_author_approval_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102256) | Prevent approval by author setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/373949) | Group |
| [`allow_committer_approval_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102256) | Prevent approvals by users who add commits setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/373949) | Group |
| [`allow_overrides_to_approver_list_per_merge_request_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102256) | Prevent editing approval rules in projects and merge requests setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/373949) | Group |
| [`audit_events_streaming_headers_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92068) | A streaming header for audit events is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/366350) | Group |
| [`compliance_control_status_fail`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/180107) | A compliance control status is updated to fail | {{< icon name="check-circle" >}} Yes | GitLab [17.10](https://gitlab.com/gitlab-org/gitlab/-/issues/513425) | Project |
| [`compliance_control_status_pass`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/180107) | A compliance control status is updated to pass | {{< icon name="check-circle" >}} Yes | GitLab [17.10](https://gitlab.com/gitlab-org/gitlab/-/issues/513425) | Project |
| [`compliance_framework_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/157893) | A compliance framework is applied to a project | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/464160) | Project |
| [`compliance_framework_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65343) | A compliance framework is removed from a project | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/329362) | Project |
| [`compliance_framework_id_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/94711) | A compliance framework is updated for a project | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369310) | Project |
| [`compliance_framework_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/157893) | A compliance framework is removed from a project | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/464160) | Project |
| [`create_compliance_framework`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74292) | A compliance framework is successfully created | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/340649) | Group |
| [`create_status_check`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | An external status check is created | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/355805) | Project |
| [`created_compliance_requirement`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169485) | A requirement is added to a compliance framework | {{< icon name="check-circle" >}} Yes | GitLab [17.6](https://gitlab.com/gitlab-org/gitlab/-/issues/470695) | Group |
| [`created_compliance_requirement_control`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/177557) | A control is added to a compliance requirement. | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/512381) | Group |
| [`delete_status_check`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | An external status check is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/355805) | Project |
| [`destroy_compliance_framework`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74292) | A compliance framework is successfully deleted | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/340649) | Group |
| [`destroyed_compliance_requirement`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/170380) | A compliance framework requirement is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/470695) | Group |
| [`destroyed_compliance_requirement_control`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/177878) | A compliance requirement control is destroyed. | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/512381) | Group |
| [`external_status_check_name_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106095) | The name of an external status check is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369333) | Project |
| [`external_status_check_url_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | The URL that is used for external status checks for a pipeline is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/355805) | Project |
| [`group_saml_provider_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111227) | A group SAML provider is created | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373964) | Group |
| [`group_saml_provider_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111227) | A group SAML provider is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373964) | Group |
| [`inactive_project_scheduled_for_deletion`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130699) | An inactive project is scheduled for deletion | {{< icon name="check-circle" >}} Yes | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/423263) | Project |
| [`member_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/109711) | A membership is created | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374112) | Group, Project |
| [`member_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/109711) | A membership is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374112) | Group, Project |
| [`member_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/109711) | A membership is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374112) | Group, Project |
| [`merge_request_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90911) | A merge request is created | {{< icon name="dotted-circle" >}} No | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/367239) | Project |
| [`merge_request_merged`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164846) | A merge request is merged | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/442279) | Project |
| [`omniauth_login_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123080) | An OmniAuth login fails | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`password_reset_requested`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114548) | A user requests a password reset using a registered email address | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`pending_compliance_external_control_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/180016) | A project's compliance external control status is updated to fail because of timeout. | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/513421) | Project |
| [`personal_access_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108952) | A user creates a personal access token | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374113) | User |
| [`personal_access_token_revoked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108952) | A personal access token is revoked | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374113) | User |
| [`project_archived`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117528) | A project is archived | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_deletion_marked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117546) | A project is marked for deletion | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117546) | A project is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Group |
| [`project_export_file_download_started`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117528) | A download of a project export file is started | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_feature_security_and_compliance_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's security and compliance access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369302) | Project |
| [`project_group_link_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108918) | A group is invited to a project | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374114) | Group |
| [`project_group_link_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108918) | A project group link is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374114) | Group |
| [`project_group_link_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108918) | A project group link is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374114) | Project |
| [`project_imported`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117528) | A project is imported | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Group |
| [`project_restored`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117528) | A project is restored | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`protected_branch_allow_force_push_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68869) | A protected branch has its ability to allow force pushes is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.3](https://gitlab.com/gitlab-org/gitlab/-/issues/338873) | Project |
| [`public_repository_download_operation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/149842) | A Git repository for a public project is downloaded | {{< icon name="dotted-circle" >}} No | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/383218) | Project |
| [`registration_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123080) | A user registers for instance access | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`release_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111080) | A release is created | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374111) | Project |
| [`release_deleted_audit_event`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111080) | A release is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374111) | Project |
| [`release_milestones_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111080) | A release's associated milestones are updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374111) | Project |
| [`release_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111080) | A release is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374111) | Project |
| [`remove_gpg_key`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111744) | A GPG key is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373961) | User |
| [`repository_download_operation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111218) | A Git repository for a private or internal project is downloaded | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374108) | Project |
| [`request_to_compliance_external_control_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/180010) | Request to compliance external control failed | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/513421) | Project |
| [`request_to_compliance_external_control_successful`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/180010) | Request to compliance external control successful | {{< icon name="dotted-circle" >}} No | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/513421) | Project |
| [`require_password_to_approve_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102256) | Require user password for approvals from group merge request setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/373949) | Group |
| [`retain_approvals_on_push_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102256) | Require new approvals when new commits are added to an MR from group merge request setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/373949) | Group |
| [`saml_group_links_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110525) | A SAML Group Link is created | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373954) | Group |
| [`saml_group_links_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110525) | A SAML Group Link is removed | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373954) | Group |
| [`smartcard_authentication_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/8120) | A user authenticates with smartcard | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/726) | User |
| [`update_approval_rules`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89939) | Updating a merge approval rule | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363092) | Project |
| [`update_compliance_framework`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74292) | A compliance framework is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/340649) | Group |
| [`update_compliance_requirement`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169485) | A compliance framework requirement is updated. | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/470695) | Group |
| [`update_project_compliance_violation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195768) | Project compliance violation is updated | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/542343) | Project |
| [`update_status_check`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | An external status check is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/355805) | Project |
| [`updated_compliance_requirement_control`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/177557) | Compliance requirement control updated. | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/512381) | Group |
### Container registry
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`container_repository_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/156037) | A container repository is first pushed to the registry | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/362290) | Project |
| [`container_repository_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152967) | A project's container registry is deleted | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/362290) | Project |
| [`container_repository_deletion_marked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152967) | A project's container repository is marked for deletion | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/362290) | Project |
| [`container_repository_tags_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/156066) | A project's container repository tag is deleted | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/362290) | Project |
| [`project_feature_container_registry_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's container registry access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369303) | Project |
### Continuous delivery
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`deploy_key_added`](https://gitlab.com/gitlab-org/gitlab/-/commit/08586a616909c7f9efe2210c2b74fd3422d4eb62) | A deploy key is added | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deploy_key_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92219) | A deploy key is removed | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deploy_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89391) | A deploy token is created | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deploy_token_creation_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89391) | A deploy token fails to create | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deploy_token_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89391) | A deploy token is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deploy_token_revoked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89391) | A project deploy token is revoked | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deployment_approved`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/153375) | A deployment is approved | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/456685) | Project |
| [`deployment_rejected`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/153375) | A deployment is rejected | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/456685) | Project |
| [`deployment_started`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/156111) | A deployment to a protected environment is started | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/456687) | Project |
| [`group_deploy_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93091) | A group deploy token is created | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_deploy_token_creation_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93091) | Creating a group deploy token failed | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_deploy_token_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93091) | A group deploy token is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_deploy_token_revoked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93091) | A group deploy token is revoked | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
### Continuous integration
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`allow_merge_on_skipped_pipeline_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/83922) | Skipped pipelines are considered successful setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.10](https://gitlab.com/gitlab-org/gitlab/-/issues/301124) | Project |
| [`ci_group_variable_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is created for a group | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Group |
| [`ci_group_variable_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is deleted for a group | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Group |
| [`ci_group_variable_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is updated for a group | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Group |
| [`ci_instance_variable_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131882) | A CI/CD variable is created for an instance | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/8070) | Instance |
| [`ci_instance_variable_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131882) | A CI/CD variable is deleted for an instance | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/8070) | Instance |
| [`ci_instance_variable_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131882) | A CI/CD variable is updated for an instance | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/8070) | Instance |
| [`ci_variable_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is created for a project | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Project |
| [`ci_variable_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is deleted for a project | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Project |
| [`ci_variable_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is updated for a project | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Project |
| [`destroy_pipeline`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/135255) | A pipeline is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.6](https://gitlab.com/gitlab-org/gitlab/-/issues/339041) | Project |
| [`multi_project_downstream_pipeline_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/168626) | Multi project downstream pipeline is created | {{< icon name="dotted-circle" >}} No | GitLab [17.6](https://gitlab.com/gitlab-org/gitlab/-/issues/481325) | Project |
| [`project_cicd_merge_pipelines_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107428) | The CI/CD merge pipelines setting for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369317) | Project |
### Delivery
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_releases_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's releases access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369308) | Project |
### Deployment management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`cluster_agent_create_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159593) | A user attempts to create a cluster agent but it failed | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/462749) | Project |
| [`cluster_agent_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159593) | A user creates a cluster agent | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/462749) | Project |
| [`cluster_agent_delete_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159593) | A user attempts to delete a cluster agent but it failed | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/462749) | Project |
| [`cluster_agent_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159593) | A user deletes a cluster agent | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/462749) | Project |
| [`cluster_agent_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112036) | A user creates a cluster agent token | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/382133) | Project |
| [`cluster_agent_token_revoked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112036) | A user revokes a cluster agent token | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/382133) | Project |
### Dora metrics
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_metrics_dashboard_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's metrics dashboard access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369289) | Project |
### GitLab Duo Agent Platform
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`api_request_access_with_scope`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/172548) | A subset of API requests authenticated by a token with an audited scope | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/499461) | User |
### Dynamic application security testing
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`dast_profile_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62604) | A dynamic application security testing profile is created | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_profile_destroy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62604) | A dynamic application security profile is removed | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_profile_schedule_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68046) | A dynamic application security testing profile schedule is created | {{< icon name="check-circle" >}} Yes | GitLab [14.3](https://gitlab.com/gitlab-org/gitlab/-/issues/330308) | Project |
| [`dast_profile_schedule_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66445) | A dynamic application security testing profile schedule is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.3](https://gitlab.com/gitlab-org/gitlab/-/issues/330308) | Project |
| [`dast_profile_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62604) | A dynamic application security profile is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_scanner_profile_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62007) | A dynamic application security testing scanner profile is created | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_scanner_profile_destroy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62007) | A dynamic application security testing scanner profile is removed | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_scanner_profile_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62007) | A dynamic application security testing scanner profile is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_site_profile_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62465) | A dynamic application security testing site profile is created | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_site_profile_destroy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62465) | A dynamic application security testing site profile is removed | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_site_profile_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62465) | A dynamic application security testing site profile is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
### Environment management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`environment_protected`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108247) | A protected environment is created | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/216164) | Group, Project |
| [`environment_unprotected`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108247) | A protected environment is unprotected | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/216164) | Group, Project |
| [`project_feature_environments_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's environments access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369307) | Project |
| [`protected_environment_approval_rule_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | An approval rule is added to a protected environment | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Group, Project |
| [`protected_environment_approval_rule_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | An approval rule is removed from a protected environment | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Project, Group |
| [`protected_environment_approval_rule_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | An approval rule of a protected environment is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Project, Group |
| [`protected_environment_deploy_access_level_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | A deploy access level is added to a protected environment | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Group, Project |
| [`protected_environment_deploy_access_level_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | A deploy access level is removed from a protected environment | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Group, Project |
| [`protected_environment_deploy_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | A deploy access level of a protected environment is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Project |
| [`protected_environment_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | A protected environment is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Group, Project |
### Feature flags
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_feature_flags_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's feature flags access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369306) | Project |
| [`feature_flag_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113453) | A feature flag is created | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/374109) | Project |
| [`feature_flag_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113453) | A feature flag is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/374109) | Project |
| [`feature_flag_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113453) | A feature flag is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/374109) | Project |
### Fleet visibility
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`ci_runner_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173885) | Triggered when a runner is created | {{< icon name="check-circle" >}} Yes | GitLab [17.8](https://gitlab.com/gitlab-org/gitlab/-/issues/503315) | Instance, Group, Project |
| [`ci_runner_usage_export`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/139578) | A runner usage report is generated | {{< icon name="check-circle" >}} Yes | GitLab [16.8](https://gitlab.com/gitlab-org/gitlab/-/issues/426560) | Instance |
| [`ci_runners_bulk_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173886) | Runners are deleted in bulk | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/503315) | User |
### Fuzz testing
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`coverage_fuzzing_corpus_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71992) | A corpus action is added | {{< icon name="check-circle" >}} Yes | GitLab [14.5](https://gitlab.com/gitlab-org/gitlab/-/issues/341485) | Project |
### Groups and projects
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`create_ssh_certificate`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/134556) | An SSH certificate is created | {{< icon name="check-circle" >}} Yes | GitLab [16.6](https://gitlab.com/gitlab-org/gitlab/-/issues/427413) | Group |
| [`delete_ssh_certificate`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/134556) | An SSH certificate is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.6](https://gitlab.com/gitlab-org/gitlab/-/issues/427413) | Group |
| [`emails_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Enable email notifications is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`enabled_git_access_protocol_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Enabled Git access protocols is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`enforce_ssh_certificates_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Enforce SSH Certificates is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`group_archived`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/199419) | A group is archived | {{< icon name="check-circle" >}} Yes | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/520013) | Group |
| [`group_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121005) | A group is created | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/411595) | Group |
| [`group_deletion_marked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116986) | A group is marked for deletion | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374106) | Group |
| [`group_description_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973/) | Group description is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`group_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116986) | A group is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374106) | Group |
| [`group_lfs_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | LFS enabled for a group is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369323) | Group |
| [`group_membership_lock_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | Membership lock for a group is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369323) | Group |
| [`group_mentions_disabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | A group's setting to notify group members on group mention is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`group_name_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's name is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369320) | Group |
| [`group_path_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's path is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369321) | Group |
| [`group_project_creation_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's project creation level is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369327) | Group |
| [`group_request_access_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's request access enabled is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369323) | Group |
| [`group_restored`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116986) | A group is restored | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374106) | Group |
| [`group_share_with_group_link_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112719) | You invite a group to another group by using the group's membership page | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/327909) | Group |
| [`group_share_with_group_link_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112719) | You remove a group from another group by using the group's membership page | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/327909) | Group |
| [`group_share_with_group_link_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112719) | You update a group's access settings to another group by using the group's membership page | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/327909) | Group |
| [`group_shared_with_group_lock_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973/) | Group can be shared with other group setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`group_unarchived`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/199419) | A group is unarchived | {{< icon name="check-circle" >}} Yes | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/520013) | Group |
| [`group_visibility_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's visibility level is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369322) | Group |
| [`prevent_sharing_groups_outside_hierarchy_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | A group's setting to Members cannot invite groups outside of group and its subgroup updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`project_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117543) | A project is created | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_description_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128978) | A project's description is updated | {{< icon name="dotted-circle" >}} No | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/377769) | Project |
| [`project_feature_operations_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's operation access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369300) | Project |
| [`project_feature_requirements_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's requirements access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369301) | Project |
| [`project_name_updated`](https://gitlab.com/gitlab-org/gitlab/-/commit/8c0b52247e717cf84bc7b248d817f8baa55b18a4) | A project has its name updated | {{< icon name="check-circle" >}} Yes | GitLab [10.2](https://gitlab.com/gitlab-org/gitlab/-/commit/8c0b52247e717cf84bc7b248d817f8baa55b18a4) | Project |
| [`project_namespace_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's namespace is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`project_path_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/100770) | A project's path is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/369271) | Project |
| [`project_topics_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/154158) | A project's topics assignments are changed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/343204) | Project |
| [`project_unarchived`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117528) | A project is unarchived | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_visibility_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's visibility level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`remove_dormant_members_period_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Days of inactivity before removal is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`remove_dormant_members_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Dormant members is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
### Importers
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`direct_transfer_relation_export_batch_downloaded`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194872) | Direct Transfer relation export batch downloaded | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/441977) | Group, Project |
| [`direct_transfer_relation_export_downloaded`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194872) | Direct Transfer relation export downloaded | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/441977) | Group, Project |
| [`direct_transfer_relations_export_initiated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194872) | Direct Transfer relations export initiated | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/441977) | Group, Project |
| [`group_export_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/TODO) | A group file export is created | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/294168) | Group |
| [`project_export_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/TODO) | A project file export is created | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/294168) | Project |
### Incident management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`incident_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An incident is closed using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`incident_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An incident is created using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`incident_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An incident is reopened using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
### Merge trains
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_cicd_merge_trains_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107428) | The CI/CD merge trains settings for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369317) | Project |
### MLOps
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_model_experiments_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121027) | A project's model experiments access level is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/412384) | Project |
| [`ml_model_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165011) | ML model is created | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/463215) | Project |
| [`ml_model_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165011) | ML model destroyed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/463215) | Project |
| [`ml_model_version_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165145) | ML model version is created | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/463215) | Project |
| [`ml_model_version_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165145) | ML model version destroyed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/463215) | Project |
| [`project_feature_model_registry_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/138399) | Model registry access level was updated | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/412734) | Project |
### Not categorized
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`experiment_features_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118222) | Enabling experiment AI features setting is toggled | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/404856/) | Group |
### Observability
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_monitor_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's monitor access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369304) | Project |
### Package registry
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`package_registry_package_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/178181) | A package was deleted from GitLab package registry. Available only when the namespace's package setting `audit_events_enabled` is true. | {{< icon name="check-circle" >}} Yes | GitLab [17.10](https://gitlab.com/gitlab-org/gitlab/-/issues/329588) | Project, Group |
| [`package_registry_package_published`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/178181) | A package was published to GitLab package registry. Available only when the namespace's package setting `audit_events_enabled` is true. | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/329588) | Project, Group |
| [`project_feature_package_registry_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's package registry access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369296) | Project |
| [`project_packages_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/7962) | The setting that controls packages for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [11.5](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
### Pages
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_pages_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's page access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369297) | Project |
### Permissions
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`custom_admin_role_assigned_to_user`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/186570) | A custom admin role is assigned to a user | {{< icon name="check-circle" >}} Yes | GitLab [18.0](https://gitlab.com/gitlab-org/gitlab/-/issues/507958) | User |
| [`custom_admin_role_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/188367) | A custom admin role is created | {{< icon name="check-circle" >}} Yes | GitLab [18.0](https://gitlab.com/gitlab-org/gitlab/-/issues/536131) | Instance |
| [`custom_admin_role_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/188367) | A custom admin role is deleted | {{< icon name="check-circle" >}} Yes | GitLab [18.0](https://gitlab.com/gitlab-org/gitlab/-/issues/536131) | Instance |
| [`custom_admin_role_unassigned_from_user`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/186570) | A custom admin role is unassigned from a user | {{< icon name="check-circle" >}} Yes | GitLab [18.0](https://gitlab.com/gitlab-org/gitlab/-/issues/507958) | User |
| [`custom_admin_role_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/188367) | A custom admin role is updated | {{< icon name="check-circle" >}} Yes | GitLab [18.0](https://gitlab.com/gitlab-org/gitlab/-/issues/536131) | Instance |
| [`member_role_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137087) | A custom role is created | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/388934) | Group, Instance |
| [`member_role_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141630) | A custom role is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.9](https://gitlab.com/gitlab-org/gitlab/-/issues/437672) | Group, Instance |
| [`member_role_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141630) | A custom role is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.9](https://gitlab.com/gitlab-org/gitlab/-/issues/437672) | Group, Instance |
### Portfolio management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`delete_epic`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96773) | An epic is successfully deleted | {{< icon name="dotted-circle" >}} No | GitLab [15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/370487) | Group |
| [`epic_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An epic is closed by a group access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Group |
| [`epic_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An epic is created by a group access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Group |
| [`epic_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An epic is reopened by a group access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Group |
### Product analytics data management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`product_analytics_settings_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/154101) | Product analytics settings are changed | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/463318) | Project |
### Quality management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`test_case_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A test case is closed using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`test_case_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A test case is created using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`test_case_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A test case is reopened using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
### Runner
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`allow_runner_registration_token_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Allow members of projects and groups to create runners with runner registration tokens is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group, Project |
| [`ci_runner_assigned_to_project`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81508) | A runner is assigned to a project | {{< icon name="check-circle" >}} Yes | GitLab [14.9](https://gitlab.com/gitlab-org/gitlab/-/issues/349542) | Project |
| [`ci_runner_registered`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/77109) | An instance, group, or project runner is registered | {{< icon name="check-circle" >}} Yes | GitLab [14.8](https://gitlab.com/gitlab-org/gitlab/-/issues/359958) | Instance, Group, Project |
| [`ci_runner_token_reset`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85535) | A runner's token is reset | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/355637) | Instance, Group, Project |
| [`ci_runner_unassigned_from_project`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81540) | A runner is unassigned from a project | {{< icon name="check-circle" >}} Yes | GitLab [14.9](https://gitlab.com/gitlab-org/gitlab/-/issues/349542) | Project |
| [`ci_runner_unregistered`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/79754) | An instance, group, or project runner is unregistered | {{< icon name="check-circle" >}} Yes | GitLab [14.9](https://gitlab.com/gitlab-org/gitlab/-/issues/349540) | Instance, Group, Project |
| [`group_shared_runners_minutes_limit_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's shared runners minutes limit is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369324) | Group |
| [`runner_registration_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Runner registration is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`set_runner_associated_projects`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/97666) | Associated projects are successfully assigned to a CI/CD runner | {{< icon name="check-circle" >}} Yes | GitLab [15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/359958) | Project |
### Seat cost management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`seat_control_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Seat control is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
### Secret detection
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`group_secret_push_protection_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/174412) | Secret push protection is enabled or disabled for a group and its child groups and projects, except those projects specified as excluded | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/502829) | Group |
| [`project_security_exclusion_applied`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166511) | A project security exclusion is applied in one of the security scanners | {{< icon name="check-circle" >}} Yes | GitLab [17.6](https://gitlab.com/gitlab-org/gitlab/-/issues/492465) | Project |
| [`project_security_exclusion_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166511) | A project security exclusion is created | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/492464) | Project |
| [`project_security_exclusion_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166511) | A project security exclusion is deleted | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/492464) | Project |
| [`project_security_exclusion_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166511) | A project security exclusion is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/492464) | Project |
| [`project_security_setting_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/150767) | A project's security setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/457024) | Project |
| [`skip_secret_push_protection`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/147855) | Secret push protection is skipped by the user | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/441185) | Project |
### Secrets management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`user_authenticated_using_job_token`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164546) | A user is authenticated using job token | {{< icon name="dotted-circle" >}} No | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/481325) | Project |
### Security policy management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`policy_project_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102154) | The security policy project is updated for a project | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/377877) | Group, Project |
| [`security_policy_access_token_push_bypass`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/196249) | Branch push that is blocked by a security policy is bypassed for configured access token | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/549644) | Project |
| [`security_policy_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192797) | A security policy is created | {{< icon name="check-circle" >}} Yes | GitLab [18.1](https://gitlab.com/gitlab-org/gitlab/-/issues/539230) | Project |
| [`security_policy_delete`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192797) | A security policy is deleted | {{< icon name="check-circle" >}} Yes | GitLab [18.1](https://gitlab.com/gitlab-org/gitlab/-/issues/539230) | Project |
| [`security_policy_limit_exceeded`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/196005) | Enabled policies count exceeded the maximum allowed limit for policy type | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/work_items/550891) | Project |
| [`security_policy_merge_request_merged_with_policy_violations`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195775) | A merge request merged with security policy violations | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/work_items/549813) | Project |
| [`security_policy_pipeline_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/196628) | A pipeline with security policy jobs failed | {{< icon name="dotted-circle" >}} No | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/539232) | Project |
| [`security_policy_pipeline_skipped`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195325) | A security policy pipeline is skipped | {{< icon name="dotted-circle" >}} No | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/539232) | Project |
| [`security_policy_service_account_push_bypass`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/196249) | Branch push that is blocked by a security policy is bypassed for configured service account | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/549644) | Project |
| [`security_policy_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192797) | A security policy is updated | {{< icon name="check-circle" >}} Yes | GitLab [18.1](https://gitlab.com/gitlab-org/gitlab/-/issues/539230) | Project |
| [`security_policy_violations_detected`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/193482) | Security policy violation is detected in the merge request | {{< icon name="dotted-circle" >}} No | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/work_items/549811) | Project |
| [`security_policy_violations_resolved`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/193482) | Security policy violations are resolved in the merge request | {{< icon name="dotted-circle" >}} No | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/549812) | Project |
| [`security_policy_yaml_invalidated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/196721) | The policy YAML is invalidated in security policy project | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/work_items/550892) | Project |
| [`status_check_response_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/189293) | A user updates external status check response for merge request | {{< icon name="dotted-circle" >}} No | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/413535) | Project |
| [`merge_request_branch_bypassed_by_security_policy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195942) | The merge request's approval is bypassed by the branches configured in the security policy | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/549646) | Project |
### Security testing configuration
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`vulnerability_severity_override`](https://gitlab.com/gitlab-org/gitlab/-/issues/515327) | When user overrides vulnerability severity | {{< icon name="check-circle" >}} Yes | GitLab [17.10](https://gitlab.com/gitlab-org/gitlab/-/issues/515327) | Project |
### Self-hosted models
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`model_selection_feature_changed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194862) | A model selection feature had its configuration changed | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/547982) | Instance, Group, Project, User |
| [`self_hosted_model_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165303) | A new self-hosted model configuration was added | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/477999) | Instance |
| [`self_hosted_model_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165321) | A new self-hosted model configuration was destroyed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/477999) | Instance |
| [`self_hosted_model_feature_changed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165489) | A self-hosted model feature had its configuration changed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/463215) | Instance |
| [`self_hosted_model_terms_accepted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165480) | Terms for usage of self-hosted models were accepted | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/477999) | Instance |
| [`self_hosted_model_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165520) | A self-hosted model configuration was updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/483295) | Instance |
### Source code management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`approval_rule_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89939) | A merge request approval rule is created | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363092) | Project |
| [`approval_rule_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82297) | A merge request approval rule is deleted | {{< icon name="check-circle" >}} Yes | GitLab [14.9](https://gitlab.com/gitlab-org/gitlab/-/issues/329514) | Project |
| [`default_branch_name_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Default branch name for the group repository is changed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`group_push_rules_author_email_regex_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for author email regex | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369343) | Group |
| [`group_push_rules_branch_name_regex_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for branch name regex | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369340) | Group |
| [`group_push_rules_commit_committer_check_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group's push rule setting is updated for reject unverified users | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_push_rules_commit_message_negative_regex_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for commit message negative regex | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369342) | Group |
| [`group_push_rules_commit_message_regex_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for commit message regex | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369341) | Group |
| [`group_push_rules_file_name_regex_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for filename regex | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369344) | Group |
| [`group_push_rules_max_file_size_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for max file size | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369345) | Group |
| [`group_push_rules_prevent_secrets_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group's push rule setting is updated to prevent pushing secret files | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_push_rules_reject_deny_delete_tag_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group's push rule setting is updated to deny deletion of tags using Git push | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_push_rules_reject_member_check_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group's push rule setting is updated to check if commit author is a GitLab user | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_push_rules_reject_non_dco_commits_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group's push rule setting is updated for reject non DCO certified commits | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_push_rules_reject_unsigned_commits_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group push's rule setting is updated for reject unsigned commits | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_repository_size_limit_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's repository size limit is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369322) | Group |
| [`merge_commit_template_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107533) | Merge commit template is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369314) | Project |
| [`merged_merge_request_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118793) | A merged merge request is deleted | {{< icon name="dotted-circle" >}} No | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/408288) | Project |
| [`merged_merge_request_deletion_started`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118793) | A merged merge request's deletion is started | {{< icon name="dotted-circle" >}} No | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/408288) | Project |
| [`prevent_forking_outside_group_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting for Prevent forking outside current group is changed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`project_default_branch_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117543) | Default branch of a project's repository is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_disable_overriding_approvers_per_merge_request_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | The disable overriding approvers per MR setting for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`project_feature_builds_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's builds access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369294) | Project |
| [`project_feature_forking_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's feature forking access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369290) | Project |
| [`project_feature_merge_requests_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's merge request access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369289) | Project |
| [`project_feature_repository_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's repository access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369295) | Project |
| [`project_feature_snippets_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's snippet access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369293) | Project |
| [`project_fork_operation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90916) | A project is forked | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90916) | Project |
| [`project_fork_relationship_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101017) | A project's fork relationship is successfully removed | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/272532) | Project |
| [`project_printing_merge_request_link_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | The setting for projects for enabling printing merge request link is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369283) | Project |
| [`project_push_rules_commit_committer_check_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132157) | A project's push rule setting for reject unverified users is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/268116) | Project |
| [`project_repository_size_limit_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | The repository size limit of a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369274) | Project |
| [`protected_branch_code_owner_approval_required_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107530) | The protected branch code owner approval required setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369318) | Project |
| [`protected_branch_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92074) | A protected branch is created | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363091) | Project |
| [`protected_branch_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92074) | A protected branch is removed | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363091) | Project |
| [`protected_branch_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107530) | The setting for protected branches is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369318) | Project |
| [`repository_git_operation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/76719) | Authenticated users push, pull, or clone a project using SSH, HTTP(S), or the UI | {{< icon name="dotted-circle" >}} No | GitLab [14.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373950) | Project |
| [`require_reauthentication_to_approve_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/150710) | The setting for requiring reauthentication for merge request approvals is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/431346) | Group, Project |
| [`squash_commit_template_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107533) | The merge request squash commit template for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369314) | Project |
| [`squash_option_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | Squash option setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/301124) | Project |
| [`manually_trigger_housekeeping`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112095) | Manually triggering housekeeping via API or admin UI | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/390761) | Project |
| [`project_blobs_removal`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152522) | Removing blobs by using the GraphQL API or project settings UI | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/450701) | Project |
| [`project_text_replacement`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152522) | Replacing text by using the GraphQL API or project settings UI | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/450701) | Project |
### System access
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`allow_mfa_for_subgroups_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting for Subgroups can set up their own two-factor authentication rules updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`allowed_email_domain_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166105) | Group setting allowed email domain entry is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`application_setting_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124639) | An application setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/282428) | Instance |
| [`disable_personal_access_tokens_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Disable personal access tokens is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`email_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114546) | An email is created | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`email_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114546) | An email is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`group_access_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | A group access token is created | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_access_token_creation_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | Creating a group access token failed | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_access_token_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | A group access token is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_access_token_deletion_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | Deleting a group access token failed | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_require_two_factor_authentication_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's require two factor authentication setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369325) | Group |
| [`group_two_factor_grace_period_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's two factor grace period is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369326) | Group |
| [`ip_restrictions_changed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86037) | Any changes in the IP allowlist | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/358986) | Group |
| [`login_failed_with_otp_authentication`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129595) | Sign-in fails because of an incorrect OTP | {{< icon name="check-circle" >}} Yes | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/377758) | User |
| [`login_failed_with_standard_authentication`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129595) | Sign-in to GitLab fails with standard authentication, such as password | {{< icon name="check-circle" >}} Yes | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/377758) | Instance |
| [`login_failed_with_webauthn_authentication`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129595) | Sign-in fails when using a WebAuthn device | {{< icon name="check-circle" >}} Yes | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/377758) | User |
| [`new_user_signups_cap_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Number of users for user cap is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`project_access_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | A project access token is created | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`project_access_token_creation_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | Creating a project access token fails | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`project_access_token_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | A project access token is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`project_access_token_deletion_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | Deleting a project access token fails | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`resource_access_token_creation_allowed_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting for Users can create project access tokens and group access tokens in this group is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group, Project |
| [`service_access_tokens_expiration_enforced_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Service account token expiration is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`update_mismatched_group_saml_extern_uid`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/104791) | The external UID is changed on a SAML identity | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/382256) | User |
| [`user_access_locked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124169) | User access to the instance is locked | {{< icon name="check-circle" >}} Yes | GitLab [16.2](https://gitlab.com/gitlab-org/modelops/anti-abuse/team-tasks/-/issues/244) | User |
| [`user_access_unlocked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124973) | User access to the instance is unlocked | {{< icon name="check-circle" >}} Yes | GitLab [16.2](https://gitlab.com/gitlab-org/modelops/anti-abuse/team-tasks/-/issues/244) | User |
| [`user_disable_two_factor`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89598) | A user disables two factor authentication. Group scope was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/171988) in GitLab 17.6. | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/238177) | User, Group |
| [`user_enable_admin_mode`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/104754) | Admin Mode enabled | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/362101) | User |
| [`authenticated_with_ldap`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/175763) | User successfully signed in with LDAP | {{< icon name="check-circle" >}} Yes | GitLab [17.11](https://gitlab.com/gitlab-org/gitlab/-/issues/509377) | User |
| [`authenticated_with_oauth`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/175763) | User successfully signed in with OAuth | {{< icon name="check-circle" >}} Yes | GitLab [17.11](https://gitlab.com/gitlab-org/gitlab/-/issues/509377) | User |
| [`authenticated_with_password`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/198216) | User successfully signed in with password | {{< icon name="check-circle" >}} Yes | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/555101) | User |
| [`authenticated_with_two_factor`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/198216) | User successfully signed in with two-factor authentication | {{< icon name="check-circle" >}} Yes | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/555101) | User |
| [`authenticated_with_webauthn`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/198216) | User successfully signed in with WebAuthn device | {{< icon name="check-circle" >}} Yes | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/555101) | User |
### Team planning
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`comment_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120927) | A comment is added to an issue or a merge request when using a project access token | {{< icon name="dotted-circle" >}} No | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`delete_issue`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96773) | An issue is successfully deleted | {{< icon name="dotted-circle" >}} No | GitLab [15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/370487) | Project |
| [`delete_work_item`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96773) | A work item is successfully deleted | {{< icon name="dotted-circle" >}} No | GitLab [15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/370487) | Project |
| [`issue_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An issue is closed using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`issue_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An issue is created using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`issue_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An issue is reopened using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`project_feature_issues_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's issues access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369289) | Project |
| [`task_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A task is closed using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`task_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A task is created using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`task_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A task is reopened using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
### User management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`authenticated_with_group_saml`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28575) | Successfully signing in with SAML authentication | {{< icon name="check-circle" >}} Yes | GitLab [12.10](https://gitlab.com/gitlab-org/gitlab/-/issues/35710) | Group |
| [`ban_user`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116103) | A user is banned, unbanned, blocked, or unblocked | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/377620) | User |
| [`change_membership_state`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/87924) | A user's membership is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/362200) | Group |
| [`inactive_scim_user_cannot_be_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173879) | A user cannot be added to a group during SAML authentication when their SCIM identity is inactive | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/422582) | Group |
| [`password_reset_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129079) | A password reset fails for a user | {{< icon name="dotted-circle" >}} No | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/377762) | User |
| [`unban_user`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116221) | A user is unbanned | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/377620) | User |
| [`unblock_user`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115727) | A user is banned | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/377620) | User |
| [`user_activate`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121708) | A user is activated | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/13473) | User |
| [`user_approved`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113784) | A user is approved for an instance | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`user_blocked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113784) | A user is blocked | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`user_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113784) | A user is created | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`user_deactivate`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117776) | A user is deactivated | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/13473) | User |
| [`user_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113784) | A user is scheduled for removal from the instance. Group and Project scopes were [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/167021) in GitLab 17.5. | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User, Group, Project |
| [`user_email_changed_and_user_signed_in`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106090) | User email changed and user signed in | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369331) | User |
| [`user_impersonation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/79340) | An instance administrator starts or stops impersonating a user | {{< icon name="check-circle" >}} Yes | GitLab [14.8](https://gitlab.com/gitlab-org/gitlab/-/issues/300961) | User, Group |
| [`user_password_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106086) | A user password is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369330) | User |
| [`user_provisioned_by_scim`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/174040) | A user is provisioned by SCIM | {{< icon name="check-circle" >}} Yes | GitLab [17.8](https://gitlab.com/gitlab-org/gitlab/-/issues/423322) | Group |
| [`user_rejected`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113784) | A user registration is rejected | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
### User profile
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`add_ssh_key`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195379) | An SSH key is added to a user's profile. Group scope is only available for enterprise users. | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/361778) | User, Group |
| [`email_confirmation_sent`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129261) | Users add or change an email address and it must be confirmed | {{< icon name="dotted-circle" >}} No | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/377625) | User |
| [`remove_ssh_key`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65615) | An SSH key is removed from a user's profile. Group scope was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195390) for enterprise users in GitLab 18.2. | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/220127) | User, Group |
| [`user_admin_status_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65168) | A user is either made an administrator or removed as an administrator | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323905) | User |
| [`user_auditor_status_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136456) | A user is either made an auditor or removed as an auditor | {{< icon name="check-circle" >}} Yes | GitLab [16.6](https://gitlab.com/gitlab-org/gitlab/-/issues/430235) | User |
| [`user_email_address_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/2103) | A user updates their email address | {{< icon name="check-circle" >}} Yes | GitLab [10.1](https://gitlab.com/gitlab-org/gitlab-ee/issues/1370) | User |
| [`user_name_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/167484) | A user's name is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | User |
| [`user_profile_visibility_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/187207) | User toggles private profile user setting | {{< icon name="dotted-circle" >}} No | GitLab [17.11](https://gitlab.com/gitlab-org/gitlab/-/issues/474386) | User |
| [`user_profile_visiblity_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129149) | User toggles private profile user setting (DEPRECATED). Use `user_profile_visibility_updated` instead. | {{< icon name="dotted-circle" >}} No | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129149) | User |
| [`user_username_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106086) | A user's username is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369329) | User |
### Value stream management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_analytics_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's analytics access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369299) | Project |
### Verify security
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`secure_ci_job_token_group_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159754) | Group added to CI_JOB_TOKEN scope | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/467840) | Project |
| [`secure_ci_job_token_group_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159754) | Group removed from CI_JOB_TOKEN scope | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/467840) | Project |
| [`secure_ci_job_token_inbound_disabled`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115350) | CI_JOB_TOKEN permissions disabled for inbound | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/338255) | Project |
| [`secure_ci_job_token_inbound_enabled`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115350) | CI_JOB_TOKEN permissions enabled for inbound | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/338255) | Project |
| [`secure_ci_job_token_project_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115350) | Project added to inbound CI_JOB_TOKEN scope | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/338255) | Project |
| [`secure_ci_job_token_project_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115350) | Project removed from inbound CI_JOB_TOKEN scope | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/338255) | Project |
### Vulnerability management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_infrastructure_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's infrastructure access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369305) | Project |
### Webhooks
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`webhook_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/154046) | A webhook is created | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/8068) | Project, Group, Instance |
| [`webhook_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102342) | A webhook is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/458817) | Project, Group, Instance |
### Wiki
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_wiki_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's wiki access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369292) | Project |
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Audit event types
breadcrumbs:
- doc
- user
- compliance
---
<!--
This documentation is auto generated by a Rake task.
Please do not edit this file directly. To update this file, run:
bundle exec rake gitlab:audit_event_types:compile_docs
To make changes to the output of the Rake task,
edit `tooling/audit_events/docs/templates/audit_event_types.md.erb`.
-->
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/172757) in GitLab 17.7, all audit events can be streamed.
{{< /history >}}
Audit event types are used to filter streamed audit events:
- [For instances](../../administration/compliance/audit_event_streaming.md#update-event-filters).
- [For top-level groups](audit_event_streaming.md#update-event-filters)
Every audit event is associated with an event type. Audit event types can allow:
- Most audit events to be saved to the database. Available in the Premium and Ultimate tier. You can retrieve
audit events associated with these types by using the audit events dashboard or the
[audit events API](../../api/audit_events.md).
- All audit events to be streamed to external destinations. Available in the Ultimate tier. You can stream audit events
associated with these types to external destinations if a destination is set.
An audit event type's scope limits the availability of the audit event type to either:
- [Project, group, or user](audit_events.md) audit events.
- [Instance](../../administration/compliance/audit_event_reports.md) audit events.
## Available audit event types
Audit event types belong to the following product categories.
### Ai framework
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`duo_features_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/145509) | GitLab Duo Features enabled setting on group or project changed | {{< icon name="check-circle" >}} Yes | GitLab [16.10](https://gitlab.com/gitlab-org/gitlab/-/issues/442485) | Group, Project |
| [`q_onbarding_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/175501) | Amazon Q instance settings changed | {{< icon name="check-circle" >}} Yes | GitLab [17.8](https://gitlab.com/gitlab-org/gitlab/-/issues/508250) | Instance |
### Audit events
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`amazon_s3_configuration_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132443) | Amazon S3 configuration for audit events streaming is created | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/423229) | Group |
| [`amazon_s3_configuration_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/133695) | Amazon S3 configuration for audit events streaming is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/423229) | Group |
| [`amazon_s3_configuration_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/133691) | Amazon S3 configuration for audit events streaming is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/423229) | Group |
| [`audit_events_streaming_headers_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92068) | A streaming header for audit events is created | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/366350) | Group |
| [`audit_events_streaming_headers_destroy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92068) | A streaming header for audit events is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/366350) | Group |
| [`audit_events_streaming_instance_headers_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125870) | A streaming header for instance level external audit event destination is created | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/417433) | Instance |
| [`audit_events_streaming_instance_headers_destroy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127228) | A streaming header for instance level external audit event destination is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/417433) | Instance |
| [`audit_events_streaming_instance_headers_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127228) | A streaming header for instance level external audit event destination is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/417433) | Instance |
| [`create_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74632) | An external audit event destination is created | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/344664) | Group |
| [`create_http_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136047) | A namespace filter for an external audit event destination for a top-level group is created | {{< icon name="check-circle" >}} Yes | GitLab [16.6](https://gitlab.com/gitlab-org/gitlab/-/issues/424176) | Group |
| [`create_instance_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123882) | An external audit event destination for an instance is created | {{< icon name="check-circle" >}} Yes | GitLab [16.2](https://gitlab.com/gitlab-org/gitlab/-/issues/404730) | Instance |
| [`created_group_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/147888) | An external audit event destination for a top-level group is created | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436610) | Group |
| [`created_group_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/150712) | A namespace filter for an external audit event destination for a top-level group is created | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/436612) | Group |
| [`created_instance_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148383) | An external audit event destination for an instance is created | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436615) | Instance |
| [`created_instance_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/153156) | A namespace filter for an external audit event destination for an instance is created | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/436613) | Instance |
| [`delete_http_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136302) | A namespace filter for an external audit event destination for a top-level group is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/424177) | Group |
| [`deleted_group_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148738) | An external audit event destination for a top-level group is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436610) | Group |
| [`deleted_group_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/150712) | A namespace filter for an external audit event destination for a top-level group is deleted | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/436612) | Group |
| [`deleted_instance_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/14910) | An external audit event destination for a GitLab instance is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436615) | Instance |
| [`deleted_instance_namespace_filter`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/153156) | A namespace filter for an external audit event destination for a GitLab instance is deleted | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/436613) | Instance |
| [`destroy_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74632) | An external audit event destination is deleted | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/344664) | Group |
| [`destroy_instance_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125846) | An instance level external audit event destination is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.2](https://gitlab.com/gitlab-org/gitlab/-/issues/404730) | Instance |
| [`event_type_filters_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113081) | A new audit events streaming event type filter is created | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/344848) | Group |
| [`event_type_filters_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113489) | An audit events streaming event type filter is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/344848) | Group |
| [`google_cloud_logging_configuration_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122025) | Google Cloud Logging configuration is created | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/409422) | Group |
| [`google_cloud_logging_configuration_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122025) | Google Cloud Logging configuration is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/409422) | Group |
| [`google_cloud_logging_configuration_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122025) | Google Cloud Logging configuration is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/409422) | Group |
| [`instance_amazon_s3_configuration_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137651) | Instance Amazon S3 configuration for audit events streaming is created | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/423235) | Instance |
| [`instance_amazon_s3_configuration_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/138318) | Instance-level Amazon S3 configuration for audit events streaming is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/423235) | Instance |
| [`instance_amazon_s3_configuration_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/138310) | Instance-level Amazon S3 configuration for audit events streaming is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/423235) | Instance |
| [`instance_google_cloud_logging_configuration_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130663) | Instance-level Google Cloud Logging configuration is created | {{< icon name="check-circle" >}} Yes | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/423038) | Instance |
| [`instance_google_cloud_logging_configuration_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131752) | Instance-level Google Cloud Logging configuration is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/423040) | Instance |
| [`instance_google_cloud_logging_configuration_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131790) | Instance-level Google Cloud Logging configuration is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/423039) | Instance |
| [`update_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74632) | An external audit event destination is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/344664) | Group |
| [`update_instance_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125846) | An instance level external audit event destination is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.2](https://gitlab.com/gitlab-org/gitlab/-/issues/404730) | Instance |
| [`updated_group_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148388) | An external audit event destination for a top-level group is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436610) | Group |
| [`updated_instance_audit_event_streaming_destination`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/149104) | An external audit event destination for a GitLab instance is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/436615) | Instance |
### Authorization
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`oauth_application_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194557) | User creates an OAuth application | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/550321) | User |
| [`secure_ci_job_token_policies_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/170930) | Permissions are updated for a CI_JOB_TOKEN scope | {{< icon name="check-circle" >}} Yes | GitLab [17.6](https://gitlab.com/gitlab-org/gitlab/-/issues/495144) | Project |
| [`user_authorized_oauth_application`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/179187) | User authorized an OAuth application | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/514152) | User |
### Build artifacts
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`job_artifact_downloaded`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129608) | A user downloads a job artifact from a project | {{< icon name="dotted-circle" >}} No | GitLab [16.8](https://gitlab.com/gitlab-org/gitlab/-/issues/250663) | Project |
### Ci variables
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`variable_viewed_api`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/197385) | A CI/CD variable is accessed with the API | {{< icon name="dotted-circle" >}} No | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/555960) | Project, Group |
### Code review
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`delete_merge_request`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96773) | A merge request is successfully deleted | {{< icon name="dotted-circle" >}} No | GitLab [15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/370487) | Project |
| [`group_merge_request_approval_setting_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/87880) | Merge request approval settings are added to a group | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/356152) | Group |
### Code review workflow
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`merge_request_approval_operation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92983) | A merge request is approved | {{< icon name="dotted-circle" >}} No | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/10869) | Project |
| [`merge_request_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120927) | A merge request is closed using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`merge_request_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120927) | A merge request is created using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`merge_request_invalid_approver_rules`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/100496) | An invalid rule when merge request is approved | {{< icon name="check-circle" >}} Yes | GitLab [15.5](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/100496) | Project |
| [`merge_request_merged_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120927) | A merge request is merged using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`merge_request_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120927) | A merge request is reopened using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`project_merge_method_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/83922) | A project's merge request method is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.10](https://gitlab.com/gitlab-org/gitlab/-/issues/301124) | Project |
| [`project_merge_requests_author_approval_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's MR author approval setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`project_merge_requests_disable_committers_approval_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's setting for disabling committers approval on merge requests is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369277) | Project |
| [`project_merge_requests_template_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | A merge request template for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/355805) | Project |
| [`project_only_allow_merge_if_all_discussions_are_resolved_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's setting for allowing merge only when all discussions are resolved is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369286) | Project |
| [`project_only_allow_merge_if_pipeline_succeeds_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's only allow merge if pipeline succeeds setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`project_remove_source_branch_after_merge_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/83922) | A project has its setting to remove branches after merges updated | {{< icon name="check-circle" >}} Yes | GitLab [14.10](https://gitlab.com/gitlab-org/gitlab/-/issues/301124) | Project |
| [`project_require_password_to_approve_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's setting for requiring a user's password for approval of merge request is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369280) | Project |
| [`project_reset_approvals_on_push_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66234) | A project has its setting on whether approvals are reset on a push is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.2](https://gitlab.com/gitlab-org/gitlab/-/issues/336211) | Project |
| [`project_resolve_outdated_diff_discussions_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's resolve outdated diff discussions setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`show_diff_preview_in_email_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Email notification to include diff preview is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group, Project |
| [`selective_code_owner_removals_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148743) | Selective code owner removal is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/327562) | Project |
### Code suggestions
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_suggestion_commit_message_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/83922) | A project has its suggested commit message updated | {{< icon name="check-circle" >}} Yes | GitLab [14.10](https://gitlab.com/gitlab-org/gitlab/-/issues/301124) | Project |
### Compliance management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`add_gpg_key`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111744) | A GPG key is added | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373961) | User |
| [`allow_author_approval_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102256) | Prevent approval by author setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/373949) | Group |
| [`allow_committer_approval_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102256) | Prevent approvals by users who add commits setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/373949) | Group |
| [`allow_overrides_to_approver_list_per_merge_request_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102256) | Prevent editing approval rules in projects and merge requests setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/373949) | Group |
| [`audit_events_streaming_headers_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92068) | A streaming header for audit events is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/366350) | Group |
| [`compliance_control_status_fail`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/180107) | A compliance control status is updated to fail | {{< icon name="check-circle" >}} Yes | GitLab [17.10](https://gitlab.com/gitlab-org/gitlab/-/issues/513425) | Project |
| [`compliance_control_status_pass`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/180107) | A compliance control status is updated to pass | {{< icon name="check-circle" >}} Yes | GitLab [17.10](https://gitlab.com/gitlab-org/gitlab/-/issues/513425) | Project |
| [`compliance_framework_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/157893) | A compliance framework is applied to a project | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/464160) | Project |
| [`compliance_framework_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65343) | A compliance framework is removed from a project | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/329362) | Project |
| [`compliance_framework_id_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/94711) | A compliance framework is updated for a project | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369310) | Project |
| [`compliance_framework_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/157893) | A compliance framework is removed from a project | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/464160) | Project |
| [`create_compliance_framework`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74292) | A compliance framework is successfully created | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/340649) | Group |
| [`create_status_check`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | An external status check is created | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/355805) | Project |
| [`created_compliance_requirement`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169485) | A requirement is added to a compliance framework | {{< icon name="check-circle" >}} Yes | GitLab [17.6](https://gitlab.com/gitlab-org/gitlab/-/issues/470695) | Group |
| [`created_compliance_requirement_control`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/177557) | A control is added to a compliance requirement. | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/512381) | Group |
| [`delete_status_check`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | An external status check is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/355805) | Project |
| [`destroy_compliance_framework`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74292) | A compliance framework is successfully deleted | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/340649) | Group |
| [`destroyed_compliance_requirement`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/170380) | A compliance framework requirement is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/470695) | Group |
| [`destroyed_compliance_requirement_control`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/177878) | A compliance requirement control is destroyed. | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/512381) | Group |
| [`external_status_check_name_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106095) | The name of an external status check is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369333) | Project |
| [`external_status_check_url_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | The URL that is used for external status checks for a pipeline is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/355805) | Project |
| [`group_saml_provider_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111227) | A group SAML provider is created | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373964) | Group |
| [`group_saml_provider_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111227) | A group SAML provider is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373964) | Group |
| [`inactive_project_scheduled_for_deletion`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130699) | An inactive project is scheduled for deletion | {{< icon name="check-circle" >}} Yes | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/423263) | Project |
| [`member_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/109711) | A membership is created | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374112) | Group, Project |
| [`member_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/109711) | A membership is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374112) | Group, Project |
| [`member_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/109711) | A membership is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374112) | Group, Project |
| [`merge_request_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90911) | A merge request is created | {{< icon name="dotted-circle" >}} No | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/367239) | Project |
| [`merge_request_merged`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164846) | A merge request is merged | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/442279) | Project |
| [`omniauth_login_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123080) | An OmniAuth login fails | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`password_reset_requested`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114548) | A user requests a password reset using a registered email address | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`pending_compliance_external_control_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/180016) | A project's compliance external control status is updated to fail because of timeout. | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/513421) | Project |
| [`personal_access_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108952) | A user creates a personal access token | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374113) | User |
| [`personal_access_token_revoked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108952) | A personal access token is revoked | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374113) | User |
| [`project_archived`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117528) | A project is archived | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_deletion_marked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117546) | A project is marked for deletion | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117546) | A project is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Group |
| [`project_export_file_download_started`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117528) | A download of a project export file is started | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_feature_security_and_compliance_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's security and compliance access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369302) | Project |
| [`project_group_link_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108918) | A group is invited to a project | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374114) | Group |
| [`project_group_link_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108918) | A project group link is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374114) | Group |
| [`project_group_link_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108918) | A project group link is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374114) | Project |
| [`project_imported`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117528) | A project is imported | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Group |
| [`project_restored`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117528) | A project is restored | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`protected_branch_allow_force_push_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68869) | A protected branch has its ability to allow force pushes is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.3](https://gitlab.com/gitlab-org/gitlab/-/issues/338873) | Project |
| [`public_repository_download_operation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/149842) | A Git repository for a public project is downloaded | {{< icon name="dotted-circle" >}} No | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/383218) | Project |
| [`registration_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123080) | A user registers for instance access | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`release_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111080) | A release is created | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374111) | Project |
| [`release_deleted_audit_event`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111080) | A release is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374111) | Project |
| [`release_milestones_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111080) | A release's associated milestones are updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374111) | Project |
| [`release_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111080) | A release is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374111) | Project |
| [`remove_gpg_key`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111744) | A GPG key is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373961) | User |
| [`repository_download_operation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111218) | A Git repository for a private or internal project is downloaded | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/374108) | Project |
| [`request_to_compliance_external_control_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/180010) | Request to compliance external control failed | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/513421) | Project |
| [`request_to_compliance_external_control_successful`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/180010) | Request to compliance external control successful | {{< icon name="dotted-circle" >}} No | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/513421) | Project |
| [`require_password_to_approve_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102256) | Require user password for approvals from group merge request setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/373949) | Group |
| [`retain_approvals_on_push_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102256) | Require new approvals when new commits are added to an MR from group merge request setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/373949) | Group |
| [`saml_group_links_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110525) | A SAML Group Link is created | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373954) | Group |
| [`saml_group_links_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110525) | A SAML Group Link is removed | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373954) | Group |
| [`smartcard_authentication_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/8120) | A user authenticates with smartcard | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/726) | User |
| [`update_approval_rules`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89939) | Updating a merge approval rule | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363092) | Project |
| [`update_compliance_framework`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74292) | A compliance framework is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/340649) | Group |
| [`update_compliance_requirement`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169485) | A compliance framework requirement is updated. | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/470695) | Group |
| [`update_project_compliance_violation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195768) | Project compliance violation is updated | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/542343) | Project |
| [`update_status_check`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | An external status check is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/355805) | Project |
| [`updated_compliance_requirement_control`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/177557) | Compliance requirement control updated. | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/512381) | Group |
### Container registry
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`container_repository_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/156037) | A container repository is first pushed to the registry | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/362290) | Project |
| [`container_repository_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152967) | A project's container registry is deleted | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/362290) | Project |
| [`container_repository_deletion_marked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152967) | A project's container repository is marked for deletion | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/362290) | Project |
| [`container_repository_tags_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/156066) | A project's container repository tag is deleted | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/362290) | Project |
| [`project_feature_container_registry_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's container registry access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369303) | Project |
### Continuous delivery
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`deploy_key_added`](https://gitlab.com/gitlab-org/gitlab/-/commit/08586a616909c7f9efe2210c2b74fd3422d4eb62) | A deploy key is added | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deploy_key_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92219) | A deploy key is removed | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deploy_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89391) | A deploy token is created | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deploy_token_creation_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89391) | A deploy token fails to create | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deploy_token_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89391) | A deploy token is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deploy_token_revoked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89391) | A project deploy token is revoked | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`deployment_approved`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/153375) | A deployment is approved | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/456685) | Project |
| [`deployment_rejected`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/153375) | A deployment is rejected | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/456685) | Project |
| [`deployment_started`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/156111) | A deployment to a protected environment is started | {{< icon name="check-circle" >}} Yes | GitLab [17.2](https://gitlab.com/gitlab-org/gitlab/-/issues/456687) | Project |
| [`group_deploy_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93091) | A group deploy token is created | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_deploy_token_creation_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93091) | Creating a group deploy token failed | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_deploy_token_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93091) | A group deploy token is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_deploy_token_revoked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93091) | A group deploy token is revoked | {{< icon name="check-circle" >}} Yes | GitLab [15.3](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
### Continuous integration
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`allow_merge_on_skipped_pipeline_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/83922) | Skipped pipelines are considered successful setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.10](https://gitlab.com/gitlab-org/gitlab/-/issues/301124) | Project |
| [`ci_group_variable_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is created for a group | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Group |
| [`ci_group_variable_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is deleted for a group | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Group |
| [`ci_group_variable_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is updated for a group | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Group |
| [`ci_instance_variable_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131882) | A CI/CD variable is created for an instance | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/8070) | Instance |
| [`ci_instance_variable_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131882) | A CI/CD variable is deleted for an instance | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/8070) | Instance |
| [`ci_instance_variable_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131882) | A CI/CD variable is updated for an instance | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/8070) | Instance |
| [`ci_variable_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is created for a project | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Project |
| [`ci_variable_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is deleted for a project | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Project |
| [`ci_variable_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91983) | A CI/CD variable is updated for a project | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363090) | Project |
| [`destroy_pipeline`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/135255) | A pipeline is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.6](https://gitlab.com/gitlab-org/gitlab/-/issues/339041) | Project |
| [`multi_project_downstream_pipeline_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/168626) | Multi project downstream pipeline is created | {{< icon name="dotted-circle" >}} No | GitLab [17.6](https://gitlab.com/gitlab-org/gitlab/-/issues/481325) | Project |
| [`project_cicd_merge_pipelines_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107428) | The CI/CD merge pipelines setting for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369317) | Project |
### Delivery
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_releases_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's releases access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369308) | Project |
### Deployment management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`cluster_agent_create_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159593) | A user attempts to create a cluster agent but it failed | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/462749) | Project |
| [`cluster_agent_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159593) | A user creates a cluster agent | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/462749) | Project |
| [`cluster_agent_delete_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159593) | A user attempts to delete a cluster agent but it failed | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/462749) | Project |
| [`cluster_agent_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159593) | A user deletes a cluster agent | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/462749) | Project |
| [`cluster_agent_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112036) | A user creates a cluster agent token | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/382133) | Project |
| [`cluster_agent_token_revoked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112036) | A user revokes a cluster agent token | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/382133) | Project |
### Dora metrics
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_metrics_dashboard_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's metrics dashboard access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369289) | Project |
### GitLab Duo Agent Platform
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`api_request_access_with_scope`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/172548) | A subset of API requests authenticated by a token with an audited scope | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/499461) | User |
### Dynamic application security testing
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`dast_profile_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62604) | A dynamic application security testing profile is created | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_profile_destroy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62604) | A dynamic application security profile is removed | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_profile_schedule_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68046) | A dynamic application security testing profile schedule is created | {{< icon name="check-circle" >}} Yes | GitLab [14.3](https://gitlab.com/gitlab-org/gitlab/-/issues/330308) | Project |
| [`dast_profile_schedule_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66445) | A dynamic application security testing profile schedule is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.3](https://gitlab.com/gitlab-org/gitlab/-/issues/330308) | Project |
| [`dast_profile_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62604) | A dynamic application security profile is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_scanner_profile_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62007) | A dynamic application security testing scanner profile is created | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_scanner_profile_destroy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62007) | A dynamic application security testing scanner profile is removed | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_scanner_profile_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62007) | A dynamic application security testing scanner profile is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_site_profile_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62465) | A dynamic application security testing site profile is created | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_site_profile_destroy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62465) | A dynamic application security testing site profile is removed | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
| [`dast_site_profile_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62465) | A dynamic application security testing site profile is updated | {{< icon name="check-circle" >}} Yes | GitLab [14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) | Project |
### Environment management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`environment_protected`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108247) | A protected environment is created | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/216164) | Group, Project |
| [`environment_unprotected`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108247) | A protected environment is unprotected | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/216164) | Group, Project |
| [`project_feature_environments_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's environments access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369307) | Project |
| [`protected_environment_approval_rule_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | An approval rule is added to a protected environment | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Group, Project |
| [`protected_environment_approval_rule_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | An approval rule is removed from a protected environment | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Project, Group |
| [`protected_environment_approval_rule_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | An approval rule of a protected environment is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Project, Group |
| [`protected_environment_deploy_access_level_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | A deploy access level is added to a protected environment | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Group, Project |
| [`protected_environment_deploy_access_level_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | A deploy access level is removed from a protected environment | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Group, Project |
| [`protected_environment_deploy_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | A deploy access level of a protected environment is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Project |
| [`protected_environment_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131484) | A protected environment is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/415603) | Group, Project |
### Feature flags
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_feature_flags_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's feature flags access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369306) | Project |
| [`feature_flag_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113453) | A feature flag is created | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/374109) | Project |
| [`feature_flag_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113453) | A feature flag is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/374109) | Project |
| [`feature_flag_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113453) | A feature flag is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/374109) | Project |
### Fleet visibility
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`ci_runner_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173885) | Triggered when a runner is created | {{< icon name="check-circle" >}} Yes | GitLab [17.8](https://gitlab.com/gitlab-org/gitlab/-/issues/503315) | Instance, Group, Project |
| [`ci_runner_usage_export`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/139578) | A runner usage report is generated | {{< icon name="check-circle" >}} Yes | GitLab [16.8](https://gitlab.com/gitlab-org/gitlab/-/issues/426560) | Instance |
| [`ci_runners_bulk_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173886) | Runners are deleted in bulk | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/503315) | User |
### Fuzz testing
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`coverage_fuzzing_corpus_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71992) | A corpus action is added | {{< icon name="check-circle" >}} Yes | GitLab [14.5](https://gitlab.com/gitlab-org/gitlab/-/issues/341485) | Project |
### Groups and projects
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`create_ssh_certificate`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/134556) | An SSH certificate is created | {{< icon name="check-circle" >}} Yes | GitLab [16.6](https://gitlab.com/gitlab-org/gitlab/-/issues/427413) | Group |
| [`delete_ssh_certificate`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/134556) | An SSH certificate is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.6](https://gitlab.com/gitlab-org/gitlab/-/issues/427413) | Group |
| [`emails_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Enable email notifications is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`enabled_git_access_protocol_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Enabled Git access protocols is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`enforce_ssh_certificates_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Enforce SSH Certificates is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`group_archived`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/199419) | A group is archived | {{< icon name="check-circle" >}} Yes | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/520013) | Group |
| [`group_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121005) | A group is created | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/411595) | Group |
| [`group_deletion_marked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116986) | A group is marked for deletion | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374106) | Group |
| [`group_description_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973/) | Group description is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`group_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116986) | A group is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374106) | Group |
| [`group_lfs_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | LFS enabled for a group is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369323) | Group |
| [`group_membership_lock_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | Membership lock for a group is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369323) | Group |
| [`group_mentions_disabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | A group's setting to notify group members on group mention is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`group_name_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's name is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369320) | Group |
| [`group_path_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's path is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369321) | Group |
| [`group_project_creation_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's project creation level is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369327) | Group |
| [`group_request_access_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's request access enabled is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369323) | Group |
| [`group_restored`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116986) | A group is restored | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374106) | Group |
| [`group_share_with_group_link_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112719) | You invite a group to another group by using the group's membership page | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/327909) | Group |
| [`group_share_with_group_link_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112719) | You remove a group from another group by using the group's membership page | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/327909) | Group |
| [`group_share_with_group_link_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112719) | You update a group's access settings to another group by using the group's membership page | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/327909) | Group |
| [`group_shared_with_group_lock_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973/) | Group can be shared with other group setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`group_unarchived`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/199419) | A group is unarchived | {{< icon name="check-circle" >}} Yes | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/520013) | Group |
| [`group_visibility_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's visibility level is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369322) | Group |
| [`prevent_sharing_groups_outside_hierarchy_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | A group's setting to Members cannot invite groups outside of group and its subgroup updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`project_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117543) | A project is created | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_description_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128978) | A project's description is updated | {{< icon name="dotted-circle" >}} No | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/377769) | Project |
| [`project_feature_operations_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's operation access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369300) | Project |
| [`project_feature_requirements_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's requirements access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369301) | Project |
| [`project_name_updated`](https://gitlab.com/gitlab-org/gitlab/-/commit/8c0b52247e717cf84bc7b248d817f8baa55b18a4) | A project has its name updated | {{< icon name="check-circle" >}} Yes | GitLab [10.2](https://gitlab.com/gitlab-org/gitlab/-/commit/8c0b52247e717cf84bc7b248d817f8baa55b18a4) | Project |
| [`project_namespace_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's namespace is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`project_path_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/100770) | A project's path is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/369271) | Project |
| [`project_topics_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/154158) | A project's topics assignments are changed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/343204) | Project |
| [`project_unarchived`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117528) | A project is unarchived | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_visibility_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | A project's visibility level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`remove_dormant_members_period_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Days of inactivity before removal is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`remove_dormant_members_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Dormant members is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
### Importers
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`direct_transfer_relation_export_batch_downloaded`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194872) | Direct Transfer relation export batch downloaded | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/441977) | Group, Project |
| [`direct_transfer_relation_export_downloaded`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194872) | Direct Transfer relation export downloaded | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/441977) | Group, Project |
| [`direct_transfer_relations_export_initiated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194872) | Direct Transfer relations export initiated | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/441977) | Group, Project |
| [`group_export_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/TODO) | A group file export is created | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/294168) | Group |
| [`project_export_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/TODO) | A project file export is created | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/294168) | Project |
### Incident management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`incident_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An incident is closed using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`incident_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An incident is created using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`incident_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An incident is reopened using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
### Merge trains
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_cicd_merge_trains_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107428) | The CI/CD merge trains settings for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369317) | Project |
### MLOps
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_model_experiments_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121027) | A project's model experiments access level is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/412384) | Project |
| [`ml_model_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165011) | ML model is created | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/463215) | Project |
| [`ml_model_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165011) | ML model destroyed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/463215) | Project |
| [`ml_model_version_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165145) | ML model version is created | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/463215) | Project |
| [`ml_model_version_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165145) | ML model version destroyed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/463215) | Project |
| [`project_feature_model_registry_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/138399) | Model registry access level was updated | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/412734) | Project |
### Not categorized
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`experiment_features_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118222) | Enabling experiment AI features setting is toggled | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/404856/) | Group |
### Observability
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_monitor_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's monitor access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369304) | Project |
### Package registry
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`package_registry_package_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/178181) | A package was deleted from GitLab package registry. Available only when the namespace's package setting `audit_events_enabled` is true. | {{< icon name="check-circle" >}} Yes | GitLab [17.10](https://gitlab.com/gitlab-org/gitlab/-/issues/329588) | Project, Group |
| [`package_registry_package_published`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/178181) | A package was published to GitLab package registry. Available only when the namespace's package setting `audit_events_enabled` is true. | {{< icon name="check-circle" >}} Yes | GitLab [17.9](https://gitlab.com/gitlab-org/gitlab/-/issues/329588) | Project, Group |
| [`project_feature_package_registry_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's package registry access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369296) | Project |
| [`project_packages_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/7962) | The setting that controls packages for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [11.5](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
### Pages
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_pages_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's page access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369297) | Project |
### Permissions
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`custom_admin_role_assigned_to_user`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/186570) | A custom admin role is assigned to a user | {{< icon name="check-circle" >}} Yes | GitLab [18.0](https://gitlab.com/gitlab-org/gitlab/-/issues/507958) | User |
| [`custom_admin_role_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/188367) | A custom admin role is created | {{< icon name="check-circle" >}} Yes | GitLab [18.0](https://gitlab.com/gitlab-org/gitlab/-/issues/536131) | Instance |
| [`custom_admin_role_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/188367) | A custom admin role is deleted | {{< icon name="check-circle" >}} Yes | GitLab [18.0](https://gitlab.com/gitlab-org/gitlab/-/issues/536131) | Instance |
| [`custom_admin_role_unassigned_from_user`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/186570) | A custom admin role is unassigned from a user | {{< icon name="check-circle" >}} Yes | GitLab [18.0](https://gitlab.com/gitlab-org/gitlab/-/issues/507958) | User |
| [`custom_admin_role_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/188367) | A custom admin role is updated | {{< icon name="check-circle" >}} Yes | GitLab [18.0](https://gitlab.com/gitlab-org/gitlab/-/issues/536131) | Instance |
| [`member_role_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137087) | A custom role is created | {{< icon name="check-circle" >}} Yes | GitLab [16.7](https://gitlab.com/gitlab-org/gitlab/-/issues/388934) | Group, Instance |
| [`member_role_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141630) | A custom role is deleted | {{< icon name="check-circle" >}} Yes | GitLab [16.9](https://gitlab.com/gitlab-org/gitlab/-/issues/437672) | Group, Instance |
| [`member_role_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141630) | A custom role is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.9](https://gitlab.com/gitlab-org/gitlab/-/issues/437672) | Group, Instance |
### Portfolio management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`delete_epic`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96773) | An epic is successfully deleted | {{< icon name="dotted-circle" >}} No | GitLab [15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/370487) | Group |
| [`epic_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An epic is closed by a group access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Group |
| [`epic_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An epic is created by a group access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Group |
| [`epic_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An epic is reopened by a group access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Group |
### Product analytics data management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`product_analytics_settings_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/154101) | Product analytics settings are changed | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/463318) | Project |
### Quality management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`test_case_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A test case is closed using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`test_case_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A test case is created using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`test_case_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A test case is reopened using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
### Runner
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`allow_runner_registration_token_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Allow members of projects and groups to create runners with runner registration tokens is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group, Project |
| [`ci_runner_assigned_to_project`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81508) | A runner is assigned to a project | {{< icon name="check-circle" >}} Yes | GitLab [14.9](https://gitlab.com/gitlab-org/gitlab/-/issues/349542) | Project |
| [`ci_runner_registered`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/77109) | An instance, group, or project runner is registered | {{< icon name="check-circle" >}} Yes | GitLab [14.8](https://gitlab.com/gitlab-org/gitlab/-/issues/359958) | Instance, Group, Project |
| [`ci_runner_token_reset`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85535) | A runner's token is reset | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/355637) | Instance, Group, Project |
| [`ci_runner_unassigned_from_project`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81540) | A runner is unassigned from a project | {{< icon name="check-circle" >}} Yes | GitLab [14.9](https://gitlab.com/gitlab-org/gitlab/-/issues/349542) | Project |
| [`ci_runner_unregistered`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/79754) | An instance, group, or project runner is unregistered | {{< icon name="check-circle" >}} Yes | GitLab [14.9](https://gitlab.com/gitlab-org/gitlab/-/issues/349540) | Instance, Group, Project |
| [`group_shared_runners_minutes_limit_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's shared runners minutes limit is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369324) | Group |
| [`runner_registration_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Runner registration is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`set_runner_associated_projects`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/97666) | Associated projects are successfully assigned to a CI/CD runner | {{< icon name="check-circle" >}} Yes | GitLab [15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/359958) | Project |
### Seat cost management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`seat_control_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Seat control is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
### Secret detection
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`group_secret_push_protection_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/174412) | Secret push protection is enabled or disabled for a group and its child groups and projects, except those projects specified as excluded | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/502829) | Group |
| [`project_security_exclusion_applied`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166511) | A project security exclusion is applied in one of the security scanners | {{< icon name="check-circle" >}} Yes | GitLab [17.6](https://gitlab.com/gitlab-org/gitlab/-/issues/492465) | Project |
| [`project_security_exclusion_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166511) | A project security exclusion is created | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/492464) | Project |
| [`project_security_exclusion_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166511) | A project security exclusion is deleted | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/492464) | Project |
| [`project_security_exclusion_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166511) | A project security exclusion is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/492464) | Project |
| [`project_security_setting_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/150767) | A project's security setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/457024) | Project |
| [`skip_secret_push_protection`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/147855) | Secret push protection is skipped by the user | {{< icon name="check-circle" >}} Yes | GitLab [16.11](https://gitlab.com/gitlab-org/gitlab/-/issues/441185) | Project |
### Secrets management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`user_authenticated_using_job_token`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164546) | A user is authenticated using job token | {{< icon name="dotted-circle" >}} No | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/481325) | Project |
### Security policy management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`policy_project_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102154) | The security policy project is updated for a project | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/377877) | Group, Project |
| [`security_policy_access_token_push_bypass`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/196249) | Branch push that is blocked by a security policy is bypassed for configured access token | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/549644) | Project |
| [`security_policy_create`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192797) | A security policy is created | {{< icon name="check-circle" >}} Yes | GitLab [18.1](https://gitlab.com/gitlab-org/gitlab/-/issues/539230) | Project |
| [`security_policy_delete`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192797) | A security policy is deleted | {{< icon name="check-circle" >}} Yes | GitLab [18.1](https://gitlab.com/gitlab-org/gitlab/-/issues/539230) | Project |
| [`security_policy_limit_exceeded`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/196005) | Enabled policies count exceeded the maximum allowed limit for policy type | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/work_items/550891) | Project |
| [`security_policy_merge_request_merged_with_policy_violations`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195775) | A merge request merged with security policy violations | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/work_items/549813) | Project |
| [`security_policy_pipeline_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/196628) | A pipeline with security policy jobs failed | {{< icon name="dotted-circle" >}} No | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/539232) | Project |
| [`security_policy_pipeline_skipped`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195325) | A security policy pipeline is skipped | {{< icon name="dotted-circle" >}} No | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/539232) | Project |
| [`security_policy_service_account_push_bypass`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/196249) | Branch push that is blocked by a security policy is bypassed for configured service account | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/549644) | Project |
| [`security_policy_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192797) | A security policy is updated | {{< icon name="check-circle" >}} Yes | GitLab [18.1](https://gitlab.com/gitlab-org/gitlab/-/issues/539230) | Project |
| [`security_policy_violations_detected`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/193482) | Security policy violation is detected in the merge request | {{< icon name="dotted-circle" >}} No | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/work_items/549811) | Project |
| [`security_policy_violations_resolved`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/193482) | Security policy violations are resolved in the merge request | {{< icon name="dotted-circle" >}} No | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/549812) | Project |
| [`security_policy_yaml_invalidated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/196721) | The policy YAML is invalidated in security policy project | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/work_items/550892) | Project |
| [`status_check_response_update`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/189293) | A user updates external status check response for merge request | {{< icon name="dotted-circle" >}} No | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/413535) | Project |
| [`merge_request_branch_bypassed_by_security_policy`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195942) | The merge request's approval is bypassed by the branches configured in the security policy | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/549646) | Project |
### Security testing configuration
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`vulnerability_severity_override`](https://gitlab.com/gitlab-org/gitlab/-/issues/515327) | When user overrides vulnerability severity | {{< icon name="check-circle" >}} Yes | GitLab [17.10](https://gitlab.com/gitlab-org/gitlab/-/issues/515327) | Project |
### Self-hosted models
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`model_selection_feature_changed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194862) | A model selection feature had its configuration changed | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/547982) | Instance, Group, Project, User |
| [`self_hosted_model_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165303) | A new self-hosted model configuration was added | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/477999) | Instance |
| [`self_hosted_model_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165321) | A new self-hosted model configuration was destroyed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/477999) | Instance |
| [`self_hosted_model_feature_changed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165489) | A self-hosted model feature had its configuration changed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/463215) | Instance |
| [`self_hosted_model_terms_accepted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165480) | Terms for usage of self-hosted models were accepted | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/477999) | Instance |
| [`self_hosted_model_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/165520) | A self-hosted model configuration was updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/483295) | Instance |
### Source code management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`approval_rule_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89939) | A merge request approval rule is created | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363092) | Project |
| [`approval_rule_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82297) | A merge request approval rule is deleted | {{< icon name="check-circle" >}} Yes | GitLab [14.9](https://gitlab.com/gitlab-org/gitlab/-/issues/329514) | Project |
| [`default_branch_name_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Default branch name for the group repository is changed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`group_push_rules_author_email_regex_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for author email regex | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369343) | Group |
| [`group_push_rules_branch_name_regex_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for branch name regex | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369340) | Group |
| [`group_push_rules_commit_committer_check_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group's push rule setting is updated for reject unverified users | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_push_rules_commit_message_negative_regex_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for commit message negative regex | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369342) | Group |
| [`group_push_rules_commit_message_regex_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for commit message regex | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369341) | Group |
| [`group_push_rules_file_name_regex_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for filename regex | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369344) | Group |
| [`group_push_rules_max_file_size_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105791) | A group's push rules settings is changed for max file size | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369345) | Group |
| [`group_push_rules_prevent_secrets_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group's push rule setting is updated to prevent pushing secret files | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_push_rules_reject_deny_delete_tag_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group's push rule setting is updated to deny deletion of tags using Git push | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_push_rules_reject_member_check_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group's push rule setting is updated to check if commit author is a GitLab user | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_push_rules_reject_non_dco_commits_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group's push rule setting is updated for reject non DCO certified commits | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_push_rules_reject_unsigned_commits_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86046) | A group push's rule setting is updated for reject unsigned commits | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/227629) | Group |
| [`group_repository_size_limit_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's repository size limit is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369322) | Group |
| [`merge_commit_template_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107533) | Merge commit template is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369314) | Project |
| [`merged_merge_request_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118793) | A merged merge request is deleted | {{< icon name="dotted-circle" >}} No | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/408288) | Project |
| [`merged_merge_request_deletion_started`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118793) | A merged merge request's deletion is started | {{< icon name="dotted-circle" >}} No | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/408288) | Project |
| [`prevent_forking_outside_group_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting for Prevent forking outside current group is changed | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`project_default_branch_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117543) | Default branch of a project's repository is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/374105) | Project |
| [`project_disable_overriding_approvers_per_merge_request_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | The disable overriding approvers per MR setting for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369288) | Project |
| [`project_feature_builds_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's builds access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369294) | Project |
| [`project_feature_forking_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's feature forking access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369290) | Project |
| [`project_feature_merge_requests_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's merge request access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369289) | Project |
| [`project_feature_repository_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's repository access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369295) | Project |
| [`project_feature_snippets_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's snippet access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369293) | Project |
| [`project_fork_operation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90916) | A project is forked | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90916) | Project |
| [`project_fork_relationship_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101017) | A project's fork relationship is successfully removed | {{< icon name="check-circle" >}} Yes | GitLab [15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/272532) | Project |
| [`project_printing_merge_request_link_enabled_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | The setting for projects for enabling printing merge request link is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369283) | Project |
| [`project_push_rules_commit_committer_check_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132157) | A project's push rule setting for reject unverified users is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/268116) | Project |
| [`project_repository_size_limit_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106652) | The repository size limit of a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369274) | Project |
| [`protected_branch_code_owner_approval_required_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107530) | The protected branch code owner approval required setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369318) | Project |
| [`protected_branch_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92074) | A protected branch is created | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363091) | Project |
| [`protected_branch_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92074) | A protected branch is removed | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363091) | Project |
| [`protected_branch_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107530) | The setting for protected branches is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369318) | Project |
| [`repository_git_operation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/76719) | Authenticated users push, pull, or clone a project using SSH, HTTP(S), or the UI | {{< icon name="dotted-circle" >}} No | GitLab [14.9](https://gitlab.com/gitlab-org/gitlab/-/issues/373950) | Project |
| [`require_reauthentication_to_approve_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/150710) | The setting for requiring reauthentication for merge request approvals is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/431346) | Group, Project |
| [`squash_commit_template_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107533) | The merge request squash commit template for a project is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369314) | Project |
| [`squash_option_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84624) | Squash option setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/301124) | Project |
| [`manually_trigger_housekeeping`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112095) | Manually triggering housekeeping via API or admin UI | {{< icon name="check-circle" >}} Yes | GitLab [15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/390761) | Project |
| [`project_blobs_removal`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152522) | Removing blobs by using the GraphQL API or project settings UI | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/450701) | Project |
| [`project_text_replacement`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152522) | Replacing text by using the GraphQL API or project settings UI | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/450701) | Project |
### System access
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`allow_mfa_for_subgroups_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting for Subgroups can set up their own two-factor authentication rules updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`allowed_email_domain_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166105) | Group setting allowed email domain entry is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`application_setting_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124639) | An application setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/282428) | Instance |
| [`disable_personal_access_tokens_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Disable personal access tokens is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`email_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114546) | An email is created | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`email_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114546) | An email is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`group_access_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | A group access token is created | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_access_token_creation_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | Creating a group access token failed | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_access_token_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | A group access token is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_access_token_deletion_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | Deleting a group access token failed | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Group |
| [`group_require_two_factor_authentication_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's require two factor authentication setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369325) | Group |
| [`group_two_factor_grace_period_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106079) | A group's two factor grace period is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369326) | Group |
| [`ip_restrictions_changed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86037) | Any changes in the IP allowlist | {{< icon name="check-circle" >}} Yes | GitLab [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/358986) | Group |
| [`login_failed_with_otp_authentication`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129595) | Sign-in fails because of an incorrect OTP | {{< icon name="check-circle" >}} Yes | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/377758) | User |
| [`login_failed_with_standard_authentication`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129595) | Sign-in to GitLab fails with standard authentication, such as password | {{< icon name="check-circle" >}} Yes | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/377758) | Instance |
| [`login_failed_with_webauthn_authentication`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129595) | Sign-in fails when using a WebAuthn device | {{< icon name="check-circle" >}} Yes | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/377758) | User |
| [`new_user_signups_cap_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Number of users for user cap is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`project_access_token_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | A project access token is created | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`project_access_token_creation_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | Creating a project access token fails | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`project_access_token_deleted`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | A project access token is deleted | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`project_access_token_deletion_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92225) | Deleting a project access token fails | {{< icon name="check-circle" >}} Yes | GitLab [15.2](https://gitlab.com/gitlab-org/gitlab/-/issues/363087) | Project |
| [`resource_access_token_creation_allowed_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting for Users can create project access tokens and group access tokens in this group is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group, Project |
| [`service_access_tokens_expiration_enforced_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/164973) | Setting Service account token expiration is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.4](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | Group |
| [`update_mismatched_group_saml_extern_uid`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/104791) | The external UID is changed on a SAML identity | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/382256) | User |
| [`user_access_locked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124169) | User access to the instance is locked | {{< icon name="check-circle" >}} Yes | GitLab [16.2](https://gitlab.com/gitlab-org/modelops/anti-abuse/team-tasks/-/issues/244) | User |
| [`user_access_unlocked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124973) | User access to the instance is unlocked | {{< icon name="check-circle" >}} Yes | GitLab [16.2](https://gitlab.com/gitlab-org/modelops/anti-abuse/team-tasks/-/issues/244) | User |
| [`user_disable_two_factor`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89598) | A user disables two factor authentication. Group scope was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/171988) in GitLab 17.6. | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/238177) | User, Group |
| [`user_enable_admin_mode`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/104754) | Admin Mode enabled | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/362101) | User |
| [`authenticated_with_ldap`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/175763) | User successfully signed in with LDAP | {{< icon name="check-circle" >}} Yes | GitLab [17.11](https://gitlab.com/gitlab-org/gitlab/-/issues/509377) | User |
| [`authenticated_with_oauth`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/175763) | User successfully signed in with OAuth | {{< icon name="check-circle" >}} Yes | GitLab [17.11](https://gitlab.com/gitlab-org/gitlab/-/issues/509377) | User |
| [`authenticated_with_password`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/198216) | User successfully signed in with password | {{< icon name="check-circle" >}} Yes | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/555101) | User |
| [`authenticated_with_two_factor`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/198216) | User successfully signed in with two-factor authentication | {{< icon name="check-circle" >}} Yes | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/555101) | User |
| [`authenticated_with_webauthn`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/198216) | User successfully signed in with WebAuthn device | {{< icon name="check-circle" >}} Yes | GitLab [18.3](https://gitlab.com/gitlab-org/gitlab/-/issues/555101) | User |
### Team planning
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`comment_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120927) | A comment is added to an issue or a merge request when using a project access token | {{< icon name="dotted-circle" >}} No | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`delete_issue`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96773) | An issue is successfully deleted | {{< icon name="dotted-circle" >}} No | GitLab [15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/370487) | Project |
| [`delete_work_item`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96773) | A work item is successfully deleted | {{< icon name="dotted-circle" >}} No | GitLab [15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/370487) | Project |
| [`issue_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An issue is closed using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`issue_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An issue is created using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`issue_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | An issue is reopened using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`project_feature_issues_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's issues access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369289) | Project |
| [`task_closed_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A task is closed using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`task_created_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A task is created using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
| [`task_reopened_by_project_bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121485) | A task is reopened using a project access token | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323299) | Project |
### User management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`authenticated_with_group_saml`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28575) | Successfully signing in with SAML authentication | {{< icon name="check-circle" >}} Yes | GitLab [12.10](https://gitlab.com/gitlab-org/gitlab/-/issues/35710) | Group |
| [`ban_user`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116103) | A user is banned, unbanned, blocked, or unblocked | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/377620) | User |
| [`change_membership_state`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/87924) | A user's membership is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.1](https://gitlab.com/gitlab-org/gitlab/-/issues/362200) | Group |
| [`inactive_scim_user_cannot_be_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173879) | A user cannot be added to a group during SAML authentication when their SCIM identity is inactive | {{< icon name="check-circle" >}} Yes | GitLab [17.7](https://gitlab.com/gitlab-org/gitlab/-/issues/422582) | Group |
| [`password_reset_failed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129079) | A password reset fails for a user | {{< icon name="dotted-circle" >}} No | GitLab [16.4](https://gitlab.com/gitlab-org/gitlab/-/issues/377762) | User |
| [`unban_user`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116221) | A user is unbanned | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/377620) | User |
| [`unblock_user`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115727) | A user is banned | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/377620) | User |
| [`user_activate`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121708) | A user is activated | {{< icon name="check-circle" >}} Yes | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/13473) | User |
| [`user_approved`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113784) | A user is approved for an instance | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`user_blocked`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113784) | A user is blocked | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`user_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113784) | A user is created | {{< icon name="check-circle" >}} Yes | GitLab [15.10](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
| [`user_deactivate`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117776) | A user is deactivated | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/13473) | User |
| [`user_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113784) | A user is scheduled for removal from the instance. Group and Project scopes were [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/167021) in GitLab 17.5. | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User, Group, Project |
| [`user_email_changed_and_user_signed_in`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106090) | User email changed and user signed in | {{< icon name="check-circle" >}} Yes | GitLab [15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/369331) | User |
| [`user_impersonation`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/79340) | An instance administrator starts or stops impersonating a user | {{< icon name="check-circle" >}} Yes | GitLab [14.8](https://gitlab.com/gitlab-org/gitlab/-/issues/300961) | User, Group |
| [`user_password_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106086) | A user password is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369330) | User |
| [`user_provisioned_by_scim`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/174040) | A user is provisioned by SCIM | {{< icon name="check-circle" >}} Yes | GitLab [17.8](https://gitlab.com/gitlab-org/gitlab/-/issues/423322) | Group |
| [`user_rejected`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113784) | A user registration is rejected | {{< icon name="check-circle" >}} Yes | GitLab [15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/374107) | User |
### User profile
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`add_ssh_key`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195379) | An SSH key is added to a user's profile. Group scope is only available for enterprise users. | {{< icon name="check-circle" >}} Yes | GitLab [18.2](https://gitlab.com/gitlab-org/gitlab/-/issues/361778) | User, Group |
| [`email_confirmation_sent`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129261) | Users add or change an email address and it must be confirmed | {{< icon name="dotted-circle" >}} No | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/377625) | User |
| [`remove_ssh_key`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65615) | An SSH key is removed from a user's profile. Group scope was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195390) for enterprise users in GitLab 18.2. | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/220127) | User, Group |
| [`user_admin_status_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65168) | A user is either made an administrator or removed as an administrator | {{< icon name="check-circle" >}} Yes | GitLab [14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/323905) | User |
| [`user_auditor_status_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136456) | A user is either made an auditor or removed as an auditor | {{< icon name="check-circle" >}} Yes | GitLab [16.6](https://gitlab.com/gitlab-org/gitlab/-/issues/430235) | User |
| [`user_email_address_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/2103) | A user updates their email address | {{< icon name="check-circle" >}} Yes | GitLab [10.1](https://gitlab.com/gitlab-org/gitlab-ee/issues/1370) | User |
| [`user_name_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/167484) | A user's name is updated | {{< icon name="check-circle" >}} Yes | GitLab [17.5](https://gitlab.com/gitlab-org/gitlab/-/issues/486532) | User |
| [`user_profile_visibility_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/187207) | User toggles private profile user setting | {{< icon name="dotted-circle" >}} No | GitLab [17.11](https://gitlab.com/gitlab-org/gitlab/-/issues/474386) | User |
| [`user_profile_visiblity_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129149) | User toggles private profile user setting (DEPRECATED). Use `user_profile_visibility_updated` instead. | {{< icon name="dotted-circle" >}} No | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129149) | User |
| [`user_username_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106086) | A user's username is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369329) | User |
### Value stream management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_analytics_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's analytics access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369299) | Project |
### Verify security
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`secure_ci_job_token_group_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159754) | Group added to CI_JOB_TOKEN scope | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/467840) | Project |
| [`secure_ci_job_token_group_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159754) | Group removed from CI_JOB_TOKEN scope | {{< icon name="check-circle" >}} Yes | GitLab [17.3](https://gitlab.com/gitlab-org/gitlab/-/issues/467840) | Project |
| [`secure_ci_job_token_inbound_disabled`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115350) | CI_JOB_TOKEN permissions disabled for inbound | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/338255) | Project |
| [`secure_ci_job_token_inbound_enabled`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115350) | CI_JOB_TOKEN permissions enabled for inbound | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/338255) | Project |
| [`secure_ci_job_token_project_added`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115350) | Project added to inbound CI_JOB_TOKEN scope | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/338255) | Project |
| [`secure_ci_job_token_project_removed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115350) | Project removed from inbound CI_JOB_TOKEN scope | {{< icon name="check-circle" >}} Yes | GitLab [16.0](https://gitlab.com/gitlab-org/gitlab/-/issues/338255) | Project |
### Vulnerability management
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_infrastructure_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's infrastructure access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369305) | Project |
### Webhooks
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`webhook_created`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/154046) | A webhook is created | {{< icon name="check-circle" >}} Yes | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/8068) | Project, Group, Instance |
| [`webhook_destroyed`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102342) | A webhook is destroyed | {{< icon name="check-circle" >}} Yes | GitLab [17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/458817) | Project, Group, Instance |
### Wiki
| Type name | Event triggered when | Saved to database | Introduced in | Scope |
|:----------|:---------------------|:------------------|:--------------|:------|
| [`project_feature_wiki_access_level_updated`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106919) | A project's wiki access level setting is updated | {{< icon name="check-circle" >}} Yes | GitLab [15.7](https://gitlab.com/gitlab-org/gitlab/-/issues/369292) | Project |
|
https://docs.gitlab.com/user/audit_events
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/audit_events.md
|
2025-08-13
|
doc/user/compliance
|
[
"doc",
"user",
"compliance"
] |
audit_events.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Audit events
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
A security audit is an in-depth analysis and review of your infrastructure, which is used to display
areas of concern and potentially hazardous practices. To assist with the audit process, GitLab provides
audit events which allow you to track a variety of different actions within GitLab.
GitLab can help owners and administrators respond to auditors by generating
comprehensive reports. These audit reports vary in scope, depending on the
needs.
For example, you can use audit events to track:
- Who changed the permission level of a particular user for a GitLab project, and when.
- Who added a new user or removed a user, and when.
These events can be used to in an audit to assess risk, strengthen security measures, respond to incidents, and adhere to compliance. For a complete list the audit
events GitLab provides, see [Audit event types](audit_event_types.md). For example:
- Generate a report of audit events to provide to an external auditor requesting proof of certain logging capabilities.
- Provide a report of all users showing their group and project memberships for a quarterly access review so the auditor can verify compliance with an organization's access management policy.
Audit events are retained indefinitely. Because there is no retention timeframe, all audit events are available.
## Prerequisites
To view specific types of audit events, you need a minimum role.
- To view the group audit events of all users in a group, you must have the [Owner role](../permissions.md#roles) for the group.
- To view the project audit events of all users in a project, you must have at least the [Maintainer role](../permissions.md#roles) for the project.
- To view the group and project audit events based on your own actions in a group or project, you must have at least the [Developer role](../permissions.md#roles)
for the group or project.
Users with the [Auditor access level](../../administration/auditor_users.md) can see group and project events for all users.
## Viewing audit events
Audit events can be viewed at the group, project, instance, and sign-in level. Each level has different audit events which it logs.
### Sign-in audit events
Successful sign-in events are the only audit events available at all tiers. To see successful sign-in events:
1. On the left sidebar, select your avatar.
1. Select **Edit profile > Authentication log**.
After upgrading to a paid tier, you can also see successful sign-in events on audit event pages.
### Group audit events
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To view a group's audit events:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. Filter the audit events by the member of the project (user) who performed the action and date range.
Group audit events can also be accessed using the [group audit events API](../../api/audit_events.md#group-audit-events). Group audit event queries `created_after` and `created_before` parameters are limited to a maximum 30 day difference between the dates.
### Project audit events
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Secure > Audit events**.
1. Filter the audit events by the member of the project (user) who performed the action and date range.
Project audit events can also be accessed using the [project audit events API](../../api/audit_events.md#project-audit-events). Project audit event queries `created_after` and `created_before` parameters are limited to a maximum 30 day difference between the dates.
## Time zones
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/242014) in GitLab 15.7, GitLab UI shows dates and times in the user's local time zone instead of UTC.
{{< /history >}}
The time zone used for audit events depends on where you view them:
- In GitLab UI, your local time zone is used.
- The [audit events API](../../api/audit_events.md) returns dates and times in UTC by default, or the
[configured time zone](../../administration/timezone.md) on GitLab Self-Managed.
- In CSV exports, UTC is used.
## Contribute to audit events
If you don't see the event you want in any of the epics, you can either:
- Use the **Audit event proposal** issue template to
[create an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Audit%20Event%20Proposal) to request it.
- Contribute to GitLab and add the event.
## Administer topics
Instance administrators can [administer audit events](../../administration/compliance/audit_event_reports.md) from the **Admin** area.
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Audit events
breadcrumbs:
- doc
- user
- compliance
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
A security audit is an in-depth analysis and review of your infrastructure, which is used to display
areas of concern and potentially hazardous practices. To assist with the audit process, GitLab provides
audit events which allow you to track a variety of different actions within GitLab.
GitLab can help owners and administrators respond to auditors by generating
comprehensive reports. These audit reports vary in scope, depending on the
needs.
For example, you can use audit events to track:
- Who changed the permission level of a particular user for a GitLab project, and when.
- Who added a new user or removed a user, and when.
These events can be used to in an audit to assess risk, strengthen security measures, respond to incidents, and adhere to compliance. For a complete list the audit
events GitLab provides, see [Audit event types](audit_event_types.md). For example:
- Generate a report of audit events to provide to an external auditor requesting proof of certain logging capabilities.
- Provide a report of all users showing their group and project memberships for a quarterly access review so the auditor can verify compliance with an organization's access management policy.
Audit events are retained indefinitely. Because there is no retention timeframe, all audit events are available.
## Prerequisites
To view specific types of audit events, you need a minimum role.
- To view the group audit events of all users in a group, you must have the [Owner role](../permissions.md#roles) for the group.
- To view the project audit events of all users in a project, you must have at least the [Maintainer role](../permissions.md#roles) for the project.
- To view the group and project audit events based on your own actions in a group or project, you must have at least the [Developer role](../permissions.md#roles)
for the group or project.
Users with the [Auditor access level](../../administration/auditor_users.md) can see group and project events for all users.
## Viewing audit events
Audit events can be viewed at the group, project, instance, and sign-in level. Each level has different audit events which it logs.
### Sign-in audit events
Successful sign-in events are the only audit events available at all tiers. To see successful sign-in events:
1. On the left sidebar, select your avatar.
1. Select **Edit profile > Authentication log**.
After upgrading to a paid tier, you can also see successful sign-in events on audit event pages.
### Group audit events
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To view a group's audit events:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Audit events**.
1. Filter the audit events by the member of the project (user) who performed the action and date range.
Group audit events can also be accessed using the [group audit events API](../../api/audit_events.md#group-audit-events). Group audit event queries `created_after` and `created_before` parameters are limited to a maximum 30 day difference between the dates.
### Project audit events
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Secure > Audit events**.
1. Filter the audit events by the member of the project (user) who performed the action and date range.
Project audit events can also be accessed using the [project audit events API](../../api/audit_events.md#project-audit-events). Project audit event queries `created_after` and `created_before` parameters are limited to a maximum 30 day difference between the dates.
## Time zones
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/242014) in GitLab 15.7, GitLab UI shows dates and times in the user's local time zone instead of UTC.
{{< /history >}}
The time zone used for audit events depends on where you view them:
- In GitLab UI, your local time zone is used.
- The [audit events API](../../api/audit_events.md) returns dates and times in UTC by default, or the
[configured time zone](../../administration/timezone.md) on GitLab Self-Managed.
- In CSV exports, UTC is used.
## Contribute to audit events
If you don't see the event you want in any of the epics, you can either:
- Use the **Audit event proposal** issue template to
[create an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Audit%20Event%20Proposal) to request it.
- Contribute to GitLab and add the event.
## Administer topics
Instance administrators can [administer audit events](../../administration/compliance/audit_event_reports.md) from the **Admin** area.
|
https://docs.gitlab.com/user/compliance/compliance_frameworks
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance/_index.md
|
2025-08-13
|
doc/user/compliance/compliance_frameworks
|
[
"doc",
"user",
"compliance",
"compliance_frameworks"
] |
_index.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Compliance frameworks
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can create a compliance framework that is a label to identify that your project has certain compliance
requirements or needs additional oversight.
In the Ultimate tier, the compliance framework can optionally enforce
[compliance pipeline configuration](../compliance_pipelines.md) and
[security policies](../../application_security/policies/enforcement/_index.md#scope) to the projects on which it is applied.
Compliance frameworks are created on top-level groups. If a project is moved outside of its existing top-level group,
its frameworks are removed.
You can apply up to 20 compliance frameworks to each project.
For a click-through demo, see [Compliance frameworks](https://gitlab.navattic.com/compliance).
<!-- Demo published on 2025-01-27 -->
## Prerequisites
- To create, edit, and delete compliance frameworks, users must have either:
- The Owner role for the top-level group.
- Be assigned a [custom role](../../custom_roles/_index.md) with the `admin_compliance_framework`
[custom permission](../../custom_roles/abilities.md#compliance-management).
- To add or remove a compliance framework to or from a project, the group to which the project belongs must have a
compliance framework.
## Create, edit, or delete a compliance framework
You can create, edit, or delete a compliance framework by using either a compliance frameworks report or a compliance projects report.
For more information on using a compliance frameworks report, see:
- [Create a new compliance framework](../compliance_center/compliance_frameworks_report.md#create-a-new-compliance-framework).
- [Edit a compliance framework](../compliance_center/compliance_frameworks_report.md#edit-a-compliance-framework).
- [Delete a compliance framework](../compliance_center/compliance_frameworks_report.md#delete-a-compliance-framework).
For more information on using a compliance projects report, see:
- [Create a new compliance framework](../compliance_center/compliance_projects_report.md#create-a-new-compliance-framework).
- [Edit a compliance framework](../compliance_center/compliance_projects_report.md#edit-a-compliance-framework).
- [Delete a compliance framework](../compliance_center/compliance_projects_report.md#delete-a-compliance-framework).
Subgroups and projects have access to all compliance frameworks created on their top-level group. However, compliance frameworks cannot be created, edited,
or deleted by using subgroups or projects. Project owners can choose a framework to apply to their projects.
## Apply a compliance framework to a project
{{< history >}}
- Applying multiple compliance frameworks [introduced](https://gitlab.com/groups/gitlab-org/-/epics/13294) in GitLab 17.3.
- Applying a compliance framework to a project through a compliance framework [introduced](https://gitlab.com/groups/gitlab-org/-/epics/16747) in GitLab 17.11.
{{< /history >}}
You can apply multiple compliance frameworks to a project but cannot apply compliance frameworks to projects in personal namespaces.
To apply a compliance framework to a project, apply the compliance framework through the
[Compliance projects report](../compliance_center/compliance_projects_report.md#apply-a-compliance-framework-to-projects-in-a-group).
You can use the [GraphQL API](../../../api/graphql/reference/_index.md#mutationprojectupdatecomplianceframeworks) to apply one or many
compliance frameworks to a project.
If you create compliance frameworks on subgroups with GraphQL, the framework is created on the root ancestor if the user
has the correct permissions. The GitLab UI presents a read-only view to discourage this behavior.
To apply a compliance framework to a project through a compliance framework:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Hover over a compliance framework, select the **Edit Framework** tab.
1. Select **Projects** section.
1. Select projects from the list.
1. Select **Update Framework**.
## Default compliance frameworks
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375036) in GitLab 15.6.
{{< /history >}}
Group owners can set a default compliance framework. The default framework is applied to all the new and imported
projects that are created in that group. It does not affect the framework applied to the existing projects. The
default framework cannot be deleted.
A compliance framework that is set to default has a **default** label.
### Set and remove a default by using the compliance center
To set as default (or remove the default) from [compliance projects report](../compliance_center/compliance_projects_report.md):
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Hover over a compliance framework, select the **Edit Framework** tab.
1. Select **Set as default**.
1. Select **Save changes**.
To set as default (or remove the default) from [compliance framework report](../compliance_center/compliance_frameworks_report.md):
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Hover over a compliance framework, select the **Edit Framework** tab.
1. Select **Set as default**.
1. Select **Save changes**.
## Remove a compliance framework from a project
To remove a compliance framework from one or multiple project in a group, remove the compliance framework through the
[Compliance projects report](../compliance_center/compliance_projects_report.md#remove-a-compliance-framework-from-projects-in-a-group).
## Import and export compliance frameworks
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/16499) in GitLab 17.11.
{{< /history >}}
Download existing compliance frameworks as JSON files and upload new frameworks from JSON templates.
A library of JSON templates is available from the
[Compliance Adherence Templates](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates) project.
Use these templates to quickly adopt predefined compliance frameworks.
### Export a compliance framework as a JSON file
With this feature, you can share and back up compliance frameworks.
To export a compliance framework from the compliance center:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Locate the compliance framework you wish to export.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}).
1. Select **Export as JSON file**.
The JSON file is downloaded to your local system.
### Import a compliance framework from a JSON file
With this feature, you can use shared or backed up compliance frameworks. The JSON file must not have the same name as an existing compliance framework.
To import a compliance framework by using a JSON template:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Select **New framework**.
1. Select **Import framework**.
1. In the dialog that appears, select the JSON file from your local system.
If the import is successful, the new compliance framework appears in the list. Any errors are displayed for correction.
## Requirements
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/186525) in GitLab 17.11 [with a flag](../../../administration/feature_flags/_index.md) named `enable_standards_adherence_dashboard_v2`. Enabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/535563) in GitLab 18.3. Feature flag `enable_standards_adherence_dashboard_v2` removed.
{{< /history >}}
In GitLab Ultimate, you can define specific **requirements** for a compliance framework. Requirements are made up of one
or more **controls**, which are checks against the configuration or behavior of projects that are assigned the framework. There is maximum of 5 controls per requirement.
Each control includes logic that GitLab uses during scheduled or triggered scans to evaluate a project's adherence. For
more details on how adherence is tracked, see [Compliance status report](../compliance_center/compliance_status_report.md).
You can use GitLab compliance controls or external controls for framework requirements.
### GitLab compliance controls
GitLab compliance controls can be used in GitLab compliance frameworks. Controls are checks against the configuration or
behavior of projects that are assigned to a compliance framework.
Combine GitLab compliance controls to help you meet
[compliance standards](compliance_standards.md).
<!-- Updates to control names must be reflected also in compliance_standards.md -->
| Control name | Control ID | Description |
|:---------------------------------------------------------|:-----------------------------------------------------------|:------------|
| API security running | `scanner_api_security_running` | Ensures that [API security scanning](../../application_security/api_security/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| At least one approval | `minimum_approvals_required_1` | Ensures that merge requests [require at least one approvals](../../project/merge_requests/approvals/_index.md) before merging. |
| At least two approvals | `minimum_approvals_required_2` | Ensures that merge requests [require at least two approvals](../../project/merge_requests/approvals/_index.md) before merging. |
| Auth SSO enabled | `auth_sso_enabled` | Ensures that [Single Sign-On (SSO) authentication](../../group/saml_sso/_index.md) is enabled for the project. |
| Author approved merge request is forbidden | `merge_request_prevent_author_approval` | Ensures that the author of a merge request [cannot approve their own changes](../../project/merge_requests/approvals/_index.md). |
| Branch deletion disabled | `branch_deletion_disabled` | Ensures that [branches can't be deleted](../../project/repository/branches/protected.md). |
| CI/CD job token scope enabled | `cicd_job_token_scope_enabled` | Ensures that [CI/CD job token](../../../ci/jobs/ci_job_token.md) scope restrictions are enabled. |
| Code changes requires code owners | `code_changes_requires_code_owners` | Ensures that code changes require approval from [code owners](../../project/codeowners/_index.md). |
| Code owner approval required | `code_owner_approval_required` | Ensures that [code owners file](../../project/codeowners/_index.md) is configured. |
| Code quality running | `scanner_code_quality_running` | Ensures that [code quality scanning](../../../ci/testing/code_quality.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Committers approved merge request is forbidden | `merge_request_prevent_committers_approval` | Ensures that users who have [committed to a merge request cannot approve it](../../project/merge_requests/approvals/_index.md). |
| Container scanning running | `scanner_container_scanning_running` | Ensures that [container scanning](../../application_security/container_scanning/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| DAST running | `scanner_dast_running` | Ensures that [Dynamic Application Security Testing](../../application_security/dast/_index.md) (DAST) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Default branch protected | `default_branch_protected` | Ensures that the default branch has [protection rules](../../project/repository/branches/protected.md) enabled. |
| Default branch protected from direct push | `default_branch_protected_from_direct_push` | [Prevents direct pushes to the default branch](../../project/repository/branches/protected.md). |
| Default branch users can merge | `default_branch_users_can_merge` | Controls [whether users can merge changes to the default branch](../../project/repository/branches/protected.md). |
| Default branch users can push | `default_branch_users_can_push` | Controls [whether users can push directly to the default branch](../../project/repository/branches/protected.md). |
| Dependency scanning running | `scanner_dep_scanning_running` | Ensures that [dependency scanning](../../application_security/dependency_scanning/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Ensure two administrators per repository | `ensure_2_admins_per_repo` | Ensures that [at least two administrators](../../project/members/_index.md) are assigned to each repository. |
| Error tracking enabled | `error_tracking_enabled` | Ensures that [error tracking](../../../operations/error_tracking.md) is enabled for the project. |
| Force push disabled | `force_push_disabled` | Prevents [force pushing](../../project/repository/branches/protected.md) to repositories. |
| Forks exist for the project | `has_forks` | Ensures that the project has been [forked](../../project/repository/forking_workflow.md) |
| Fuzz testing running | `scanner_fuzz_testing_running` | Ensures that [fuzz testing](../../application_security/coverage_fuzzing/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| GitLab license level Ultimate | `gitlab_license_level_ultimate` | Ensures that the GitLab instance is using an [Ultimate license](https://about.gitlab.com/pricing/feature-comparison/). |
| Has valid CI/CD configuration | `has_valid_ci_config` | Ensures that the project has a [valid CI/CD configuration](../../../ci/yaml/_index.md). |
| IaC scanning running | `scanner_iac_running` | Ensures [Infrastructure as Code (IaC) scanning](../../application_security/iac_scanning/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Internal visibility is forbidden | `project_visibility_not_internal` | Ensures that projects are not set to [internal visibility](../../public_access.md). |
| Issue tracking enabled | `issue_tracking_enabled` | Ensures that [issue tracking](../../project/issues/_index.md) is enabled for the project. |
| License compliance running | `scanner_license_compliance_running` | Ensures that [license compliance scanning](../license_approval_policies.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Merge request commit reset approvals | `merge_request_commit_reset_approvals` | Ensures that [new commits to merge requests reset approvals](../../project/merge_requests/approvals/settings.md). |
| Merge requests approval rules prevent editing | `merge_requests_approval_rules_prevent_editing` | Ensures that [merge request approval rules](../../project/merge_requests/approvals/settings.md) can't be edited. |
| Merge requests require code owner approval | `merge_requests_require_code_owner_approval` | Ensures that merge requests require approval from [code owners](../../project/codeowners/_index.md). |
| More members than admins | `more_members_than_admins` | Ensures fewer [administrators](../../project/members/_index.md) are assigned to the project than total members. |
| Package Hunter no findings untriaged | `package_hunter_no_findings_untriaged` | Ensures that all [Package Hunter](../../application_security/triage/_index.md) findings are triaged. |
| Project not archived | `project_archived` | Checks whether the [project is archived](../../project/settings/_index.md). Typically `false` is compliant. |
| Project not marked for deletion | `project_marked_for_deletion` | Checks whether the [project is marked for deletion](../../project/settings/_index.md). `false` is compliant. |
| Project pipelines not public | `project_pipelines_not_public` | Ensures that [project pipelines are not publicly visible](../../../ci/pipelines/settings.md). |
| Project repository exists | `project_repo_exists` | Ensures that a [Git repository](../../../topics/git/_index.md) exists for the project. |
| Project visibility not public | `project_visibility_not_public` | Ensures that projects are not set to [public visibility](../../public_access.md). |
| Protected branches exist | `protected_branches_set` | Ensures that project contains [protected branches](../../project/repository/branches/protected.md). |
| Push protection enabled | `push_protection_enabled` | Ensures that [push protection](../../project/repository/push_rules.md) is enabled for sensitive files. |
| Require branch up to date | `require_branch_up_to_date` | Ensures that the [source branch is up to date with the target branch before merging](../../project/merge_requests/methods/_index.md). |
| Require linear history | `require_linear_history` | Ensures a [linear commit history](../../project/merge_requests/methods/_index.md#fast-forward-merge) by forbidding merge commits. |
| Require MFA at organization level | `require_mfa_at_org_level` | Ensures that [multi-factor authentication](../../profile/account/two_factor_authentication.md) is required at the organization level. |
| Require MFA for contributors | `require_mfa_for_contributors` | Ensures that [contributors have multi-factor authentication enabled](../../profile/account/two_factor_authentication.md). |
| Requires signed commits | `require_signed_commits` | Ensures that [signed commits](../../project/repository/signed_commits) are required. |
| Reset approvals on push | `reset_approvals_on_push` | Ensures that [approvals are reset when new commits are pushed](../../project/merge_requests/approvals/settings.md) to the merge request. |
| Resolve discussions required | `resolve_discussions_required` | Ensures that all [discussions must be resolved](../../discussions/_index.md) before merging is allowed. |
| Restrict push/merge access | `restrict_push_merge_access` | Restricts who can push to or merge into [protected branches](../../project/repository/branches/protected.md). |
| Restricted build access | `restricted_build_access` | Ensures [restricted access to build artifacts and pipeline outputs](../../../ci/pipelines/settings.md). |
| Review and archive stale repositories | `review_and_archive_stale_repos` | Ensures that stale repositories are reviewed and [archived](../../project/settings/_index.md). |
| Review and remove inactive users | `review_and_remove_inactive_users` | Ensures that [inactive users](../../../administration/admin_area.md) are reviewed and removed. |
| SAST running | `scanner_sast_running` | Ensures that [Static Application Security Testing](../../application_security/sast/_index.md) (SAST) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Secret detection running | `scanner_secret_detection_running` | Ensures that [secret detection scanning](../../application_security/secret_detection/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Secure webhooks | `secure_webhooks` | Ensures that [webhooks](../../project/integrations/webhooks.md) are securely configured. |
| Stale branch cleanup enabled | `stale_branch_cleanup_enabled` | Ensures that [automatic cleanup of stale branches](../../project/repository/branches/_index.md) is enabled. |
| Status checks required | `status_checks_required` | Ensures that [status checks](../../project/merge_requests/status_checks.md) must pass before merging is allowed. |
| Status page configured | `status_page_configured` | Ensures that a [status page](../../../operations/incident_management/status_page.md) is configured for the project. |
| Strict Permission for Repository | `strict_permissions_for_repo` | Ensures that [strict permissions](../../permissions.md) are set for repository access. |
| Terraform enabled | `terraform_enabled` | Ensures that the [Terraform integration](../../../administration/terraform_state.md) is enabled for the project. |
| User-defined CI/CD variables restricted to maintainers | `project_user_defined_variables_restricted_to_maintainers` | Ensures that only users with the maintainer role or higher can pass [user-defined variables when triggering pipelines](../../../ci/variables/_index.md). |
| Vulnerabilities SLO days over threshold | `vulnerabilities_slo_days_over_threshold` | Ensures that [vulnerabilities are addressed](../../application_security/vulnerabilities/_index.md) inside SLO thresholds (180 days). |
### External controls
{{< history >}}
- External control name [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192177) in GitLab 18.1.
{{< /history >}}
External controls are API calls to external systems that request the status of an external control or requirement.
You can create a external control that sends data to third-party tools.
When the [compliance scans](../compliance_center/compliance_status_report.md#scan-timing-and-triggers) are run, GitLab sends a notification. The users or automated workflows can then update the status of control from outside of GitLab.
With this integration, you can integrate with third-party workflow tools, like ServiceNow, or the custom tool of your choice. The third-party tool
responds with an associated status. This status is then displayed in the [Compliance status report](../compliance_center/compliance_status_report.md).
You can configure external controls for each individual project. External controls are not shared between projects.
Status checks fail if an external control stays in the pending state for more than six hours.
#### Add external controls
To add an external control when creating or editing a framework:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Select **New framework** or edit an existing one.
1. In the **Requirements** section, select **New requirement**.
1. Select **Add an external control**.
1. In the fields edit **External Control Name**, **External URL** and **`HMAC` shared secret**.
1. Select **Save changes to the framework** to save the requirement.
#### External control lifecycle
External controls have an **asynchronous** workflow. [Compliance scans](../compliance_center/compliance_status_report.md#scan-timing-and-triggers) emit a payload to an external service whenever.
```mermaid
sequenceDiagram
GitLab->>+External service: Requirement payload
External service-->>-GitLab: Control response
Note over External service,GitLab: Response includes SHA at HEAD
```
After the payload is received, the external service can run any required processes. The external service can then post
its response back to the merge request by using the REST API.
External controls can have one of three statuses.
| Status | Description |
|:----------|:------------|
| `pending` | Default status. No response received from the external service. |
| `pass` | Response received from the external service and the external control was approved by the external service. |
| `fail` | Response received from the external service and the external control was denied by the external service. |
If something changes outside of GitLab, you can set the [status of an external control by using the API](../../../api/external_controls.md). You don't need to wait for a payload to be sent first.
### Add requirements
To add a requirement when creating or editing a framework:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Select **New framework** or edit an existing one.
1. In the **Requirements** section, select **New requirement**.
1. In the dialog add **Name** and **Description**.
1. Select **Add a GitLab control** to add more controls.
1. In the control dropdown list search and select a control.
1. Select **Save changes to the framework** to save the requirement.
### Edit requirements
To edit a requirement when creating or editing a framework:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Select **New framework** or edit an existing one.
1. In the **Requirements** section, select **Action** > **Edit**.
1. In the dialog edit **Name** and **Description**.
1. Select **Add a GitLab control** to add more controls.
1. In the control dropdown list search and select a control.
1. Select {{< icon name="remove" >}} to remove a control.
1. Select **Save changes to the framework** to save the requirement.
## Troubleshooting
When working with compliance frameworks, you might encounter the following issues.
### Error: `Unable to determine the correct upload URL`
You will encounter this error during a [compliance framework import](#import-a-compliance-framework-from-a-json-file) if a compliance framework already exists with the same name as
the JSON template.
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Compliance frameworks
breadcrumbs:
- doc
- user
- compliance
- compliance_frameworks
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can create a compliance framework that is a label to identify that your project has certain compliance
requirements or needs additional oversight.
In the Ultimate tier, the compliance framework can optionally enforce
[compliance pipeline configuration](../compliance_pipelines.md) and
[security policies](../../application_security/policies/enforcement/_index.md#scope) to the projects on which it is applied.
Compliance frameworks are created on top-level groups. If a project is moved outside of its existing top-level group,
its frameworks are removed.
You can apply up to 20 compliance frameworks to each project.
For a click-through demo, see [Compliance frameworks](https://gitlab.navattic.com/compliance).
<!-- Demo published on 2025-01-27 -->
## Prerequisites
- To create, edit, and delete compliance frameworks, users must have either:
- The Owner role for the top-level group.
- Be assigned a [custom role](../../custom_roles/_index.md) with the `admin_compliance_framework`
[custom permission](../../custom_roles/abilities.md#compliance-management).
- To add or remove a compliance framework to or from a project, the group to which the project belongs must have a
compliance framework.
## Create, edit, or delete a compliance framework
You can create, edit, or delete a compliance framework by using either a compliance frameworks report or a compliance projects report.
For more information on using a compliance frameworks report, see:
- [Create a new compliance framework](../compliance_center/compliance_frameworks_report.md#create-a-new-compliance-framework).
- [Edit a compliance framework](../compliance_center/compliance_frameworks_report.md#edit-a-compliance-framework).
- [Delete a compliance framework](../compliance_center/compliance_frameworks_report.md#delete-a-compliance-framework).
For more information on using a compliance projects report, see:
- [Create a new compliance framework](../compliance_center/compliance_projects_report.md#create-a-new-compliance-framework).
- [Edit a compliance framework](../compliance_center/compliance_projects_report.md#edit-a-compliance-framework).
- [Delete a compliance framework](../compliance_center/compliance_projects_report.md#delete-a-compliance-framework).
Subgroups and projects have access to all compliance frameworks created on their top-level group. However, compliance frameworks cannot be created, edited,
or deleted by using subgroups or projects. Project owners can choose a framework to apply to their projects.
## Apply a compliance framework to a project
{{< history >}}
- Applying multiple compliance frameworks [introduced](https://gitlab.com/groups/gitlab-org/-/epics/13294) in GitLab 17.3.
- Applying a compliance framework to a project through a compliance framework [introduced](https://gitlab.com/groups/gitlab-org/-/epics/16747) in GitLab 17.11.
{{< /history >}}
You can apply multiple compliance frameworks to a project but cannot apply compliance frameworks to projects in personal namespaces.
To apply a compliance framework to a project, apply the compliance framework through the
[Compliance projects report](../compliance_center/compliance_projects_report.md#apply-a-compliance-framework-to-projects-in-a-group).
You can use the [GraphQL API](../../../api/graphql/reference/_index.md#mutationprojectupdatecomplianceframeworks) to apply one or many
compliance frameworks to a project.
If you create compliance frameworks on subgroups with GraphQL, the framework is created on the root ancestor if the user
has the correct permissions. The GitLab UI presents a read-only view to discourage this behavior.
To apply a compliance framework to a project through a compliance framework:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Hover over a compliance framework, select the **Edit Framework** tab.
1. Select **Projects** section.
1. Select projects from the list.
1. Select **Update Framework**.
## Default compliance frameworks
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375036) in GitLab 15.6.
{{< /history >}}
Group owners can set a default compliance framework. The default framework is applied to all the new and imported
projects that are created in that group. It does not affect the framework applied to the existing projects. The
default framework cannot be deleted.
A compliance framework that is set to default has a **default** label.
### Set and remove a default by using the compliance center
To set as default (or remove the default) from [compliance projects report](../compliance_center/compliance_projects_report.md):
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Hover over a compliance framework, select the **Edit Framework** tab.
1. Select **Set as default**.
1. Select **Save changes**.
To set as default (or remove the default) from [compliance framework report](../compliance_center/compliance_frameworks_report.md):
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Hover over a compliance framework, select the **Edit Framework** tab.
1. Select **Set as default**.
1. Select **Save changes**.
## Remove a compliance framework from a project
To remove a compliance framework from one or multiple project in a group, remove the compliance framework through the
[Compliance projects report](../compliance_center/compliance_projects_report.md#remove-a-compliance-framework-from-projects-in-a-group).
## Import and export compliance frameworks
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/16499) in GitLab 17.11.
{{< /history >}}
Download existing compliance frameworks as JSON files and upload new frameworks from JSON templates.
A library of JSON templates is available from the
[Compliance Adherence Templates](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates) project.
Use these templates to quickly adopt predefined compliance frameworks.
### Export a compliance framework as a JSON file
With this feature, you can share and back up compliance frameworks.
To export a compliance framework from the compliance center:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Locate the compliance framework you wish to export.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}).
1. Select **Export as JSON file**.
The JSON file is downloaded to your local system.
### Import a compliance framework from a JSON file
With this feature, you can use shared or backed up compliance frameworks. The JSON file must not have the same name as an existing compliance framework.
To import a compliance framework by using a JSON template:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Select **New framework**.
1. Select **Import framework**.
1. In the dialog that appears, select the JSON file from your local system.
If the import is successful, the new compliance framework appears in the list. Any errors are displayed for correction.
## Requirements
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/186525) in GitLab 17.11 [with a flag](../../../administration/feature_flags/_index.md) named `enable_standards_adherence_dashboard_v2`. Enabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/535563) in GitLab 18.3. Feature flag `enable_standards_adherence_dashboard_v2` removed.
{{< /history >}}
In GitLab Ultimate, you can define specific **requirements** for a compliance framework. Requirements are made up of one
or more **controls**, which are checks against the configuration or behavior of projects that are assigned the framework. There is maximum of 5 controls per requirement.
Each control includes logic that GitLab uses during scheduled or triggered scans to evaluate a project's adherence. For
more details on how adherence is tracked, see [Compliance status report](../compliance_center/compliance_status_report.md).
You can use GitLab compliance controls or external controls for framework requirements.
### GitLab compliance controls
GitLab compliance controls can be used in GitLab compliance frameworks. Controls are checks against the configuration or
behavior of projects that are assigned to a compliance framework.
Combine GitLab compliance controls to help you meet
[compliance standards](compliance_standards.md).
<!-- Updates to control names must be reflected also in compliance_standards.md -->
| Control name | Control ID | Description |
|:---------------------------------------------------------|:-----------------------------------------------------------|:------------|
| API security running | `scanner_api_security_running` | Ensures that [API security scanning](../../application_security/api_security/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| At least one approval | `minimum_approvals_required_1` | Ensures that merge requests [require at least one approvals](../../project/merge_requests/approvals/_index.md) before merging. |
| At least two approvals | `minimum_approvals_required_2` | Ensures that merge requests [require at least two approvals](../../project/merge_requests/approvals/_index.md) before merging. |
| Auth SSO enabled | `auth_sso_enabled` | Ensures that [Single Sign-On (SSO) authentication](../../group/saml_sso/_index.md) is enabled for the project. |
| Author approved merge request is forbidden | `merge_request_prevent_author_approval` | Ensures that the author of a merge request [cannot approve their own changes](../../project/merge_requests/approvals/_index.md). |
| Branch deletion disabled | `branch_deletion_disabled` | Ensures that [branches can't be deleted](../../project/repository/branches/protected.md). |
| CI/CD job token scope enabled | `cicd_job_token_scope_enabled` | Ensures that [CI/CD job token](../../../ci/jobs/ci_job_token.md) scope restrictions are enabled. |
| Code changes requires code owners | `code_changes_requires_code_owners` | Ensures that code changes require approval from [code owners](../../project/codeowners/_index.md). |
| Code owner approval required | `code_owner_approval_required` | Ensures that [code owners file](../../project/codeowners/_index.md) is configured. |
| Code quality running | `scanner_code_quality_running` | Ensures that [code quality scanning](../../../ci/testing/code_quality.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Committers approved merge request is forbidden | `merge_request_prevent_committers_approval` | Ensures that users who have [committed to a merge request cannot approve it](../../project/merge_requests/approvals/_index.md). |
| Container scanning running | `scanner_container_scanning_running` | Ensures that [container scanning](../../application_security/container_scanning/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| DAST running | `scanner_dast_running` | Ensures that [Dynamic Application Security Testing](../../application_security/dast/_index.md) (DAST) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Default branch protected | `default_branch_protected` | Ensures that the default branch has [protection rules](../../project/repository/branches/protected.md) enabled. |
| Default branch protected from direct push | `default_branch_protected_from_direct_push` | [Prevents direct pushes to the default branch](../../project/repository/branches/protected.md). |
| Default branch users can merge | `default_branch_users_can_merge` | Controls [whether users can merge changes to the default branch](../../project/repository/branches/protected.md). |
| Default branch users can push | `default_branch_users_can_push` | Controls [whether users can push directly to the default branch](../../project/repository/branches/protected.md). |
| Dependency scanning running | `scanner_dep_scanning_running` | Ensures that [dependency scanning](../../application_security/dependency_scanning/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Ensure two administrators per repository | `ensure_2_admins_per_repo` | Ensures that [at least two administrators](../../project/members/_index.md) are assigned to each repository. |
| Error tracking enabled | `error_tracking_enabled` | Ensures that [error tracking](../../../operations/error_tracking.md) is enabled for the project. |
| Force push disabled | `force_push_disabled` | Prevents [force pushing](../../project/repository/branches/protected.md) to repositories. |
| Forks exist for the project | `has_forks` | Ensures that the project has been [forked](../../project/repository/forking_workflow.md) |
| Fuzz testing running | `scanner_fuzz_testing_running` | Ensures that [fuzz testing](../../application_security/coverage_fuzzing/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| GitLab license level Ultimate | `gitlab_license_level_ultimate` | Ensures that the GitLab instance is using an [Ultimate license](https://about.gitlab.com/pricing/feature-comparison/). |
| Has valid CI/CD configuration | `has_valid_ci_config` | Ensures that the project has a [valid CI/CD configuration](../../../ci/yaml/_index.md). |
| IaC scanning running | `scanner_iac_running` | Ensures [Infrastructure as Code (IaC) scanning](../../application_security/iac_scanning/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Internal visibility is forbidden | `project_visibility_not_internal` | Ensures that projects are not set to [internal visibility](../../public_access.md). |
| Issue tracking enabled | `issue_tracking_enabled` | Ensures that [issue tracking](../../project/issues/_index.md) is enabled for the project. |
| License compliance running | `scanner_license_compliance_running` | Ensures that [license compliance scanning](../license_approval_policies.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Merge request commit reset approvals | `merge_request_commit_reset_approvals` | Ensures that [new commits to merge requests reset approvals](../../project/merge_requests/approvals/settings.md). |
| Merge requests approval rules prevent editing | `merge_requests_approval_rules_prevent_editing` | Ensures that [merge request approval rules](../../project/merge_requests/approvals/settings.md) can't be edited. |
| Merge requests require code owner approval | `merge_requests_require_code_owner_approval` | Ensures that merge requests require approval from [code owners](../../project/codeowners/_index.md). |
| More members than admins | `more_members_than_admins` | Ensures fewer [administrators](../../project/members/_index.md) are assigned to the project than total members. |
| Package Hunter no findings untriaged | `package_hunter_no_findings_untriaged` | Ensures that all [Package Hunter](../../application_security/triage/_index.md) findings are triaged. |
| Project not archived | `project_archived` | Checks whether the [project is archived](../../project/settings/_index.md). Typically `false` is compliant. |
| Project not marked for deletion | `project_marked_for_deletion` | Checks whether the [project is marked for deletion](../../project/settings/_index.md). `false` is compliant. |
| Project pipelines not public | `project_pipelines_not_public` | Ensures that [project pipelines are not publicly visible](../../../ci/pipelines/settings.md). |
| Project repository exists | `project_repo_exists` | Ensures that a [Git repository](../../../topics/git/_index.md) exists for the project. |
| Project visibility not public | `project_visibility_not_public` | Ensures that projects are not set to [public visibility](../../public_access.md). |
| Protected branches exist | `protected_branches_set` | Ensures that project contains [protected branches](../../project/repository/branches/protected.md). |
| Push protection enabled | `push_protection_enabled` | Ensures that [push protection](../../project/repository/push_rules.md) is enabled for sensitive files. |
| Require branch up to date | `require_branch_up_to_date` | Ensures that the [source branch is up to date with the target branch before merging](../../project/merge_requests/methods/_index.md). |
| Require linear history | `require_linear_history` | Ensures a [linear commit history](../../project/merge_requests/methods/_index.md#fast-forward-merge) by forbidding merge commits. |
| Require MFA at organization level | `require_mfa_at_org_level` | Ensures that [multi-factor authentication](../../profile/account/two_factor_authentication.md) is required at the organization level. |
| Require MFA for contributors | `require_mfa_for_contributors` | Ensures that [contributors have multi-factor authentication enabled](../../profile/account/two_factor_authentication.md). |
| Requires signed commits | `require_signed_commits` | Ensures that [signed commits](../../project/repository/signed_commits) are required. |
| Reset approvals on push | `reset_approvals_on_push` | Ensures that [approvals are reset when new commits are pushed](../../project/merge_requests/approvals/settings.md) to the merge request. |
| Resolve discussions required | `resolve_discussions_required` | Ensures that all [discussions must be resolved](../../discussions/_index.md) before merging is allowed. |
| Restrict push/merge access | `restrict_push_merge_access` | Restricts who can push to or merge into [protected branches](../../project/repository/branches/protected.md). |
| Restricted build access | `restricted_build_access` | Ensures [restricted access to build artifacts and pipeline outputs](../../../ci/pipelines/settings.md). |
| Review and archive stale repositories | `review_and_archive_stale_repos` | Ensures that stale repositories are reviewed and [archived](../../project/settings/_index.md). |
| Review and remove inactive users | `review_and_remove_inactive_users` | Ensures that [inactive users](../../../administration/admin_area.md) are reviewed and removed. |
| SAST running | `scanner_sast_running` | Ensures that [Static Application Security Testing](../../application_security/sast/_index.md) (SAST) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Secret detection running | `scanner_secret_detection_running` | Ensures that [secret detection scanning](../../application_security/secret_detection/_index.md) is configured and running in the project's default branch pipeline. Requires a successful pipeline run. |
| Secure webhooks | `secure_webhooks` | Ensures that [webhooks](../../project/integrations/webhooks.md) are securely configured. |
| Stale branch cleanup enabled | `stale_branch_cleanup_enabled` | Ensures that [automatic cleanup of stale branches](../../project/repository/branches/_index.md) is enabled. |
| Status checks required | `status_checks_required` | Ensures that [status checks](../../project/merge_requests/status_checks.md) must pass before merging is allowed. |
| Status page configured | `status_page_configured` | Ensures that a [status page](../../../operations/incident_management/status_page.md) is configured for the project. |
| Strict Permission for Repository | `strict_permissions_for_repo` | Ensures that [strict permissions](../../permissions.md) are set for repository access. |
| Terraform enabled | `terraform_enabled` | Ensures that the [Terraform integration](../../../administration/terraform_state.md) is enabled for the project. |
| User-defined CI/CD variables restricted to maintainers | `project_user_defined_variables_restricted_to_maintainers` | Ensures that only users with the maintainer role or higher can pass [user-defined variables when triggering pipelines](../../../ci/variables/_index.md). |
| Vulnerabilities SLO days over threshold | `vulnerabilities_slo_days_over_threshold` | Ensures that [vulnerabilities are addressed](../../application_security/vulnerabilities/_index.md) inside SLO thresholds (180 days). |
### External controls
{{< history >}}
- External control name [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192177) in GitLab 18.1.
{{< /history >}}
External controls are API calls to external systems that request the status of an external control or requirement.
You can create a external control that sends data to third-party tools.
When the [compliance scans](../compliance_center/compliance_status_report.md#scan-timing-and-triggers) are run, GitLab sends a notification. The users or automated workflows can then update the status of control from outside of GitLab.
With this integration, you can integrate with third-party workflow tools, like ServiceNow, or the custom tool of your choice. The third-party tool
responds with an associated status. This status is then displayed in the [Compliance status report](../compliance_center/compliance_status_report.md).
You can configure external controls for each individual project. External controls are not shared between projects.
Status checks fail if an external control stays in the pending state for more than six hours.
#### Add external controls
To add an external control when creating or editing a framework:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Select **New framework** or edit an existing one.
1. In the **Requirements** section, select **New requirement**.
1. Select **Add an external control**.
1. In the fields edit **External Control Name**, **External URL** and **`HMAC` shared secret**.
1. Select **Save changes to the framework** to save the requirement.
#### External control lifecycle
External controls have an **asynchronous** workflow. [Compliance scans](../compliance_center/compliance_status_report.md#scan-timing-and-triggers) emit a payload to an external service whenever.
```mermaid
sequenceDiagram
GitLab->>+External service: Requirement payload
External service-->>-GitLab: Control response
Note over External service,GitLab: Response includes SHA at HEAD
```
After the payload is received, the external service can run any required processes. The external service can then post
its response back to the merge request by using the REST API.
External controls can have one of three statuses.
| Status | Description |
|:----------|:------------|
| `pending` | Default status. No response received from the external service. |
| `pass` | Response received from the external service and the external control was approved by the external service. |
| `fail` | Response received from the external service and the external control was denied by the external service. |
If something changes outside of GitLab, you can set the [status of an external control by using the API](../../../api/external_controls.md). You don't need to wait for a payload to be sent first.
### Add requirements
To add a requirement when creating or editing a framework:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Select **New framework** or edit an existing one.
1. In the **Requirements** section, select **New requirement**.
1. In the dialog add **Name** and **Description**.
1. Select **Add a GitLab control** to add more controls.
1. In the control dropdown list search and select a control.
1. Select **Save changes to the framework** to save the requirement.
### Edit requirements
To edit a requirement when creating or editing a framework:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Select **New framework** or edit an existing one.
1. In the **Requirements** section, select **Action** > **Edit**.
1. In the dialog edit **Name** and **Description**.
1. Select **Add a GitLab control** to add more controls.
1. In the control dropdown list search and select a control.
1. Select {{< icon name="remove" >}} to remove a control.
1. Select **Save changes to the framework** to save the requirement.
## Troubleshooting
When working with compliance frameworks, you might encounter the following issues.
### Error: `Unable to determine the correct upload URL`
You will encounter this error during a [compliance framework import](#import-a-compliance-framework-from-a-json-file) if a compliance framework already exists with the same name as
the JSON template.
|
https://docs.gitlab.com/user/compliance/compliance_standards
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance/compliance_standards.md
|
2025-08-13
|
doc/user/compliance/compliance_frameworks
|
[
"doc",
"user",
"compliance",
"compliance_frameworks"
] |
compliance_standards.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Compliance standards
| null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/16620) in GitLab 17.11.
{{< /history >}}
You can use [GitLab compliance controls](_index.md#gitlab-compliance-controls) to help meet the requirements of many
compliance standards.
The [Compliance Adherence Templates](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates) project
contains a library of JSON templates. Use these templates to quickly adopt predefined compliance frameworks.
## FedRAMP compliance requirements
FedRAMP (Federal Risk and Authorization Management Program) categorizes cloud services into three impact levels:
Low, Moderate, and High, based on the potential impact of a data breach on government operations, assets, or individuals.
These levels correspond to different sets of security controls and requirements that cloud service providers (CSPs) must
meet to achieve FedRAMP authorization. Controls are available for FedRAMP Low, FedRAMP Moderate, and FedRAMP High compliance.
### FedRAMP Low compliance requirements
The following table lists the requirements supported by GitLab for FedRAMP Low and the controls for the requirements.
You can use the
[`fedramp_low_r5.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/fedramp_low_r5.json?ref_type=heads)
to create a compliance framework for this standard.
| FedRAMP Low requirement | Description | Supported controls |
|:-----------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| CM-5: Access Restrictions for Change | Define, document, approve, and enforce physical and logical access restrictions associated with changes to the system. | <ul><li>Default branch protected</li><li>At least two approvals</li></ul> |
| CM-6: Configuration Settings | Establish and document secure configuration settings for system components; implement these settings; identify, document, and approve deviations based on operational requirements; and monitor and control changes to configurations according to organizational policies. | <ul><li>Author approved merge request is forbidden</li></ul> |
| CM-7: Least Functionality | Configure the system to provide only organization-defined mission essential capabilities; and Prohibit or restrict the use of the following functions, ports, protocols, software, and/or services: organization-defined prohibited or restricted functions, system ports, protocols, software, and/or services. | <ul><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-10: Software Usage Restrictions | Use software and associated documentation in accordance with contract agreements and copyright laws; track the use of software and associated documentation protected by quantity licenses to control copying and distribution; and control and document the use of peer-to-peer file sharing technology to ensure that this capability is not used for the unauthorized distribution, display, performance, or reproduction of copyrighted work. | <ul><li>License compliance running</li></ul> |
| IA-2(12): Acceptance of PIV Credentials | Accept and electronically verify Personal Identity Verification (PIV) credentials. | <ul><li>Auth SSO enabled</li></ul> |
| IA-8(1): Acceptance of PIV Credentials From Other Agencies | Accept and electronically verify Personal Identity Verification (PIV) credentials from other federal agencies. | <ul><li>Auth SSO enabled</li></ul> |
| RA-5: Vulnerability Monitoring and Scanning | Scan for vulnerabilities in the system and hosted applications; employ vulnerability scanning tools and techniques; analyze vulnerability scan reports and results; remediate legitimate vulnerabilities; and share vulnerability information. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
### FedRAMP Moderate compliance requirements
The following table lists the requirements supported by GitLab for FedRAMP Moderate and the controls for the requirements.
You can use the
[`fedramp_moderate_r5.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/fedramp_moderate_r5.json?ref_type=heads)
to create a compliance framework for this standard.
| FedRAMP Moderate requirement | Description | Supported controls |
|:-----------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| AC-5: Separation of Duties | Separate duties of individuals to prevent malevolent activity without collusion; document separation of duties; and define system access authorizations to support separation of duties. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-3: Configuration Change Control | Determine types of configuration-controlled changes; review and approve changes with security/privacy impact analysis; document decisions; implement approved changes; retain records; monitor activities associated with changes; and coordinate change control oversight through designated elements. | <ul><li>Default branch protected</li><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-5: Access Restrictions for Change | Define, document, approve, and enforce physical and logical access restrictions associated with changes to the system. | <ul><li>Default branch protected</li><li>At least two approvals</li></ul> |
| CM-6: Configuration Settings | Establish and document secure configuration settings for system components; implement these settings; identify, document, and approve deviations based on operational requirements; and monitor and control changes to configurations according to organizational policies. | <ul><li>Author approved merge request is forbidden</li></ul> |
| CM-7: Least Functionality | Configure the system to provide only organization-defined mission essential capabilities; and Prohibit or restrict the use of the following functions, ports, protocols, software, and/or services: organization-defined prohibited or restricted functions, system ports, protocols, software, and/or services. | <ul><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-10: Software Usage Restrictions | Use software and associated documentation in accordance with contract agreements and copyright laws; track the use of software and associated documentation protected by quantity licenses to control copying and distribution; and control and document the use of peer-to-peer file sharing technology to ensure that this capability is not used for the unauthorized distribution, display, performance, or reproduction of copyrighted work. | <ul><li>License compliance running</li></ul> |
| IA-2(12): Acceptance of PIV Credentials | Accept and electronically verify Personal Identity Verification (PIV) credentials. | <ul><li>Auth SSO enabled</li></ul> |
| IA-5(7): No Embedded Unencrypted Static Authenticators | Ensure that unencrypted static authenticators are not embedded in applications or other forms of static storage. | <ul><li>Secret detection running</li></ul> |
| IA-8(1): Acceptance of PIV Credentials From Other Agencies | Accept and electronically verify Personal Identity Verification (PIV) credentials from other federal agencies. | <ul><li>Auth SSO enabled</li></ul> |
| RA-5: Vulnerability Monitoring and Scanning | Scan for vulnerabilities in the system and hosted applications; employ vulnerability scanning tools and techniques; analyze vulnerability scan reports and results; remediate legitimate vulnerabilities; and share vulnerability information. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| SA-11(1): Static Code Analysis | Require the developer of the system, system component, or system service to employ static code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>SAST running</li></ul> |
| SA-11(8): Dynamic Code Analysis | Require the developer of the system, system component, or system service to employ dynamic code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>DAST running</li><li>Fuzz testing running</li></ul> |
### FedRAMP High compliance requirements
The following table lists the requirements supported by GitLab for FedRAMP High and the controls for the requirements.
You can use the
[`fedramp_high_r5.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/fedramp_high_r5.json?ref_type=heads)
to create a compliance framework for this standard.
| FedRAMP High requirement | Description | Supported controls |
|:---------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| AC-5: Separation of Duties | Separate duties of individuals to prevent malevolent activity without collusion; document separation of duties; and define system access authorizations to support separation of duties. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-3: Configuration Change Control | Determine types of configuration-controlled changes; review and approve changes with security/privacy impact analysis; document decisions; implement approved changes; retain records; monitor activities associated with changes; and coordinate change control oversight through designated elements. | <ul><li>Default branch protected</li><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-3(1): Automated Documentation, Notification, and Prohibition of Changes | Use automated mechanisms to document proposed changes to the system; notify organization-defined approval authorities; highlight change approvals that have not been received by organization-defined time period; prohibit changes to the system until designated approvals are received; and document all changes to the system. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-5: Access Restrictions for Change | Define, document, approve, and enforce physical and logical access restrictions associated with changes to the system. | <ul><li>Default branch protected</li><li>At least two approvals</li></ul> |
| CM-6: Configuration Settings | Establish and document secure configuration settings for system components; implement these settings; identify, document, and approve deviations based on operational requirements; and monitor and control changes to configurations according to organizational policies. | <ul><li>Author approved merge request is forbidden</li></ul> |
| CM-7: Least Functionality | Configure the system to provide only organization-defined mission essential capabilities; and Prohibit or restrict the use of the following functions, ports, protocols, software, and/or services: organization-defined prohibited or restricted functions, system ports, protocols, software, and/or services. | <ul><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-10: Software Usage Restrictions | Use software and associated documentation in accordance with contract agreements and copyright laws; track the use of software and associated documentation protected by quantity licenses to control copying and distribution; and control and document the use of peer-to-peer file sharing technology to ensure that this capability is not used for the unauthorized distribution, display, performance, or reproduction of copyrighted work. | <ul><li>License compliance running</li></ul> |
| IA-2(12): Acceptance of PIV Credentials | Accept and electronically verify Personal Identity Verification (PIV) credentials. | <ul><li>Auth SSO enabled</li></ul> |
| IA-5(7): No Embedded Unencrypted Static Authenticators | Ensure that unencrypted static authenticators are not embedded in applications or other forms of static storage. | <ul><li>Secret detection running</li></ul> |
| IA-8(1): Acceptance of PIV Credentials From Other Agencies | Accept and electronically verify Personal Identity Verification (PIV) credentials from other federal agencies. | <ul><li>Auth SSO enabled</li></ul> |
| RA-5: Vulnerability Monitoring and Scanning | Scan for vulnerabilities in the system and hosted applications; employ vulnerability scanning tools and techniques; analyze vulnerability scan reports and results; remediate legitimate vulnerabilities; and share vulnerability information. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| SA-11(1): Static Code Analysis | Require the developer of the system, system component, or system service to employ static code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>SAST running</li></ul> |
| SA-11(8): Dynamic Code Analysis | Require the developer of the system, system component, or system service to employ dynamic code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>DAST running</li><li>Fuzz testing running</li></ul> |
## IRAP compliance requirements
IRAP is the Infosec Registered Assessors Program. Controls are available for IRAP Official, IRAP Protected, IRAP Secret,
and IRAP Top Secret.
### IRAP Official
The following table lists the requirements supported by GitLab for IRAP Official and the controls for the requirements.
You can use the
[`irap_official.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/irap_official.json?ref_type=heads)
to create a compliance framework for this standard.
| IRAP Official requirement | Description | Supported controls |
|:----------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| ISM-0402 Application security testing | Applications are comprehensively tested for vulnerabilities, using static application security testing and dynamic application security testing, prior to their initial release and any subsequent releases. | <ul><li>SAST running</li><li>DAST running</li></ul> |
| ISM-1163 Continuous monitoring plan | Systems have a continuous monitoring plan that includes: conducting vulnerability scans for systems at least fortnightly, conducting vulnerability assessments and penetration tests for systems prior to deployment, including prior to deployment of significant changes, and at least annually thereafter, analysing identified vulnerabilities to determine their potential impact, and implementing mitigations based on risk, effectiveness and cost. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| ISM-1422 Development, testing and production environments | Unauthorised access to the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1698 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in online services. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1700 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in applications other than office productivity suites, web browsers and their extensions, email clients, PDF software, and security products. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1701 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in operating systems of internet-facing servers and internet-facing network devices. | <ul><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1702 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in operating systems of workstations, non-internet-facing servers and non-internet-facing network devices. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1808 Scanning for unmitigated vulnerabilities | A vulnerability scanner with an up-to-date vulnerability database is used for vulnerability scanning activities. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1816 Development, testing and production environments | Unauthorised modification of the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1875 Protecting credentials | Networks are scanned at least monthly to identify any credentials that are being stored in the clear. | <ul><li>Secret detection running</li></ul> |
### IRAP Protected
The following table lists the requirements supported by GitLab for IRAP Protected and the controls for the requirements.
You can use the
[`irap_protected.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/irap_protected.json?ref_type=heads)
to create a compliance framework for this standard.
| IRAP Protected requirement | Description | Supported controls |
|:----------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| ISM-0402 Application security testing | Applications are comprehensively tested for vulnerabilities, using static application security testing and dynamic application security testing, prior to their initial release and any subsequent releases. | <ul><li>SAST running</li><li>DAST running</li></ul> |
| ISM-1163 Continuous monitoring plan | Systems have a continuous monitoring plan that includes: conducting vulnerability scans for systems at least fortnightly, conducting vulnerability assessments and penetration tests for systems prior to deployment, including prior to deployment of significant changes, and at least annually thereafter, analysing identified vulnerabilities to determine their potential impact, and implementing mitigations based on risk, effectiveness and cost. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| ISM-1422 Development, testing and production environments | Unauthorised access to the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1698 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in online services. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1700 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in applications other than office productivity suites, web browsers and their extensions, email clients, PDF software, and security products. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1701 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in operating systems of internet-facing servers and internet-facing network devices. | <ul><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1702 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in operating systems of workstations, non-internet-facing servers and non-internet-facing network devices. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1808 Scanning for unmitigated vulnerabilities | A vulnerability scanner with an up-to-date vulnerability database is used for vulnerability scanning activities. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1816 Development, testing and production environments | Unauthorised modification of the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1875 Protecting credentials | Networks are scanned at least monthly to identify any credentials that are being stored in the clear. | <ul><li>Secret detection running</li></ul> |
### IRAP Secret
The following table lists the requirements supported by GitLab for IRAP Secret and the controls for the requirements.
You can use the
[`irap_secret.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/irap_secret.json?ref_type=heads)
to create a compliance framework for this standard.
| IRAP Secret requirement | Description | Supported controls |
|:----------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| ISM-0402 Application security testing | Applications are comprehensively tested for vulnerabilities, using static application security testing and dynamic application security testing, prior to their initial release and any subsequent releases. | <ul><li>SAST running</li><li>DAST running</li></ul> |
| ISM-1163 Continuous monitoring plan | Systems have a continuous monitoring plan that includes: conducting vulnerability scans for systems at least fortnightly, conducting vulnerability assessments and penetration tests for systems prior to deployment, including prior to deployment of significant changes, and at least annually thereafter, analysing identified vulnerabilities to determine their potential impact, and implementing mitigations based on risk, effectiveness and cost. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| ISM-1422 Development, testing and production environments | Unauthorised access to the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1698 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in online services. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1700 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in applications other than office productivity suites, web browsers and their extensions, email clients, PDF software, and security products. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1701 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in operating systems of internet-facing servers and internet-facing network devices. | <ul><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1702 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in operating systems of workstations, non-internet-facing servers and non-internet-facing network devices. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1808 Scanning for unmitigated vulnerabilities | A vulnerability scanner with an up-to-date vulnerability database is used for vulnerability scanning activities. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1816 Development, testing and production environments | Unauthorised modification of the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1875 Protecting credentials | Networks are scanned at least monthly to identify any credentials that are being stored in the clear. | <ul><li>Secret detection running</li></ul> |
### IRAP Top Secret
The following table lists the requirements supported by GitLab for IRAP Top Secret and the controls for the requirements.
You can use the
[`irap_top_secret.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/irap_top_secret.json?ref_type=heads)
to create a compliance framework for this standard.
| IRAP Top Secret requirement | Description | Supported controls |
|:----------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| ISM-0402 Application security testing | Applications are comprehensively tested for vulnerabilities, using static application security testing and dynamic application security testing, prior to their initial release and any subsequent releases. | <ul><li>SAST running</li><li>DAST running</li></ul> |
| ISM-1163 Continuous monitoring plan | Systems have a continuous monitoring plan that includes: conducting vulnerability scans for systems at least fortnightly, conducting vulnerability assessments and penetration tests for systems prior to deployment, including prior to deployment of significant changes, and at least annually thereafter, analysing identified vulnerabilities to determine their potential impact, and implementing mitigations based on risk, effectiveness and cost. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| ISM-1422 Development, testing and production environments | Unauthorised access to the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1698 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in online services. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1700 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in applications other than office productivity suites, web browsers and their extensions, email clients, PDF software, and security products. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1701 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in operating systems of internet-facing servers and internet-facing network devices. | <ul><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1702 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in operating systems of workstations, non-internet-facing servers and non-internet-facing network devices. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1808 Scanning for unmitigated vulnerabilities | A vulnerability scanner with an up-to-date vulnerability database is used for vulnerability scanning activities. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1816 Development, testing and production environments | Unauthorised modification of the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1875 Protecting credentials | Networks are scanned at least monthly to identify any credentials that are being stored in the clear. | <ul><li>Secret detection running</li></ul> |
## ISMAP compliance requirements
The Information system Security Management and Assessment Program (ISMAP) aims to secure the security level of the government's cloud service procurement
by evaluating and registering cloud services that meet the security requirements of the government in advance, thereby contributing to the smooth introduction
of cloud services.
The following table lists the requirements supported by GitLab for ISMAP and the controls for the requirements.
You can use the
[`ismap.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/ismap.json?ref_type=heads)
to create a compliance framework for this standard.
| ISMAP requirement | Description | Supported controls |
|:-----------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| 6.1.2 Segregation of duties | Conflicting duties and areas of responsibility should be segregated to reduce opportunities for unauthorized or unintentional modification or misuse of the organization's assets. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| 9.3.1 Use of secret authentication information | Users should be required to follow the organization's practices in the use of secret authentication information. | <ul><li>Secret detection running</li></ul> |
| 9.4.5 Access control to program source code | Access to program source code should be restricted. | <ul><li>Default branch protected</li></ul> |
| 12.1.2 Change management | Changes to the organization, business processes, information processing facilities and systems that affect information security should be controlled. | <ul><li>Default branch protected</li></ul> |
| 12.6.1 Management of technical vulnerabilities | Information about technical vulnerabilities of information systems being used should be obtained in a timely fashion, the organization's exposure to such vulnerabilities evaluated and appropriate measures taken to address the associated risk. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| 14.2.1 Secure development policy | Rules for the development of software and systems should be established and applied to developments within the organization. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
| 14.2.8 System security testing | Testing of security functionality should be carried out during development. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
| 18.1.2 Intellectual property rights | Appropriate procedures should be implemented to ensure compliance with legislative, regulatory and contractual requirements related to intellectual property rights and use of proprietary software products. | <ul><li>License compliance running</li></ul> |
## ISO 27001 compliance requirements
ISO 27001 is an internationally recognized standard that provides a framework for implementing and managing an
Information Security Management System (ISMS).
The following table lists the requirements supported by GitLab for ISO 27001 and the controls for the requirements.
You can use the
[`iso_27001:2022.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/iso_27001:2022.json?ref_type=heads)
to create a compliance framework for this standard.
| ISO 27001 requirement | Description | Supported controls |
|:----------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| 5.3 Segregation of duties | Conflicting duties and conflicting areas of responsibility shall be segregated. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| 5.17 Authentication information | Allocation and management of authentication information should be controlled by a management process, including advising personnel on the appropriate handling of authentication information. | <ul><li>Secret detection running</li></ul> |
| 5.18 Access rights | Access rights to information and other associated assets should be provisioned, reviewed, modified and removed in accordance with the organization's topic-specific policy on and rules for access control. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| 5.32 Intellectual property rights | The organization should implement appropriate procedures to protect intellectual property rights. | <ul><li>License compliance running</li></ul> |
| 8.4 Access to source code | Read and write access to source code, development tools and software libraries shall be appropriately managed. | <ul><li>Default branch protected</li></ul> |
| 8.8 Management of technical vulnerabilities | Information about technical vulnerabilities of information systems in use shall be obtained, the organization's exposure to such vulnerabilities shall be evaluated and appropriate measures shall be taken. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| 8.28 Secure coding | Secure coding principles shall be applied to software development. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
| 8.29 Security testing in development and acceptance | Security testing processes shall be defined and implemented in the development lifecycle. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
| 8.32 Change management | Changes to information processing facilities and information systems shall be subject to change management procedures. | <ul><li>Default branch protected</li></ul> |
## NIST compliance requirements
The National Institute of Standards and Technology (NIST) Information Technology Laboratory (ITL) provides standards,
measurements, and testing for information systems, focusing on interoperability, security, usability, and reliability.
These compliance standards involves implementing security and privacy controls across various areas, including:
- Risk management
- Identification and authentication
- Incident response
- System and communications protection
Controls are available for NIST 800-53, NIST 800-171, NIST SP 800-218, and NIST CSF 2.0 compliance standards.
### NIST 800-53 compliance requirements
The following table lists the requirements supported by GitLab for NIST 800-53 Revision 5 and the controls for the
requirements.
You can use the
[`nist_800-53_r5` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/nist_800-53_r5.json?ref_type=heads)
to create a compliance framework for this standard.
| NIST 800-53 requirement | Description | Supported controls |
|:---------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| AC-3(2): Dual Authorization | Enforce dual authorization for organization-defined privileged commands and/or other organization-defined actions. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| AC-5: Separation of Duties | Separate duties of individuals to prevent malevolent activity without collusion; document separation of duties; and define system access authorizations to support separation of duties. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| AU-9(5): Dual Authorization | Enforce dual authorization for the deletion or modification of organization-defined audit information. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-3: Configuration Change Control | Determine types of configuration-controlled changes; review and approve changes with security/privacy impact analysis; document decisions; implement approved changes; retain records; monitor activities associated with changes; and coordinate change control oversight through designated elements. | <ul><li>Default branch protected</li><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-3(1): Automated Documentation, Notification, and Prohibition of Changes | Use automated mechanisms to document proposed changes to the system; notify organization-defined approval authorities; highlight change approvals that have not been received by organization-defined time period; prohibit changes to the system until designated approvals are received; and document all changes to the system. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-5: Access Restrictions for Change | Define, document, approve, and enforce physical and logical access restrictions associated with changes to the system. | <ul><li>Default branch protected</li><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-5(4): Dual Authorization | Enforce dual authorization for implementing changes to organization-defined system components and system-level information. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-6: Configuration Settings | Establish and document secure configuration settings for system components; implement these settings; identify, document, and approve deviations based on operational requirements; and monitor and control changes to configurations according to organizational policies. | <ul><li>Author approved merge request is forbidden</li></ul> |
| CM-7: Least Functionality | Configure the system to provide only organization-defined mission essential capabilities; and Prohibit or restrict the use of the following functions, ports, protocols, software, and/or services: organization-defined prohibited or restricted functions, system ports, protocols, software, and/or services. | <ul><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-9(1): Assignment of Responsibility | Assign responsibility for developing the configuration management process to organizational personnel that are not directly involved in system development. | <ul><li>Default branch protected</li></ul> |
| CM-10: Software Usage Restrictions | Use software and associated documentation in accordance with contract agreements and copyright laws; track the use of software and associated documentation protected by quantity licenses to control copying and distribution; and control and document the use of peer-to-peer file sharing technology to ensure that this capability is not used for the unauthorized distribution, display, performance, or reproduction of copyrighted work. | <ul><li>License compliance running</li></ul> |
| CP-9(7): Dual Authorization | Enforce dual authorization for the deletion or destruction of organization-defined backup information. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| IA-2(10): Single Sign-on | Provide a single sign-on capability for organization-defined system accounts and services. | <ul><li>Auth SSO enabled</li></ul> |
| IA-2(12): Acceptance of PIV Credentials | Accept and electronically verify Personal Identity Verification (PIV) credentials. | <ul><li>Auth SSO enabled</li></ul> |
| IA-5(7): No Embedded Unencrypted Static Authenticators | Ensure that unencrypted static authenticators are not embedded in applications or other forms of static storage. | <ul><li>Secret detection running</li></ul> |
| IA-5(9): Federated Credential Management | Use organization-defined external organizations to federate credentials. | <ul><li>Auth SSO enabled</li></ul> |
| IA-8(1): Acceptance of PIV Credentials From Other Agencies | Accept and electronically verify Personal Identity Verification (PIV) credentials from other federal agencies. | <ul><li>Auth SSO enabled</li></ul> |
| IA-8(5): Acceptance of PIV-I Credentials | Accept and verify Personal Identity Verification-I (PIV-I) credentials. | <ul><li>Auth SSO enabled</li></ul> |
| RA-5: Vulnerability Monitoring and Scanning | Scan for vulnerabilities in the system and hosted applications; employ vulnerability scanning tools and techniques; analyze vulnerability scan reports and results; remediate legitimate vulnerabilities; and share vulnerability information. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| SA-11(1): Static Code Analysis | Require the developer of the system, system component, or system service to employ static code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>SAST running</li></ul> |
| SA-11(8): Dynamic Code Analysis | Require the developer of the system, system component, or system service to employ dynamic code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>DAST running</li><li>Fuzz testing running</li></ul> |
### NIST 800-171 compliance requirements
The following table lists the requirements supported by GitLab for NIST 800-171 Revision 3 CMMC and the controls for
the requirements.
You can use the
[`nist_800-171_r3_cmmc.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/nist_800-171_r3_cmmc.json?ref_type=heads)
to create a compliance framework for this standard.
| NIST 800-171 requirement | Description | Supported controls |
|:-----------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| 03.01.04 Separation of Duties | a) Identify the duties of individuals requiring separation. b) Define system access authorizations to support separation of duties. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| 03.04.04 Impact Analyses | a) Analyze changes to the system to determine potential security impacts prior to change implementation. b) Verify that the security requirements for the system continue to be satisfied after the system changes have been implemented. | <ul><li>Default branch protected</li></ul> |
| 03.04.05 Access Restrictions for Change | a) Define, document, approve, and enforce physical and logical access restrictions associated with changes to the system. | <ul><li>Default branch protected</li></ul> |
| 03.04.10 System Component Inventory | a) Develop and document an inventory of system components. b) Review and update the system component inventory (organization-defined frequency). c) Update the system component inventory as part of installations, removals, and system updates. | <ul><li>License compliance running</li></ul> |
| 03.05.07 Password Management | <!-- List intentionally starts at b) --> b) Verify that passwords are not found on the list of commonly used, expected, or compromised passwords when users create or update passwords. c) Transmit passwords only over cryptographically protected channels. d) Store passwords in a cryptographically protected form. | <ul><li>Secret detection running</li></ul> |
| 03.11.02 Vulnerability Monitoring and Scanning | a) Monitor and scan the system for vulnerabilities (organization-defined frequency) and when new vulnerabilities affecting the system are identified. <!-- List intentionally omits at b) --> c) Update system vulnerabilities to be scanned (organization-defined frequency) and when new vulnerabilities are identified and reported. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
### NIST CSF 2.0 compliance requirements
The following table lists the requirements supported by GitLab for NIST CSF and the controls for the requirements.
You can use the
[`nist_csf_2.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/nist_csf_2.json?ref_type=heads)
to create a compliance framework for this standard.
| NIST CSF 2.0 requirement | Description | Supported controls |
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| ID.RA-01 - Identity - Risk Assessment: The cybersecurity risk to the organization, assets, and individuals is understood by the organization. | Vulnerabilities in assets are identified, validated, and recorded. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ID.RA-07 - Identity - Risk Assessment: The cybersecurity risk to the organization, assets, and individuals is understood by the organization. | Changes and exceptions are managed, assessed for risk impact, recorded, and tracked. | <ul><li>Default branch protected</li></ul> |
| PR.AA-05 - Protect - Identity Management, Authentication, and Access Control - Access to physical and logical assets is limited to authorized users, services, and hardware and managed commensurate with the assessed risk of unauthorized access. | Access permissions, entitlements, and authorizations are defined in a policy, managed, enforced, and reviewed, and incorporate the principles of least privilege and separation of duties. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| PR.PS-06 - Protect - Platform Security - Management of hardware, software, and services aligned with risk strategy. | Secure software development practices are integrated, and their performance is monitored throughout the software development lifecycle. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
### NIST SP 800-218 compliance requirements
The following table lists the requirements supported by GitLab for NIST SP 800-218 and the controls for the requirements.
You can use the
[`nist_800-218_v1-1.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/nist_800-218_v1-1.json?ref_type=heads)
to create a compliance framework for this standard.
| NIST SP 800-218 requirement | Description | Supported controls |
|:----------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| PO.1.1 Define Security Requirements for Software Development | PO.1.1: Identify and document all security requirements for the organization's software development infrastructures and processes, and maintain the requirements over time. | <ul><li>Default branch protected</li></ul> |
| PW.4 Reuse Existing, Well-Secured Software When Feasible Instead of Duplicating Functionality | PW.4.1: Acquire and maintain well-secured software components (e.g., software libraries, modules, middleware, frameworks) from commercial, open-source, and other third-party developers for use by the organization's software. PW.4.4: Verify that acquired commercial, open-source, and all other third-party software components comply with the requirements, as defined by the organization, throughout their life cycles. | <ul><li>License compliance running</li><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| PW.5.1 Create Source Code by Adhering to Secure Coding Practices | PW.5.1: Follow all secure coding practices that are appropriate to the development languages and environment to meet the organization's requirements. | <ul><li>Code quality running</li></ul> |
| PW.7 Review and/or Analyze Human-Readable Code to Identify Vulnerabilities and Verify Compliance with Security Requirements | PW.7.1: Implement code review (manual inspection) and/or code analysis (tool-based scanning) according to organizational needs. Perform these reviews based on secure coding standards and track all discovered issues in the development workflow system. | <ul><li>SAST running</li><li>DAST running</li><li>Secret detection running</li></ul> |
| PW.8 Test Executable Code to Identify Vulnerabilities and Verify Compliance with Security Requirements | PW.8.2: Scope the testing, design the tests, perform the testing, and document the results, including recording and triaging all discovered issues and recommended remediations in the development team's workflow or issue tracking system. | <ul><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| RV.1 Identify and Confirm Vulnerabilities on an Ongoing Basis | RV.1.1: Gather information from software acquirers, users, and public sources on potential vulnerabilities in the software and third-party components that the software uses, and investigate all credible reports. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
## PCI DSS v4.0.1 compliance requirements
PCI DSS is the PCI Data Security Standard.
The following table lists the requirements supported by GitLab for PCI DSS v4.0.1 and the controls for the requirements.
You can use the
[`pci_dss_v4-0-1.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/pci_dss_v4-0-1.json?ref_type=heads)
to create a compliance framework for this standard.
| PCI DSS v4.0.1 requirement | Description | Supported controls |
|:------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 6.2 Bespoke and custom software are developed securely. | 6.2.3 Review bespoke and custom software prior to release to identify and correct coding vulnerabilities. Ensure code follows secure coding guidelines and addresses emerging vulnerabilities. Implement software engineering techniques to prevent common software attacks. | <ul><li>API security running</li><li>DAST running</li><li>Fuzz testing running</li><li>SAST running</li><li>Secret detection running</li></ul> |
| 6.5 Changes to all system components are managed securely. | 6.5.1 Implement changes to system components according to established procedures including: documenting reason and description, security impact analysis, approval by authorized parties, and testing for security impacts. Separate production and pre-production environments.<br/><br/>6.5.3 Pre-production environments are separated from production environments and the separation is enforced with access controls.<br/><br/>6.5.4 Roles and functions are separated between production and pre-production environments to provide accountability such that only reviewed and approved changes are deployed. | <ul><li>Code changes requires code owners</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>At least two approvals</li><li>Reset approvals on push</li><li>Default branch protected</li><li>Merge requests approval rules prevent editing</li></ul> |
| 7.2 Access to system components and data is appropriately defined and assigned. | 7.2.5 All application and system accounts and related access privileges are assigned and managed as follows: Based on the least privileges necessary for the operability of the system or application; access is limited to the systems, applications, or processes that specifically require their use. | <ul><li>CI/CD job token scope enabled</li><li>User-defined CI/CD variables restricted to maintainers</li><li>Project visibility not public</li><li>Restricted build access</li><li>Strict Permission for Repository</li></ul> |
| 7.3 Access to system components and data is managed via an access control system(s). | 7.3.1 An access control system(s) is in place that restricts access based on a user's need to know and covers all system components.<br/><br/>7.3.2 The access control system(s) is configured to enforce permissions assigned to individuals, applications, and systems based on job classification and function. | <ul><li>CI/CD job token scope enabled</li><li>User-defined CI/CD variables restricted to maintainers</li><li>Project visibility not public</li><li>Restricted build access</li><li>Strict Permission for Repository</li></ul> |
| 8.3 Strong authentication for users and administrators is established and managed. | 8.3.1 All user access to system components for users and administrators is authenticated via at least one of the following authentication factors: Something you know, such as a password or passphrase; something you have, such as a token device or smart card; Something you are, such as a biometric element. | <ul><li>Auth SSO enabled</li><li>Require MFA at organization level</li><li>Require MFA for contributors</li></ul> |
| 8.4 Multi-factor authentication (MFA) is implemented to secure access into the CDE. | 8.4.1 MFA is implemented for all non-console access into the CDE for personnel with administrative access.<br/><br/>8.4.2 MFA is implemented for all non-console access into the CDE. | <ul><li>Auth SSO enabled</li><li>Require MFA at organization level</li><li>Require MFA for contributors</li></ul> |
| 8.6 Use of application and system accounts and associated authentication factors is strictly managed. | 8.6.2 Passwords/passphrases for any application and system accounts that can be used for interactive login are not hard coded in scripts, configuration/property files, or bespoke and custom source code. | <ul><li>Secret detection running</li></ul> |
| 11.3 External and internal vulnerabilities are regularly identified, prioritized, and addressed. | 11.3.1 Perform internal vulnerability scans using authenticated scanning methods. Address high-risk/critical vulnerabilities promptly and manage other vulnerabilities based on risk assessment. Conduct scans after significant changes to systems.<br/><br/>11.3.2 Perform external vulnerability scans via qualified personnel. Address high-risk/critical vulnerabilities promptly and manage other vulnerabilities based on risk assessment. Conduct scans after significant changes to systems. | <ul><li>Container scanning running</li><li>Dependency scanning running</li><li>DAST running</li><li>Fuzz testing running</li><li>IaC scanning running</li></ul> |
## SOC 2 compliance requirements
SOC is the System and Organization Controls.
The following table lists the requirements supported by GitLab for SOC 2 and the controls for the requirements.
| SOC 2 requirement | Description | Supported controls |
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| CC3.2 - COSO Principle 7: The entity identifies risks to the achievement of its objectives across the entity and analyzes risks as a basis for determining how the risks should be managed. | POF 7: Identifies Vulnerability of System Components - The entity identifies the vulnerabilities of system components, including system processes, infrastructure, software, and other information assets. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| CC3.4 - COSO Principle 9: The entity identifies and assesses changes that could significantly impact the system of internal control. | POF 4: Assesses Changes in Systems and Technology - The risk identification process considers changes arising from changes in the entity's systems and changes in the technology environment. POF 6: Assesses Changes in Threats and Vulnerabilities - The risk identification process assesses changes in (1) internal and external threats to and vulnerabilities of the components of the entity's systems and (2) the likelihood and magnitude of the resultant risks to the achievement of the entity's objectives. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li><li>Default branch protected</li></ul> |
| CC5.1 - COSO Principle 10: The entity selects and develops control activities that contribute to the mitigation of risks to the achievement of objectives to acceptable levels. | POF 6: Addresses Segregation of Duties - Management segregates incompatible duties and, where such segregation is not practical, management selects and develops alternative control activities. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CC6.6 - The entity implements logical access security measures to protect against threats from sources outside its system boundaries. | POF 2: Protects Identification and Authentication Credentials - Identification and authentication credentials are protected during transmission outside its system boundaries. | <ul><li>Secret detection running</li></ul> |
| CC6.8 - The entity implements controls to prevent or detect and act upon the introduction of unauthorized or malicious software to meet the entity's objectives. | POF 2: Detects Unauthorized Changes to Software and Configuration Parameters - Processes are in place to detect changes to software and configuration parameters that may be indicative of unauthorized or malicious software. | <ul><li>Default branch protected</li></ul> |
| CC7.1 - To meet its objectives, the entity uses detection and monitoring procedures to identify (1) changes to configurations that result in the introduction of new vulnerabilities, and (2) susceptibilities to newly discovered vulnerabilities. | POF 5: Conducts Vulnerability Scans - The entity conducts infrastructure and software vulnerability scans designed to identify potential vulnerabilities or misconfigurations on a periodic basis and after significant changes are made to the environment. Action is taken to remediate identified deficiencies in a timely manner to support the achievement of the entity's objectives. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| CC7.2 - The entity monitors system components and the operation of those components for anomalies that are indicative of malicious acts, natural disasters, and errors affecting the entity's ability to meet its objectives; anomalies are analyzed to determine whether they represent security events. | POF 1: Implements Detection Policies, Procedures, and Tools - Detection policies, procedures, and tools are defined and implemented on infrastructure and software to identify potential intrusions, inappropriate access, and anomalies in the operation of or unusual activity on systems. Procedures may include (1) a defined governance process for security event detection and management; (2) use of intelligence sources to identify newly discovered threats and vulnerabilities; and (3) logging of unusual system activities. | <ul><li>Secret detection running</li></ul> |
| CC8.1 - The entity authorizes, designs, develops or acquires, configures, documents, tests, approves, and implements changes to infrastructure, data, software, and procedures to meet its objectives. | POF 2: Authorizes Changes - A process is in place to authorize system and architecture changes prior to design, development, or acquisition and configuration. POF 7: Tests System Changes - A process is in place to test internally developed and acquired system changes prior to implementation into the production environment. Examples of testing may include unit, integration, regression, static and dynamic application source code, quality assurance, or automated testing (whether point in time or continuous). POF 8: Approves System Changes - A process is in place to approve system changes prior to implementation. POF 16: Protects Confidential Information - The entity protects confidential information during system design, development, testing, implementation, and change processes to support the achievement of the entity's objectives related to confidentiality. | <ul><li>SAST running</li><li>DAST running</li><li>Secret detection running</li><li>Default branch protected</li><li>At least two approvals</li></ul> |
## TISAX compliance requirements
TISAX is the Trusted Information Security Assessment Exchange.
The following table lists the requirements supported by GitLab for TISAX and the controls for the requirements.
| TISAX requirement | Description | Supported controls |
|:-------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| 1.2.2 To what extent are information security responsibilities organized? | A successful ISMS requires clear responsibilities in the organization. An appropriate organizational separation of responsibilities should be established to avoid conflict of interests (separation of duties). (C, I, A) | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| 1.3.4 To what extent is it ensured that only evaluated and approved software is used for processing the organization's information assets? | Information processing is mostly done using of specific software. Security issues in software can become a risk for the information processed. Accordingly, software must be appropriately managed. Software is approved before installation or use. The software repositories are protected against unauthorized manipulation. Approval of software is regularly reviewed. Software versions and patch levels are known. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>License compliance running</li> |
| 5.2.1 To what extent are changes managed? | The objective is to ensure that information security aspects are considered in case of any changes to the organization, business processes and IT systems (Change Management) to prevent these changes from causing an uncontrolled reduction in the information security level. Information security requirements for changes to the organization, business processes, and IT systems are determined and applied. A formal approval procedure is established. | <ul><li>Default branch protected</li></ul> |
| 5.2.5 To what extent are vulnerabilities identified and addressed? | Vulnerabilities increase the risk of IT systems being unable to meet the requirements for confidentiality, availability and integrity. Exploitation of vulnerabilities is among the possible ways for attackers to gain access to the IT system or to threaten its operating stability. Information on technical vulnerabilities for the IT systems in use is gathered (for example, information from the manufacturer, system audits, CVS database) and evaluated. For example, Common Vulnerability Scoring System (CVSS). Potentially affected IT systems and software are identified, assessed and any vulnerabilities are addressed. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| 5.3.1 To what extent is information security considered in new or further developed IT systems? | Information security is an integral part of the entire lifecycle of IT systems. This particularly includes consideration of information security requirements in the development or acquisition of IT systems. The information security requirements associated with the design and development of IT systems are determined and considered. The information security requirements associated with the acquisition or extension of IT systems and IT components are determined and considered. Information security requirements associated with changes to developed IT systems are considered. System approval tests are carried out under consideration of the information security requirements. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
| 7.1.1 To what extent is compliance with regulatory and contractual provisions ensured? | Non-compliance with legal, regulatory, or contractual provisions can create risks to the information security of customers and the own organization. Therefore, it is essential to ensure that these provisions are known and observed. Legal, regulatory, and contractual provisions of relevance to information security (see examples) are determined at regular intervals. | <ul><li>License compliance running</li></ul> |
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Compliance standards
breadcrumbs:
- doc
- user
- compliance
- compliance_frameworks
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/16620) in GitLab 17.11.
{{< /history >}}
You can use [GitLab compliance controls](_index.md#gitlab-compliance-controls) to help meet the requirements of many
compliance standards.
The [Compliance Adherence Templates](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates) project
contains a library of JSON templates. Use these templates to quickly adopt predefined compliance frameworks.
## FedRAMP compliance requirements
FedRAMP (Federal Risk and Authorization Management Program) categorizes cloud services into three impact levels:
Low, Moderate, and High, based on the potential impact of a data breach on government operations, assets, or individuals.
These levels correspond to different sets of security controls and requirements that cloud service providers (CSPs) must
meet to achieve FedRAMP authorization. Controls are available for FedRAMP Low, FedRAMP Moderate, and FedRAMP High compliance.
### FedRAMP Low compliance requirements
The following table lists the requirements supported by GitLab for FedRAMP Low and the controls for the requirements.
You can use the
[`fedramp_low_r5.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/fedramp_low_r5.json?ref_type=heads)
to create a compliance framework for this standard.
| FedRAMP Low requirement | Description | Supported controls |
|:-----------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| CM-5: Access Restrictions for Change | Define, document, approve, and enforce physical and logical access restrictions associated with changes to the system. | <ul><li>Default branch protected</li><li>At least two approvals</li></ul> |
| CM-6: Configuration Settings | Establish and document secure configuration settings for system components; implement these settings; identify, document, and approve deviations based on operational requirements; and monitor and control changes to configurations according to organizational policies. | <ul><li>Author approved merge request is forbidden</li></ul> |
| CM-7: Least Functionality | Configure the system to provide only organization-defined mission essential capabilities; and Prohibit or restrict the use of the following functions, ports, protocols, software, and/or services: organization-defined prohibited or restricted functions, system ports, protocols, software, and/or services. | <ul><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-10: Software Usage Restrictions | Use software and associated documentation in accordance with contract agreements and copyright laws; track the use of software and associated documentation protected by quantity licenses to control copying and distribution; and control and document the use of peer-to-peer file sharing technology to ensure that this capability is not used for the unauthorized distribution, display, performance, or reproduction of copyrighted work. | <ul><li>License compliance running</li></ul> |
| IA-2(12): Acceptance of PIV Credentials | Accept and electronically verify Personal Identity Verification (PIV) credentials. | <ul><li>Auth SSO enabled</li></ul> |
| IA-8(1): Acceptance of PIV Credentials From Other Agencies | Accept and electronically verify Personal Identity Verification (PIV) credentials from other federal agencies. | <ul><li>Auth SSO enabled</li></ul> |
| RA-5: Vulnerability Monitoring and Scanning | Scan for vulnerabilities in the system and hosted applications; employ vulnerability scanning tools and techniques; analyze vulnerability scan reports and results; remediate legitimate vulnerabilities; and share vulnerability information. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
### FedRAMP Moderate compliance requirements
The following table lists the requirements supported by GitLab for FedRAMP Moderate and the controls for the requirements.
You can use the
[`fedramp_moderate_r5.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/fedramp_moderate_r5.json?ref_type=heads)
to create a compliance framework for this standard.
| FedRAMP Moderate requirement | Description | Supported controls |
|:-----------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| AC-5: Separation of Duties | Separate duties of individuals to prevent malevolent activity without collusion; document separation of duties; and define system access authorizations to support separation of duties. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-3: Configuration Change Control | Determine types of configuration-controlled changes; review and approve changes with security/privacy impact analysis; document decisions; implement approved changes; retain records; monitor activities associated with changes; and coordinate change control oversight through designated elements. | <ul><li>Default branch protected</li><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-5: Access Restrictions for Change | Define, document, approve, and enforce physical and logical access restrictions associated with changes to the system. | <ul><li>Default branch protected</li><li>At least two approvals</li></ul> |
| CM-6: Configuration Settings | Establish and document secure configuration settings for system components; implement these settings; identify, document, and approve deviations based on operational requirements; and monitor and control changes to configurations according to organizational policies. | <ul><li>Author approved merge request is forbidden</li></ul> |
| CM-7: Least Functionality | Configure the system to provide only organization-defined mission essential capabilities; and Prohibit or restrict the use of the following functions, ports, protocols, software, and/or services: organization-defined prohibited or restricted functions, system ports, protocols, software, and/or services. | <ul><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-10: Software Usage Restrictions | Use software and associated documentation in accordance with contract agreements and copyright laws; track the use of software and associated documentation protected by quantity licenses to control copying and distribution; and control and document the use of peer-to-peer file sharing technology to ensure that this capability is not used for the unauthorized distribution, display, performance, or reproduction of copyrighted work. | <ul><li>License compliance running</li></ul> |
| IA-2(12): Acceptance of PIV Credentials | Accept and electronically verify Personal Identity Verification (PIV) credentials. | <ul><li>Auth SSO enabled</li></ul> |
| IA-5(7): No Embedded Unencrypted Static Authenticators | Ensure that unencrypted static authenticators are not embedded in applications or other forms of static storage. | <ul><li>Secret detection running</li></ul> |
| IA-8(1): Acceptance of PIV Credentials From Other Agencies | Accept and electronically verify Personal Identity Verification (PIV) credentials from other federal agencies. | <ul><li>Auth SSO enabled</li></ul> |
| RA-5: Vulnerability Monitoring and Scanning | Scan for vulnerabilities in the system and hosted applications; employ vulnerability scanning tools and techniques; analyze vulnerability scan reports and results; remediate legitimate vulnerabilities; and share vulnerability information. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| SA-11(1): Static Code Analysis | Require the developer of the system, system component, or system service to employ static code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>SAST running</li></ul> |
| SA-11(8): Dynamic Code Analysis | Require the developer of the system, system component, or system service to employ dynamic code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>DAST running</li><li>Fuzz testing running</li></ul> |
### FedRAMP High compliance requirements
The following table lists the requirements supported by GitLab for FedRAMP High and the controls for the requirements.
You can use the
[`fedramp_high_r5.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/fedramp_high_r5.json?ref_type=heads)
to create a compliance framework for this standard.
| FedRAMP High requirement | Description | Supported controls |
|:---------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| AC-5: Separation of Duties | Separate duties of individuals to prevent malevolent activity without collusion; document separation of duties; and define system access authorizations to support separation of duties. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-3: Configuration Change Control | Determine types of configuration-controlled changes; review and approve changes with security/privacy impact analysis; document decisions; implement approved changes; retain records; monitor activities associated with changes; and coordinate change control oversight through designated elements. | <ul><li>Default branch protected</li><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-3(1): Automated Documentation, Notification, and Prohibition of Changes | Use automated mechanisms to document proposed changes to the system; notify organization-defined approval authorities; highlight change approvals that have not been received by organization-defined time period; prohibit changes to the system until designated approvals are received; and document all changes to the system. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-5: Access Restrictions for Change | Define, document, approve, and enforce physical and logical access restrictions associated with changes to the system. | <ul><li>Default branch protected</li><li>At least two approvals</li></ul> |
| CM-6: Configuration Settings | Establish and document secure configuration settings for system components; implement these settings; identify, document, and approve deviations based on operational requirements; and monitor and control changes to configurations according to organizational policies. | <ul><li>Author approved merge request is forbidden</li></ul> |
| CM-7: Least Functionality | Configure the system to provide only organization-defined mission essential capabilities; and Prohibit or restrict the use of the following functions, ports, protocols, software, and/or services: organization-defined prohibited or restricted functions, system ports, protocols, software, and/or services. | <ul><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-10: Software Usage Restrictions | Use software and associated documentation in accordance with contract agreements and copyright laws; track the use of software and associated documentation protected by quantity licenses to control copying and distribution; and control and document the use of peer-to-peer file sharing technology to ensure that this capability is not used for the unauthorized distribution, display, performance, or reproduction of copyrighted work. | <ul><li>License compliance running</li></ul> |
| IA-2(12): Acceptance of PIV Credentials | Accept and electronically verify Personal Identity Verification (PIV) credentials. | <ul><li>Auth SSO enabled</li></ul> |
| IA-5(7): No Embedded Unencrypted Static Authenticators | Ensure that unencrypted static authenticators are not embedded in applications or other forms of static storage. | <ul><li>Secret detection running</li></ul> |
| IA-8(1): Acceptance of PIV Credentials From Other Agencies | Accept and electronically verify Personal Identity Verification (PIV) credentials from other federal agencies. | <ul><li>Auth SSO enabled</li></ul> |
| RA-5: Vulnerability Monitoring and Scanning | Scan for vulnerabilities in the system and hosted applications; employ vulnerability scanning tools and techniques; analyze vulnerability scan reports and results; remediate legitimate vulnerabilities; and share vulnerability information. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| SA-11(1): Static Code Analysis | Require the developer of the system, system component, or system service to employ static code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>SAST running</li></ul> |
| SA-11(8): Dynamic Code Analysis | Require the developer of the system, system component, or system service to employ dynamic code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>DAST running</li><li>Fuzz testing running</li></ul> |
## IRAP compliance requirements
IRAP is the Infosec Registered Assessors Program. Controls are available for IRAP Official, IRAP Protected, IRAP Secret,
and IRAP Top Secret.
### IRAP Official
The following table lists the requirements supported by GitLab for IRAP Official and the controls for the requirements.
You can use the
[`irap_official.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/irap_official.json?ref_type=heads)
to create a compliance framework for this standard.
| IRAP Official requirement | Description | Supported controls |
|:----------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| ISM-0402 Application security testing | Applications are comprehensively tested for vulnerabilities, using static application security testing and dynamic application security testing, prior to their initial release and any subsequent releases. | <ul><li>SAST running</li><li>DAST running</li></ul> |
| ISM-1163 Continuous monitoring plan | Systems have a continuous monitoring plan that includes: conducting vulnerability scans for systems at least fortnightly, conducting vulnerability assessments and penetration tests for systems prior to deployment, including prior to deployment of significant changes, and at least annually thereafter, analysing identified vulnerabilities to determine their potential impact, and implementing mitigations based on risk, effectiveness and cost. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| ISM-1422 Development, testing and production environments | Unauthorised access to the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1698 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in online services. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1700 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in applications other than office productivity suites, web browsers and their extensions, email clients, PDF software, and security products. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1701 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in operating systems of internet-facing servers and internet-facing network devices. | <ul><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1702 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in operating systems of workstations, non-internet-facing servers and non-internet-facing network devices. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1808 Scanning for unmitigated vulnerabilities | A vulnerability scanner with an up-to-date vulnerability database is used for vulnerability scanning activities. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1816 Development, testing and production environments | Unauthorised modification of the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1875 Protecting credentials | Networks are scanned at least monthly to identify any credentials that are being stored in the clear. | <ul><li>Secret detection running</li></ul> |
### IRAP Protected
The following table lists the requirements supported by GitLab for IRAP Protected and the controls for the requirements.
You can use the
[`irap_protected.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/irap_protected.json?ref_type=heads)
to create a compliance framework for this standard.
| IRAP Protected requirement | Description | Supported controls |
|:----------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| ISM-0402 Application security testing | Applications are comprehensively tested for vulnerabilities, using static application security testing and dynamic application security testing, prior to their initial release and any subsequent releases. | <ul><li>SAST running</li><li>DAST running</li></ul> |
| ISM-1163 Continuous monitoring plan | Systems have a continuous monitoring plan that includes: conducting vulnerability scans for systems at least fortnightly, conducting vulnerability assessments and penetration tests for systems prior to deployment, including prior to deployment of significant changes, and at least annually thereafter, analysing identified vulnerabilities to determine their potential impact, and implementing mitigations based on risk, effectiveness and cost. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| ISM-1422 Development, testing and production environments | Unauthorised access to the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1698 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in online services. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1700 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in applications other than office productivity suites, web browsers and their extensions, email clients, PDF software, and security products. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1701 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in operating systems of internet-facing servers and internet-facing network devices. | <ul><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1702 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in operating systems of workstations, non-internet-facing servers and non-internet-facing network devices. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1808 Scanning for unmitigated vulnerabilities | A vulnerability scanner with an up-to-date vulnerability database is used for vulnerability scanning activities. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1816 Development, testing and production environments | Unauthorised modification of the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1875 Protecting credentials | Networks are scanned at least monthly to identify any credentials that are being stored in the clear. | <ul><li>Secret detection running</li></ul> |
### IRAP Secret
The following table lists the requirements supported by GitLab for IRAP Secret and the controls for the requirements.
You can use the
[`irap_secret.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/irap_secret.json?ref_type=heads)
to create a compliance framework for this standard.
| IRAP Secret requirement | Description | Supported controls |
|:----------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| ISM-0402 Application security testing | Applications are comprehensively tested for vulnerabilities, using static application security testing and dynamic application security testing, prior to their initial release and any subsequent releases. | <ul><li>SAST running</li><li>DAST running</li></ul> |
| ISM-1163 Continuous monitoring plan | Systems have a continuous monitoring plan that includes: conducting vulnerability scans for systems at least fortnightly, conducting vulnerability assessments and penetration tests for systems prior to deployment, including prior to deployment of significant changes, and at least annually thereafter, analysing identified vulnerabilities to determine their potential impact, and implementing mitigations based on risk, effectiveness and cost. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| ISM-1422 Development, testing and production environments | Unauthorised access to the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1698 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in online services. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1700 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in applications other than office productivity suites, web browsers and their extensions, email clients, PDF software, and security products. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1701 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in operating systems of internet-facing servers and internet-facing network devices. | <ul><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1702 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in operating systems of workstations, non-internet-facing servers and non-internet-facing network devices. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1808 Scanning for unmitigated vulnerabilities | A vulnerability scanner with an up-to-date vulnerability database is used for vulnerability scanning activities. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1816 Development, testing and production environments | Unauthorised modification of the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1875 Protecting credentials | Networks are scanned at least monthly to identify any credentials that are being stored in the clear. | <ul><li>Secret detection running</li></ul> |
### IRAP Top Secret
The following table lists the requirements supported by GitLab for IRAP Top Secret and the controls for the requirements.
You can use the
[`irap_top_secret.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/irap_top_secret.json?ref_type=heads)
to create a compliance framework for this standard.
| IRAP Top Secret requirement | Description | Supported controls |
|:----------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| ISM-0402 Application security testing | Applications are comprehensively tested for vulnerabilities, using static application security testing and dynamic application security testing, prior to their initial release and any subsequent releases. | <ul><li>SAST running</li><li>DAST running</li></ul> |
| ISM-1163 Continuous monitoring plan | Systems have a continuous monitoring plan that includes: conducting vulnerability scans for systems at least fortnightly, conducting vulnerability assessments and penetration tests for systems prior to deployment, including prior to deployment of significant changes, and at least annually thereafter, analysing identified vulnerabilities to determine their potential impact, and implementing mitigations based on risk, effectiveness and cost. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| ISM-1422 Development, testing and production environments | Unauthorised access to the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1698 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in online services. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1700 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in applications other than office productivity suites, web browsers and their extensions, email clients, PDF software, and security products. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1701 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least daily to identify missing patches or updates for vulnerabilities in operating systems of internet-facing servers and internet-facing network devices. | <ul><li>Container scanning running</li><li>DAST running</li><li>API security running</li></ul> |
| ISM-1702 Scanning for unmitigated vulnerabilities | A vulnerability scanner is used at least fortnightly to identify missing patches or updates for vulnerabilities in operating systems of workstations, non-internet-facing servers and non-internet-facing network devices. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1808 Scanning for unmitigated vulnerabilities | A vulnerability scanner with an up-to-date vulnerability database is used for vulnerability scanning activities. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ISM-1816 Development, testing and production environments | Unauthorised modification of the authoritative source for software is prevented. | <ul><li>Default branch protected</li></ul> |
| ISM-1875 Protecting credentials | Networks are scanned at least monthly to identify any credentials that are being stored in the clear. | <ul><li>Secret detection running</li></ul> |
## ISMAP compliance requirements
The Information system Security Management and Assessment Program (ISMAP) aims to secure the security level of the government's cloud service procurement
by evaluating and registering cloud services that meet the security requirements of the government in advance, thereby contributing to the smooth introduction
of cloud services.
The following table lists the requirements supported by GitLab for ISMAP and the controls for the requirements.
You can use the
[`ismap.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/ismap.json?ref_type=heads)
to create a compliance framework for this standard.
| ISMAP requirement | Description | Supported controls |
|:-----------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| 6.1.2 Segregation of duties | Conflicting duties and areas of responsibility should be segregated to reduce opportunities for unauthorized or unintentional modification or misuse of the organization's assets. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| 9.3.1 Use of secret authentication information | Users should be required to follow the organization's practices in the use of secret authentication information. | <ul><li>Secret detection running</li></ul> |
| 9.4.5 Access control to program source code | Access to program source code should be restricted. | <ul><li>Default branch protected</li></ul> |
| 12.1.2 Change management | Changes to the organization, business processes, information processing facilities and systems that affect information security should be controlled. | <ul><li>Default branch protected</li></ul> |
| 12.6.1 Management of technical vulnerabilities | Information about technical vulnerabilities of information systems being used should be obtained in a timely fashion, the organization's exposure to such vulnerabilities evaluated and appropriate measures taken to address the associated risk. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| 14.2.1 Secure development policy | Rules for the development of software and systems should be established and applied to developments within the organization. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
| 14.2.8 System security testing | Testing of security functionality should be carried out during development. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
| 18.1.2 Intellectual property rights | Appropriate procedures should be implemented to ensure compliance with legislative, regulatory and contractual requirements related to intellectual property rights and use of proprietary software products. | <ul><li>License compliance running</li></ul> |
## ISO 27001 compliance requirements
ISO 27001 is an internationally recognized standard that provides a framework for implementing and managing an
Information Security Management System (ISMS).
The following table lists the requirements supported by GitLab for ISO 27001 and the controls for the requirements.
You can use the
[`iso_27001:2022.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/iso_27001:2022.json?ref_type=heads)
to create a compliance framework for this standard.
| ISO 27001 requirement | Description | Supported controls |
|:----------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| 5.3 Segregation of duties | Conflicting duties and conflicting areas of responsibility shall be segregated. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| 5.17 Authentication information | Allocation and management of authentication information should be controlled by a management process, including advising personnel on the appropriate handling of authentication information. | <ul><li>Secret detection running</li></ul> |
| 5.18 Access rights | Access rights to information and other associated assets should be provisioned, reviewed, modified and removed in accordance with the organization's topic-specific policy on and rules for access control. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| 5.32 Intellectual property rights | The organization should implement appropriate procedures to protect intellectual property rights. | <ul><li>License compliance running</li></ul> |
| 8.4 Access to source code | Read and write access to source code, development tools and software libraries shall be appropriately managed. | <ul><li>Default branch protected</li></ul> |
| 8.8 Management of technical vulnerabilities | Information about technical vulnerabilities of information systems in use shall be obtained, the organization's exposure to such vulnerabilities shall be evaluated and appropriate measures shall be taken. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| 8.28 Secure coding | Secure coding principles shall be applied to software development. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
| 8.29 Security testing in development and acceptance | Security testing processes shall be defined and implemented in the development lifecycle. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
| 8.32 Change management | Changes to information processing facilities and information systems shall be subject to change management procedures. | <ul><li>Default branch protected</li></ul> |
## NIST compliance requirements
The National Institute of Standards and Technology (NIST) Information Technology Laboratory (ITL) provides standards,
measurements, and testing for information systems, focusing on interoperability, security, usability, and reliability.
These compliance standards involves implementing security and privacy controls across various areas, including:
- Risk management
- Identification and authentication
- Incident response
- System and communications protection
Controls are available for NIST 800-53, NIST 800-171, NIST SP 800-218, and NIST CSF 2.0 compliance standards.
### NIST 800-53 compliance requirements
The following table lists the requirements supported by GitLab for NIST 800-53 Revision 5 and the controls for the
requirements.
You can use the
[`nist_800-53_r5` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/nist_800-53_r5.json?ref_type=heads)
to create a compliance framework for this standard.
| NIST 800-53 requirement | Description | Supported controls |
|:---------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| AC-3(2): Dual Authorization | Enforce dual authorization for organization-defined privileged commands and/or other organization-defined actions. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| AC-5: Separation of Duties | Separate duties of individuals to prevent malevolent activity without collusion; document separation of duties; and define system access authorizations to support separation of duties. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| AU-9(5): Dual Authorization | Enforce dual authorization for the deletion or modification of organization-defined audit information. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-3: Configuration Change Control | Determine types of configuration-controlled changes; review and approve changes with security/privacy impact analysis; document decisions; implement approved changes; retain records; monitor activities associated with changes; and coordinate change control oversight through designated elements. | <ul><li>Default branch protected</li><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-3(1): Automated Documentation, Notification, and Prohibition of Changes | Use automated mechanisms to document proposed changes to the system; notify organization-defined approval authorities; highlight change approvals that have not been received by organization-defined time period; prohibit changes to the system until designated approvals are received; and document all changes to the system. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-5: Access Restrictions for Change | Define, document, approve, and enforce physical and logical access restrictions associated with changes to the system. | <ul><li>Default branch protected</li><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-5(4): Dual Authorization | Enforce dual authorization for implementing changes to organization-defined system components and system-level information. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-6: Configuration Settings | Establish and document secure configuration settings for system components; implement these settings; identify, document, and approve deviations based on operational requirements; and monitor and control changes to configurations according to organizational policies. | <ul><li>Author approved merge request is forbidden</li></ul> |
| CM-7: Least Functionality | Configure the system to provide only organization-defined mission essential capabilities; and Prohibit or restrict the use of the following functions, ports, protocols, software, and/or services: organization-defined prohibited or restricted functions, system ports, protocols, software, and/or services. | <ul><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CM-9(1): Assignment of Responsibility | Assign responsibility for developing the configuration management process to organizational personnel that are not directly involved in system development. | <ul><li>Default branch protected</li></ul> |
| CM-10: Software Usage Restrictions | Use software and associated documentation in accordance with contract agreements and copyright laws; track the use of software and associated documentation protected by quantity licenses to control copying and distribution; and control and document the use of peer-to-peer file sharing technology to ensure that this capability is not used for the unauthorized distribution, display, performance, or reproduction of copyrighted work. | <ul><li>License compliance running</li></ul> |
| CP-9(7): Dual Authorization | Enforce dual authorization for the deletion or destruction of organization-defined backup information. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| IA-2(10): Single Sign-on | Provide a single sign-on capability for organization-defined system accounts and services. | <ul><li>Auth SSO enabled</li></ul> |
| IA-2(12): Acceptance of PIV Credentials | Accept and electronically verify Personal Identity Verification (PIV) credentials. | <ul><li>Auth SSO enabled</li></ul> |
| IA-5(7): No Embedded Unencrypted Static Authenticators | Ensure that unencrypted static authenticators are not embedded in applications or other forms of static storage. | <ul><li>Secret detection running</li></ul> |
| IA-5(9): Federated Credential Management | Use organization-defined external organizations to federate credentials. | <ul><li>Auth SSO enabled</li></ul> |
| IA-8(1): Acceptance of PIV Credentials From Other Agencies | Accept and electronically verify Personal Identity Verification (PIV) credentials from other federal agencies. | <ul><li>Auth SSO enabled</li></ul> |
| IA-8(5): Acceptance of PIV-I Credentials | Accept and verify Personal Identity Verification-I (PIV-I) credentials. | <ul><li>Auth SSO enabled</li></ul> |
| RA-5: Vulnerability Monitoring and Scanning | Scan for vulnerabilities in the system and hosted applications; employ vulnerability scanning tools and techniques; analyze vulnerability scan reports and results; remediate legitimate vulnerabilities; and share vulnerability information. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| SA-11(1): Static Code Analysis | Require the developer of the system, system component, or system service to employ static code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>SAST running</li></ul> |
| SA-11(8): Dynamic Code Analysis | Require the developer of the system, system component, or system service to employ dynamic code analysis tools to identify common flaws and document the results of the analysis. | <ul><li>DAST running</li><li>Fuzz testing running</li></ul> |
### NIST 800-171 compliance requirements
The following table lists the requirements supported by GitLab for NIST 800-171 Revision 3 CMMC and the controls for
the requirements.
You can use the
[`nist_800-171_r3_cmmc.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/nist_800-171_r3_cmmc.json?ref_type=heads)
to create a compliance framework for this standard.
| NIST 800-171 requirement | Description | Supported controls |
|:-----------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| 03.01.04 Separation of Duties | a) Identify the duties of individuals requiring separation. b) Define system access authorizations to support separation of duties. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| 03.04.04 Impact Analyses | a) Analyze changes to the system to determine potential security impacts prior to change implementation. b) Verify that the security requirements for the system continue to be satisfied after the system changes have been implemented. | <ul><li>Default branch protected</li></ul> |
| 03.04.05 Access Restrictions for Change | a) Define, document, approve, and enforce physical and logical access restrictions associated with changes to the system. | <ul><li>Default branch protected</li></ul> |
| 03.04.10 System Component Inventory | a) Develop and document an inventory of system components. b) Review and update the system component inventory (organization-defined frequency). c) Update the system component inventory as part of installations, removals, and system updates. | <ul><li>License compliance running</li></ul> |
| 03.05.07 Password Management | <!-- List intentionally starts at b) --> b) Verify that passwords are not found on the list of commonly used, expected, or compromised passwords when users create or update passwords. c) Transmit passwords only over cryptographically protected channels. d) Store passwords in a cryptographically protected form. | <ul><li>Secret detection running</li></ul> |
| 03.11.02 Vulnerability Monitoring and Scanning | a) Monitor and scan the system for vulnerabilities (organization-defined frequency) and when new vulnerabilities affecting the system are identified. <!-- List intentionally omits at b) --> c) Update system vulnerabilities to be scanned (organization-defined frequency) and when new vulnerabilities are identified and reported. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
### NIST CSF 2.0 compliance requirements
The following table lists the requirements supported by GitLab for NIST CSF and the controls for the requirements.
You can use the
[`nist_csf_2.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/nist_csf_2.json?ref_type=heads)
to create a compliance framework for this standard.
| NIST CSF 2.0 requirement | Description | Supported controls |
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| ID.RA-01 - Identity - Risk Assessment: The cybersecurity risk to the organization, assets, and individuals is understood by the organization. | Vulnerabilities in assets are identified, validated, and recorded. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| ID.RA-07 - Identity - Risk Assessment: The cybersecurity risk to the organization, assets, and individuals is understood by the organization. | Changes and exceptions are managed, assessed for risk impact, recorded, and tracked. | <ul><li>Default branch protected</li></ul> |
| PR.AA-05 - Protect - Identity Management, Authentication, and Access Control - Access to physical and logical assets is limited to authorized users, services, and hardware and managed commensurate with the assessed risk of unauthorized access. | Access permissions, entitlements, and authorizations are defined in a policy, managed, enforced, and reviewed, and incorporate the principles of least privilege and separation of duties. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| PR.PS-06 - Protect - Platform Security - Management of hardware, software, and services aligned with risk strategy. | Secure software development practices are integrated, and their performance is monitored throughout the software development lifecycle. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
### NIST SP 800-218 compliance requirements
The following table lists the requirements supported by GitLab for NIST SP 800-218 and the controls for the requirements.
You can use the
[`nist_800-218_v1-1.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/nist_800-218_v1-1.json?ref_type=heads)
to create a compliance framework for this standard.
| NIST SP 800-218 requirement | Description | Supported controls |
|:----------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| PO.1.1 Define Security Requirements for Software Development | PO.1.1: Identify and document all security requirements for the organization's software development infrastructures and processes, and maintain the requirements over time. | <ul><li>Default branch protected</li></ul> |
| PW.4 Reuse Existing, Well-Secured Software When Feasible Instead of Duplicating Functionality | PW.4.1: Acquire and maintain well-secured software components (e.g., software libraries, modules, middleware, frameworks) from commercial, open-source, and other third-party developers for use by the organization's software. PW.4.4: Verify that acquired commercial, open-source, and all other third-party software components comply with the requirements, as defined by the organization, throughout their life cycles. | <ul><li>License compliance running</li><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| PW.5.1 Create Source Code by Adhering to Secure Coding Practices | PW.5.1: Follow all secure coding practices that are appropriate to the development languages and environment to meet the organization's requirements. | <ul><li>Code quality running</li></ul> |
| PW.7 Review and/or Analyze Human-Readable Code to Identify Vulnerabilities and Verify Compliance with Security Requirements | PW.7.1: Implement code review (manual inspection) and/or code analysis (tool-based scanning) according to organizational needs. Perform these reviews based on secure coding standards and track all discovered issues in the development workflow system. | <ul><li>SAST running</li><li>DAST running</li><li>Secret detection running</li></ul> |
| PW.8 Test Executable Code to Identify Vulnerabilities and Verify Compliance with Security Requirements | PW.8.2: Scope the testing, design the tests, perform the testing, and document the results, including recording and triaging all discovered issues and recommended remediations in the development team's workflow or issue tracking system. | <ul><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| RV.1 Identify and Confirm Vulnerabilities on an Ongoing Basis | RV.1.1: Gather information from software acquirers, users, and public sources on potential vulnerabilities in the software and third-party components that the software uses, and investigate all credible reports. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
## PCI DSS v4.0.1 compliance requirements
PCI DSS is the PCI Data Security Standard.
The following table lists the requirements supported by GitLab for PCI DSS v4.0.1 and the controls for the requirements.
You can use the
[`pci_dss_v4-0-1.json` template](https://gitlab.com/gitlab-org/software-supply-chain-security/compliance/engineering/compliance-adherence-templates/-/blob/main/pci_dss_v4-0-1.json?ref_type=heads)
to create a compliance framework for this standard.
| PCI DSS v4.0.1 requirement | Description | Supported controls |
|:------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 6.2 Bespoke and custom software are developed securely. | 6.2.3 Review bespoke and custom software prior to release to identify and correct coding vulnerabilities. Ensure code follows secure coding guidelines and addresses emerging vulnerabilities. Implement software engineering techniques to prevent common software attacks. | <ul><li>API security running</li><li>DAST running</li><li>Fuzz testing running</li><li>SAST running</li><li>Secret detection running</li></ul> |
| 6.5 Changes to all system components are managed securely. | 6.5.1 Implement changes to system components according to established procedures including: documenting reason and description, security impact analysis, approval by authorized parties, and testing for security impacts. Separate production and pre-production environments.<br/><br/>6.5.3 Pre-production environments are separated from production environments and the separation is enforced with access controls.<br/><br/>6.5.4 Roles and functions are separated between production and pre-production environments to provide accountability such that only reviewed and approved changes are deployed. | <ul><li>Code changes requires code owners</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>At least two approvals</li><li>Reset approvals on push</li><li>Default branch protected</li><li>Merge requests approval rules prevent editing</li></ul> |
| 7.2 Access to system components and data is appropriately defined and assigned. | 7.2.5 All application and system accounts and related access privileges are assigned and managed as follows: Based on the least privileges necessary for the operability of the system or application; access is limited to the systems, applications, or processes that specifically require their use. | <ul><li>CI/CD job token scope enabled</li><li>User-defined CI/CD variables restricted to maintainers</li><li>Project visibility not public</li><li>Restricted build access</li><li>Strict Permission for Repository</li></ul> |
| 7.3 Access to system components and data is managed via an access control system(s). | 7.3.1 An access control system(s) is in place that restricts access based on a user's need to know and covers all system components.<br/><br/>7.3.2 The access control system(s) is configured to enforce permissions assigned to individuals, applications, and systems based on job classification and function. | <ul><li>CI/CD job token scope enabled</li><li>User-defined CI/CD variables restricted to maintainers</li><li>Project visibility not public</li><li>Restricted build access</li><li>Strict Permission for Repository</li></ul> |
| 8.3 Strong authentication for users and administrators is established and managed. | 8.3.1 All user access to system components for users and administrators is authenticated via at least one of the following authentication factors: Something you know, such as a password or passphrase; something you have, such as a token device or smart card; Something you are, such as a biometric element. | <ul><li>Auth SSO enabled</li><li>Require MFA at organization level</li><li>Require MFA for contributors</li></ul> |
| 8.4 Multi-factor authentication (MFA) is implemented to secure access into the CDE. | 8.4.1 MFA is implemented for all non-console access into the CDE for personnel with administrative access.<br/><br/>8.4.2 MFA is implemented for all non-console access into the CDE. | <ul><li>Auth SSO enabled</li><li>Require MFA at organization level</li><li>Require MFA for contributors</li></ul> |
| 8.6 Use of application and system accounts and associated authentication factors is strictly managed. | 8.6.2 Passwords/passphrases for any application and system accounts that can be used for interactive login are not hard coded in scripts, configuration/property files, or bespoke and custom source code. | <ul><li>Secret detection running</li></ul> |
| 11.3 External and internal vulnerabilities are regularly identified, prioritized, and addressed. | 11.3.1 Perform internal vulnerability scans using authenticated scanning methods. Address high-risk/critical vulnerabilities promptly and manage other vulnerabilities based on risk assessment. Conduct scans after significant changes to systems.<br/><br/>11.3.2 Perform external vulnerability scans via qualified personnel. Address high-risk/critical vulnerabilities promptly and manage other vulnerabilities based on risk assessment. Conduct scans after significant changes to systems. | <ul><li>Container scanning running</li><li>Dependency scanning running</li><li>DAST running</li><li>Fuzz testing running</li><li>IaC scanning running</li></ul> |
## SOC 2 compliance requirements
SOC is the System and Organization Controls.
The following table lists the requirements supported by GitLab for SOC 2 and the controls for the requirements.
| SOC 2 requirement | Description | Supported controls |
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| CC3.2 - COSO Principle 7: The entity identifies risks to the achievement of its objectives across the entity and analyzes risks as a basis for determining how the risks should be managed. | POF 7: Identifies Vulnerability of System Components - The entity identifies the vulnerabilities of system components, including system processes, infrastructure, software, and other information assets. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| CC3.4 - COSO Principle 9: The entity identifies and assesses changes that could significantly impact the system of internal control. | POF 4: Assesses Changes in Systems and Technology - The risk identification process considers changes arising from changes in the entity's systems and changes in the technology environment. POF 6: Assesses Changes in Threats and Vulnerabilities - The risk identification process assesses changes in (1) internal and external threats to and vulnerabilities of the components of the entity's systems and (2) the likelihood and magnitude of the resultant risks to the achievement of the entity's objectives. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li><li>Default branch protected</li></ul> |
| CC5.1 - COSO Principle 10: The entity selects and develops control activities that contribute to the mitigation of risks to the achievement of objectives to acceptable levels. | POF 6: Addresses Segregation of Duties - Management segregates incompatible duties and, where such segregation is not practical, management selects and develops alternative control activities. | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| CC6.6 - The entity implements logical access security measures to protect against threats from sources outside its system boundaries. | POF 2: Protects Identification and Authentication Credentials - Identification and authentication credentials are protected during transmission outside its system boundaries. | <ul><li>Secret detection running</li></ul> |
| CC6.8 - The entity implements controls to prevent or detect and act upon the introduction of unauthorized or malicious software to meet the entity's objectives. | POF 2: Detects Unauthorized Changes to Software and Configuration Parameters - Processes are in place to detect changes to software and configuration parameters that may be indicative of unauthorized or malicious software. | <ul><li>Default branch protected</li></ul> |
| CC7.1 - To meet its objectives, the entity uses detection and monitoring procedures to identify (1) changes to configurations that result in the introduction of new vulnerabilities, and (2) susceptibilities to newly discovered vulnerabilities. | POF 5: Conducts Vulnerability Scans - The entity conducts infrastructure and software vulnerability scans designed to identify potential vulnerabilities or misconfigurations on a periodic basis and after significant changes are made to the environment. Action is taken to remediate identified deficiencies in a timely manner to support the achievement of the entity's objectives. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Fuzz testing running</li></ul> |
| CC7.2 - The entity monitors system components and the operation of those components for anomalies that are indicative of malicious acts, natural disasters, and errors affecting the entity's ability to meet its objectives; anomalies are analyzed to determine whether they represent security events. | POF 1: Implements Detection Policies, Procedures, and Tools - Detection policies, procedures, and tools are defined and implemented on infrastructure and software to identify potential intrusions, inappropriate access, and anomalies in the operation of or unusual activity on systems. Procedures may include (1) a defined governance process for security event detection and management; (2) use of intelligence sources to identify newly discovered threats and vulnerabilities; and (3) logging of unusual system activities. | <ul><li>Secret detection running</li></ul> |
| CC8.1 - The entity authorizes, designs, develops or acquires, configures, documents, tests, approves, and implements changes to infrastructure, data, software, and procedures to meet its objectives. | POF 2: Authorizes Changes - A process is in place to authorize system and architecture changes prior to design, development, or acquisition and configuration. POF 7: Tests System Changes - A process is in place to test internally developed and acquired system changes prior to implementation into the production environment. Examples of testing may include unit, integration, regression, static and dynamic application source code, quality assurance, or automated testing (whether point in time or continuous). POF 8: Approves System Changes - A process is in place to approve system changes prior to implementation. POF 16: Protects Confidential Information - The entity protects confidential information during system design, development, testing, implementation, and change processes to support the achievement of the entity's objectives related to confidentiality. | <ul><li>SAST running</li><li>DAST running</li><li>Secret detection running</li><li>Default branch protected</li><li>At least two approvals</li></ul> |
## TISAX compliance requirements
TISAX is the Trusted Information Security Assessment Exchange.
The following table lists the requirements supported by GitLab for TISAX and the controls for the requirements.
| TISAX requirement | Description | Supported controls |
|:-------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|
| 1.2.2 To what extent are information security responsibilities organized? | A successful ISMS requires clear responsibilities in the organization. An appropriate organizational separation of responsibilities should be established to avoid conflict of interests (separation of duties). (C, I, A) | <ul><li>At least two approvals</li><li>Author approved merge request is forbidden</li><li>Committers approved merge request is forbidden</li><li>Merge requests approval rules prevent editing</li></ul> |
| 1.3.4 To what extent is it ensured that only evaluated and approved software is used for processing the organization's information assets? | Information processing is mostly done using of specific software. Security issues in software can become a risk for the information processed. Accordingly, software must be appropriately managed. Software is approved before installation or use. The software repositories are protected against unauthorized manipulation. Approval of software is regularly reviewed. Software versions and patch levels are known. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>License compliance running</li> |
| 5.2.1 To what extent are changes managed? | The objective is to ensure that information security aspects are considered in case of any changes to the organization, business processes and IT systems (Change Management) to prevent these changes from causing an uncontrolled reduction in the information security level. Information security requirements for changes to the organization, business processes, and IT systems are determined and applied. A formal approval procedure is established. | <ul><li>Default branch protected</li></ul> |
| 5.2.5 To what extent are vulnerabilities identified and addressed? | Vulnerabilities increase the risk of IT systems being unable to meet the requirements for confidentiality, availability and integrity. Exploitation of vulnerabilities is among the possible ways for attackers to gain access to the IT system or to threaten its operating stability. Information on technical vulnerabilities for the IT systems in use is gathered (for example, information from the manufacturer, system audits, CVS database) and evaluated. For example, Common Vulnerability Scoring System (CVSS). Potentially affected IT systems and software are identified, assessed and any vulnerabilities are addressed. | <ul><li>Dependency scanning running</li><li>Container scanning running</li></ul> |
| 5.3.1 To what extent is information security considered in new or further developed IT systems? | Information security is an integral part of the entire lifecycle of IT systems. This particularly includes consideration of information security requirements in the development or acquisition of IT systems. The information security requirements associated with the design and development of IT systems are determined and considered. The information security requirements associated with the acquisition or extension of IT systems and IT components are determined and considered. Information security requirements associated with changes to developed IT systems are considered. System approval tests are carried out under consideration of the information security requirements. | <ul><li>Dependency scanning running</li><li>Container scanning running</li><li>SAST running</li><li>DAST running</li><li>API security running</li><li>Secret detection running</li><li>Fuzz testing running</li></ul> |
| 7.1.1 To what extent is compliance with regulatory and contractual provisions ensured? | Non-compliance with legal, regulatory, or contractual provisions can create risks to the information security of customers and the own organization. Therefore, it is essential to ensure that these provisions are known and observed. Legal, regulatory, and contractual provisions of relevance to information security (see examples) are determined at regular intervals. | <ul><li>License compliance running</li></ul> |
|
https://docs.gitlab.com/user/compliance/license_scanning_of_cyclonedx_files
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance/_index.md
|
2025-08-13
|
doc/user/compliance/license_scanning_of_cyclonedx_files
|
[
"doc",
"user",
"compliance",
"license_scanning_of_cyclonedx_files"
] |
_index.md
|
Application Security Testing
|
Composition Analysis
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
License scanning of CycloneDX files
| null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384932) in GitLab 15.9 for GitLab SaaS [with two flags](../../../administration/feature_flags/_index.md) named `license_scanning_sbom_scanner` and `package_metadata_synchronization`. Both flags disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/385176) in GitLab 16.4. Feature flags `license_scanning_sbom_scanner` and `package_metadata_synchronization` removed.
- The legacy License Compliance analyzer (`License-Scanning.gitlab-ci.yml`) was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/439162) in GitLab 17.0.
- In GitLab 17.5 we introduced the ability to use a CycloneDX report artifact as a source of data for license information behind the feature flag `license_scanning_with_sbom_licenses`, disabled by default.
- In GitLab 17.6 the ability to use a CycloneDX report artifact as a source of data for license information has been enabled by default. The feature flag `license_scanning_with_sbom_licenses` is still present to disable the feature if necessary.
- In GitLab 17.8 the feature flag `license_scanning_with_sbom_licenses` was removed.
{{< /history >}}
To detect the licenses in use, License Compliance relies on running the
[Dependency Scanning CI Jobs](../../application_security/dependency_scanning/_index.md),
and analyzing the [CycloneDX](https://cyclonedx.org/) Software Bill of Materials (SBOM) generated by those jobs.
This method of scanning is capable of parsing and identifying over 600 different types of licenses, as defined in [the SPDX list](https://spdx.org/licenses/).
Third-party scanners may be used to generate the list of dependencies, as long as they produce a CycloneDX report artifact for [one of our supported languages](#supported-languages-and-package-managers) and follow the GitLab CycloneDX property taxonomy.
The ability to provide other licenses is tracked in [epic 10861](https://gitlab.com/groups/gitlab-org/-/epics/10861).
{{< alert type="note" >}}
The License Scanning feature relies on publicly available package metadata collected in an
external database and synced with the GitLab instance automatically. This database is a multi-region Google Cloud Storage bucket hosted in the United States.
The scan is executed exclusively within the GitLab instance.
No contextual information (for example, a list of project dependencies) is sent to the external service.
{{< /alert >}}
## Configuration
To enable License scanning of CycloneDX files:
- Using the Dependency Scanning template
- Enable [Dependency Scanning](../../application_security/dependency_scanning/_index.md#getting-started)
and ensure that its prerequisites are met.
- On GitLab Self-Managed, you can [choose package registry metadata to synchronize](../../../administration/settings/security_and_compliance.md#choose-package-registry-metadata-to-sync) in the **Admin** area for the GitLab instance. For this data synchronization to work, you must allow outbound network traffic from your GitLab instance to the domain `storage.googleapis.com`. If you have limited or no network connectivity then refer to the documentation section [running in an offline environment](#running-in-an-offline-environment) for further guidance.
- Or use the [CI/CD component](../../../ci/components/_index.md) for applicable package registries.
## Supported languages and package managers
License scanning is supported for the following languages and package managers:
<!-- markdownlint-disable MD044 -->
<table class="supported-languages">
<thead>
<tr>
<th>Language</th>
<th>Package Manager</th>
<th>Dependency Scanning Template</th>
<th>CI/CD Component</th>
</tr>
</thead>
<tbody>
<tr>
<td>.NET</td>
<td rowspan="2"><a href="https://www.nuget.org/">NuGet</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>C#</td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>C</td>
<td rowspan="2"><a href="https://conan.io/">Conan</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>C++</td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>Go<sup><b><a href="#notes-regarding-supported-languages-and-package-managers-1">1</a></b></sup></td>
<td><a href="https://go.dev/">Go</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td rowspan="3">Java</td>
<td><a href="https://gradle.org/">Gradle</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://maven.apache.org/">Maven</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://developer.android.com/">Android</a></td>
<td>Yes</td>
<td><a href="https://gitlab.com/components/android-dependency-scanning">Yes</a></td>
</tr>
<tr>
<td rowspan="3">JavaScript and TypeScript</td>
<td><a href="https://www.npmjs.com/">npm</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://pnpm.io/">pnpm</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://classic.yarnpkg.com/en/">yarn</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>PHP</td>
<td><a href="https://getcomposer.org/">Composer</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td rowspan="4">Python</td>
<td><a href="https://setuptools.readthedocs.io/en/latest/">setuptools</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://pip.pypa.io/en/stable/">pip</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://pipenv.pypa.io/en/latest/">Pipenv</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://python-poetry.org/">Poetry</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>Ruby</td>
<td><a href="https://bundler.io/">Bundler</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>Rust</td>
<td><a href="https://doc.rust-lang.org/cargo/">cargo</a></td>
<td>No</td>
<td><a href="https://gitlab.com/components/dependency-scanning#generating-cargo-sboms">Yes</a></td>
</tr>
<tr>
<td>Scala</td>
<td><a href="https://www.scala-sbt.org/">sbt</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>Swift</td>
<td><a href="https://developer.apple.com/swift/">sbt</a></td>
<td>Yes</td>
<td>No</td>
</tr>
</tbody>
</table>
<ol>
<li>
<a id="notes-regarding-supported-languages-and-package-managers-1"></a>
<p>
Go standard libraries such as `stdlib` are not supported and will appear with an `unknown`
license. Support for these is tracked in
<a href="https://gitlab.com/gitlab-org/gitlab/-/issues/480305">issue 480305</a>.
</p>
</li>
</ol>
<!-- markdownlint-disable MD044 -->
The supported files and versions are the ones supported by
[Dependency Scanning](../../application_security/dependency_scanning/_index.md#supported-languages-and-package-managers).
## Data sources
License information for supported packages is obtained from the sources below. GitLab does
additional processing on the original data, which includes mapping variations to the canonical
license names.
| Package manager | Source |
|-----------------|------------------------------------------------------------------|
| Cargo | <https://deps.dev/> |
| Conan | <https://github.com/conan-io/conan-center-index> |
| Go | <https://index.golang.org/> |
| Maven | <https://storage.googleapis.com/maven-central> |
| npm | <https://deps.dev/> |
| NuGet | <https://api.nuget.org/v3/catalog0/index.json> |
| Packagist | <https://packagist.org/packages/list.json> |
| PyPI | <https://warehouse.pypa.io/api-reference/bigquery-datasets.html> |
| Rubygems | <https://rubygems.org/versions> |
## License expressions
The License Scanning of CycloneDX files does not support [composite licenses](https://spdx.github.io/spdx-spec/v2-draft/SPDX-license-expressions/).
Adding this capability is tracked in issue [336878](https://gitlab.com/gitlab-org/gitlab/-/issues/336878).
## Blocking merge requests based on detected licenses
Users can require approval for merge requests based on the licenses that are detected by configuring a [license approval policy](../license_approval_policies.md).
## Running in an offline environment
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
For instances in an environment with limited, restricted, or intermittent access to external resources through the internet, some adjustments are required to successfully scan
CycloneDX reports for licenses. For more information, see the offline [quick start guide](../../../topics/offline/quick_start_guide.md#enabling-the-package-metadata-database).
## Use CycloneDX report as a source of license information
The ability to use a CI report artifact as a source of license information data was introduced in GitLab 17.5 behind the feature flag `license_scanning_with_sbom_licenses` and enabled by default in 17.6.
In GitLab 17.8 the feature flag `license_scanning_with_sbom_licenses` was removed.
The License Scanning uses the [licenses](https://cyclonedx.org/use-cases/#license-compliance) field of the CycloneDX JSON SBOM when available. If the license information is unavailable, the license information imported from the external license database will be used(current behavior).
License information can be provided using a valid SPDX identifier or a license name. However, providing a license using an SPDX License Expression is not supported.
More information about the license field format can be found on the [CycloneDX](https://cyclonedx.org/use-cases/#license-compliance) specification.
Compatible CycloneDX SBOM generators that provide the licenses field can be found in the [CycloneDX Tool Center](https://cyclonedx.org/tool-center/).
Only licenses providing an SPDX identifier are currently supported. Extending this feature beyond SDPX licenses is tracked in [issue 505677](https://gitlab.com/gitlab-org/gitlab/-/issues/505677).
### Configure license information source
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/501662) in GitLab 18.3.
{{< /history >}}
You can configure the preferred source for license information in your project's security configuration:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Secure > Security configuration**.
1. In the **License information source** section, select either:
- **SBOM** (default) - Uses license information from CycloneDX reports
- **PMDB** - Uses license information from the external license database
This setting determines which source GitLab prioritizes when both CycloneDX license data and external license database information are available.
## Troubleshooting
### A CycloneDX file is not being scanned and appears to provide no results
Ensure that the CycloneDX file adheres to the [CycloneDX JSON specification](https://cyclonedx.org/docs/latest/json). This specification does [not permit duplicate entries](https://cyclonedx.org/docs/latest/json/#components). Projects that contain multiple SBOM files should either report each SBOM file up as individual CI report artifacts or they should ensure that duplicates are removed if the SBOMs are merged as part of the CI pipeline.
You can validate CycloneDX SBOM files against the `CycloneDX JSON specification` as follows:
```shell
$ docker run -it --rm -v "$PWD:/my-cyclonedx-sboms" -w /my-cyclonedx-sboms cyclonedx/cyclonedx-cli:latest cyclonedx validate --input-version v1_4 --input-file gl-sbom-all.cdx.json
Validating JSON BOM...
BOM validated successfully.
```
If the JSON BOM fails validation, for example, because there are duplicate components:
```shell
Validation failed: Found duplicates at the following index pairs: "(A, B), (C, D)"
#/properties/components/uniqueItems
```
This issue can be fixed by updating the CI template to use [jq](https://jqlang.github.io/jq/) to remove the duplicate components from the `gl-sbom-*.cdx.json` report by overriding the job definition that produces the duplicate components. For example, the following removes duplicate components from the `gl-sbom-gem-bundler.cdx.json` report file produced by the `gemnasium-dependency_scanning` job:
```yaml
include:
- template: Jobs/Dependency-Scanning.gitlab-ci.yml
gemnasium-dependency_scanning:
after_script:
- apk update && apk add jq
- jq '.components |= unique' gl-sbom-gem-bundler.cdx.json > tmp.json && mv tmp.json gl-sbom-gem-bundler.cdx.json
```
### Remove unused license data
License scanning changes (released in GitLab 15.9) required a significant amount of additional disk space to be available on the instances. This issue was resolved in GitLab 16.3 by the [Reduce package metadata table on-disk footprint](https://gitlab.com/groups/gitlab-org/-/epics/10415) epic. But if your instance was running license scanning between GitLab 15.9 and 16.3, you may want to remove the unneeded data.
To remove the unneeded data:
1. Check if the [package_metadata_synchronization](https://about.gitlab.com/releases/2023/02/22/gitlab-15-9-released/#new-license-compliance-scanner) feature flag is currently, or was previously enabled, and if so, disable it. Use [Rails console](../../../administration/operations/rails_console.md) to execute the following commands.
```ruby
Feature.enabled?(:package_metadata_synchronization) && Feature.disable(:package_metadata_synchronization)
```
1. Check if there is deprecated data in the database:
```ruby
PackageMetadata::PackageVersionLicense.count
PackageMetadata::PackageVersion.count
```
1. If there is deprecated data in the database, remove it by running the following commands in order:
```ruby
ActiveRecord::Base.connection.execute('SET statement_timeout TO 0')
PackageMetadata::PackageVersionLicense.delete_all
PackageMetadata::PackageVersion.delete_all
```
### Dependency licenses are unknown
Open source license information is stored in the database and used to resolve licenses for a
project's dependencies. A dependency's license may appear as `unknown` if license information does
not exist or if that data is not yet available in the database.
Lookups for a dependency's licenses are done upon pipeline completion, so if this data was not
available at that time an `unknown` license is recorded. This license is shown up until a subsequent
pipeline is executed at which point another license lookup is made. If a lookup confirms the
dependency's license has changed, the new license is shown at this time.
|
---
stage: Application Security Testing
group: Composition Analysis
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: License scanning of CycloneDX files
breadcrumbs:
- doc
- user
- compliance
- license_scanning_of_cyclonedx_files
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384932) in GitLab 15.9 for GitLab SaaS [with two flags](../../../administration/feature_flags/_index.md) named `license_scanning_sbom_scanner` and `package_metadata_synchronization`. Both flags disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/385176) in GitLab 16.4. Feature flags `license_scanning_sbom_scanner` and `package_metadata_synchronization` removed.
- The legacy License Compliance analyzer (`License-Scanning.gitlab-ci.yml`) was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/439162) in GitLab 17.0.
- In GitLab 17.5 we introduced the ability to use a CycloneDX report artifact as a source of data for license information behind the feature flag `license_scanning_with_sbom_licenses`, disabled by default.
- In GitLab 17.6 the ability to use a CycloneDX report artifact as a source of data for license information has been enabled by default. The feature flag `license_scanning_with_sbom_licenses` is still present to disable the feature if necessary.
- In GitLab 17.8 the feature flag `license_scanning_with_sbom_licenses` was removed.
{{< /history >}}
To detect the licenses in use, License Compliance relies on running the
[Dependency Scanning CI Jobs](../../application_security/dependency_scanning/_index.md),
and analyzing the [CycloneDX](https://cyclonedx.org/) Software Bill of Materials (SBOM) generated by those jobs.
This method of scanning is capable of parsing and identifying over 600 different types of licenses, as defined in [the SPDX list](https://spdx.org/licenses/).
Third-party scanners may be used to generate the list of dependencies, as long as they produce a CycloneDX report artifact for [one of our supported languages](#supported-languages-and-package-managers) and follow the GitLab CycloneDX property taxonomy.
The ability to provide other licenses is tracked in [epic 10861](https://gitlab.com/groups/gitlab-org/-/epics/10861).
{{< alert type="note" >}}
The License Scanning feature relies on publicly available package metadata collected in an
external database and synced with the GitLab instance automatically. This database is a multi-region Google Cloud Storage bucket hosted in the United States.
The scan is executed exclusively within the GitLab instance.
No contextual information (for example, a list of project dependencies) is sent to the external service.
{{< /alert >}}
## Configuration
To enable License scanning of CycloneDX files:
- Using the Dependency Scanning template
- Enable [Dependency Scanning](../../application_security/dependency_scanning/_index.md#getting-started)
and ensure that its prerequisites are met.
- On GitLab Self-Managed, you can [choose package registry metadata to synchronize](../../../administration/settings/security_and_compliance.md#choose-package-registry-metadata-to-sync) in the **Admin** area for the GitLab instance. For this data synchronization to work, you must allow outbound network traffic from your GitLab instance to the domain `storage.googleapis.com`. If you have limited or no network connectivity then refer to the documentation section [running in an offline environment](#running-in-an-offline-environment) for further guidance.
- Or use the [CI/CD component](../../../ci/components/_index.md) for applicable package registries.
## Supported languages and package managers
License scanning is supported for the following languages and package managers:
<!-- markdownlint-disable MD044 -->
<table class="supported-languages">
<thead>
<tr>
<th>Language</th>
<th>Package Manager</th>
<th>Dependency Scanning Template</th>
<th>CI/CD Component</th>
</tr>
</thead>
<tbody>
<tr>
<td>.NET</td>
<td rowspan="2"><a href="https://www.nuget.org/">NuGet</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>C#</td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>C</td>
<td rowspan="2"><a href="https://conan.io/">Conan</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>C++</td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>Go<sup><b><a href="#notes-regarding-supported-languages-and-package-managers-1">1</a></b></sup></td>
<td><a href="https://go.dev/">Go</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td rowspan="3">Java</td>
<td><a href="https://gradle.org/">Gradle</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://maven.apache.org/">Maven</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://developer.android.com/">Android</a></td>
<td>Yes</td>
<td><a href="https://gitlab.com/components/android-dependency-scanning">Yes</a></td>
</tr>
<tr>
<td rowspan="3">JavaScript and TypeScript</td>
<td><a href="https://www.npmjs.com/">npm</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://pnpm.io/">pnpm</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://classic.yarnpkg.com/en/">yarn</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>PHP</td>
<td><a href="https://getcomposer.org/">Composer</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td rowspan="4">Python</td>
<td><a href="https://setuptools.readthedocs.io/en/latest/">setuptools</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://pip.pypa.io/en/stable/">pip</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://pipenv.pypa.io/en/latest/">Pipenv</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="https://python-poetry.org/">Poetry</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>Ruby</td>
<td><a href="https://bundler.io/">Bundler</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>Rust</td>
<td><a href="https://doc.rust-lang.org/cargo/">cargo</a></td>
<td>No</td>
<td><a href="https://gitlab.com/components/dependency-scanning#generating-cargo-sboms">Yes</a></td>
</tr>
<tr>
<td>Scala</td>
<td><a href="https://www.scala-sbt.org/">sbt</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>Swift</td>
<td><a href="https://developer.apple.com/swift/">sbt</a></td>
<td>Yes</td>
<td>No</td>
</tr>
</tbody>
</table>
<ol>
<li>
<a id="notes-regarding-supported-languages-and-package-managers-1"></a>
<p>
Go standard libraries such as `stdlib` are not supported and will appear with an `unknown`
license. Support for these is tracked in
<a href="https://gitlab.com/gitlab-org/gitlab/-/issues/480305">issue 480305</a>.
</p>
</li>
</ol>
<!-- markdownlint-disable MD044 -->
The supported files and versions are the ones supported by
[Dependency Scanning](../../application_security/dependency_scanning/_index.md#supported-languages-and-package-managers).
## Data sources
License information for supported packages is obtained from the sources below. GitLab does
additional processing on the original data, which includes mapping variations to the canonical
license names.
| Package manager | Source |
|-----------------|------------------------------------------------------------------|
| Cargo | <https://deps.dev/> |
| Conan | <https://github.com/conan-io/conan-center-index> |
| Go | <https://index.golang.org/> |
| Maven | <https://storage.googleapis.com/maven-central> |
| npm | <https://deps.dev/> |
| NuGet | <https://api.nuget.org/v3/catalog0/index.json> |
| Packagist | <https://packagist.org/packages/list.json> |
| PyPI | <https://warehouse.pypa.io/api-reference/bigquery-datasets.html> |
| Rubygems | <https://rubygems.org/versions> |
## License expressions
The License Scanning of CycloneDX files does not support [composite licenses](https://spdx.github.io/spdx-spec/v2-draft/SPDX-license-expressions/).
Adding this capability is tracked in issue [336878](https://gitlab.com/gitlab-org/gitlab/-/issues/336878).
## Blocking merge requests based on detected licenses
Users can require approval for merge requests based on the licenses that are detected by configuring a [license approval policy](../license_approval_policies.md).
## Running in an offline environment
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
For instances in an environment with limited, restricted, or intermittent access to external resources through the internet, some adjustments are required to successfully scan
CycloneDX reports for licenses. For more information, see the offline [quick start guide](../../../topics/offline/quick_start_guide.md#enabling-the-package-metadata-database).
## Use CycloneDX report as a source of license information
The ability to use a CI report artifact as a source of license information data was introduced in GitLab 17.5 behind the feature flag `license_scanning_with_sbom_licenses` and enabled by default in 17.6.
In GitLab 17.8 the feature flag `license_scanning_with_sbom_licenses` was removed.
The License Scanning uses the [licenses](https://cyclonedx.org/use-cases/#license-compliance) field of the CycloneDX JSON SBOM when available. If the license information is unavailable, the license information imported from the external license database will be used(current behavior).
License information can be provided using a valid SPDX identifier or a license name. However, providing a license using an SPDX License Expression is not supported.
More information about the license field format can be found on the [CycloneDX](https://cyclonedx.org/use-cases/#license-compliance) specification.
Compatible CycloneDX SBOM generators that provide the licenses field can be found in the [CycloneDX Tool Center](https://cyclonedx.org/tool-center/).
Only licenses providing an SPDX identifier are currently supported. Extending this feature beyond SDPX licenses is tracked in [issue 505677](https://gitlab.com/gitlab-org/gitlab/-/issues/505677).
### Configure license information source
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/501662) in GitLab 18.3.
{{< /history >}}
You can configure the preferred source for license information in your project's security configuration:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Secure > Security configuration**.
1. In the **License information source** section, select either:
- **SBOM** (default) - Uses license information from CycloneDX reports
- **PMDB** - Uses license information from the external license database
This setting determines which source GitLab prioritizes when both CycloneDX license data and external license database information are available.
## Troubleshooting
### A CycloneDX file is not being scanned and appears to provide no results
Ensure that the CycloneDX file adheres to the [CycloneDX JSON specification](https://cyclonedx.org/docs/latest/json). This specification does [not permit duplicate entries](https://cyclonedx.org/docs/latest/json/#components). Projects that contain multiple SBOM files should either report each SBOM file up as individual CI report artifacts or they should ensure that duplicates are removed if the SBOMs are merged as part of the CI pipeline.
You can validate CycloneDX SBOM files against the `CycloneDX JSON specification` as follows:
```shell
$ docker run -it --rm -v "$PWD:/my-cyclonedx-sboms" -w /my-cyclonedx-sboms cyclonedx/cyclonedx-cli:latest cyclonedx validate --input-version v1_4 --input-file gl-sbom-all.cdx.json
Validating JSON BOM...
BOM validated successfully.
```
If the JSON BOM fails validation, for example, because there are duplicate components:
```shell
Validation failed: Found duplicates at the following index pairs: "(A, B), (C, D)"
#/properties/components/uniqueItems
```
This issue can be fixed by updating the CI template to use [jq](https://jqlang.github.io/jq/) to remove the duplicate components from the `gl-sbom-*.cdx.json` report by overriding the job definition that produces the duplicate components. For example, the following removes duplicate components from the `gl-sbom-gem-bundler.cdx.json` report file produced by the `gemnasium-dependency_scanning` job:
```yaml
include:
- template: Jobs/Dependency-Scanning.gitlab-ci.yml
gemnasium-dependency_scanning:
after_script:
- apk update && apk add jq
- jq '.components |= unique' gl-sbom-gem-bundler.cdx.json > tmp.json && mv tmp.json gl-sbom-gem-bundler.cdx.json
```
### Remove unused license data
License scanning changes (released in GitLab 15.9) required a significant amount of additional disk space to be available on the instances. This issue was resolved in GitLab 16.3 by the [Reduce package metadata table on-disk footprint](https://gitlab.com/groups/gitlab-org/-/epics/10415) epic. But if your instance was running license scanning between GitLab 15.9 and 16.3, you may want to remove the unneeded data.
To remove the unneeded data:
1. Check if the [package_metadata_synchronization](https://about.gitlab.com/releases/2023/02/22/gitlab-15-9-released/#new-license-compliance-scanner) feature flag is currently, or was previously enabled, and if so, disable it. Use [Rails console](../../../administration/operations/rails_console.md) to execute the following commands.
```ruby
Feature.enabled?(:package_metadata_synchronization) && Feature.disable(:package_metadata_synchronization)
```
1. Check if there is deprecated data in the database:
```ruby
PackageMetadata::PackageVersionLicense.count
PackageMetadata::PackageVersion.count
```
1. If there is deprecated data in the database, remove it by running the following commands in order:
```ruby
ActiveRecord::Base.connection.execute('SET statement_timeout TO 0')
PackageMetadata::PackageVersionLicense.delete_all
PackageMetadata::PackageVersion.delete_all
```
### Dependency licenses are unknown
Open source license information is stored in the database and used to resolve licenses for a
project's dependencies. A dependency's license may appear as `unknown` if license information does
not exist or if that data is not yet available in the database.
Lookups for a dependency's licenses are done upon pipeline completion, so if this data was not
available at that time an `unknown` license is recorded. This license is shown up until a subsequent
pipeline is executed at which point another license lookup is made. If a lookup confirms the
dependency's license has changed, the new license is shown at this time.
|
https://docs.gitlab.com/user/compliance/compliance_frameworks_report
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance/compliance_frameworks_report.md
|
2025-08-13
|
doc/user/compliance/compliance_center
|
[
"doc",
"user",
"compliance",
"compliance_center"
] |
compliance_frameworks_report.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Compliance frameworks report
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/422973) in GitLab 16.5 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_framework_report_ui`. Disabled by default.
- In GitLab 16.4 and earlier, **Compliance frameworks report** referred to what is now called **Compliance projects report**. The formally-named **Compliance frameworks report** was [renamed to **Compliance projects report**](https://gitlab.com/gitlab-org/gitlab/-/issues/422963) in GitLab 16.5.
- [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140825) in GitLab 16.8.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/425242) in GitLab 16.10. Feature flag `compliance_framework_report_ui` removed.
{{< /history >}}
With the compliance frameworks report, you can see all the compliance frameworks in a group. Each row of the report shows:
- Framework name.
- Associated projects.
The default framework for the group has a **default** badge.
## View the compliance frameworks report
To view the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
## Create a new compliance framework
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To create a new compliance framework from the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Select the **New framework**.
1. Select **Create blank framework**.
1. Select the **Add framework** to create compliance framework.
## Edit a compliance framework
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To edit a compliance framework from the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Hover over framework and select **Edit the framework**.
1. Select the **Save changes** to edit compliance framework.
## Delete a compliance framework
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To delete a compliance framework from the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Hover over framework and select **Edit the framework**.
1. Select the **Delete framework** to delete compliance framework.
## Set and remove a compliance framework as default
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/181500) in GitLab 17.10.
{{< /history >}}
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To set a compliance framework as [default](../compliance_frameworks/_index.md#default-compliance-frameworks)] from the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Next to the compliance framework you want to set as default, select {{< icon name="pencil" >}} action.
1. Select the **Set as default** to set as default.
To remove a compliance framework as default from the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Next to the compliance framework that is default, select {{< icon name="pencil" >}} action.
1. Select the **Remove as default** to remove as default.
## Export a report of compliance frameworks in a group
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413736) in GitLab 16.11 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_frameworks_report_csv_export`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152644) in GitLab 17.1. Feature flag `compliance_frameworks_report_csv_export` removed.
{{< /history >}}
Exports the contents of a compliance frameworks report in a group. Reports are truncated at 15 MB to avoid a large email attachment.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export the standards adherence report for projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export framework report**.
A report is compiled and delivered to your email inbox as an attachment.
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Compliance frameworks report
breadcrumbs:
- doc
- user
- compliance
- compliance_center
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/422973) in GitLab 16.5 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_framework_report_ui`. Disabled by default.
- In GitLab 16.4 and earlier, **Compliance frameworks report** referred to what is now called **Compliance projects report**. The formally-named **Compliance frameworks report** was [renamed to **Compliance projects report**](https://gitlab.com/gitlab-org/gitlab/-/issues/422963) in GitLab 16.5.
- [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140825) in GitLab 16.8.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/425242) in GitLab 16.10. Feature flag `compliance_framework_report_ui` removed.
{{< /history >}}
With the compliance frameworks report, you can see all the compliance frameworks in a group. Each row of the report shows:
- Framework name.
- Associated projects.
The default framework for the group has a **default** badge.
## View the compliance frameworks report
To view the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
## Create a new compliance framework
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To create a new compliance framework from the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Select the **New framework**.
1. Select **Create blank framework**.
1. Select the **Add framework** to create compliance framework.
## Edit a compliance framework
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To edit a compliance framework from the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Hover over framework and select **Edit the framework**.
1. Select the **Save changes** to edit compliance framework.
## Delete a compliance framework
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To delete a compliance framework from the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Hover over framework and select **Edit the framework**.
1. Select the **Delete framework** to delete compliance framework.
## Set and remove a compliance framework as default
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/181500) in GitLab 17.10.
{{< /history >}}
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To set a compliance framework as [default](../compliance_frameworks/_index.md#default-compliance-frameworks)] from the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Next to the compliance framework you want to set as default, select {{< icon name="pencil" >}} action.
1. Select the **Set as default** to set as default.
To remove a compliance framework as default from the compliance frameworks report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Frameworks** tab.
1. Next to the compliance framework that is default, select {{< icon name="pencil" >}} action.
1. Select the **Remove as default** to remove as default.
## Export a report of compliance frameworks in a group
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413736) in GitLab 16.11 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_frameworks_report_csv_export`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152644) in GitLab 17.1. Feature flag `compliance_frameworks_report_csv_export` removed.
{{< /history >}}
Exports the contents of a compliance frameworks report in a group. Reports are truncated at 15 MB to avoid a large email attachment.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export the standards adherence report for projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export framework report**.
A report is compiled and delivered to your email inbox as an attachment.
|
https://docs.gitlab.com/user/compliance/compliance_violations_report
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance/compliance_violations_report.md
|
2025-08-13
|
doc/user/compliance/compliance_center
|
[
"doc",
"user",
"compliance",
"compliance_center"
] |
compliance_violations_report.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Compliance violations report
| null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112111) to compliance violations report in GitLab 15.9.
- Ability to create and edit compliance frameworks [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394950) in GitLab 16.0.
- New dynamic compliance violations report [introduced](https://gitlab.com/groups/gitlab-org/-/epics/12774) in GitLab 18.2 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_violations_report`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use. For production use, continue to use the
[static compliance violations report](#static-compliance-violations-report).
{{< /alert >}}
Use the compliance violations report to see a comprehensive view of compliance violations across all projects in
your group. The report provides detailed information about violated controls, associated audit events, and allows you
to manage violation statuses.
## View the compliance violations report
Prerequisites:
- You must be an administrator or have the Owner role for the project or group.
To view the compliance violations report:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Secure > Compliance center**.
The compliance violations report displays:
- **Status**: The current status of the violation. For example, Needs Review, Resolved, or Dismissed.
- **Violated control and framework**: The specific compliance control that was violated and its associated framework.
- **Audit Event**: Details about the event that triggered the violation.
- **Project**: The project where the violation occurred.
- **Date detected**: When the violation was identified.
- **Action**: Link to view detailed information about the violation.
In the report, you can:
- Sort the report by selecting column headers.
- Change the status of violations using the status dropdown list.
- Navigate through multiple pages of violations by using pagination.
- View detailed information about each violation.
- Export the report as a CSV file.
## Violation details
When you select **Details** for a specific violation, you can view:
- The violation ID and status.
- Location (project) where the violation occurred.
- Comprehensive audit event information including:
- Event author.
- Event target.
- Event details.
- IP address.
- Target type.
- Violated control information including:
- Control name and description.
- Associated compliance framework.
- Requirements.
- Fix suggestions with links to resolve the violation.
## Manage violation statuses
You can update the status of compliance violations to track their remediation progress. Available statuses include:
- **Needs Review**: Default status for new violations
- **In Progress**: Violation is being addressed
- **Resolved**: Violation has been remediated
- **Dismissed**: Violation has been reviewed and dismissed
To change a violation status:
1. In the compliance violations report, locate the violation you want to update.
1. Select the current status dropdown list in the **Status** column.
1. Choose the new status from the dropdown list menu.
The status updates immediately and is reflected in the report.
## Export compliance violations report
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/551244) in GitLab 18.3.
{{< /history >}}
Export a CSV report of compliance violations for all projects in a group. The exported report includes:
- Detected at (DateTime most current first)
- Violation ID
- Status
- Framework
- Compliance Control
- Compliance Requirement
- Audit Event Author
- Audit Event Type
- Audit Event Name
- Audit Event Message
- Project ID
Reports:
- Are truncated at 15 MB so the email attachment is not too large.
- Include all violations regardless of current filters applied to the web interface.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export a compliance violations report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export violations report**.
A report is compiled and delivered to your email inbox as an attachment.
## Static compliance violations report
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/551236) in GitLab 18.2
and is planned for removal in 18.8.
{{< /alert >}}
The static compliance violations report provides a high-level view of merge request activity for all projects in the group.
When you select a row in the static compliance violations report, a drawer appears that provides:
- The project name and [compliance framework label](../../project/working_with_projects.md#add-a-compliance-framework-to-a-project),
if the project has one assigned.
- A link to the merge request that introduced the violation.
- The merge request's branch path in the format `[source] into [target]`.
- A list of users that committed changes to the merge request.
- A list of users that commented on the merge request.
- A list of users that approved the merge request.
- The user that merged the merge request.
### View the static compliance violations report
{{< history >}}
- Target branch search [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358414) in GitLab 16.0.
{{< /history >}}
Prerequisites:
- You must be an administrator or have the Owner role for the project or group.
To view the static compliance violations report:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Secure > Compliance center**.
You can sort the compliance report on:
- Severity level.
- Type of violation.
- Merge request title.
You can filter the compliance violations report on:
- The project that the violation was found on.
- The date range of violation.
- The target branch of the violation.
Select a row to see details of the compliance violation.
### Severity levels
Each compliance violation has one of the following severities.
<!-- vale gitlab_base.SubstitutionWarning = NO -->
| Icon | Severity level |
|:------------------------|:---------------|
| {{< icon name="severity-critical" >}} | Critical |
| {{< icon name="severity-high" >}} | High |
| {{< icon name="severity-medium" >}} | Medium |
| {{< icon name="severity-low" >}} | Low |
| {{< icon name="severity-info" >}} | Info |
<!-- vale gitlab_base.SubstitutionWarning = YES -->
### Violation types
From [GitLab 14.10](https://gitlab.com/groups/gitlab-org/-/epics/6870), these are the available compliance violations.
| Violation | Severity level | Category | Description |
|:----------------------------------|:---------------|:----------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Author approved merge request | High | [Separation of duties](#separation-of-duties) | Author of the merge request approved their own merge request. For more information, see [Prevent approval by author](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author). |
| Committers approved merge request | High | [Separation of duties](#separation-of-duties) | Committers of the merge request approved the merge request they contributed to. For more information, see [Prevent approvals by users who add commits](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits). |
| Fewer than two approvals | High | [Separation of duties](#separation-of-duties) | Merge request was merged with fewer than two approvals. For more information, see [Merge request approval rules](../../project/merge_requests/approvals/rules.md). |
#### Separation of duties
GitLab supports a separation of duties policy between users who create and approve merge requests. Our criteria for the
separation of duties is:
- [A merge request author is **not** allowed to approve their merge request](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author).
- [A merge request committer is **not** allowed to approve a merge request they have added commits to](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits).
- [The minimum number of approvals required to merge a merge request is **at least** two](../../project/merge_requests/approvals/rules.md).
### Export a report of merge request compliance violations on projects in a group
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/356791) in GitLab 16.4 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_violation_csv_export`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/424447) in GitLab 16.5.
- [Feature flag `compliance_violation_csv_export`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/142568) removed in GitLab 16.9.
{{< /history >}}
Export a report of merge request compliance violations on merge requests belonging to projects in a group. Reports:
- Do not use filters on the violations report.
- Are truncated at 15 MB so the email attachment is not too large.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export a report of merge request compliance violations for projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export violations report**.
A report is compiled and delivered to your email inbox as an attachment.
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Compliance violations report
breadcrumbs:
- doc
- user
- compliance
- compliance_center
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112111) to compliance violations report in GitLab 15.9.
- Ability to create and edit compliance frameworks [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394950) in GitLab 16.0.
- New dynamic compliance violations report [introduced](https://gitlab.com/groups/gitlab-org/-/epics/12774) in GitLab 18.2 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_violations_report`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use. For production use, continue to use the
[static compliance violations report](#static-compliance-violations-report).
{{< /alert >}}
Use the compliance violations report to see a comprehensive view of compliance violations across all projects in
your group. The report provides detailed information about violated controls, associated audit events, and allows you
to manage violation statuses.
## View the compliance violations report
Prerequisites:
- You must be an administrator or have the Owner role for the project or group.
To view the compliance violations report:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Secure > Compliance center**.
The compliance violations report displays:
- **Status**: The current status of the violation. For example, Needs Review, Resolved, or Dismissed.
- **Violated control and framework**: The specific compliance control that was violated and its associated framework.
- **Audit Event**: Details about the event that triggered the violation.
- **Project**: The project where the violation occurred.
- **Date detected**: When the violation was identified.
- **Action**: Link to view detailed information about the violation.
In the report, you can:
- Sort the report by selecting column headers.
- Change the status of violations using the status dropdown list.
- Navigate through multiple pages of violations by using pagination.
- View detailed information about each violation.
- Export the report as a CSV file.
## Violation details
When you select **Details** for a specific violation, you can view:
- The violation ID and status.
- Location (project) where the violation occurred.
- Comprehensive audit event information including:
- Event author.
- Event target.
- Event details.
- IP address.
- Target type.
- Violated control information including:
- Control name and description.
- Associated compliance framework.
- Requirements.
- Fix suggestions with links to resolve the violation.
## Manage violation statuses
You can update the status of compliance violations to track their remediation progress. Available statuses include:
- **Needs Review**: Default status for new violations
- **In Progress**: Violation is being addressed
- **Resolved**: Violation has been remediated
- **Dismissed**: Violation has been reviewed and dismissed
To change a violation status:
1. In the compliance violations report, locate the violation you want to update.
1. Select the current status dropdown list in the **Status** column.
1. Choose the new status from the dropdown list menu.
The status updates immediately and is reflected in the report.
## Export compliance violations report
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/551244) in GitLab 18.3.
{{< /history >}}
Export a CSV report of compliance violations for all projects in a group. The exported report includes:
- Detected at (DateTime most current first)
- Violation ID
- Status
- Framework
- Compliance Control
- Compliance Requirement
- Audit Event Author
- Audit Event Type
- Audit Event Name
- Audit Event Message
- Project ID
Reports:
- Are truncated at 15 MB so the email attachment is not too large.
- Include all violations regardless of current filters applied to the web interface.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export a compliance violations report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export violations report**.
A report is compiled and delivered to your email inbox as an attachment.
## Static compliance violations report
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/551236) in GitLab 18.2
and is planned for removal in 18.8.
{{< /alert >}}
The static compliance violations report provides a high-level view of merge request activity for all projects in the group.
When you select a row in the static compliance violations report, a drawer appears that provides:
- The project name and [compliance framework label](../../project/working_with_projects.md#add-a-compliance-framework-to-a-project),
if the project has one assigned.
- A link to the merge request that introduced the violation.
- The merge request's branch path in the format `[source] into [target]`.
- A list of users that committed changes to the merge request.
- A list of users that commented on the merge request.
- A list of users that approved the merge request.
- The user that merged the merge request.
### View the static compliance violations report
{{< history >}}
- Target branch search [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358414) in GitLab 16.0.
{{< /history >}}
Prerequisites:
- You must be an administrator or have the Owner role for the project or group.
To view the static compliance violations report:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Secure > Compliance center**.
You can sort the compliance report on:
- Severity level.
- Type of violation.
- Merge request title.
You can filter the compliance violations report on:
- The project that the violation was found on.
- The date range of violation.
- The target branch of the violation.
Select a row to see details of the compliance violation.
### Severity levels
Each compliance violation has one of the following severities.
<!-- vale gitlab_base.SubstitutionWarning = NO -->
| Icon | Severity level |
|:------------------------|:---------------|
| {{< icon name="severity-critical" >}} | Critical |
| {{< icon name="severity-high" >}} | High |
| {{< icon name="severity-medium" >}} | Medium |
| {{< icon name="severity-low" >}} | Low |
| {{< icon name="severity-info" >}} | Info |
<!-- vale gitlab_base.SubstitutionWarning = YES -->
### Violation types
From [GitLab 14.10](https://gitlab.com/groups/gitlab-org/-/epics/6870), these are the available compliance violations.
| Violation | Severity level | Category | Description |
|:----------------------------------|:---------------|:----------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Author approved merge request | High | [Separation of duties](#separation-of-duties) | Author of the merge request approved their own merge request. For more information, see [Prevent approval by author](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author). |
| Committers approved merge request | High | [Separation of duties](#separation-of-duties) | Committers of the merge request approved the merge request they contributed to. For more information, see [Prevent approvals by users who add commits](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits). |
| Fewer than two approvals | High | [Separation of duties](#separation-of-duties) | Merge request was merged with fewer than two approvals. For more information, see [Merge request approval rules](../../project/merge_requests/approvals/rules.md). |
#### Separation of duties
GitLab supports a separation of duties policy between users who create and approve merge requests. Our criteria for the
separation of duties is:
- [A merge request author is **not** allowed to approve their merge request](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author).
- [A merge request committer is **not** allowed to approve a merge request they have added commits to](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits).
- [The minimum number of approvals required to merge a merge request is **at least** two](../../project/merge_requests/approvals/rules.md).
### Export a report of merge request compliance violations on projects in a group
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/356791) in GitLab 16.4 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_violation_csv_export`. Disabled by default.
- [Enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/424447) in GitLab 16.5.
- [Feature flag `compliance_violation_csv_export`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/142568) removed in GitLab 16.9.
{{< /history >}}
Export a report of merge request compliance violations on merge requests belonging to projects in a group. Reports:
- Do not use filters on the violations report.
- Are truncated at 15 MB so the email attachment is not too large.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export a report of merge request compliance violations for projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export violations report**.
A report is compiled and delivered to your email inbox as an attachment.
|
https://docs.gitlab.com/user/compliance/compliance_standards_adherence_dashboard
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance/compliance_standards_adherence_dashboard.md
|
2025-08-13
|
doc/user/compliance/compliance_center
|
[
"doc",
"user",
"compliance",
"compliance_center"
] |
compliance_standards_adherence_dashboard.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Compliance standards adherence dashboard (deprecated)
| null |
<!--- start_remove The following content will be removed on remove_date: '2026-02-01' -->
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/470834) in GitLab 17.11
and is planned for removal in 18.6. Use the [compliance status report](compliance_status_report.md) instead.
{{< /alert >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125875) GraphQL APIs in GitLab 16.2 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_adherence_report`. Disabled by default.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125444) compliance standards adherence dashboard in GitLab 16.3 [with a flag](../../../administration/feature_flags/_index.md) named `adherence_report_ui`. Disabled by default.
- [Enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/414495) in GitLab 16.5.
- [Feature flag `compliance_adherence_report` and `adherence_report_ui`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137398) removed in GitLab 16.7.
- Standards adherence filtering [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413734) in GitLab 16.7.
- Standards adherence grouping [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413735) in GitLab 16.9.
- Standards adherence grouping by standards that a check belongs to and grouping by projects that a check belongs to [added](https://gitlab.com/gitlab-org/gitlab/-/issues/413735) in GitLab 16.10.
- **Last Scanned** column [renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/439545) to **Date since last status change** in GitLab 16.10.
- DAST scanner check [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/440721) to GitLab Standard in GitLab 17.6.
- SAST scanner check [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/440722) to GitLab Standard in GitLab 17.6.
{{< /history >}}
The compliance standards adherence dashboard lists the adherence status of projects complying to the _GitLab standard_.
When a project is added, or an associated project or group setting is changed, an adherence scan is run on that project to update the standards adherence for that project.
The field in the **Date since last status change** column reflects the date of the initial status and any subsequent changes to the status.
## View the compliance standards adherence dashboard
Prerequisites:
- You must be an administrator or have the Owner role for the project or group.
To view the compliance standards adherence dashboard:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Secure > Compliance center**.
You can filter the compliance standards adherence dashboard on:
- The project that the check was performed on.
- The type of check that was performed on a project.
- The standard that the check belongs to.
You can group the compliance standards adherence dashboard on:
- The project that the check was performed on.
- The type of check that was performed on a project.
- The standard that the check belongs to.
## GitLab standard
The GitLab standard consists of the following rules:
- Prevent authors as approvers.
- Prevent committers as approvers.
- At least two approvals.
- Static Application Security Testing (SAST) scanner artifact.
- Dynamic Application Security Testing (DAST) scanner artifact.
### Prevent authors as approvers
To comply with the GitLab standard, you must prevent users from approving their own merge requests. For more information,
see [Prevent approval by author](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author).
On GitLab Self-Managed, when instance-level setting for [prevent approval by author](../../../administration/merge_requests_approvals.md)
is updated, the adherence status for all the projects on the instance is not updated automatically.
To update the adherence status for these projects, the group-level or the project-level setting must be updated.
### Prevent committers as approvers
To comply with the GitLab standard, you must prevent users from approving merge requests where they've added commits. For
more information, see [Prevent approvals by users who add commits](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits).
On GitLab Self-Managed, when instance-level setting for [prevent approvals by users who add commits](../../../administration/merge_requests_approvals.md)
is updated, the adherence status for all the projects on the instance is not updated automatically.
To update the adherence status for these projects, the group-level or the project-level setting must be updated.
### At least two approvals
To comply with the GitLab standard, you must have at least two users approve a merge request to get it merged. For more
information, see [Merge request approval rules](../../project/merge_requests/approvals/rules.md).
### SAST scanner artifact
To comply with the GitLab standard, you must have the SAST scanner enabled, configured, and producing an artifact in the project's pipeline. For more
information, see [Static Application Security Testing (SAST)](../../application_security/sast/_index.md).
### DAST scanner artifact
To comply with the GitLab standard, you must have the DAST scanner enabled, configured, and producing an artifact in the project's pipeline. For more
information, see [DAST on-demand scan](../../application_security/dast/on-demand_scan.md).
## SOC 2 standard
{{< history >}}
- At least one non-author approval SOC 2 check [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/433201) in GitLab 16.10.
{{< /history >}}
The SOC 2 standard consists of one rule:
- At least one non-author approval.
### At least one non-author approval
To comply with the SOC 2 standard, you must:
- Prevent users from approving their own merge requests. For more information, see
[Prevent approval by author](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author).
- Prevent users from approving merge requests where they've added commits, see
[Prevent approvals by users who add commits](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits).
- At least one approval is required, see [Merge request approval rules](../../project/merge_requests/approvals/rules.md).
These settings are available for an entire instance. However, when these settings are updated at the instance level,
the adherence status for all the projects on the instance is not updated automatically. To update the adherence status
for these projects, you must update the group-level or project-level setting. For more information on the instance-level settings, see:
- [Prevent approval by author](../../../administration/merge_requests_approvals.md).
- [Prevent approvals by users who add commits](../../../administration/merge_requests_approvals.md).
## Export compliance standards adherence report for projects in a group
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413736) in GitLab 16.8 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_standards_adherence_csv_export`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/142568) in GitLab 16.9. Feature flag `compliance_standards_adherence_csv_export` removed.
{{< /history >}}
Exports the contents of a standards adherence report for projects in a group. Reports are truncated at 15 MB to avoid a large email attachment.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export the compliance standards adherence report for projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export standards adherence report**.
A report is compiled and delivered to your email inbox as an attachment.
<!--- end_remove -->
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Compliance standards adherence dashboard (deprecated)
breadcrumbs:
- doc
- user
- compliance
- compliance_center
---
<!--- start_remove The following content will be removed on remove_date: '2026-02-01' -->
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/470834) in GitLab 17.11
and is planned for removal in 18.6. Use the [compliance status report](compliance_status_report.md) instead.
{{< /alert >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125875) GraphQL APIs in GitLab 16.2 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_adherence_report`. Disabled by default.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125444) compliance standards adherence dashboard in GitLab 16.3 [with a flag](../../../administration/feature_flags/_index.md) named `adherence_report_ui`. Disabled by default.
- [Enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/414495) in GitLab 16.5.
- [Feature flag `compliance_adherence_report` and `adherence_report_ui`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137398) removed in GitLab 16.7.
- Standards adherence filtering [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413734) in GitLab 16.7.
- Standards adherence grouping [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413735) in GitLab 16.9.
- Standards adherence grouping by standards that a check belongs to and grouping by projects that a check belongs to [added](https://gitlab.com/gitlab-org/gitlab/-/issues/413735) in GitLab 16.10.
- **Last Scanned** column [renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/439545) to **Date since last status change** in GitLab 16.10.
- DAST scanner check [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/440721) to GitLab Standard in GitLab 17.6.
- SAST scanner check [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/440722) to GitLab Standard in GitLab 17.6.
{{< /history >}}
The compliance standards adherence dashboard lists the adherence status of projects complying to the _GitLab standard_.
When a project is added, or an associated project or group setting is changed, an adherence scan is run on that project to update the standards adherence for that project.
The field in the **Date since last status change** column reflects the date of the initial status and any subsequent changes to the status.
## View the compliance standards adherence dashboard
Prerequisites:
- You must be an administrator or have the Owner role for the project or group.
To view the compliance standards adherence dashboard:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Secure > Compliance center**.
You can filter the compliance standards adherence dashboard on:
- The project that the check was performed on.
- The type of check that was performed on a project.
- The standard that the check belongs to.
You can group the compliance standards adherence dashboard on:
- The project that the check was performed on.
- The type of check that was performed on a project.
- The standard that the check belongs to.
## GitLab standard
The GitLab standard consists of the following rules:
- Prevent authors as approvers.
- Prevent committers as approvers.
- At least two approvals.
- Static Application Security Testing (SAST) scanner artifact.
- Dynamic Application Security Testing (DAST) scanner artifact.
### Prevent authors as approvers
To comply with the GitLab standard, you must prevent users from approving their own merge requests. For more information,
see [Prevent approval by author](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author).
On GitLab Self-Managed, when instance-level setting for [prevent approval by author](../../../administration/merge_requests_approvals.md)
is updated, the adherence status for all the projects on the instance is not updated automatically.
To update the adherence status for these projects, the group-level or the project-level setting must be updated.
### Prevent committers as approvers
To comply with the GitLab standard, you must prevent users from approving merge requests where they've added commits. For
more information, see [Prevent approvals by users who add commits](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits).
On GitLab Self-Managed, when instance-level setting for [prevent approvals by users who add commits](../../../administration/merge_requests_approvals.md)
is updated, the adherence status for all the projects on the instance is not updated automatically.
To update the adherence status for these projects, the group-level or the project-level setting must be updated.
### At least two approvals
To comply with the GitLab standard, you must have at least two users approve a merge request to get it merged. For more
information, see [Merge request approval rules](../../project/merge_requests/approvals/rules.md).
### SAST scanner artifact
To comply with the GitLab standard, you must have the SAST scanner enabled, configured, and producing an artifact in the project's pipeline. For more
information, see [Static Application Security Testing (SAST)](../../application_security/sast/_index.md).
### DAST scanner artifact
To comply with the GitLab standard, you must have the DAST scanner enabled, configured, and producing an artifact in the project's pipeline. For more
information, see [DAST on-demand scan](../../application_security/dast/on-demand_scan.md).
## SOC 2 standard
{{< history >}}
- At least one non-author approval SOC 2 check [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/433201) in GitLab 16.10.
{{< /history >}}
The SOC 2 standard consists of one rule:
- At least one non-author approval.
### At least one non-author approval
To comply with the SOC 2 standard, you must:
- Prevent users from approving their own merge requests. For more information, see
[Prevent approval by author](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author).
- Prevent users from approving merge requests where they've added commits, see
[Prevent approvals by users who add commits](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits).
- At least one approval is required, see [Merge request approval rules](../../project/merge_requests/approvals/rules.md).
These settings are available for an entire instance. However, when these settings are updated at the instance level,
the adherence status for all the projects on the instance is not updated automatically. To update the adherence status
for these projects, you must update the group-level or project-level setting. For more information on the instance-level settings, see:
- [Prevent approval by author](../../../administration/merge_requests_approvals.md).
- [Prevent approvals by users who add commits](../../../administration/merge_requests_approvals.md).
## Export compliance standards adherence report for projects in a group
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413736) in GitLab 16.8 [with a flag](../../../administration/feature_flags/_index.md) named `compliance_standards_adherence_csv_export`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/142568) in GitLab 16.9. Feature flag `compliance_standards_adherence_csv_export` removed.
{{< /history >}}
Exports the contents of a standards adherence report for projects in a group. Reports are truncated at 15 MB to avoid a large email attachment.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export the compliance standards adherence report for projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export standards adherence report**.
A report is compiled and delivered to your email inbox as an attachment.
<!--- end_remove -->
|
https://docs.gitlab.com/user/compliance/compliance_center
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance/_index.md
|
2025-08-13
|
doc/user/compliance/compliance_center
|
[
"doc",
"user",
"compliance",
"compliance_center"
] |
_index.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Compliance center
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122931) from Compliance report in GitLab 16.3.
- [Available at project level](https://gitlab.com/gitlab-org/gitlab/-/issues/441350) in GitLab 17.5.
{{< /history >}}
The compliance center is the central location for compliance teams to manage their compliance standards adherence reporting, violations reporting, and compliance frameworks for their group.
The compliance center comprises the:
- [Compliance overview dashboard](compliance_overview_dashboard.md).
- [Compliance status report](compliance_status_report.md).
- [Compliance standards adherence dashboard](compliance_standards_adherence_dashboard.md).
- [Compliance violations report](compliance_violations_report.md).
- [Compliance frameworks report](compliance_frameworks_report.md).
- [Compliance projects report](compliance_projects_report.md).
For more information on other GitLab compliance features for projects, groups, and instances, see
[Compliance features](../../../administration/compliance/compliance_features.md).
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Compliance center
breadcrumbs:
- doc
- user
- compliance
- compliance_center
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122931) from Compliance report in GitLab 16.3.
- [Available at project level](https://gitlab.com/gitlab-org/gitlab/-/issues/441350) in GitLab 17.5.
{{< /history >}}
The compliance center is the central location for compliance teams to manage their compliance standards adherence reporting, violations reporting, and compliance frameworks for their group.
The compliance center comprises the:
- [Compliance overview dashboard](compliance_overview_dashboard.md).
- [Compliance status report](compliance_status_report.md).
- [Compliance standards adherence dashboard](compliance_standards_adherence_dashboard.md).
- [Compliance violations report](compliance_violations_report.md).
- [Compliance frameworks report](compliance_frameworks_report.md).
- [Compliance projects report](compliance_projects_report.md).
For more information on other GitLab compliance features for projects, groups, and instances, see
[Compliance features](../../../administration/compliance/compliance_features.md).
|
https://docs.gitlab.com/user/compliance/compliance_overview_dashboard
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance/compliance_overview_dashboard.md
|
2025-08-13
|
doc/user/compliance/compliance_center
|
[
"doc",
"user",
"compliance",
"compliance_center"
] |
compliance_overview_dashboard.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Compliance overview dashboard
| null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13909) in GitLab 18.2 with a flag named `compliance_group_dashboard`. Enabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/555804) in GitLab 18.3. Feature flag `compliance_group_dashboard` removed.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.
{{< /alert >}}
The compliance overview dashboard provides visual insights into your group's compliance posture through interactive
charts and metrics. It helps you quickly identify areas that need attention and track your overall compliance status.
The compliance overview dashboard displays four key areas of compliance monitoring:
- Compliance framework coverage.
- Failed requirements status.
- Failed controls status.
- Compliance frameworks that need attention.
## View the compliance overview dashboard
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To view the compliance overview dashboard:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. Select **Overview** to view the compliance dashboard.
## Compliance framework coverage
The framework coverage section provides an overview of how many projects in your group have compliance frameworks
assigned.
The framework coverage section displays:
- **Total projects**: The total number of projects in your group.
- **Covered projects**: Number of projects with at least one compliance framework assigned.
- **Coverage percentage**: Visual representation of framework coverage across your projects.
Below the summary metrics, you can see individual framework coverage including:
- Framework name with visual badge.
- Number of projects using each framework.
- Percentage of total projects covered by each framework.
## Failed requirements chart
The failed requirements chart visualizes the compliance status of requirements across your frameworks.
The failed requirements chart displays three categories:
- **Passed**: Requirements that are fully compliant (shown in blue).
- **Pending**: Requirements under review (shown in orange).
- **Failed**: Requirements not meeting compliance standards (shown in magenta).
## Failed controls chart
The failed controls chart provides a visual representation of control compliance status across your organization.
The failed controls chart displays three categories:
- **Passed**: Controls that meet compliance requirements (shown in blue).
- **Pending**: Controls awaiting evaluation (shown in orange).
- **Failed**: Controls that don't meet compliance requirements (shown in magenta).
## Frameworks table
The frameworks table highlights compliance frameworks that require immediate attention. This view helps you identify
frameworks with configuration issues or missing components.
The frameworks table displays:
- **Framework name**: The compliance framework with a visual badge.
- **Projects**: Number of projects using this framework (highlighted in red if zero).
- **Requirements**: Total number of requirements in the framework (highlighted in red if zero).
- **Requirements without controls**: Lists specific requirements that don't have associated controls.
- **Policies**: Security policies linked to the framework, including:
- Scan execution policies.
- Vulnerability management policies.
- Scan result policies.
- Pipeline execution policies.
- **Actions**: Edit framework button (visible to users with admin permissions).
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Compliance overview dashboard
breadcrumbs:
- doc
- user
- compliance
- compliance_center
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/13909) in GitLab 18.2 with a flag named `compliance_group_dashboard`. Enabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/555804) in GitLab 18.3. Feature flag `compliance_group_dashboard` removed.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.
{{< /alert >}}
The compliance overview dashboard provides visual insights into your group's compliance posture through interactive
charts and metrics. It helps you quickly identify areas that need attention and track your overall compliance status.
The compliance overview dashboard displays four key areas of compliance monitoring:
- Compliance framework coverage.
- Failed requirements status.
- Failed controls status.
- Compliance frameworks that need attention.
## View the compliance overview dashboard
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To view the compliance overview dashboard:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. Select **Overview** to view the compliance dashboard.
## Compliance framework coverage
The framework coverage section provides an overview of how many projects in your group have compliance frameworks
assigned.
The framework coverage section displays:
- **Total projects**: The total number of projects in your group.
- **Covered projects**: Number of projects with at least one compliance framework assigned.
- **Coverage percentage**: Visual representation of framework coverage across your projects.
Below the summary metrics, you can see individual framework coverage including:
- Framework name with visual badge.
- Number of projects using each framework.
- Percentage of total projects covered by each framework.
## Failed requirements chart
The failed requirements chart visualizes the compliance status of requirements across your frameworks.
The failed requirements chart displays three categories:
- **Passed**: Requirements that are fully compliant (shown in blue).
- **Pending**: Requirements under review (shown in orange).
- **Failed**: Requirements not meeting compliance standards (shown in magenta).
## Failed controls chart
The failed controls chart provides a visual representation of control compliance status across your organization.
The failed controls chart displays three categories:
- **Passed**: Controls that meet compliance requirements (shown in blue).
- **Pending**: Controls awaiting evaluation (shown in orange).
- **Failed**: Controls that don't meet compliance requirements (shown in magenta).
## Frameworks table
The frameworks table highlights compliance frameworks that require immediate attention. This view helps you identify
frameworks with configuration issues or missing components.
The frameworks table displays:
- **Framework name**: The compliance framework with a visual badge.
- **Projects**: Number of projects using this framework (highlighted in red if zero).
- **Requirements**: Total number of requirements in the framework (highlighted in red if zero).
- **Requirements without controls**: Lists specific requirements that don't have associated controls.
- **Policies**: Security policies linked to the framework, including:
- Scan execution policies.
- Vulnerability management policies.
- Scan result policies.
- Pipeline execution policies.
- **Actions**: Edit framework button (visible to users with admin permissions).
|
https://docs.gitlab.com/user/compliance/compliance_chain_of_custody_report
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance/compliance_chain_of_custody_report.md
|
2025-08-13
|
doc/user/compliance/compliance_center
|
[
"doc",
"user",
"compliance",
"compliance_center"
] |
compliance_chain_of_custody_report.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Chain of Custody report
| null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213364) in GitLab 13.3.
- Chain of Custody reports sent using email [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342594) in GitLab 15.3 with a flag named `async_chain_of_custody_report`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/370100) in GitLab 15.5. Feature flag `async_chain_of_custody_report` removed.
- Chain of Custody report includes all commits (instead of just merge commits) [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267601) in GitLab 15.9 with a flag named `all_commits_compliance_report`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112092) in GitLab 15.9. Feature flag `all_commits_compliance_report` removed.
{{< /history >}}
The Chain of Custody report provides a 1 month trailing window of all commits to a project under the group.
To generate the report for all commits, GitLab:
1. Fetches all projects under the group.
1. For each project, fetches the last 1 month of commits. Each project is capped at 1024 commits. If there are more than
1024 commits in the 1-month window, they are truncated.
1. Writes the commits to a CSV file. The file is truncated at 15 MB because the report is emailed as an attachment
(GitLab 15.5 and later).
The report includes:
- Commit SHA.
- Commit author.
- Committer.
- Date committed.
- Group.
- Project.
If the commit has a related merge commit, then the following are also included:
- Merge commit SHA.
- Merge request ID.
- User who merged the merge request.
- Merge date.
- Pipeline ID.
- Merge request approvers.
## Generate Chain of Custody report
To generate the Chain of Custody report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export chain of custody report**.
Depending on your version of GitLab, the Chain of Custody report is either sent through email or available for download.
## Generate commit-specific Chain of Custody report
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267629) in GitLab 13.6.
- Support for including all commits instead of only merge commits [added](https://gitlab.com/gitlab-org/gitlab/-/issues/393446) in GitLab 15.10.
{{< /history >}}
You can generate a commit-specific Chain of Custody report for a given commit SHA. This report provides only the
details for the provided commit SHA.
To generate a commit-specific Chain of Custody report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export custody report of a specific commit**.
1. Enter the commit SHA, and then select **Export custody report**.
Depending on your version of GitLab, the Chain of Custody report is either sent through email or available for download.
Alternatively, use a direct link: `https://gitlab.com/groups/<group-name>/-/security/merge_commit_reports.csv?commit_sha={optional_commit_sha}`,
passing in an optional value to the `commit_sha` query parameter.
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Chain of Custody report
breadcrumbs:
- doc
- user
- compliance
- compliance_center
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213364) in GitLab 13.3.
- Chain of Custody reports sent using email [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342594) in GitLab 15.3 with a flag named `async_chain_of_custody_report`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/370100) in GitLab 15.5. Feature flag `async_chain_of_custody_report` removed.
- Chain of Custody report includes all commits (instead of just merge commits) [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267601) in GitLab 15.9 with a flag named `all_commits_compliance_report`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112092) in GitLab 15.9. Feature flag `all_commits_compliance_report` removed.
{{< /history >}}
The Chain of Custody report provides a 1 month trailing window of all commits to a project under the group.
To generate the report for all commits, GitLab:
1. Fetches all projects under the group.
1. For each project, fetches the last 1 month of commits. Each project is capped at 1024 commits. If there are more than
1024 commits in the 1-month window, they are truncated.
1. Writes the commits to a CSV file. The file is truncated at 15 MB because the report is emailed as an attachment
(GitLab 15.5 and later).
The report includes:
- Commit SHA.
- Commit author.
- Committer.
- Date committed.
- Group.
- Project.
If the commit has a related merge commit, then the following are also included:
- Merge commit SHA.
- Merge request ID.
- User who merged the merge request.
- Merge date.
- Pipeline ID.
- Merge request approvers.
## Generate Chain of Custody report
To generate the Chain of Custody report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export chain of custody report**.
Depending on your version of GitLab, the Chain of Custody report is either sent through email or available for download.
## Generate commit-specific Chain of Custody report
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267629) in GitLab 13.6.
- Support for including all commits instead of only merge commits [added](https://gitlab.com/gitlab-org/gitlab/-/issues/393446) in GitLab 15.10.
{{< /history >}}
You can generate a commit-specific Chain of Custody report for a given commit SHA. This report provides only the
details for the provided commit SHA.
To generate a commit-specific Chain of Custody report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export custody report of a specific commit**.
1. Enter the commit SHA, and then select **Export custody report**.
Depending on your version of GitLab, the Chain of Custody report is either sent through email or available for download.
Alternatively, use a direct link: `https://gitlab.com/groups/<group-name>/-/security/merge_commit_reports.csv?commit_sha={optional_commit_sha}`,
passing in an optional value to the `commit_sha` query parameter.
|
https://docs.gitlab.com/user/compliance/compliance_status_report
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance/compliance_status_report.md
|
2025-08-13
|
doc/user/compliance/compliance_center
|
[
"doc",
"user",
"compliance",
"compliance_center"
] |
compliance_status_report.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Compliance status report
| null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/186525) in GitLab 17.11 [with a flag](../../../administration/feature_flags/_index.md) named `enable_standards_adherence_dashboard_v2`. Enabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/535563) in GitLab 18.3. Feature flag `enable_standards_adherence_dashboard_v2` removed.
{{< /history >}}
The compliance status report displays the most recent instances where projects do not adhere to [compliance framework requirements](../compliance_frameworks/_index.md#requirements). It is part of the
Compliance Center, and helps you quickly identify and remediate gaps in control implementation across your projects.
## Scan timing and triggers
Compliance scans that update the status report are automatically triggered in the following situations:
- A framework is added to a project.
- The requirements of an associated framework are modified.
- A scheduled scan runs (every 12 hours).
After a scan is triggered, results can take 5 to 10 minutes to appear in the compliance status report.
To learn more about how requirements and controls are defined in a compliance framework, see [Create and manage compliance framework requirements](../compliance_frameworks/_index.md#add-requirements).
## View the compliance status report
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To view the compliance status report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the **Compliance reports** section, select **Compliance status report**.
## Report details
The compliance status report shows the latest instance where a project is **adhering or not adhering** to a framework control. Each row provides details
about the current status of a control in a specific project, helping you monitor compliance across your group.
You can:
- Filter the report by **project**, **framework**, or **control**.
- Navigate directly to a project's compliance detail view.
- Review when the non-adherence was first detected.
The compliance status report has the following columns:
- **Project**: The project with non-adherence.
- **Framework**: The compliance framework the control belongs to (for example, GitLab or SOC 2).
- **Control**: The specific control the project is not adhering to (for example, "At least two approvals").
- **Detected on**: The date and time the non-adherence was first recorded.
- **More info**: A link to additional context or related settings for the project.
## Export compliance status report
Export the contents of a status report for projects in a group. Reports are truncated at 15 MB to avoid a large email attachment.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export the compliance status report for projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export compliance status report**.
A report is compiled and delivered to your email inbox as an attachment.
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Compliance status report
breadcrumbs:
- doc
- user
- compliance
- compliance_center
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/186525) in GitLab 17.11 [with a flag](../../../administration/feature_flags/_index.md) named `enable_standards_adherence_dashboard_v2`. Enabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/535563) in GitLab 18.3. Feature flag `enable_standards_adherence_dashboard_v2` removed.
{{< /history >}}
The compliance status report displays the most recent instances where projects do not adhere to [compliance framework requirements](../compliance_frameworks/_index.md#requirements). It is part of the
Compliance Center, and helps you quickly identify and remediate gaps in control implementation across your projects.
## Scan timing and triggers
Compliance scans that update the status report are automatically triggered in the following situations:
- A framework is added to a project.
- The requirements of an associated framework are modified.
- A scheduled scan runs (every 12 hours).
After a scan is triggered, results can take 5 to 10 minutes to appear in the compliance status report.
To learn more about how requirements and controls are defined in a compliance framework, see [Create and manage compliance framework requirements](../compliance_frameworks/_index.md#add-requirements).
## View the compliance status report
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To view the compliance status report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the **Compliance reports** section, select **Compliance status report**.
## Report details
The compliance status report shows the latest instance where a project is **adhering or not adhering** to a framework control. Each row provides details
about the current status of a control in a specific project, helping you monitor compliance across your group.
You can:
- Filter the report by **project**, **framework**, or **control**.
- Navigate directly to a project's compliance detail view.
- Review when the non-adherence was first detected.
The compliance status report has the following columns:
- **Project**: The project with non-adherence.
- **Framework**: The compliance framework the control belongs to (for example, GitLab or SOC 2).
- **Control**: The specific control the project is not adhering to (for example, "At least two approvals").
- **Detected on**: The date and time the non-adherence was first recorded.
- **More info**: A link to additional context or related settings for the project.
## Export compliance status report
Export the contents of a status report for projects in a group. Reports are truncated at 15 MB to avoid a large email attachment.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export the compliance status report for projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export compliance status report**.
A report is compiled and delivered to your email inbox as an attachment.
|
https://docs.gitlab.com/user/compliance/compliance_projects_report
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/compliance/compliance_projects_report.md
|
2025-08-13
|
doc/user/compliance/compliance_center
|
[
"doc",
"user",
"compliance",
"compliance_center"
] |
compliance_projects_report.md
|
Software Supply Chain Security
|
Compliance
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Compliance projects report
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387910) in GitLab 15.10.
- [Renamed from **compliance frameworks report**](https://gitlab.com/gitlab-org/gitlab/-/issues/422963) in GitLab 16.5.
{{< /history >}}
With the compliance projects report, you can see the compliance frameworks that are applied to projects in a group, subgroup, or project.
Each row of the report shows:
- Project name.
- Project path.
- Compliance framework labels if the project has one or more assigned.
The default framework for the group has a **default** badge.
## View the compliance projects report
Prerequisites:
- You must be an administrator or have the Owner role for the project or group.
To view the compliance projects report:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
## Apply a compliance framework to projects in a group
{{< history >}}
- Adding compliance frameworks using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383209) in GitLab 15.11.
- Adding compliance frameworks without using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394795) in GitLab 16.0.
- Ability to add compliance frameworks to subgroups [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/469004) in GitLab 17.2.
- Ability to add compliance frameworks to projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/507986) in GitLab 17.9.
{{< /history >}}
You can apply one or more compliance frameworks to projects in a group, subgroup, or project.
Prerequisites:
- You must have the Owner role for the group.
To apply a compliance framework to one project in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Next to the project you want to add the compliance framework to, select {{< icon name="pencil" >}} action.
1. Select one or more existing compliance frameworks or create a new one.
To apply a compliance framework to multiple projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Select multiple projects.
1. From the **Choose one bulk action** dropdown list, select **Apply framework to selected projects**.
1. Select framework to apply.
1. Select **Apply**.
## Remove a compliance framework from projects in a group
{{< history >}}
- Removing compliance frameworks using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383209) in GitLab 15.11.
- Removing compliance frameworks without using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394795) in GitLab 16.0.
- Ability to remove compliance frameworks from subgroups [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/469004) in GitLab 17.2.
- Ability to remove compliance frameworks from projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/507986) in GitLab 17.9.
{{< /history >}}
You can remove a compliance framework from projects in a group, subgroup, or project.
Prerequisites:
- You must have the Owner role for the group.
To remove a compliance framework from one project in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Next to the compliance framework to remove from the project, select {{< icon name="close" >}} on the framework label.
To remove a compliance framework from multiple projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Select multiple projects.
1. From the **Choose one bulk action** dropdown list, select **Remove framework from selected projects**.
1. Select **Remove**.
## Export a report of compliance frameworks on projects in a group
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387912) in GitLab 16.0.
{{< /history >}}
Export a report of compliance frameworks that are applied to projects in a group. Reports:
- Do not use filters on the framework report.
- Are truncated at 15 MB so the email attachment too large.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export a report of compliance frameworks on projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export list of project frameworks**.
A report is compiled and delivered to your email inbox as an attachment.
## Filter the compliance projects report
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387911) in GitLab 15.11.
{{< /history >}}
To filter the list of compliance frameworks:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. In the search field:
1. Select the attribute you want to filter by.
1. Select an operator.
1. Select from the list of options or enter text for the search.
1. Select **Search**.
Repeat this process to filter by multiple attributes.
## Create a new compliance framework
You can create new compliance frameworks on top-level groups.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To create a new compliance framework from the compliance projects report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Select the **+ Add framework**.
1. Select the **Create a new framework**.
1. Select the **Add framework** to create compliance framework.
## Edit a compliance framework
You can edit compliance frameworks on top-level groups.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To edit a compliance framework from the compliance projects report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Hover over framework and select **Edit the framework**.
1. Select the **Save changes** to edit compliance framework.
## Delete a compliance framework
You can delete compliance frameworks from top-level groups.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To delete a compliance framework from the compliance projects report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Hover over framework and select **Edit the framework**.
1. Select the **Delete framework** to delete compliance framework.
|
---
stage: Software Supply Chain Security
group: Compliance
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Compliance projects report
breadcrumbs:
- doc
- user
- compliance
- compliance_center
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387910) in GitLab 15.10.
- [Renamed from **compliance frameworks report**](https://gitlab.com/gitlab-org/gitlab/-/issues/422963) in GitLab 16.5.
{{< /history >}}
With the compliance projects report, you can see the compliance frameworks that are applied to projects in a group, subgroup, or project.
Each row of the report shows:
- Project name.
- Project path.
- Compliance framework labels if the project has one or more assigned.
The default framework for the group has a **default** badge.
## View the compliance projects report
Prerequisites:
- You must be an administrator or have the Owner role for the project or group.
To view the compliance projects report:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
## Apply a compliance framework to projects in a group
{{< history >}}
- Adding compliance frameworks using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383209) in GitLab 15.11.
- Adding compliance frameworks without using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394795) in GitLab 16.0.
- Ability to add compliance frameworks to subgroups [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/469004) in GitLab 17.2.
- Ability to add compliance frameworks to projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/507986) in GitLab 17.9.
{{< /history >}}
You can apply one or more compliance frameworks to projects in a group, subgroup, or project.
Prerequisites:
- You must have the Owner role for the group.
To apply a compliance framework to one project in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Next to the project you want to add the compliance framework to, select {{< icon name="pencil" >}} action.
1. Select one or more existing compliance frameworks or create a new one.
To apply a compliance framework to multiple projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Select multiple projects.
1. From the **Choose one bulk action** dropdown list, select **Apply framework to selected projects**.
1. Select framework to apply.
1. Select **Apply**.
## Remove a compliance framework from projects in a group
{{< history >}}
- Removing compliance frameworks using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383209) in GitLab 15.11.
- Removing compliance frameworks without using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394795) in GitLab 16.0.
- Ability to remove compliance frameworks from subgroups [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/469004) in GitLab 17.2.
- Ability to remove compliance frameworks from projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/507986) in GitLab 17.9.
{{< /history >}}
You can remove a compliance framework from projects in a group, subgroup, or project.
Prerequisites:
- You must have the Owner role for the group.
To remove a compliance framework from one project in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Next to the compliance framework to remove from the project, select {{< icon name="close" >}} on the framework label.
To remove a compliance framework from multiple projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Select multiple projects.
1. From the **Choose one bulk action** dropdown list, select **Remove framework from selected projects**.
1. Select **Remove**.
## Export a report of compliance frameworks on projects in a group
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387912) in GitLab 16.0.
{{< /history >}}
Export a report of compliance frameworks that are applied to projects in a group. Reports:
- Do not use filters on the framework report.
- Are truncated at 15 MB so the email attachment too large.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To export a report of compliance frameworks on projects in a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. In the top-right corner, select **Export**.
1. Select **Export list of project frameworks**.
A report is compiled and delivered to your email inbox as an attachment.
## Filter the compliance projects report
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387911) in GitLab 15.11.
{{< /history >}}
To filter the list of compliance frameworks:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. In the search field:
1. Select the attribute you want to filter by.
1. Select an operator.
1. Select from the list of options or enter text for the search.
1. Select **Search**.
Repeat this process to filter by multiple attributes.
## Create a new compliance framework
You can create new compliance frameworks on top-level groups.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To create a new compliance framework from the compliance projects report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Select the **+ Add framework**.
1. Select the **Create a new framework**.
1. Select the **Add framework** to create compliance framework.
## Edit a compliance framework
You can edit compliance frameworks on top-level groups.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To edit a compliance framework from the compliance projects report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Hover over framework and select **Edit the framework**.
1. Select the **Save changes** to edit compliance framework.
## Delete a compliance framework
You can delete compliance frameworks from top-level groups.
Prerequisites:
- You must be an administrator or have the Owner role for the group.
To delete a compliance framework from the compliance projects report:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Secure > Compliance center**.
1. On the page, select the **Projects** tab.
1. Hover over framework and select **Edit the framework**.
1. Select the **Delete framework** to delete compliance framework.
|
https://docs.gitlab.com/user/ai_impact_analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/ai_impact_analytics.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
ai_impact_analytics.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
AI impact analytics
| null |
{{< details >}}
- Tier: Ultimate
- Add-on: GitLab Duo Enterprise, GitLab Duo with Amazon Q
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/443696) in GitLab 16.11 [with a flag](../../administration/feature_flags/_index.md) named `ai_impact_analytics_dashboard`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/451873) in GitLab 17.2. Feature flag `ai_impact_analytics_dashboard` removed.
- Changed to require GitLab Duo add-on in GitLab 17.6.
- Changed to support Amazon Q in GitLab 18.2.1.
{{< /history >}}
AI impact analytics measure the impact of GitLab Duo on software development lifecycle (SDLC) performance.
This dashboard provides visibility into key SDLC metrics in the context of AI adoption for projects or groups.
You can use the dashboard to measure which metrics have improved from your AI investments.
Use AI impact analytics for:
- Correlation observations: Examine how trends in AI usage in a project or group influence other crucial productivity metrics. AI usage metrics are displayed for the last six months, including the current one.
- Snapshot of GitLab Duo usage: Track the use of seats and features in a project or group over the last 30 days.
To learn how you can optimize your license utilization,
see [GitLab Duo add-ons](../../subscriptions/subscription-add-ons.md).
To learn more about AI impact analytics, see the blog post
[Developing GitLab Duo: AI impact analytics dashboard measures the ROI of AI](https://about.gitlab.com/blog/2024/05/15/developing-gitlab-duo-ai-impact-analytics-dashboard-measures-the-roi-of-ai/).
For a click-through demo, see the [AI impact analytics product tour](https://gitlab.navattic.com/ai-impact).
<i class="fa-youtube-play" aria-hidden="true"></i>
For an overview, see [GitLab Duo AI Impact Dashboard](https://youtu.be/FxSWX64aUOE?si=7Yfc6xHm63c3BRwn).
<!-- Video published on 2025-03-06 -->
## Key metrics
- **Assigned Duo seat engagement**: Percentage of users that are assigned a Duo seat and used at least one AI feature in the last 30 days.
It is calculated as the number of users with Duo seats that use AI features divided by the total number of assigned Duo seats.
- **Code Suggestions: Usage**: Percentage of users that engage with Code Suggestions every month.
It is calculated as the number of monthly unique Code Suggestions users divided by total monthly [unique contributors](../profile/contributions_calendar.md#user-contribution-events).
Only unique code contributors (users with `pushed` events) are included in the calculation.
- **Code Suggestions: Acceptance rate**: Percentage of code suggestions provided by GitLab Duo that have been accepted by code contributors in the last 30 days.
It is calculated as the number of accepted code suggestions divided by the total number of generated code suggestions.
- **Duo Chat: Usage**: Percentage of users that engage with GitLab Duo Chat every month.
It is calculated as the number of monthly unique GitLab Duo Chat users divided by the total GitLab Duo assigned users.
{{< alert type="note" >}}
For tracking Code Suggestions events, GitLab collects data only from code editor extensions.
[Epic 14203](https://gitlab.com/groups/gitlab-org/-/epics/14203) proposes support for the Web IDE as well.
{{< /alert >}}
## Metric trends
The **Metric trends** table displays metrics for the last six months, with monthly values, percentage changes in the past six months, and trend sparklines.
### Lifecycle metrics
- [**Lead time**](../group/value_stream_analytics/_index.md#lifecycle-metrics)
- [**Median time to merge**](merge_request_analytics.md)
- [**Deployment frequency**](dora_metrics.md#deployment-frequency)
- [**Merge request throughput**](merge_request_analytics.md#view-the-number-of-merge-requests-in-a-date-range)
- [**Critical vulnerabilities over time**](../application_security/vulnerability_report/_index.md)
- [**Contributor count**](../profile/contributions_calendar.md#user-contribution-events)
### AI usage metrics
**Code Suggestions: Usage**: Monthly user engagement with AI Code Suggestions.
On GitLab.com, data updates every fives minutes.
GitLab counts Code Suggestions usage only if the user has pushed code to the project in the current month.
The month-over-month comparison of the AI Usage unique users rate gives a more accurate indication Code Suggestion usage,
because it eliminates factors such as developer experience level and project type or complexity.
The baseline for the AI Usage trend is the total number of code contributors, not only users with GitLab Duo seats.
This baseline gives a more accurate representation of AI usage by team members.
To analyze the performance of teams that use AI versus teams that don't, you can create a custom
[Value Streams Dashboard Scheduled Report](https://gitlab.com/explore/catalog/components/vsd-reports-generator)
based on the AI impact view of projects and groups with and without GitLab Duo.
{{< alert type="note" >}}
Usage rate for Code Suggestions is calculated with data starting from GitLab 16.11.
For more information, see [epic 12978](https://gitlab.com/groups/gitlab-org/-/epics/12978).
{{< /alert >}}
**Duo RCA: Usage**: Monthly user engagement with Duo Root Cause Analysis.
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/513252) in GitLab 18.1 [with a flag](../../administration/feature_flags/_index.md) named `duo_rca_usage_rate`. Disabled by default.
- [Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated](https://gitlab.com/gitlab-org/gitlab/-/issues/543987) in GitLab 18.3.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
This metric tracks the percentage of Duo users who select [**Troubleshoot** to analyze failed CI/CD jobs](../gitlab_duo_chat/examples.md#from-a-merge-request).
{{< alert type="note" >}}
Usage rate for Duo RCA is calculated with data starting from GitLab 18.0.
For more information, see [epic 15025](https://gitlab.com/groups/gitlab-org/-/epics/15025).
{{< /alert >}}
## View AI impact analytics
Prerequisites:
- [Code Suggestions](../project/repository/code_suggestions/_index.md) must be enabled.
- For GitLab Self-Managed, [ClickHouse for contribution analytics](../group/contribution_analytics/_index.md#contribution-analytics-with-clickhouse) must be configured.
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Analytics Dashboards**.
1. Select **AI impact analytics**.
To retrieve AI impact metrics, you can also use the `AiMetrics`, `AiUserMetrics`, and `AiUsageData` [GraphQL APIs](../../api/graphql/reference/_index.md).
For an overview and sample queries, see [issue 512931](https://gitlab.com/gitlab-org/gitlab/-/issues/512931).
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: AI impact analytics
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Ultimate
- Add-on: GitLab Duo Enterprise, GitLab Duo with Amazon Q
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/443696) in GitLab 16.11 [with a flag](../../administration/feature_flags/_index.md) named `ai_impact_analytics_dashboard`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/451873) in GitLab 17.2. Feature flag `ai_impact_analytics_dashboard` removed.
- Changed to require GitLab Duo add-on in GitLab 17.6.
- Changed to support Amazon Q in GitLab 18.2.1.
{{< /history >}}
AI impact analytics measure the impact of GitLab Duo on software development lifecycle (SDLC) performance.
This dashboard provides visibility into key SDLC metrics in the context of AI adoption for projects or groups.
You can use the dashboard to measure which metrics have improved from your AI investments.
Use AI impact analytics for:
- Correlation observations: Examine how trends in AI usage in a project or group influence other crucial productivity metrics. AI usage metrics are displayed for the last six months, including the current one.
- Snapshot of GitLab Duo usage: Track the use of seats and features in a project or group over the last 30 days.
To learn how you can optimize your license utilization,
see [GitLab Duo add-ons](../../subscriptions/subscription-add-ons.md).
To learn more about AI impact analytics, see the blog post
[Developing GitLab Duo: AI impact analytics dashboard measures the ROI of AI](https://about.gitlab.com/blog/2024/05/15/developing-gitlab-duo-ai-impact-analytics-dashboard-measures-the-roi-of-ai/).
For a click-through demo, see the [AI impact analytics product tour](https://gitlab.navattic.com/ai-impact).
<i class="fa-youtube-play" aria-hidden="true"></i>
For an overview, see [GitLab Duo AI Impact Dashboard](https://youtu.be/FxSWX64aUOE?si=7Yfc6xHm63c3BRwn).
<!-- Video published on 2025-03-06 -->
## Key metrics
- **Assigned Duo seat engagement**: Percentage of users that are assigned a Duo seat and used at least one AI feature in the last 30 days.
It is calculated as the number of users with Duo seats that use AI features divided by the total number of assigned Duo seats.
- **Code Suggestions: Usage**: Percentage of users that engage with Code Suggestions every month.
It is calculated as the number of monthly unique Code Suggestions users divided by total monthly [unique contributors](../profile/contributions_calendar.md#user-contribution-events).
Only unique code contributors (users with `pushed` events) are included in the calculation.
- **Code Suggestions: Acceptance rate**: Percentage of code suggestions provided by GitLab Duo that have been accepted by code contributors in the last 30 days.
It is calculated as the number of accepted code suggestions divided by the total number of generated code suggestions.
- **Duo Chat: Usage**: Percentage of users that engage with GitLab Duo Chat every month.
It is calculated as the number of monthly unique GitLab Duo Chat users divided by the total GitLab Duo assigned users.
{{< alert type="note" >}}
For tracking Code Suggestions events, GitLab collects data only from code editor extensions.
[Epic 14203](https://gitlab.com/groups/gitlab-org/-/epics/14203) proposes support for the Web IDE as well.
{{< /alert >}}
## Metric trends
The **Metric trends** table displays metrics for the last six months, with monthly values, percentage changes in the past six months, and trend sparklines.
### Lifecycle metrics
- [**Lead time**](../group/value_stream_analytics/_index.md#lifecycle-metrics)
- [**Median time to merge**](merge_request_analytics.md)
- [**Deployment frequency**](dora_metrics.md#deployment-frequency)
- [**Merge request throughput**](merge_request_analytics.md#view-the-number-of-merge-requests-in-a-date-range)
- [**Critical vulnerabilities over time**](../application_security/vulnerability_report/_index.md)
- [**Contributor count**](../profile/contributions_calendar.md#user-contribution-events)
### AI usage metrics
**Code Suggestions: Usage**: Monthly user engagement with AI Code Suggestions.
On GitLab.com, data updates every fives minutes.
GitLab counts Code Suggestions usage only if the user has pushed code to the project in the current month.
The month-over-month comparison of the AI Usage unique users rate gives a more accurate indication Code Suggestion usage,
because it eliminates factors such as developer experience level and project type or complexity.
The baseline for the AI Usage trend is the total number of code contributors, not only users with GitLab Duo seats.
This baseline gives a more accurate representation of AI usage by team members.
To analyze the performance of teams that use AI versus teams that don't, you can create a custom
[Value Streams Dashboard Scheduled Report](https://gitlab.com/explore/catalog/components/vsd-reports-generator)
based on the AI impact view of projects and groups with and without GitLab Duo.
{{< alert type="note" >}}
Usage rate for Code Suggestions is calculated with data starting from GitLab 16.11.
For more information, see [epic 12978](https://gitlab.com/groups/gitlab-org/-/epics/12978).
{{< /alert >}}
**Duo RCA: Usage**: Monthly user engagement with Duo Root Cause Analysis.
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/513252) in GitLab 18.1 [with a flag](../../administration/feature_flags/_index.md) named `duo_rca_usage_rate`. Disabled by default.
- [Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated](https://gitlab.com/gitlab-org/gitlab/-/issues/543987) in GitLab 18.3.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
This metric tracks the percentage of Duo users who select [**Troubleshoot** to analyze failed CI/CD jobs](../gitlab_duo_chat/examples.md#from-a-merge-request).
{{< alert type="note" >}}
Usage rate for Duo RCA is calculated with data starting from GitLab 18.0.
For more information, see [epic 15025](https://gitlab.com/groups/gitlab-org/-/epics/15025).
{{< /alert >}}
## View AI impact analytics
Prerequisites:
- [Code Suggestions](../project/repository/code_suggestions/_index.md) must be enabled.
- For GitLab Self-Managed, [ClickHouse for contribution analytics](../group/contribution_analytics/_index.md#contribution-analytics-with-clickhouse) must be configured.
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Analytics Dashboards**.
1. Select **AI impact analytics**.
To retrieve AI impact metrics, you can also use the `AiMetrics`, `AiUserMetrics`, and `AiUsageData` [GraphQL APIs](../../api/graphql/reference/_index.md).
For an overview and sample queries, see [issue 512931](https://gitlab.com/gitlab-org/gitlab/-/issues/512931).
|
https://docs.gitlab.com/user/analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/_index.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
_index.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Analyze GitLab usage
|
Instance, group, and project analytics.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Group-level analytics moved to GitLab Premium in 13.9.
{{< /history >}}
GitLab provides different types of analytics insights for instances, groups, and [projects](../project/settings/_index.md#turn-off-project-analytics).
Analytics features require different [roles and permissions](../permissions.md#analytics) for projects and groups.
## Analytics features
### End-to-end insight & visibility analytics
Use these features to gain insights into your overall software development lifecycle.
| Feature | Description | Project-level | Group-level | Instance-level |
| ------- | ----------- | ------------- | ----------- | -------------- |
| [Value Streams Dashboard](value_streams_dashboard.md) | Insights into DevSecOps trends, patterns, and opportunities for digital transformation improvements. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [Value Stream Management Analytics](../group/value_stream_analytics/_index.md) | Insights into time-to-value through customizable stages. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| DevOps adoption [by group](../group/devops_adoption/_index.md) and [by instance](../../administration/analytics/devops_adoption.md) | Organization's maturity in DevOps adoption, with feature adoption over time and feature distribution by group. | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes |
| [Usage trends](../../administration/analytics/usage_trends.md) | Overview of instance data and changes in data volume over time. | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes |
| [Insights](../project/insights/_index.md) | Customizable reports to explore issues, merged merge requests, and triage hygiene. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [Analytics dashboards](analytics_dashboards.md) | Built-in and customizable dashboards to visualize collected data. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
### Productivity analytics
Use these features to gain insights into the productivity of your team on issues and merge requests.
| Feature | Description | Project-level | Group-level | Instance-level |
| ------- | ----------- | ------------- | ----------- | -------------- |
| [Issue analytics](../group/issues_analytics/_index.md) | Visualization of issues created each month. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [Merge request analytics](merge_request_analytics.md) | Overview of merge requests, with mean time to merge, throughput, and activity details. | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No |
| [Productivity analytics](productivity_analytics.md) | Merge request lifecycle, filterable down to author level. | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [Code review analytics](code_review_analytics.md) | Open merge requests with information about merge request activity. | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No |
### Developer analytics
Use these features to gain insights into developer productivity and code coverage.
| Feature | Description | Project-level | Group-level | Instance-level |
| ------- | ----------- | ------------- | ----------- | -------------- |
| [Contribution analytics](../group/contribution_analytics/_index.md) | Overview of [contribution events](../profile/contributions_calendar.md) made by group members, with bar chart of push events, merge requests, and issues. | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [Contributor analytics](contributor_analytics.md) | Overview of commits made by project members, with line chart of number of commits. | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No |
| [Repository analytics](../group/repositories_analytics/_index.md) | Programming languages used in the repository and code coverage statistics. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
### CI/CD analytics
Use these features to gain insights into CI/CD performance.
| Feature | Description | Project-level | Group-level | Instance-level |
| ------- | ----------- | ------------- | ----------- | -------------- |
| [CI/CD analytics](ci_cd_analytics.md) | Pipeline duration and successes or failures. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [DORA metrics](dora_metrics.md) | DORA metrics over time. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
### Security analytics
Use these features to gain insights into security vulnerabilities and metrics.
| Feature | Description | Project-level | Group-level | Instance-level |
| ------- | ----------- | ------------- | ----------- | -------------- |
| [Security Dashboards](../application_security/security_dashboard/_index.md) | Collection of metrics, ratings, and charts for vulnerabilities detected by security scanners. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
## Metric glossary
The following glossary provides definitions for common development metrics used in analytics features,
and explains how they are measured in GitLab.
| Metric | Definition | Measurement in GitLab |
| ------ | ---------- | --------------------- |
| Mean Time to Change (MTTC) | The average duration between idea and delivery. | From when an issue is created until its related merge request is deployed to production. |
| Mean Time to Detect (MTTD) | The average duration that a bug goes undetected in production. | From when a bug is deployed to production until an issue is created to report it. |
| Mean Time to Merge (MTTM) | The average lifespan of a merge request. | From when a merge request is created until it is merged. Excludes merge requests that are closed or unmerged. For more information, see [merge request analytics](merge_request_analytics.md). |
| Mean Time to Recover / Repair / Resolution / Resolve / Restore (MTTR) | The average duration that a bug is not fixed in production. | From when a bug is deployed to production until the bug fix is deployed. |
| Velocity | The total issue burden completed in a specific period of time. The burden is usually measured in points or weight, often per sprint. | Total points or weight of issues closed in a specific period of time. For example, "30 points per sprint". |
For more definitions, see also the [Value Streams Dashboard metrics and drill-down reports](value_streams_dashboard.md#dashboard-metrics-and-drill-down-reports).
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Instance, group, and project analytics.
title: Analyze GitLab usage
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Group-level analytics moved to GitLab Premium in 13.9.
{{< /history >}}
GitLab provides different types of analytics insights for instances, groups, and [projects](../project/settings/_index.md#turn-off-project-analytics).
Analytics features require different [roles and permissions](../permissions.md#analytics) for projects and groups.
## Analytics features
### End-to-end insight & visibility analytics
Use these features to gain insights into your overall software development lifecycle.
| Feature | Description | Project-level | Group-level | Instance-level |
| ------- | ----------- | ------------- | ----------- | -------------- |
| [Value Streams Dashboard](value_streams_dashboard.md) | Insights into DevSecOps trends, patterns, and opportunities for digital transformation improvements. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [Value Stream Management Analytics](../group/value_stream_analytics/_index.md) | Insights into time-to-value through customizable stages. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| DevOps adoption [by group](../group/devops_adoption/_index.md) and [by instance](../../administration/analytics/devops_adoption.md) | Organization's maturity in DevOps adoption, with feature adoption over time and feature distribution by group. | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes |
| [Usage trends](../../administration/analytics/usage_trends.md) | Overview of instance data and changes in data volume over time. | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes |
| [Insights](../project/insights/_index.md) | Customizable reports to explore issues, merged merge requests, and triage hygiene. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [Analytics dashboards](analytics_dashboards.md) | Built-in and customizable dashboards to visualize collected data. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
### Productivity analytics
Use these features to gain insights into the productivity of your team on issues and merge requests.
| Feature | Description | Project-level | Group-level | Instance-level |
| ------- | ----------- | ------------- | ----------- | -------------- |
| [Issue analytics](../group/issues_analytics/_index.md) | Visualization of issues created each month. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [Merge request analytics](merge_request_analytics.md) | Overview of merge requests, with mean time to merge, throughput, and activity details. | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No |
| [Productivity analytics](productivity_analytics.md) | Merge request lifecycle, filterable down to author level. | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [Code review analytics](code_review_analytics.md) | Open merge requests with information about merge request activity. | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No |
### Developer analytics
Use these features to gain insights into developer productivity and code coverage.
| Feature | Description | Project-level | Group-level | Instance-level |
| ------- | ----------- | ------------- | ----------- | -------------- |
| [Contribution analytics](../group/contribution_analytics/_index.md) | Overview of [contribution events](../profile/contributions_calendar.md) made by group members, with bar chart of push events, merge requests, and issues. | {{< icon name="dotted-circle" >}} No | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [Contributor analytics](contributor_analytics.md) | Overview of commits made by project members, with line chart of number of commits. | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No | {{< icon name="dotted-circle" >}} No |
| [Repository analytics](../group/repositories_analytics/_index.md) | Programming languages used in the repository and code coverage statistics. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
### CI/CD analytics
Use these features to gain insights into CI/CD performance.
| Feature | Description | Project-level | Group-level | Instance-level |
| ------- | ----------- | ------------- | ----------- | -------------- |
| [CI/CD analytics](ci_cd_analytics.md) | Pipeline duration and successes or failures. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
| [DORA metrics](dora_metrics.md) | DORA metrics over time. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
### Security analytics
Use these features to gain insights into security vulnerabilities and metrics.
| Feature | Description | Project-level | Group-level | Instance-level |
| ------- | ----------- | ------------- | ----------- | -------------- |
| [Security Dashboards](../application_security/security_dashboard/_index.md) | Collection of metrics, ratings, and charts for vulnerabilities detected by security scanners. | {{< icon name="check-circle" >}} Yes | {{< icon name="check-circle" >}} Yes | {{< icon name="dotted-circle" >}} No |
## Metric glossary
The following glossary provides definitions for common development metrics used in analytics features,
and explains how they are measured in GitLab.
| Metric | Definition | Measurement in GitLab |
| ------ | ---------- | --------------------- |
| Mean Time to Change (MTTC) | The average duration between idea and delivery. | From when an issue is created until its related merge request is deployed to production. |
| Mean Time to Detect (MTTD) | The average duration that a bug goes undetected in production. | From when a bug is deployed to production until an issue is created to report it. |
| Mean Time to Merge (MTTM) | The average lifespan of a merge request. | From when a merge request is created until it is merged. Excludes merge requests that are closed or unmerged. For more information, see [merge request analytics](merge_request_analytics.md). |
| Mean Time to Recover / Repair / Resolution / Resolve / Restore (MTTR) | The average duration that a bug is not fixed in production. | From when a bug is deployed to production until the bug fix is deployed. |
| Velocity | The total issue burden completed in a specific period of time. The burden is usually measured in points or weight, often per sprint. | Total points or weight of issues closed in a specific period of time. For example, "30 points per sprint". |
For more definitions, see also the [Value Streams Dashboard metrics and drill-down reports](value_streams_dashboard.md#dashboard-metrics-and-drill-down-reports).
|
https://docs.gitlab.com/user/analytics_dashboards
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/analytics_dashboards.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
analytics_dashboards.md
|
Monitor
|
Platform Insights
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Analytics dashboards
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Introduced in GitLab 15.9 as an [experiment](../../policy/development_stages_support.md#experiment) feature [with a flag](../../administration/feature_flags/_index.md) named `combined_analytics_dashboards`. Disabled by default.
- `combined_analytics_dashboards` [enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/389067) by default in GitLab 16.11.
- `combined_analytics_dashboards` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/454350) in GitLab 17.1.
- `filters` configuration [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/505317) in GitLab 17.9. Disabled by default.
- Inline visualizations configuration [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/509111) in GitLab 17.9.
- [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195086) from GitLab Ultimate to GitLab Premium in 18.2.
{{< /history >}}
Analytics dashboards help you visualize collected data on built-in dashboards.
An enhanced dashboard experience is proposed in [epic 13801](https://gitlab.com/groups/gitlab-org/-/epics/13801).
## Data sources
{{< history >}}
- Product analytics and custom visualization data sources [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/497577) in GitLab 17.7.
{{< /history >}}
A data source is a connection to a database or collection of data which can be used by your dashboard
filters and visualizations to query and retrieve results.
## Built-in dashboards
To help you get started with analytics, GitLab provides built-in dashboards with predefined visualizations.
These dashboards are labeled **By GitLab**.
You cannot edit the built-in dashboards, but you can create custom dashboards with a similar style.
The following built-in dashboards are available:
- [**Value Streams Dashboard**](value_streams_dashboard.md) displays metrics related to DevOps performance, security exposure, and workstream optimization.
- [**AI Impact Dashboard**](ai_impact_analytics.md) displays the impact of AI tools on software development lifecycle (SDLC) metrics for a project or group.
## Custom dashboards
You can [create custom dashboards](#create-a-dashboard-by-configuration) to visualize the metrics that are most relevant to your case.
- Each project can have an unlimited number of dashboards.
The only limitation might be the [repository size limit](../project/repository/repository_size.md#size-and-storage-limits).
- Each dashboard can reference one or more [visualizations](#define-a-chart-visualization-template).
- Visualizations can be shared across dashboards.
Project maintainers can enforce approval rules on dashboard changes with features such as [code owners](../project/codeowners/_index.md) and [approval rules](../project/merge_requests/approvals/rules.md).
Your dashboard files are versioned in source control with the rest of a project's code.
## View project dashboards
Prerequisites:
- You must have at least the Reporter role for the project.
To view a list of dashboards (both built-in and custom) for a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Analytics dashboards**.
1. From the list of available dashboards, select the dashboard you want to view.
## View group dashboards
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390542) in GitLab 16.2 [with a flag](../../administration/feature_flags/_index.md) named `group_analytics_dashboards`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/416970) in GitLab 16.8.
- Feature flag `group_analytics_dashboards` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/439718) in GitLab 16.11.
{{< /history >}}
Prerequisites:
- You must have at least the Reporter role for the group.
To view a list of dashboards (both built-in and custom) for a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Analytics dashboards**.
1. From the list of available dashboards, select the dashboard you want to view.
## Change the location of dashboards
You can change the location of your project or group custom dashboards.
Prerequisites:
- You must have at least the Maintainer role for the project or group the project belongs to.
### Group dashboards
{{< alert type="note" >}}
[Issue 411572](https://gitlab.com/gitlab-org/gitlab/-/issues/411572) proposes connecting this feature to group-level dashboards.
{{< /alert >}}
To change the location of a group's custom dashboards:
1. On the left sidebar, select **Search or go to** and find the project you want to store your dashboard files in.
The project must belong to the group for which you create the dashboards.
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > Analytics**.
1. In the **Analytics Dashboards** section, select your dashboard files project.
1. Select **Save changes**.
### Project dashboards
By default custom dashboards are saved to the current project, because
dashboards are usually defined in the project where the analytics data is retrieved from.
However, you can also have a separate project for dashboards.
This setup is recommended if you want to enforce specific access rules to the dashboard definitions or share dashboards across multiple projects.
{{< alert type="note" >}}
You can share dashboards only between projects that are located in the same group.
{{< /alert >}}
To change the location of project dashboards:
1. On the left sidebar, select **Search or go to** and find your project,
or select **Create new** ({{< icon name="plus" >}}) and **New project/repository**
to create the project to store your dashboard files.
1. On the left sidebar, select **Search or go to** and find the analytics project.
1. Select **Settings > Analytics**.
1. In the **Analytics Dashboards** section, select your dashboard files project.
1. Select **Save changes**.
## Create a dashboard by configuration
You can create dashboards manually by configuration.
To define a dashboard:
1. In `.gitlab/analytics/dashboards/`, create a directory named like the dashboard.
Each dashboard should have its own directory.
1. In the new directory, create a `.yaml` file with the same name as the directory, for example `.gitlab/analytics/dashboards/my_dashboard/my_dashboard.yaml`.
This file contains the dashboard definition. It must conform to the JSON schema defined in `ee/app/validators/json_schemas/analytics_dashboard.json`.
1. Optional. To create new visualizations to add to your dashboard, see [defining a chart visualization template](#define-a-chart-visualization-template).
For [example](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/gitlab/analytics/product_analytics/dashboards/audience.yaml), if you want to create three dashboards (Conversion funnels, Demographic breakdown, and North star metrics)
and one visualization (line chart) that applies to all dashboards, the file structure looks like this:
```plaintext
.gitlab/analytics/dashboards
├── conversion_funnels
│ └── conversion_funnels.yaml
├── demographic_breakdown
│ └── demographic_breakdown.yaml
├── north_star_metrics
| └── north_star_metrics.yaml
├── visualizations
│ └── example_line_chart.yaml
```
### Dashboard filters
Dashboards support the following filters:
- **Date range**: Date selector to filter data by date.
- **Anonymous users**: Toggle to include or exclude anonymous users from the dataset.
To enable filters, in the `.yaml` configuration file set the filter's `enabled` option to `true`:
```yaml
title: My dashboard
# ...
filters:
excludeAnonymousUsers:
enabled: true
dateRange:
enabled: true
```
See a complete [dashboard configuration example](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/gitlab/analytics/product_analytics/dashboards/audience.yaml).
### Define an inline chart visualization
You can define different charts and add visualization options to some of them, such as:
- Line chart, with the options listed in the [ECharts documentation](https://echarts.apache.org/en/option.html).
- Column chart, with the options listed in the [ECharts documentation](https://echarts.apache.org/en/option.html).
- Data table.
- Single stat, with the only option to set `decimalPlaces` (number, default value is 0).
This process can also be followed for user-created dashboards. Each visualization must be written with the following
required fields:
- version
- type
- data
- options
### Define a chart visualization template
{{< alert type="note" >}}
We recommend using visualization templates sparingly. Visualization templates can lead to long visualization
selection lists in the dashboard editor UI if not managed, which may lead to visualizations being missed or duplicated.
Generally, visualization templates should be reserved for visualizations that will be used identically
across several dashboards.
{{< /alert >}}
If you need a visualization to be used by multiple dashboards, you might store them as separate template files.
When added to a dashboard, the visualization template will be copied over to the dashboard. Visualization templates
copied to dashboards are not updated when the visualization template is updated.
To define a chart visualization template for your dashboards:
1. In the `.gitlab/analytics/dashboards/visualizations/` directory, create a `.yaml` file.
The filename should be descriptive of the visualization it defines.
1. In the `.yaml` file, define the visualization configuration, according to the schema in
`ee/app/validators/json_schemas/analytics_visualization.json`.
For [example](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/gitlab/analytics/product_analytics/visualizations/events_over_time.yaml), to create a line chart that illustrates event count over time, in the `visualizations` folder
create a `line_chart.yaml` file with the following required fields:
- version
- type
- data
- options
## Troubleshooting
### `Something went wrong while loading the dashboard.`
If the dashboard displays a global error message that data could not be loaded, first try reloading the page.
If the error persists:
- Check that your configurations match the dashboard JSON schema defined in `ee/app/validators/json_schemas/analytics_dashboard.json`.
### `Invalid dashboard configuration`
If the dashboard displays a global error message that the configuration is invalid, check that your configurations match the dashboard JSON schema defined in `ee/app/validators/json_schemas/analytics_dashboard.json`.
### `Invalid visualization configuration`
If a dashboard panel displays a message that the visualization configuration is invalid,
check that your visualization configurations match the [visualization JSON schema](#define-a-chart-visualization-template)
defined in `ee/app/validators/json_schemas/analytics_visualization.json`.
### Dashboard panel error
If a dashboard panel displays an error message:
- Make sure your [visualization](analytics_dashboards.md#define-a-chart-visualization-template) configuration is set up correctly.
|
---
stage: Monitor
group: Platform Insights
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Analytics dashboards
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Introduced in GitLab 15.9 as an [experiment](../../policy/development_stages_support.md#experiment) feature [with a flag](../../administration/feature_flags/_index.md) named `combined_analytics_dashboards`. Disabled by default.
- `combined_analytics_dashboards` [enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/389067) by default in GitLab 16.11.
- `combined_analytics_dashboards` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/454350) in GitLab 17.1.
- `filters` configuration [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/505317) in GitLab 17.9. Disabled by default.
- Inline visualizations configuration [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/509111) in GitLab 17.9.
- [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195086) from GitLab Ultimate to GitLab Premium in 18.2.
{{< /history >}}
Analytics dashboards help you visualize collected data on built-in dashboards.
An enhanced dashboard experience is proposed in [epic 13801](https://gitlab.com/groups/gitlab-org/-/epics/13801).
## Data sources
{{< history >}}
- Product analytics and custom visualization data sources [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/497577) in GitLab 17.7.
{{< /history >}}
A data source is a connection to a database or collection of data which can be used by your dashboard
filters and visualizations to query and retrieve results.
## Built-in dashboards
To help you get started with analytics, GitLab provides built-in dashboards with predefined visualizations.
These dashboards are labeled **By GitLab**.
You cannot edit the built-in dashboards, but you can create custom dashboards with a similar style.
The following built-in dashboards are available:
- [**Value Streams Dashboard**](value_streams_dashboard.md) displays metrics related to DevOps performance, security exposure, and workstream optimization.
- [**AI Impact Dashboard**](ai_impact_analytics.md) displays the impact of AI tools on software development lifecycle (SDLC) metrics for a project or group.
## Custom dashboards
You can [create custom dashboards](#create-a-dashboard-by-configuration) to visualize the metrics that are most relevant to your case.
- Each project can have an unlimited number of dashboards.
The only limitation might be the [repository size limit](../project/repository/repository_size.md#size-and-storage-limits).
- Each dashboard can reference one or more [visualizations](#define-a-chart-visualization-template).
- Visualizations can be shared across dashboards.
Project maintainers can enforce approval rules on dashboard changes with features such as [code owners](../project/codeowners/_index.md) and [approval rules](../project/merge_requests/approvals/rules.md).
Your dashboard files are versioned in source control with the rest of a project's code.
## View project dashboards
Prerequisites:
- You must have at least the Reporter role for the project.
To view a list of dashboards (both built-in and custom) for a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Analytics dashboards**.
1. From the list of available dashboards, select the dashboard you want to view.
## View group dashboards
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390542) in GitLab 16.2 [with a flag](../../administration/feature_flags/_index.md) named `group_analytics_dashboards`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/416970) in GitLab 16.8.
- Feature flag `group_analytics_dashboards` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/439718) in GitLab 16.11.
{{< /history >}}
Prerequisites:
- You must have at least the Reporter role for the group.
To view a list of dashboards (both built-in and custom) for a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Analytics dashboards**.
1. From the list of available dashboards, select the dashboard you want to view.
## Change the location of dashboards
You can change the location of your project or group custom dashboards.
Prerequisites:
- You must have at least the Maintainer role for the project or group the project belongs to.
### Group dashboards
{{< alert type="note" >}}
[Issue 411572](https://gitlab.com/gitlab-org/gitlab/-/issues/411572) proposes connecting this feature to group-level dashboards.
{{< /alert >}}
To change the location of a group's custom dashboards:
1. On the left sidebar, select **Search or go to** and find the project you want to store your dashboard files in.
The project must belong to the group for which you create the dashboards.
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > Analytics**.
1. In the **Analytics Dashboards** section, select your dashboard files project.
1. Select **Save changes**.
### Project dashboards
By default custom dashboards are saved to the current project, because
dashboards are usually defined in the project where the analytics data is retrieved from.
However, you can also have a separate project for dashboards.
This setup is recommended if you want to enforce specific access rules to the dashboard definitions or share dashboards across multiple projects.
{{< alert type="note" >}}
You can share dashboards only between projects that are located in the same group.
{{< /alert >}}
To change the location of project dashboards:
1. On the left sidebar, select **Search or go to** and find your project,
or select **Create new** ({{< icon name="plus" >}}) and **New project/repository**
to create the project to store your dashboard files.
1. On the left sidebar, select **Search or go to** and find the analytics project.
1. Select **Settings > Analytics**.
1. In the **Analytics Dashboards** section, select your dashboard files project.
1. Select **Save changes**.
## Create a dashboard by configuration
You can create dashboards manually by configuration.
To define a dashboard:
1. In `.gitlab/analytics/dashboards/`, create a directory named like the dashboard.
Each dashboard should have its own directory.
1. In the new directory, create a `.yaml` file with the same name as the directory, for example `.gitlab/analytics/dashboards/my_dashboard/my_dashboard.yaml`.
This file contains the dashboard definition. It must conform to the JSON schema defined in `ee/app/validators/json_schemas/analytics_dashboard.json`.
1. Optional. To create new visualizations to add to your dashboard, see [defining a chart visualization template](#define-a-chart-visualization-template).
For [example](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/gitlab/analytics/product_analytics/dashboards/audience.yaml), if you want to create three dashboards (Conversion funnels, Demographic breakdown, and North star metrics)
and one visualization (line chart) that applies to all dashboards, the file structure looks like this:
```plaintext
.gitlab/analytics/dashboards
├── conversion_funnels
│ └── conversion_funnels.yaml
├── demographic_breakdown
│ └── demographic_breakdown.yaml
├── north_star_metrics
| └── north_star_metrics.yaml
├── visualizations
│ └── example_line_chart.yaml
```
### Dashboard filters
Dashboards support the following filters:
- **Date range**: Date selector to filter data by date.
- **Anonymous users**: Toggle to include or exclude anonymous users from the dataset.
To enable filters, in the `.yaml` configuration file set the filter's `enabled` option to `true`:
```yaml
title: My dashboard
# ...
filters:
excludeAnonymousUsers:
enabled: true
dateRange:
enabled: true
```
See a complete [dashboard configuration example](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/gitlab/analytics/product_analytics/dashboards/audience.yaml).
### Define an inline chart visualization
You can define different charts and add visualization options to some of them, such as:
- Line chart, with the options listed in the [ECharts documentation](https://echarts.apache.org/en/option.html).
- Column chart, with the options listed in the [ECharts documentation](https://echarts.apache.org/en/option.html).
- Data table.
- Single stat, with the only option to set `decimalPlaces` (number, default value is 0).
This process can also be followed for user-created dashboards. Each visualization must be written with the following
required fields:
- version
- type
- data
- options
### Define a chart visualization template
{{< alert type="note" >}}
We recommend using visualization templates sparingly. Visualization templates can lead to long visualization
selection lists in the dashboard editor UI if not managed, which may lead to visualizations being missed or duplicated.
Generally, visualization templates should be reserved for visualizations that will be used identically
across several dashboards.
{{< /alert >}}
If you need a visualization to be used by multiple dashboards, you might store them as separate template files.
When added to a dashboard, the visualization template will be copied over to the dashboard. Visualization templates
copied to dashboards are not updated when the visualization template is updated.
To define a chart visualization template for your dashboards:
1. In the `.gitlab/analytics/dashboards/visualizations/` directory, create a `.yaml` file.
The filename should be descriptive of the visualization it defines.
1. In the `.yaml` file, define the visualization configuration, according to the schema in
`ee/app/validators/json_schemas/analytics_visualization.json`.
For [example](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/gitlab/analytics/product_analytics/visualizations/events_over_time.yaml), to create a line chart that illustrates event count over time, in the `visualizations` folder
create a `line_chart.yaml` file with the following required fields:
- version
- type
- data
- options
## Troubleshooting
### `Something went wrong while loading the dashboard.`
If the dashboard displays a global error message that data could not be loaded, first try reloading the page.
If the error persists:
- Check that your configurations match the dashboard JSON schema defined in `ee/app/validators/json_schemas/analytics_dashboard.json`.
### `Invalid dashboard configuration`
If the dashboard displays a global error message that the configuration is invalid, check that your configurations match the dashboard JSON schema defined in `ee/app/validators/json_schemas/analytics_dashboard.json`.
### `Invalid visualization configuration`
If a dashboard panel displays a message that the visualization configuration is invalid,
check that your visualization configurations match the [visualization JSON schema](#define-a-chart-visualization-template)
defined in `ee/app/validators/json_schemas/analytics_visualization.json`.
### Dashboard panel error
If a dashboard panel displays an error message:
- Make sure your [visualization](analytics_dashboards.md#define-a-chart-visualization-template) configuration is set up correctly.
|
https://docs.gitlab.com/user/contributor_analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/contributor_analytics.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
contributor_analytics.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Contributor analytics
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Contributor analytics give you an overview of the commits made by projects members to a project over time.
## View contributor analytics
The contributor analytics page displays a line chart with the number of commits to the selected project branch over time,
and line charts with the number of commits by each project member.
To view contributor analytics for a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Contributor analytics**.
1. From the **Branches** (**main**) dropdown list, select the branch you want to view commits for.
1. To view the number of commits made on a specific day, hover over the line chart.
1. Optional. To display commits only for a specific time period, select the pause icons ({{< icon name="status-paused" >}}) and slide them along the horizontal axis:
- To change the start date, slide the left pause icon to the left or right.
- To change the end date, slide the right pause icon to the left or right.
## View project commit history
To view a list of commits made by project members per day:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Contributor analytics**.
1. Select **History**.
1. From the **Branches** (**main**) dropdown list, select the branch you want to view commits for.
1. To view the number of commits made by the members on a specific day, hover over the line chart.
1. Optional. Filter the results.
- To filter by author, from the **Author** dropdown list, select the user whose commits you want to view.
- To filter by commit message, in the text box, enter your search criteria.
## Retrieve project commits as an RSS feed
To view the list of commits to the project as an RSS feed in Atom format:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Contributor analytics**.
1. Select **History**.
1. In the upper-right corner, select the feed symbol ({{< icon name="rss" >}}).
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Contributor analytics
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Contributor analytics give you an overview of the commits made by projects members to a project over time.
## View contributor analytics
The contributor analytics page displays a line chart with the number of commits to the selected project branch over time,
and line charts with the number of commits by each project member.
To view contributor analytics for a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Contributor analytics**.
1. From the **Branches** (**main**) dropdown list, select the branch you want to view commits for.
1. To view the number of commits made on a specific day, hover over the line chart.
1. Optional. To display commits only for a specific time period, select the pause icons ({{< icon name="status-paused" >}}) and slide them along the horizontal axis:
- To change the start date, slide the left pause icon to the left or right.
- To change the end date, slide the right pause icon to the left or right.
## View project commit history
To view a list of commits made by project members per day:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Contributor analytics**.
1. Select **History**.
1. From the **Branches** (**main**) dropdown list, select the branch you want to view commits for.
1. To view the number of commits made by the members on a specific day, hover over the line chart.
1. Optional. Filter the results.
- To filter by author, from the **Author** dropdown list, select the user whose commits you want to view.
- To filter by commit message, in the text box, enter your search criteria.
## Retrieve project commits as an RSS feed
To view the list of commits to the project as an RSS feed in Atom format:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Contributor analytics**.
1. Select **History**.
1. In the upper-right corner, select the feed symbol ({{< icon name="rss" >}}).
|
https://docs.gitlab.com/user/dora_metrics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/dora_metrics.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
dora_metrics.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
DevOps Research and Assessment (DORA) metrics
|
Gain insights into DevOps performance and identify opportunities for workflow improvements.
|
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
[DevOps Research and Assessment (DORA)](https://cloud.google.com/blog/products/devops-sre/using-the-four-keys-to-measure-your-devops-performance) metrics
deliver evidence-based insights about your DevOps performance.
These four key measurements demonstrate how fast your team delivers changes
and how well those changes perform in production.
When tracked consistently, DORA metrics highlight improvement opportunities
across your software delivery process.
Use DORA metrics for strategic decision-making, to justify process improvement investments to stakeholders,
or to compare your team's performance against industry benchmarks to identify competitive advantages.
The four DORA metrics measure two critical aspects of DevOps:
- **Velocity metrics** track how quickly your organization delivers software:
- [Deployment frequency](#deployment-frequency): How often code is deployed to production
- [Lead time for changes](#lead-time-for-changes): How long it takes code to reach production
- **Stability metrics** measure your software's reliability:
- [Change failure rate](#change-failure-rate): How often deployments cause production failures
- [Time to restore service](#time-to-restore-service): How quickly service recovers after failures
The dual focus on velocity and stability metrics helps leaders find the optimal balance between speed and quality in their delivery workflows.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For a video explanation, see [DORA metrics: User analytics](https://www.youtube.com/watch?v=jYQSH4EY6_U) and [GitLab speed run: DORA metrics](https://www.youtube.com/watch?v=1BrcMV6rCDw).
## Deployment frequency
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394712) fix for the frequency calculation formula for `all` and `monthly` intervals in GitLab 16.0.
{{< /history >}}
Deployment frequency is the frequency of successful deployments to production over the given date range (hourly, daily, weekly, monthly, or yearly).
Software leaders can use the deployment frequency metric to understand how often the team successfully deploys software to production, and how quickly the teams can respond to customers' requests or new market opportunities.
High deployment frequency means you can get feedback sooner and iterate faster to deliver improvements and features.
### Deployment frequency forecasting
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Experiment
{{< /details >}}
Deployment frequency forecasting (formerly named Value stream forecasting) uses a statistical forecasting model to predict productivity metrics and identify anomalies across the software development lifecycle.
This information can help you improve planning and decision-making for your product and teams.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
Watch an overview of [Value stream forecasting](https://www.youtube.com/watch?v=6u8_8QQ5pEQ&list=PLFGfElNsQthYDx0A_FaNNfUm9NHsK6zED).
### How deployment frequency is calculated
In GitLab, deployment frequency is measured by the average number of deployments per day to a given environment, based on the deployment's end time (its `finished_at` property).
GitLab calculates the deployment frequency from the number of finished deployments on the given day. Only successful deployments (`Deployment.statuses = success`) are counted.
The calculation takes into account the production `environment tier` or the environments named `production/prod`. The environment must be part of the production deployment tier for its deployment information to appear on the graphs.
You can configure DORA metrics for different environments by specifying `other` under the `environment_tiers` parameter in the [`.gitlab/insights.yml` file](../project/insights/_index.md#configuration).
{{< alert type="note" >}}
Deployment frequency is calculated as the **average (mean)**, unlike the other DORA metrics that use the median, which is preferred because it provides a more accurate and reliable view of performance.
This difference is because deployment frequency was added to GitLab prior to adopting the DORA framework, and the calculation of this metric remained unchanged when it was incorporated into other reports.
[Issue 499591](https://gitlab.com/gitlab-org/gitlab/-/issues/499591) proposes offering the option to customize the calculation method for each metric, choosing between mean and median.
{{< /alert >}}
### How to improve deployment frequency
The first step is to benchmark the cadence of code releases between groups and projects. Next, you should consider:
- Adding automated testing.
- Adding automated code validation.
- Breaking the changes down into smaller iterations.
## Lead time for changes
Lead time for changes is the amount of time it takes a code change to get into production.
**Lead time for changes** is not the same as **Lead time**. In value stream analytics, lead time measures the time it takes for work on an issue to move from the moment it's requested (Issue created) to the moment it's fulfilled and delivered (Issue closed).
For software leaders, lead time for changes reflects the efficiency of CI/CD pipelines and visualizes how quickly work is delivered to customers.
Over time, the lead time for changes should decrease, while your team's performance should increase. Low lead time for changes means more efficient CI/CD pipelines.
### How lead time for changes is calculated
GitLab calculates lead time for changes based on the number of seconds to successfully deliver a merge request into production: from merge request merge time (when the merge button is clicked) to code successfully running in production, without adding the `coding_time` to the calculation. Data is aggregated right after the deployment is finished, with a slight delay.
By default, lead time for changes supports measuring only one branch operation with multiple deployment jobs (for example, from development to staging to production on the default branch). When a merge request gets merged on staging, and then on production, GitLab interprets them as two deployed merge requests, not one.
#### Deployments finishing before merge
In rare cases, a deployment may finish before its associated merge request is merged.
This scenario can happen when:
- Deployment processes are triggered independently of the merge workflow.
- Manual deployment interventions occur before code review completion.
In this situation, GitLab uses the formula: `GREATEST(0, deployment_finished_at - merge_request_merged_at)`.
The `GREATEST` function ensures that lead time values are never negative, by returning `0` instead of a negative value.
This function prevents database constraint violations while maintaining data integrity.
### How to improve lead time for changes
The first step is to benchmark the CI/CD pipelines' efficiency between groups and projects. Next, you should consider:
- Using Value Stream Analytics to identify bottlenecks in the processes.
- Breaking the changes down into smaller iterations.
- Adding automation.
- Improving the performance of your pipelines.
## Time to restore service
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/356959) in GitLab 15.1.
{{< /history >}}
Time to restore service is the amount of time it takes an organization to recover from a failure in production.
For software leaders, time to restore service reflects how long it takes an organization to recover from a failure in production.
Low time to restore service means the organization can take risks with new innovative features to drive competitive advantages and increase business results.
### How time to restore service is calculated
In GitLab, time to restore service is measured as the median time an incident was open on a production environment.
GitLab calculates the number of seconds an incident was open on a production environment in the given time period. This assumes:
- [GitLab incidents](../../operations/incident_management/incidents.md) are tracked.
- All incidents are related to a production environment.
- Incidents and deployments have a strictly one-to-one relationship. An incident is related to only one production deployment, and any production deployment is related to no more than one incident.
### How to improve time to restore service
The first step is to benchmark the team response and recover from service interruptions and outages, between groups and projects. Next, you should consider:
- Improving the observability into the production environment.
- Improving response workflows.
- Improving deployment frequency and lead time for changes so fixes can get into production more efficiently.
## Change failure rate
Change failure rate is how often a change causes a failure in production.
Software leaders can use the change failure rate metric to gain insights into the quality of the code being shipped.
High change failure rate may indicate an inefficient deployment process or insufficient automated testing coverage.
### How change failure rate is calculated
In GitLab, change failure rate is measured as the percentage of deployments that cause an incident in production in a given time period.
GitLab calculates change failure rate as the number of incidents divided by the number of deployments to a production environment. This calculation assumes:
- [GitLab incidents](../../operations/incident_management/incidents.md) are tracked.
- All incidents are production incidents, regardless of the environment.
- Change failure rate is used primarily as high-level stability tracking, which is why in a given day, all incidents and deployments are aggregated into a joined daily rate. Adding specific relations between deployments and incidents is proposed in [issue 444295](https://gitlab.com/gitlab-org/gitlab/-/issues/444295).
- Change failure rate calculates duplicate incidents as separate entries, which results in double counting. [Issue 480920](https://gitlab.com/gitlab-org/gitlab/-/issues/480920) proposes a solution for a more accurate calculation.
For example, if you have 10 deployments (considering one deployment per day) with two incidents on the first day and one incident on the last day, then your change failure rate is 0.3.
### How to improve change failure rate
The first step is to benchmark the quality and stability, between groups and projects. Next, you should consider:
- Finding the right balance between stability and throughput (Deployment frequency and Lead time for changes), and not sacrificing quality for speed.
- Improving the efficacy of code review processes.
- Adding automated testing.
## DORA custom calculation rules
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Self-Managed
- Status: Experiment
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96561) in GitLab 15.4 [with a flag](../../administration/feature_flags/_index.md) named `dora_configuration`. Disabled by default. This feature is an [experiment](../../policy/development_stages_support.md).
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
This feature is an [experiment](../../policy/development_stages_support.md).
To join the list of users testing this feature, [here is a suggested test flow](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96561#steps-to-check-on-localhost).
If you find a bug, [open an issue here](https://gitlab.com/groups/gitlab-org/-/epics/11490).
To share your use cases and feedback, comment in [epic 11490](https://gitlab.com/groups/gitlab-org/-/epics/11490).
### Multi-branch rule for lead time for changes
Unlike the default [calculation of lead time for changes](#how-lead-time-for-changes-is-calculated), this calculation rule allows measuring multi-branch operations with a single deployment job for each operation.
For example, from development job on development branch, to staging job on staging branch, to production job on production branch.
This calculation rule has been implemented by updating the `dora_configurations` table with the target branches that are part of the development flow.
This way, GitLab can recognize the branches as one, and filter out other merge requests.
This configuration changes how daily DORA metrics are calculated for the selected project, but doesn't affect other projects, groups, or users.
This feature supports only project-level propagation.
To do this, in the Rails console run the following command:
```ruby
my_project = Project.find_by_full_path('group/subgroup/project')
Dora::Configuration.create!(project: my_project, branches_for_lead_time_for_changes: ['master', 'main'])
```
To update an existing configuration, run the following command:
```ruby
my_project = Project.find_by_full_path('group/subgroup/project')
record = Dora::Configuration.where(project: my_project).first
record.branches_for_lead_time_for_changes = ['development', 'staging', 'master', 'main']
record.save!
```
## Measure DORA metrics
### Without using GitLab CI/CD pipelines
Deployment frequency is calculated based on the deployments record, which is created for typical push-based deployments.
These deployment records are not created for pull-based deployments, for example when Container Images are connected to GitLab with an agent.
To track DORA metrics in these cases, you can [create a deployment record](../../api/deployments.md#create-a-deployment) using the Deployments API.
You must set the environment name where the deployment tier is configured, because the tier variable is specified for the given environment, not for the deployments.
For more information, see how to [track deployments of an external deployment tool](../../ci/environments/external_deployment_tools.md).
### With Jira
- Deployment frequency and lead time for changes are calculated based on GitLab CI/CD and Merge Requests (MRs), and do not require Jira data.
- Time to restore service and change failure rate require [GitLab incidents](../../operations/incident_management/manage_incidents.md) for the calculation. For more information, see how to measure these metrics [with external incidents](#with-external-incidents) and the [Jira incident replicator guide](https://gitlab.com/smathur/jira-incident-replicator).
### With external incidents
You can measure the time to restore service and change failure rate for incident management.
For PagerDuty, you can [set up a webhook](../../operations/incident_management/manage_incidents.md#using-the-pagerduty-webhook)
to automatically create a GitLab incident for each PagerDuty incident.
This configuration requires you to make changes in both PagerDuty and GitLab.
For other incident management tools, you can set up the
[HTTP integration](../../operations/incident_management/integrations.md#alerting-endpoints),
and use it to automatically:
1. [Create an incident when an alert is triggered](../../operations/incident_management/manage_incidents.md#automatically-when-an-alert-is-triggered).
1. [Close incidents via recovery alerts](../../operations/incident_management/manage_incidents.md#automatically-close-incidents-via-recovery-alerts).
## Analytics features
DORA metrics are displayed in the following analytics features:
- [Value Streams Dashboard](value_streams_dashboard.md) includes the [DORA metrics comparison panel](value_streams_dashboard.md#devsecops-metrics-comparison) and [DORA Performers score panel](value_streams_dashboard.md#dora-performers-score).
- [CI/CD analytics charts](ci_cd_analytics.md) show the history of DORA metrics over time.
- [Insights reports](../project/insights/_index.md) provide the option to create custom charts with [DORA query parameters](../project/insights/_index.md#dora-query-parameters).
- [GraphQL API](../../api/graphql/reference/_index.md) (with the interactive [GraphQL explorer](../../api/graphql/_index.md#interactive-graphql-explorer)) and [REST API](../../api/dora/metrics.md) support the retrieval of metrics data.
## Project and group availability
The following table provides an overview of the DORA metrics' availability in projects and groups.
| Metric | Level | Comments |
|---------------------------|-------------------|----------|
| `deployment_frequency` | Project | Unit in deployment count. |
| `deployment_frequency` | Group | Unit in deployment count. Aggregation method is average. |
| `lead_time_for_changes` | Project | Unit in seconds. Aggregation method is median. |
| `lead_time_for_changes` | Group | Unit in seconds. Aggregation method is median. |
| `time_to_restore_service` | Project and group | Unit in days. Aggregation method is median. (Available in UI chart in GitLab 15.1 and later) |
| `change_failure_rate` | Project and group | Percentage of deployments. (Available in UI chart in GitLab 15.2 and later) |
## Data aggregation
The following table provides an overview of the DORA metrics' data aggregation in different charts.
| Metric name | Measured values | Data aggregation in the [Value Streams Dashboard](value_streams_dashboard.md) | Data aggregation in [CI/CD analytics charts](ci_cd_analytics.md) | Data aggregation in [Custom insights reporting](../project/insights/_index.md#dora-query-parameters) |
|---------------------------|-------------------|-----------------------------------------------------|------------------------|----------|
| Deployment frequency | Number of successful deployments | daily average per month | daily average | `day` (default) or `month` |
| Lead time for changes | Number of seconds to successfully deliver a commit into production | daily median per month | median time | `day` (default) or `month` |
| Time to restore service | Number of seconds an incident was open for | daily median per month | daily median | `day` (default) or `month` |
| Change failure rate | percentage of deployments that cause an incident in production | daily median per month | percentage of failed deployments | `day` (default) or `month` |
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Gain insights into DevOps performance and identify opportunities for
workflow improvements.
title: DevOps Research and Assessment (DORA) metrics
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
[DevOps Research and Assessment (DORA)](https://cloud.google.com/blog/products/devops-sre/using-the-four-keys-to-measure-your-devops-performance) metrics
deliver evidence-based insights about your DevOps performance.
These four key measurements demonstrate how fast your team delivers changes
and how well those changes perform in production.
When tracked consistently, DORA metrics highlight improvement opportunities
across your software delivery process.
Use DORA metrics for strategic decision-making, to justify process improvement investments to stakeholders,
or to compare your team's performance against industry benchmarks to identify competitive advantages.
The four DORA metrics measure two critical aspects of DevOps:
- **Velocity metrics** track how quickly your organization delivers software:
- [Deployment frequency](#deployment-frequency): How often code is deployed to production
- [Lead time for changes](#lead-time-for-changes): How long it takes code to reach production
- **Stability metrics** measure your software's reliability:
- [Change failure rate](#change-failure-rate): How often deployments cause production failures
- [Time to restore service](#time-to-restore-service): How quickly service recovers after failures
The dual focus on velocity and stability metrics helps leaders find the optimal balance between speed and quality in their delivery workflows.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For a video explanation, see [DORA metrics: User analytics](https://www.youtube.com/watch?v=jYQSH4EY6_U) and [GitLab speed run: DORA metrics](https://www.youtube.com/watch?v=1BrcMV6rCDw).
## Deployment frequency
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394712) fix for the frequency calculation formula for `all` and `monthly` intervals in GitLab 16.0.
{{< /history >}}
Deployment frequency is the frequency of successful deployments to production over the given date range (hourly, daily, weekly, monthly, or yearly).
Software leaders can use the deployment frequency metric to understand how often the team successfully deploys software to production, and how quickly the teams can respond to customers' requests or new market opportunities.
High deployment frequency means you can get feedback sooner and iterate faster to deliver improvements and features.
### Deployment frequency forecasting
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Experiment
{{< /details >}}
Deployment frequency forecasting (formerly named Value stream forecasting) uses a statistical forecasting model to predict productivity metrics and identify anomalies across the software development lifecycle.
This information can help you improve planning and decision-making for your product and teams.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
Watch an overview of [Value stream forecasting](https://www.youtube.com/watch?v=6u8_8QQ5pEQ&list=PLFGfElNsQthYDx0A_FaNNfUm9NHsK6zED).
### How deployment frequency is calculated
In GitLab, deployment frequency is measured by the average number of deployments per day to a given environment, based on the deployment's end time (its `finished_at` property).
GitLab calculates the deployment frequency from the number of finished deployments on the given day. Only successful deployments (`Deployment.statuses = success`) are counted.
The calculation takes into account the production `environment tier` or the environments named `production/prod`. The environment must be part of the production deployment tier for its deployment information to appear on the graphs.
You can configure DORA metrics for different environments by specifying `other` under the `environment_tiers` parameter in the [`.gitlab/insights.yml` file](../project/insights/_index.md#configuration).
{{< alert type="note" >}}
Deployment frequency is calculated as the **average (mean)**, unlike the other DORA metrics that use the median, which is preferred because it provides a more accurate and reliable view of performance.
This difference is because deployment frequency was added to GitLab prior to adopting the DORA framework, and the calculation of this metric remained unchanged when it was incorporated into other reports.
[Issue 499591](https://gitlab.com/gitlab-org/gitlab/-/issues/499591) proposes offering the option to customize the calculation method for each metric, choosing between mean and median.
{{< /alert >}}
### How to improve deployment frequency
The first step is to benchmark the cadence of code releases between groups and projects. Next, you should consider:
- Adding automated testing.
- Adding automated code validation.
- Breaking the changes down into smaller iterations.
## Lead time for changes
Lead time for changes is the amount of time it takes a code change to get into production.
**Lead time for changes** is not the same as **Lead time**. In value stream analytics, lead time measures the time it takes for work on an issue to move from the moment it's requested (Issue created) to the moment it's fulfilled and delivered (Issue closed).
For software leaders, lead time for changes reflects the efficiency of CI/CD pipelines and visualizes how quickly work is delivered to customers.
Over time, the lead time for changes should decrease, while your team's performance should increase. Low lead time for changes means more efficient CI/CD pipelines.
### How lead time for changes is calculated
GitLab calculates lead time for changes based on the number of seconds to successfully deliver a merge request into production: from merge request merge time (when the merge button is clicked) to code successfully running in production, without adding the `coding_time` to the calculation. Data is aggregated right after the deployment is finished, with a slight delay.
By default, lead time for changes supports measuring only one branch operation with multiple deployment jobs (for example, from development to staging to production on the default branch). When a merge request gets merged on staging, and then on production, GitLab interprets them as two deployed merge requests, not one.
#### Deployments finishing before merge
In rare cases, a deployment may finish before its associated merge request is merged.
This scenario can happen when:
- Deployment processes are triggered independently of the merge workflow.
- Manual deployment interventions occur before code review completion.
In this situation, GitLab uses the formula: `GREATEST(0, deployment_finished_at - merge_request_merged_at)`.
The `GREATEST` function ensures that lead time values are never negative, by returning `0` instead of a negative value.
This function prevents database constraint violations while maintaining data integrity.
### How to improve lead time for changes
The first step is to benchmark the CI/CD pipelines' efficiency between groups and projects. Next, you should consider:
- Using Value Stream Analytics to identify bottlenecks in the processes.
- Breaking the changes down into smaller iterations.
- Adding automation.
- Improving the performance of your pipelines.
## Time to restore service
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/356959) in GitLab 15.1.
{{< /history >}}
Time to restore service is the amount of time it takes an organization to recover from a failure in production.
For software leaders, time to restore service reflects how long it takes an organization to recover from a failure in production.
Low time to restore service means the organization can take risks with new innovative features to drive competitive advantages and increase business results.
### How time to restore service is calculated
In GitLab, time to restore service is measured as the median time an incident was open on a production environment.
GitLab calculates the number of seconds an incident was open on a production environment in the given time period. This assumes:
- [GitLab incidents](../../operations/incident_management/incidents.md) are tracked.
- All incidents are related to a production environment.
- Incidents and deployments have a strictly one-to-one relationship. An incident is related to only one production deployment, and any production deployment is related to no more than one incident.
### How to improve time to restore service
The first step is to benchmark the team response and recover from service interruptions and outages, between groups and projects. Next, you should consider:
- Improving the observability into the production environment.
- Improving response workflows.
- Improving deployment frequency and lead time for changes so fixes can get into production more efficiently.
## Change failure rate
Change failure rate is how often a change causes a failure in production.
Software leaders can use the change failure rate metric to gain insights into the quality of the code being shipped.
High change failure rate may indicate an inefficient deployment process or insufficient automated testing coverage.
### How change failure rate is calculated
In GitLab, change failure rate is measured as the percentage of deployments that cause an incident in production in a given time period.
GitLab calculates change failure rate as the number of incidents divided by the number of deployments to a production environment. This calculation assumes:
- [GitLab incidents](../../operations/incident_management/incidents.md) are tracked.
- All incidents are production incidents, regardless of the environment.
- Change failure rate is used primarily as high-level stability tracking, which is why in a given day, all incidents and deployments are aggregated into a joined daily rate. Adding specific relations between deployments and incidents is proposed in [issue 444295](https://gitlab.com/gitlab-org/gitlab/-/issues/444295).
- Change failure rate calculates duplicate incidents as separate entries, which results in double counting. [Issue 480920](https://gitlab.com/gitlab-org/gitlab/-/issues/480920) proposes a solution for a more accurate calculation.
For example, if you have 10 deployments (considering one deployment per day) with two incidents on the first day and one incident on the last day, then your change failure rate is 0.3.
### How to improve change failure rate
The first step is to benchmark the quality and stability, between groups and projects. Next, you should consider:
- Finding the right balance between stability and throughput (Deployment frequency and Lead time for changes), and not sacrificing quality for speed.
- Improving the efficacy of code review processes.
- Adding automated testing.
## DORA custom calculation rules
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Self-Managed
- Status: Experiment
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96561) in GitLab 15.4 [with a flag](../../administration/feature_flags/_index.md) named `dora_configuration`. Disabled by default. This feature is an [experiment](../../policy/development_stages_support.md).
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
This feature is an [experiment](../../policy/development_stages_support.md).
To join the list of users testing this feature, [here is a suggested test flow](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96561#steps-to-check-on-localhost).
If you find a bug, [open an issue here](https://gitlab.com/groups/gitlab-org/-/epics/11490).
To share your use cases and feedback, comment in [epic 11490](https://gitlab.com/groups/gitlab-org/-/epics/11490).
### Multi-branch rule for lead time for changes
Unlike the default [calculation of lead time for changes](#how-lead-time-for-changes-is-calculated), this calculation rule allows measuring multi-branch operations with a single deployment job for each operation.
For example, from development job on development branch, to staging job on staging branch, to production job on production branch.
This calculation rule has been implemented by updating the `dora_configurations` table with the target branches that are part of the development flow.
This way, GitLab can recognize the branches as one, and filter out other merge requests.
This configuration changes how daily DORA metrics are calculated for the selected project, but doesn't affect other projects, groups, or users.
This feature supports only project-level propagation.
To do this, in the Rails console run the following command:
```ruby
my_project = Project.find_by_full_path('group/subgroup/project')
Dora::Configuration.create!(project: my_project, branches_for_lead_time_for_changes: ['master', 'main'])
```
To update an existing configuration, run the following command:
```ruby
my_project = Project.find_by_full_path('group/subgroup/project')
record = Dora::Configuration.where(project: my_project).first
record.branches_for_lead_time_for_changes = ['development', 'staging', 'master', 'main']
record.save!
```
## Measure DORA metrics
### Without using GitLab CI/CD pipelines
Deployment frequency is calculated based on the deployments record, which is created for typical push-based deployments.
These deployment records are not created for pull-based deployments, for example when Container Images are connected to GitLab with an agent.
To track DORA metrics in these cases, you can [create a deployment record](../../api/deployments.md#create-a-deployment) using the Deployments API.
You must set the environment name where the deployment tier is configured, because the tier variable is specified for the given environment, not for the deployments.
For more information, see how to [track deployments of an external deployment tool](../../ci/environments/external_deployment_tools.md).
### With Jira
- Deployment frequency and lead time for changes are calculated based on GitLab CI/CD and Merge Requests (MRs), and do not require Jira data.
- Time to restore service and change failure rate require [GitLab incidents](../../operations/incident_management/manage_incidents.md) for the calculation. For more information, see how to measure these metrics [with external incidents](#with-external-incidents) and the [Jira incident replicator guide](https://gitlab.com/smathur/jira-incident-replicator).
### With external incidents
You can measure the time to restore service and change failure rate for incident management.
For PagerDuty, you can [set up a webhook](../../operations/incident_management/manage_incidents.md#using-the-pagerduty-webhook)
to automatically create a GitLab incident for each PagerDuty incident.
This configuration requires you to make changes in both PagerDuty and GitLab.
For other incident management tools, you can set up the
[HTTP integration](../../operations/incident_management/integrations.md#alerting-endpoints),
and use it to automatically:
1. [Create an incident when an alert is triggered](../../operations/incident_management/manage_incidents.md#automatically-when-an-alert-is-triggered).
1. [Close incidents via recovery alerts](../../operations/incident_management/manage_incidents.md#automatically-close-incidents-via-recovery-alerts).
## Analytics features
DORA metrics are displayed in the following analytics features:
- [Value Streams Dashboard](value_streams_dashboard.md) includes the [DORA metrics comparison panel](value_streams_dashboard.md#devsecops-metrics-comparison) and [DORA Performers score panel](value_streams_dashboard.md#dora-performers-score).
- [CI/CD analytics charts](ci_cd_analytics.md) show the history of DORA metrics over time.
- [Insights reports](../project/insights/_index.md) provide the option to create custom charts with [DORA query parameters](../project/insights/_index.md#dora-query-parameters).
- [GraphQL API](../../api/graphql/reference/_index.md) (with the interactive [GraphQL explorer](../../api/graphql/_index.md#interactive-graphql-explorer)) and [REST API](../../api/dora/metrics.md) support the retrieval of metrics data.
## Project and group availability
The following table provides an overview of the DORA metrics' availability in projects and groups.
| Metric | Level | Comments |
|---------------------------|-------------------|----------|
| `deployment_frequency` | Project | Unit in deployment count. |
| `deployment_frequency` | Group | Unit in deployment count. Aggregation method is average. |
| `lead_time_for_changes` | Project | Unit in seconds. Aggregation method is median. |
| `lead_time_for_changes` | Group | Unit in seconds. Aggregation method is median. |
| `time_to_restore_service` | Project and group | Unit in days. Aggregation method is median. (Available in UI chart in GitLab 15.1 and later) |
| `change_failure_rate` | Project and group | Percentage of deployments. (Available in UI chart in GitLab 15.2 and later) |
## Data aggregation
The following table provides an overview of the DORA metrics' data aggregation in different charts.
| Metric name | Measured values | Data aggregation in the [Value Streams Dashboard](value_streams_dashboard.md) | Data aggregation in [CI/CD analytics charts](ci_cd_analytics.md) | Data aggregation in [Custom insights reporting](../project/insights/_index.md#dora-query-parameters) |
|---------------------------|-------------------|-----------------------------------------------------|------------------------|----------|
| Deployment frequency | Number of successful deployments | daily average per month | daily average | `day` (default) or `month` |
| Lead time for changes | Number of seconds to successfully deliver a commit into production | daily median per month | median time | `day` (default) or `month` |
| Time to restore service | Number of seconds an incident was open for | daily median per month | daily median | `day` (default) or `month` |
| Change failure rate | percentage of deployments that cause an incident in production | daily median per month | percentage of failed deployments | `day` (default) or `month` |
|
https://docs.gitlab.com/user/ci_cd_analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/ci_cd_analytics.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
ci_cd_analytics.md
|
Deploy
|
Environments
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
CI/CD analytics
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use CI/CD analytics to gain insights into your pipeline performance and success rates.
The CI/CD analytics page provides visualizations for critical CI/CD pipeline metrics directly in the GitLab UI.
These visualizations can help development teams quickly understand the health and efficiency of their software development process.
## View CI/CD analytics
{{< history >}}
- [Updated](https://gitlab.com/gitlab-org/gitlab/-/issues/353607) in GitLab 18.0 to improve analytics by using ClickHouse as the data source when available.
{{< /history >}}
To view CI/CD analytics:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > CI/CD analytics**.
## Pipeline metrics
You can view the history of your pipeline successes and failures, and how long each pipeline ran.
Pipeline statistics are gathered by collecting all available pipelines for the
project, regardless of status. The data available for each individual day is based
on when the pipeline was created.
CI/CD analytics displays key metrics about your pipelines:
- **Total pipeline runs**: The total number of pipelines that have run in the selected time period. The total pipeline calculation includes child pipelines and pipelines that failed with an invalid YAML.
To filter pipelines based on other attributes, use the [Pipelines API](../../api/pipelines.md#list-project-pipelines).
- **Median duration**: The median time it takes for pipelines to complete.
- **Failure rate**: The percentage of pipelines that failed.
- **Success rate**: The percentage of pipelines that completed successfully.
## Filter your results
You can filter the analytics data to focus on specific areas:
- **Source**: Filter by pipeline trigger source.
- **Branch**: Filter by the branch where the pipeline ran.
- **Date range**: Select the time period to analyze (for example, last week).
Filtering allows you to analyze the performance of specific workflow components or compare different branches.
## Pipeline duration chart
The duration chart shows how your pipeline execution times changed over time. The chart displays:
- **Median (50th percentile)**: The typical pipeline duration.
- **95th percentile**: 95% of pipelines complete in this time or less, while only 5% take longer.
This visualization helps you identify trends in pipeline duration, which can help you determine your CI/CD process efficiency over time.
## Pipeline status chart
The status chart shows the distribution of pipeline statuses over time:
- **Successful**: Pipelines that completed without errors.
- **Failed**: Pipelines that did not complete successfully due to errors.
- **Other**: Pipelines with other statuses (canceled, skipped).
This visualization helps you track the stability of your pipelines and identify periods with higher failure rates.
|
---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: CI/CD analytics
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use CI/CD analytics to gain insights into your pipeline performance and success rates.
The CI/CD analytics page provides visualizations for critical CI/CD pipeline metrics directly in the GitLab UI.
These visualizations can help development teams quickly understand the health and efficiency of their software development process.
## View CI/CD analytics
{{< history >}}
- [Updated](https://gitlab.com/gitlab-org/gitlab/-/issues/353607) in GitLab 18.0 to improve analytics by using ClickHouse as the data source when available.
{{< /history >}}
To view CI/CD analytics:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > CI/CD analytics**.
## Pipeline metrics
You can view the history of your pipeline successes and failures, and how long each pipeline ran.
Pipeline statistics are gathered by collecting all available pipelines for the
project, regardless of status. The data available for each individual day is based
on when the pipeline was created.
CI/CD analytics displays key metrics about your pipelines:
- **Total pipeline runs**: The total number of pipelines that have run in the selected time period. The total pipeline calculation includes child pipelines and pipelines that failed with an invalid YAML.
To filter pipelines based on other attributes, use the [Pipelines API](../../api/pipelines.md#list-project-pipelines).
- **Median duration**: The median time it takes for pipelines to complete.
- **Failure rate**: The percentage of pipelines that failed.
- **Success rate**: The percentage of pipelines that completed successfully.
## Filter your results
You can filter the analytics data to focus on specific areas:
- **Source**: Filter by pipeline trigger source.
- **Branch**: Filter by the branch where the pipeline ran.
- **Date range**: Select the time period to analyze (for example, last week).
Filtering allows you to analyze the performance of specific workflow components or compare different branches.
## Pipeline duration chart
The duration chart shows how your pipeline execution times changed over time. The chart displays:
- **Median (50th percentile)**: The typical pipeline duration.
- **95th percentile**: 95% of pipelines complete in this time or less, while only 5% take longer.
This visualization helps you identify trends in pipeline duration, which can help you determine your CI/CD process efficiency over time.
## Pipeline status chart
The status chart shows the distribution of pipeline statuses over time:
- **Successful**: Pipelines that completed without errors.
- **Failed**: Pipelines that did not complete successfully due to errors.
- **Other**: Pipelines with other statuses (canceled, skipped).
This visualization helps you track the stability of your pipelines and identify periods with higher failure rates.
|
https://docs.gitlab.com/user/productivity_analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/productivity_analytics.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
productivity_analytics.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Productivity analytics
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Productivity analytics display information about merge requests for groups.
Use productivity analytics to identify:
- Your development velocity based on how long it takes for a merge request to merge.
- Potential causes of merge requests that take a long time to merge.
- Authors, labels, or milestones that take the longest time to merge or contain most changes.
To view merge request data for projects, use [merge request analytics](merge_request_analytics.md).
## Charts
Productivity analytics display the following charts:
- Bar charts that illustrate the:
- Number of merge requests by number of days to merge.
- Time between commits, comments, and merge dates.
- Number of commits, lines of code, and files changed.
- A scatterplot that illustrates the number of merge request metrics (such as number of commits per merge request) per day (merged date).
- A table that lists merge request titles, time to merge, and duration between commits, comments, and merge dates.
## View productivity analytics
Prerequisites:
- You must have at least the Reporter role for the group.
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Productivity analytics**.
1. Optional. Filter results:
- To view analytics for a specific project, from the **Projects** dropdown list, select a project.
- To filter results by author, milestone, or label, select **Filter results** and enter a value.
- To adjust the date range:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Productivity analytics
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Productivity analytics display information about merge requests for groups.
Use productivity analytics to identify:
- Your development velocity based on how long it takes for a merge request to merge.
- Potential causes of merge requests that take a long time to merge.
- Authors, labels, or milestones that take the longest time to merge or contain most changes.
To view merge request data for projects, use [merge request analytics](merge_request_analytics.md).
## Charts
Productivity analytics display the following charts:
- Bar charts that illustrate the:
- Number of merge requests by number of days to merge.
- Time between commits, comments, and merge dates.
- Number of commits, lines of code, and files changed.
- A scatterplot that illustrates the number of merge request metrics (such as number of commits per merge request) per day (merged date).
- A table that lists merge request titles, time to merge, and duration between commits, comments, and merge dates.
## View productivity analytics
Prerequisites:
- You must have at least the Reporter role for the group.
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Productivity analytics**.
1. Optional. Filter results:
- To view analytics for a specific project, from the **Projects** dropdown list, select a project.
- To filter results by author, milestone, or label, select **Filter results** and enter a value.
- To adjust the date range:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
|
https://docs.gitlab.com/user/repository_analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/repository_analytics.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
repository_analytics.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Repository analytics for projects
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Repository analytics is part of [GitLab Community Edition](https://gitlab.com/gitlab-org/gitlab-foss)
and is available to users with permission to clone the repository.
Use repository analytics to view information about a project's Git repository, such as:
- Programming languages used in the repository's default branch.
- Code coverage statistics for the last three months.
- Commit statistics for the last month.
- Number of commits per day of month, per weekday, and per hour.
## Chart data processing
Data in the charts is queued.
Background workers update the charts 10 minutes after each commit to the default branch.
Depending on the size of GitLab installation and background job queues, it might take longer for data to refresh.
## View repository analytics
Prerequisites:
- You must have an initialized Git repository.
- There must be at least one commit in the default branch (`main` by default), excluding commits in a project's [wiki](../project/wiki/_index.md#track-wiki-events), which are not included in the analysis.
To view repository analytics for a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Repository analytics**.
1. To view details about a category, hover over a bar in the chart.
1. To view statistics of code coverage and commits in a specific branch, from the dropdown list next to **Commit statistics**, select a branch.
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Repository analytics for projects
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Repository analytics is part of [GitLab Community Edition](https://gitlab.com/gitlab-org/gitlab-foss)
and is available to users with permission to clone the repository.
Use repository analytics to view information about a project's Git repository, such as:
- Programming languages used in the repository's default branch.
- Code coverage statistics for the last three months.
- Commit statistics for the last month.
- Number of commits per day of month, per weekday, and per hour.
## Chart data processing
Data in the charts is queued.
Background workers update the charts 10 minutes after each commit to the default branch.
Depending on the size of GitLab installation and background job queues, it might take longer for data to refresh.
## View repository analytics
Prerequisites:
- You must have an initialized Git repository.
- There must be at least one commit in the default branch (`main` by default), excluding commits in a project's [wiki](../project/wiki/_index.md#track-wiki-events), which are not included in the analysis.
To view repository analytics for a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Repository analytics**.
1. To view details about a category, hover over a bar in the chart.
1. To view statistics of code coverage and commits in a specific branch, from the dropdown list next to **Commit statistics**, select a branch.
|
https://docs.gitlab.com/user/merge_request_analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/merge_request_analytics.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
merge_request_analytics.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Merge request analytics
|
Merge request analytics help you understand the efficiency of your code review process, and the productivity of your team.
|
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Merge request analytics provide DevOps managers with valuable insights into their team's code review and merging workflows.
Based on the detailed metrics and trends related to merge requests, organizations can monitor and optimize their development processes.
Use merge request analytics to view:
- The number of merge requests your organization merged per month.
- The average time between merge request creation and merge event.
- Information about each merged merge request (such as milestone, commits, line changes, and assignees).
You can use merge request analytics to identify:
- Low or high productivity months.
- The efficiency and productivity of your merge request and code review processes.
These insights can help you make data-driven decisions like:
- Resource allocation: Address low productivity periods by reallocating resources or adjusting timelines.
- Performance benchmarking: Highlight high-performing teams and share best practices.
- Milestone planning: Adjust timelines based on historical merging trends.
- Process optimization: Identify and resolve bottlenecks in code review and merging workflows.
## View merge request analytics
Prerequisites:
- You must have at least the Reporter role.
To view merge request analytics:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Merge request analytics**.
## View the number of merge requests in a date range
To view the number of merge requests merged during a specific date range:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Merge request analytics**.
1. Optional. Filter results:
1. Select the filter bar.
1. Select a parameter.
1. Select a value or enter text to refine the results.
1. To adjust the date range:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
The **Throughput** chart shows issues closed or merge requests merged (not closed) over a period of
time.
The table shows up to 20 merge requests per page, and includes
the following information about each merge request:
- Merge request name
- Date merged
- Time to merge
- Milestone
- Commits
- Pipelines
- Line changes
- Assignees
## View average time between merge request creation and merge
The number in **Mean time to merge** shows the average time between when a merge request is
created and when it's merged. Closed and not yet merged merge requests are not included.
To view **Mean time to merge**:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Merge request analytics**. The **Mean time to merge** number
is displayed on the dashboard.
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Merge request analytics help you understand the efficiency of your code
review process, and the productivity of your team.
title: Merge request analytics
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Merge request analytics provide DevOps managers with valuable insights into their team's code review and merging workflows.
Based on the detailed metrics and trends related to merge requests, organizations can monitor and optimize their development processes.
Use merge request analytics to view:
- The number of merge requests your organization merged per month.
- The average time between merge request creation and merge event.
- Information about each merged merge request (such as milestone, commits, line changes, and assignees).
You can use merge request analytics to identify:
- Low or high productivity months.
- The efficiency and productivity of your merge request and code review processes.
These insights can help you make data-driven decisions like:
- Resource allocation: Address low productivity periods by reallocating resources or adjusting timelines.
- Performance benchmarking: Highlight high-performing teams and share best practices.
- Milestone planning: Adjust timelines based on historical merging trends.
- Process optimization: Identify and resolve bottlenecks in code review and merging workflows.
## View merge request analytics
Prerequisites:
- You must have at least the Reporter role.
To view merge request analytics:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Merge request analytics**.
## View the number of merge requests in a date range
To view the number of merge requests merged during a specific date range:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Merge request analytics**.
1. Optional. Filter results:
1. Select the filter bar.
1. Select a parameter.
1. Select a value or enter text to refine the results.
1. To adjust the date range:
- In the **From** field, select a start date.
- In the **To** field, select an end date.
The **Throughput** chart shows issues closed or merge requests merged (not closed) over a period of
time.
The table shows up to 20 merge requests per page, and includes
the following information about each merge request:
- Merge request name
- Date merged
- Time to merge
- Milestone
- Commits
- Pipelines
- Line changes
- Assignees
## View average time between merge request creation and merge
The number in **Mean time to merge** shows the average time between when a merge request is
created and when it's merged. Closed and not yet merged merge requests are not included.
To view **Mean time to merge**:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Merge request analytics**. The **Mean time to merge** number
is displayed on the dashboard.
|
https://docs.gitlab.com/user/dora_metrics_charts
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/dora_metrics_charts.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
dora_metrics_charts.md
|
Deploy
|
Environments
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
DevOps Research and Assessment (DORA) metrics charts
| null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
CI/CD analytics page display metrics and charts for [DevOps Research and Assessment (DORA) metrics](dora_metrics.md).
The charts display the evolution of each DORA metric over time, for the last week, month, 90 days, or 180 days.
This information provides insights into the health of your organization.
## View CI/CD analytics
You can view CI/CD analytics for a group or project.
Prerequisites:
- To view DORA metrics, the group or project must have an environment in the [production deployment tier](../../ci/environments/_index.md#deployment-tier-of-environments).
### For a group
To view CI/CD analytics for a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > CI/CD analytics**.
The page displays metrics and charts for:
- Release statistics
- DORA metrics
### For a project
To view CI/CD analytics for a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > CI/CD analytics**.
The page displays metrics and charts for:
- Pipelines
- DORA metrics
- Project quality
|
---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: DevOps Research and Assessment (DORA) metrics charts
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
CI/CD analytics page display metrics and charts for [DevOps Research and Assessment (DORA) metrics](dora_metrics.md).
The charts display the evolution of each DORA metric over time, for the last week, month, 90 days, or 180 days.
This information provides insights into the health of your organization.
## View CI/CD analytics
You can view CI/CD analytics for a group or project.
Prerequisites:
- To view DORA metrics, the group or project must have an environment in the [production deployment tier](../../ci/environments/_index.md#deployment-tier-of-environments).
### For a group
To view CI/CD analytics for a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > CI/CD analytics**.
The page displays metrics and charts for:
- Release statistics
- DORA metrics
### For a project
To view CI/CD analytics for a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > CI/CD analytics**.
The page displays metrics and charts for:
- Pipelines
- DORA metrics
- Project quality
|
https://docs.gitlab.com/user/code_review_analytics
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/code_review_analytics.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
code_review_analytics.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Code review analytics
|
Learn how long your open merge requests have spent in code review, and what distinguishes the longest-running.
|
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Moved to GitLab Premium in 13.9.
{{< /history >}}
Code review analytics displays a table of open merge requests that have at least one non-author comment.
The review time is the amount of time since the first comment by a non-author in a merge request.
You can use code review analytics to view review metrics per merge request
and improve your code review process.
- A high number of comments or commits may indicate:
- Code that is too complex.
- Authors who require more training.
- A long review time may indicate:
- Types of work that move slower than other types.
- Opportunities to accelerate your development cycle.
- Few comments and approvers may indicate a lack of available team members.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For a video explanation, see [Code review analytics: Faster code review](https://www.youtube.com/watch?v=849o0XD991M).
## View code review analytics
Prerequisites:
- You must have at least the Reporter role.
To view code review analytics:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Code review analytics**.
1. Optional. Filter results:
1. Select the filter bar.
1. Select a parameter. You can filter merge requests by milestone and label.
1. Select a value for the selected parameter.
The table shows up to 20 merge requests in review per page,
and includes the following information about each merge request:
- Merge request title
- Review time
- Author
- Approvers
- Comments
- Commits
- Line changes
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Learn how long your open merge requests have spent in code review, and
what distinguishes the longest-running.
title: Code review analytics
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Moved to GitLab Premium in 13.9.
{{< /history >}}
Code review analytics displays a table of open merge requests that have at least one non-author comment.
The review time is the amount of time since the first comment by a non-author in a merge request.
You can use code review analytics to view review metrics per merge request
and improve your code review process.
- A high number of comments or commits may indicate:
- Code that is too complex.
- Authors who require more training.
- A long review time may indicate:
- Types of work that move slower than other types.
- Opportunities to accelerate your development cycle.
- Few comments and approvers may indicate a lack of available team members.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For a video explanation, see [Code review analytics: Faster code review](https://www.youtube.com/watch?v=849o0XD991M).
## View code review analytics
Prerequisites:
- You must have at least the Reporter role.
To view code review analytics:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Code review analytics**.
1. Optional. Filter results:
1. Select the filter bar.
1. Select a parameter. You can filter merge requests by milestone and label.
1. Select a value for the selected parameter.
The table shows up to 20 merge requests in review per page,
and includes the following information about each merge request:
- Merge request title
- Review time
- Author
- Approvers
- Comments
- Commits
- Line changes
|
https://docs.gitlab.com/user/value_streams_dashboard
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/value_streams_dashboard.md
|
2025-08-13
|
doc/user/analytics
|
[
"doc",
"user",
"analytics"
] |
value_streams_dashboard.md
|
Plan
|
Optimize
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Value Streams Dashboard
|
View DevSecOps metrics (such as DORA and vulnerabilities) across your organization on a customizable dashboard.
|
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Introduced in GitLab 15.8 as a closed [beta](../../policy/development_stages_support.md#beta) feature [with a flag](../../administration/feature_flags/_index.md) named `group_analytics_dashboards_page`. Disabled by default.
- Released in GitLab 15.11 as an open [beta](../../policy/development_stages_support.md#beta) feature [with a flag](../../administration/feature_flags/_index.md) named `group_analytics_dashboards_page`. Enabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/392734) in GitLab 16.0. Feature flag `group_analytics_dashboards_page` removed.
- [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195086) from GitLab Ultimate to GitLab Premium in 18.2.
{{< /history >}}
To help us improve the Value Streams Dashboard, share feedback about your experience in this [survey](https://gitlab.fra1.qualtrics.com/jfe/form/SV_50guMGNU2HhLeT4).
For more information, see the [Value Stream Management category direction page](https://about.gitlab.com/direction/plan/value_stream_management/).
The Value Streams Dashboard is a customizable dashboard you can use to identify trends, patterns, and opportunities for digital transformation improvements.
The centralized UI in the Value Streams Dashboard acts as the single source of truth (SSOT), where all stakeholders can access and view the same set of metrics that are relevant to the organization.
The Value Streams Dashboard includes panels that visualize the following metrics:
- [DORA metrics](dora_metrics.md)
- [Value Stream Analytics (VSA) - flow metrics](../group/value_stream_analytics/_index.md)
- [Vulnerabilities](https://gitlab.com/gitlab-org/gitlab/-/security/vulnerability_report) metrics
- [GitLab Duo Code Suggestions](../project/repository/code_suggestions/_index.md)
With the Value Streams Dashboard, you can:
- Track and compare the metrics listed previously over a period of time.
- Identify downward trends early on.
- Understand security exposure.
- Drill down into individual projects or metrics to take actions for improvement.
- Understand the impact of adding AI to the software development lifecycle (SDLC) and demonstrate the return on investment (ROI) of investments in GitLab Duo.
For a click-through demo, see [the Value Stream Management product tour](https://gitlab.navattic.com/vsm).
To view the Value Streams Dashboard as an analytics dashboard for a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Analytics dashboards**.
1. From the list of available dashboards, select **Value Streams Dashboard**.
{{< alert type="note" >}}
Data displayed on the Value Streams Dashboard is continuously collected in the backend.
If you upgrade to the Ultimate tier, you get access to historical data, and can view metrics about past GitLab usage and performance.
{{< /alert >}}
## Panels
The Value Streams Dashboard panels have a default configuration, but you can also [customize the dashboard panels](#customize-dashboard-panels).
### Overview
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/439699) in GitLab 16.7 [with a flag](../../administration/feature_flags/_index.md) named `group_analytics_dashboard_dynamic_vsd`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/432185) in GitLab 17.0.
- Feature flag `group_analytics_dashboard_dynamic_vsd` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/441206) in GitLab 17.0.
{{< /history >}}
The Overview panel provides a holistic view of the top-level namespace activity by visualizing key DevOps metrics.
The panel displays metrics for:
- Subgroups
- Projects
- Users
- Issues
- Merge requests
- Pipelines
Data displayed in the Overview panel is collected by batch processing. GitLab stores record counts for each subgroup in the database, then aggregates the record counts to provide metrics for the top-level group.
Data is aggregated monthly, around the end of the month, on a best-effort basis depending on the load on GitLab systems.
For more information, see [epic 10417](https://gitlab.com/groups/gitlab-org/-/epics/10417#iterations-path).
{{< alert type="note" >}}
To view metrics on the Overview panel, the [background aggregation](#enable-or-disable-overview-background-aggregation) must be enabled.
{{< /alert >}}
### DevSecOps metrics comparison
{{< history >}}
- Contributor count metric at the group level [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/433353) to GitLab.com in GitLab 16.9.
- Contributor count metric at the project level [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/474119) to GitLab.com in GitLab 18.0.
{{< /history >}}
The DevSecOps metrics comparison panels display metrics for a group or project
in the month-to-date, last month, the month before, and the past 180 days.
These visualizations help you understand whether the key DevSecOps metrics improve month over month. The Value Stream Dashboard displays three DevSecOps metric comparison panels:
- Lifecycle metrics
- DORA metrics (Ultimate only)
- Security metrics (Ultimate only)
In each comparison panel, you can:
- Compare the performance between groups, projects, and teams at a glance.
- Identify the teams and projects that are the largest value contributors, overperforming, or underperforming.
- Drill down the metrics for further analysis.
When you hover over a metric, a tooltip displays an explanation of the metric and a link to the related documentation page.
The monthly values also indicate a percentage increase or decrease compared to the previous month.
The sparkline for the past six months represents value trends over this time period, not the percentage change rate.
The sparkline color ranges from blue to green, where green indicates a positive trend, and blue indicates a negative trend.
Sparklines help you identify patterns in metric trends (such as seasonal changes) over time.
#### Filter panels by label
Label filters are appended as query parameters to the URL of the drill-down report of each eligible metric and automatically applied.
If a comparison panel from the configuration file is enabled with `filters.labels`, the drill-down links inherit the labels from the panel filter.
```yaml
panels:
- title: 'Group dora metrics'
visualization: vsd_dora_metrics_table
queryOverrides:
namespace: my-dora-group
filters:
labels:
- in_development
- in_review
```
{{< alert type="note" >}}
Only labels that exactly match the specified filters are applied.
{{< /alert >}}
### DORA Performers score
{{< details >}}
- Tier: Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386843) in GitLab 16.3 [with a flag](../../administration/feature_flags/_index.md) named `dora_performers_score_panel`. Disabled by default.
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/439737) in GitLab 16.9.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/440694) in GitLab 16.11. Feature flag `dora_performers_score_panel` removed.
{{< /history >}}
The [DORA](dora_metrics.md) Performers score panel is a group-level bar chart that visualizes the status of the organization's DevOps performance levels across different projects for the last full calendar month.
The chart is a breakdown of your project's DORA scores, [categorized](https://cloud.google.com/blog/products/devops-sre/dora-2022-accelerate-state-of-devops-report-now-out) as high, medium, or low.
The chart aggregates all the child projects in the group.
The chart bars display the total number of projects per score category, calculated monthly.
To exclude data from the chart (for example, **Not included**), in the legend select the series you want to exclude.
Hovering over each bar reveals a dialog that explains the score's definition.
For example, if a project has a high score for deployment frequency (velocity), it means that the project has one or more deploys to production per day.
| Metric | High | Medium | Low | Description |
|-------------------------|------|---------|------|-------------|
| Deployment frequency | ≥30 | 1-29 | \<1 | The number of deploys to production per day |
| Lead time for changes | ≤7 | 8-29 | ≥30 | The number of days to go from code committed to code successfully running in production |
| Time to restore service | ≤1 | 2-6 | ≥7 | The number of days to restore service when a service incident or a defect that impacts users occurs |
| Change failure rate | ≤15% | 16%-44% | ≥45% | The percentage of changes to production resulted in degraded service |
To learn more, see the blog post [Inside DORA Performers score in GitLab Value Streams Dashboard](https://about.gitlab.com/blog/2024/01/18/inside-dora-performers-score-in-gitlab-value-streams-dashboard/).
#### Filter the panel by project topic
When you customize dashboards with a YAML configuration,
you can filter the displayed projects by assigned [topics](../project/project_topics.md).
```yaml
panels:
- title: 'My dora performers scores'
visualization: dora_performers_score
queryOverrides:
namespace: group/my-custom-group
filters:
projectTopics:
- JavaScript
- Vue.js
```
If multiple topics are provided, all topics must match for the project to be included in the results.
### Projects by DORA metric
{{< details >}}
- Tier: Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/408516) in GitLab 17.7.
{{< /history >}}
The **Projects by [DORA](dora_metrics.md) metric** panel is a group-level table that lists the status of the organization's DevOps performance levels across projects.
The table lists all projects with their DORA metrics, aggregating data from child projects in groups and subgroups.
The metrics are aggregated for the last full calendar month.
You can sort the projects by metric values, helping you identify high, medium, and low-performing projects.
For further investigation, you can select a project name to drill down into that project's page.
## Enable or disable overview background aggregation
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120610) in GitLab 16.1 [with a flag](../../administration/feature_flags/_index.md) named `value_stream_dashboard_on_off_setting`. Disabled by default.
- [Enabled on GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130704) in GitLab 16.4.
- [Feature flag `value_stream_dashboard_on_off_setting` removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/134619) in GitLab 16.6.
{{< /history >}}
To enable or disable the overview count aggregation for the Value Streams Dashboard:
1. On the left sidebar, select **Search or go to** and find your group.
This group must be at the top level.
1. Select **Settings > Analytics**.
1. In **Value Streams Dashboard**, select or clear the **Enable overview background aggregation for Value Streams Dashboard** checkbox.
To retrieve aggregated usage counts in the group, use the [GraphQL API](../../api/graphql/reference/_index.md#groupvaluestreamdashboardusageoverview).
## View the Value Streams Dashboard
Prerequisites:
- You must have at least the Reporter role for the group or project.
- [Overview background aggregation](#enable-or-disable-overview-background-aggregation) must be enabled.
- To view the contributor count metric in the comparison panel, you must [set up ClickHouse](../../integration/clickhouse.md).
- To track deployment to production, the group or project must have an environment in the [production deployment tier](../../ci/environments/_index.md#deployment-tier-of-environments).
- To measure the cycle time, [issues must be crosslinked from commit messages](../../user/project/issues/crosslinking_issues.md#from-commit-messages).
### For groups
To view the Value Streams Dashboard for a group:
- From Analytics Dashboards:
1. On the group left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Analytics Dashboards**.
- From Value Stream Analytics:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. Below the **Filter results** text box, in the **Lifecycle metrics** row, select **Value Streams Dashboard / DORA**.
1. Optional. To open the new page, append this path `/analytics/dashboards/value_streams_dashboard` to the group URL (for example, `https://gitlab.com/groups/gitlab-org/-/analytics/dashboards/value_streams_dashboard`).
### For projects
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137483) in GitLab 16.7 [with a flag](../../administration/feature_flags/_index.md) named `project_analytics_dashboard_dynamic_vsd`. Disabled by default.
- Feature flag `project_analytics_dashboard_dynamic_vsd` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/441207) in GitLab 17.5.
{{< /history >}}
To view the Value Streams Dashboard as an analytics dashboard for a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Analytics dashboards**.
1. From the list of available dashboards, select **Value Streams Dashboard**.
## Schedule reports
You can schedule reports using the CI/CD component
[Value Streams Dashboard Scheduled Reports tool](https://gitlab.com/components/vsd-reports-generator).
This tool saves time and effort by eliminating the need to manually search for the right dashboard with the relevant data, so that you can focus on analyzing insights.
By scheduling reports, you can ensure that the decision-makers in your organization receive proactive, timely, and relevant information.
The Scheduled Reports tool collects metrics from projects or groups through the public GitLab GraphQL API,
then builds a report using [GitLab Flavored Markdown](../markdown.md),
and opens an issue in a specified project.
The issue includes a comparison metrics table in Markdown format.
See an [example scheduled report](https://gitlab.com/components/vsd-reports-generator#example-for-monthly-executive-value-streams-report). To learn more, see the blog post [New Scheduled Reports Generation tool simplifies value stream management](https://about.gitlab.com/blog/2024/06/20/new-scheduled-reports-generation-tool-simplifies-value-stream-management/).
## Customize dashboard panels
You can customize the Value Streams Dashboard and configure what subgroups and projects to include in the page.
To customize the default content of the page, you need to create a YAML configuration file in a project of your choice.
In this file, you can define various settings and parameters, such as title, description, and number of panels and labels filters.
The file is schema-driven and managed with version control systems like Git.
This enables tracking and maintaining a history of configuration changes, reverting to previous versions if necessary, and collaborating effectively with team members.
Query parameters can still be used to override the YAML configuration.
Before you customize the dashboard panels, you must select a project to store your YAML configuration file.
Prerequisites:
- You must have at least the Maintainer role for the group.
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > Analytics**.
1. Select the project where you would like to store your YAML configuration file.
1. Select **Save changes**.
After you have set up the project, set up the configuration file:
1. On the left sidebar, select **Search or go to** and find the project you selected in the previous step.
1. In the default branch, create the configuration file: `.gitlab/analytics/dashboards/value_streams/value_streams.yaml`.
1. In the `value_streams.yaml` configuration file, fill in the configuration options:
| Field | Description |
|--------------------------------------------|-------------|
| `title` | Custom name for the panel |
| `queryOverrides` (formerly `data`) | Overrides data query parameters specific to each visualization. |
| `namespace` (subfield of `queryOverrides`) | Group or project path to use for the panel |
| `filters` (subfield of `queryOverrides`) | Filters the query for each visualization type. See [supported visualizations](#supported-visualization-filters). |
| `visualization` | The type of visualization to be rendered. Supported options are `dora_chart`, `dora_performers_score`, and `usage_overview`. |
| `gridAttributes` | The size and positioning of the panel |
| `xPos` (subfield of `gridAttributes`) | Horizontal position of the panel |
| `yPos` (subfield of `gridAttributes`) | Vertical position of the panel |
| `width` (subfield of `gridAttributes`) | Width of the panel (max. 12) |
| `height` (subfield of `gridAttributes`) | Height of the panel |
```yaml
# version - The latest version of the analytics dashboard schema
version: '2'
# title - Change the title of the Value Streams Dashboard.
title: 'Custom Dashboard title'
# description - Change the description of the Value Streams Dashboard. [optional]
description: 'Custom description'
# panels - List of panels that contain panel settings.
# title - Change the title of the panel.
# visualization - The type of visualization to be rendered
# gridAttributes - The size and positioning of the panel
# queryOverrides.namespace - The Group or Project path to use for the chart panel
# queryOverrides.filters.excludeMetrics - Hide rows by metric ID from the chart panel.
# queryOverrides.filters.labels -
# Only show results for data that matches the queried label(s). If multiple labels are provided,
# only a single label needs to match for the data to be included in the results.
# Compatible metrics (other metrics will be automatically excluded):
# * lead_time
# * cycle_time
# * issues
# * issues_completed
# * merge_request_throughput
panels:
- title: 'Group usage overview'
visualization: usage_overview
queryOverrides:
namespace: group
filters:
include:
- groups
- projects
gridAttributes:
yPos: 1
xPos: 1
height: 1
width: 12
- title: 'Group dora and issue metrics'
visualization: dora_chart
queryOverrides:
namespace: group
filters:
excludeMetrics:
- deployment_frequency
- deploys
labels:
- in_development
- in_review
gridAttributes:
yPos: 2
xPos: 1
height: 12
width: 12
- title: 'My dora performers scores'
visualization: dora_performers_score
queryOverrides:
namespace: group/my-project
filters:
projectTopics:
- ruby
- javasript
gridAttributes:
yPos: 26
xPos: 1
height: 12
width: 12
```
### Supported visualization filters
The `filters` subfield on the `queryOverrides` field can be used to customize the data displayed in a panel.
#### DevSecOps metrics comparison panel filters
Filters for the `dora_chart` visualization.
| Filter | Description | Supported values |
|------------------|----------------------------------------------|------------------|
| `excludeMetrics` | Hides rows by metric ID from the chart panel | `deployment_frequency`, `lead_time_for_changes`,`time_to_restore_service`, `change_failure_rate`, `lead_time`, `cycle_time`, `issues`, `issues_completed`, `deploys`, `merge_request_throughput`, `median_time_to_merge`, `contributor_count`, `vulnerability_critical`, `vulnerability_high` |
| `labels` | Filters data by labels | Any available group label. Label filtering is supported by the following metrics: `lead_time`, `cycle_time`, `issues`, `issues_completed`, `merge_request_throughput`, `median_time_to_merge`. |
#### DORA Performers score panel filters
Filters for the `dora_performers_score` visualization.
| Filter | Description | Supported values |
|-----------------|-------------------------------------------------------------------------------------------|------------------|
| `projectTopics` | Filters the projects shown based on their assigned [topics](../project/project_topics.md) | Any available group topic |
#### Usage overview panel filters
Filters for the `usage_overview` visualization.
##### Group and subgroup namespaces
| Filter | Description | Supported values |
|-----------|----------------------------------------------------------------|------------------|
| `include` | Limits the metrics returned, by default displays all available | `groups`, `projects`, `issues`, `merge_requests`, `pipelines`, `users` |
##### Project namespaces
| Filter | Description | Supported values |
|-----------|----------------------------------------------------------------|------------------|
| `include` | Limits the metrics returned, by default displays all available | `issues`, `merge_requests`, `pipelines` |
## Dashboard metrics and drill-down reports
| Metric | ID | Description | Drill-down report | Documentation page |
|------------------------------------|----------------------------|-------------|-------------------|--------------------|
| Deployment frequency | `deployment_frequency` | Average number of deployments to production per day. This metric measures how often value is delivered to end users. | [Deployment frequency tab](https://gitlab.com/groups/gitlab-org/-/analytics/ci_cd?tab=deployment-frequency) | [Deployment frequency](dora_metrics.md#deployment-frequency) |
| Lead time for changes | `lead_time_for_changes` | The time to successfully deliver a commit into production. This metric reflects the efficiency of CI/CD pipelines. | [Lead time tab](https://gitlab.com/groups/gitlab-org/-/analytics/ci_cd?tab=lead-time) | [Lead time for changes](dora_metrics.md#lead-time-for-changes) |
| Time to restore service | `time_to_restore_service` | The time it takes an organization to recover from a failure in production. | [Time to restore service tab](https://gitlab.com/groups/gitlab-org/-/analytics/ci_cd?tab=time-to-restore-service) | [Time to restore service](dora_metrics.md#time-to-restore-service) |
| Change failure rate | `change_failure_rate` | Percentage of deployments that cause an incident in production. | [Change failure rate tab](https://gitlab.com/groups/gitlab-org/-/analytics/ci_cd?tab=change-failure-rate) | [Change failure rate](dora_metrics.md#change-failure-rate) |
| Lead time | `lead_time` | Median time from issue created to issue closed. | [Value Stream Analytics](https://gitlab.com/groups/gitlab-org/-/analytics/value_stream_analytics) | [View the lead time and cycle time for issues](../group/value_stream_analytics/_index.md#lifecycle-metrics) |
| Cycle time | `cycle_time` | Median time from the earliest commit of a linked issue's merge request to when that issue is closed. | [VSA overview](https://gitlab.com/groups/gitlab-org/-/analytics/value_stream_analytics) | [View the lead time and cycle time for issues](../group/value_stream_analytics/_index.md#lifecycle-metrics) |
| Issues created | `issues` | Number of new issues created. | [Issue Analytics](https://gitlab.com/groups/gitlab-org/-/issues_analytics) | [Issue Analytics](../group/issues_analytics/_index.md) |
| Issues closed | `issues_completed` | Number of issues closed by month. | [Issue Analytics](https://gitlab.com/groups/gitlab-org/-/issues_analytics) | [Issue Analytics](../group/issues_analytics/_index.md) |
| Number of deploys | `deploys` | Total number of deploys to production. | [Merge Request Analytics](https://gitlab.com/gitlab-org/gitlab/-/analytics/merge_request_analytics) | [Merge request analytics](merge_request_analytics.md) |
| Merge request throughput | `merge_request_throughput` | The number of merge requests merged by month. | [Groups Productivity analytics](productivity_analytics.md), [Projects Merge Request Analytics](https://gitlab.com/gitlab-org/gitlab/-/analytics/merge_request_analytics) | [Groups Productivity analytics](productivity_analytics.md) [Projects Merge request analytics](merge_request_analytics.md) |
| Median time to merge | `median_time_to_merge` | Median time between merge request created and merge request merged. | [Groups Productivity analytics](productivity_analytics.md), [Projects Merge Request Analytics](https://gitlab.com/gitlab-org/gitlab/-/analytics/merge_request_analytics) | [Groups Productivity analytics](productivity_analytics.md) [Projects Merge request analytics](merge_request_analytics.md) |
| Contributor count | `contributor_count` | Number of monthly unique users with contributions in the group. | [Contribution Analytics](https://gitlab.com/groups/gitlab-org/-/contribution_analytics) | [User contribution events](../profile/contributions_calendar.md#user-contribution-events) |
| Critical vulnerabilities over time | `vulnerability_critical` | Critical vulnerabilities over time in project or group | [Vulnerability report](https://gitlab.com/gitlab-org/gitlab/-/security/vulnerability_report) | [Vulnerability report](../application_security/vulnerability_report/_index.md) |
| High vulnerabilities over time | `vulnerability_high` | High vulnerabilities over time in project or group | [Vulnerability report](https://gitlab.com/gitlab-org/gitlab/-/security/vulnerability_report) | [Vulnerability report](../application_security/vulnerability_report/_index.md) |
## Metrics with Jira
The following metrics do not depend on using Jira:
- DORA Deployment frequency
- DORA Lead time for changes
- Number of deploys
- Merge request throughput
- Median time to merge
- Vulnerabilities
|
---
stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: View DevSecOps metrics (such as DORA and vulnerabilities) across your
organization on a customizable dashboard.
title: Value Streams Dashboard
breadcrumbs:
- doc
- user
- analytics
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Introduced in GitLab 15.8 as a closed [beta](../../policy/development_stages_support.md#beta) feature [with a flag](../../administration/feature_flags/_index.md) named `group_analytics_dashboards_page`. Disabled by default.
- Released in GitLab 15.11 as an open [beta](../../policy/development_stages_support.md#beta) feature [with a flag](../../administration/feature_flags/_index.md) named `group_analytics_dashboards_page`. Enabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/392734) in GitLab 16.0. Feature flag `group_analytics_dashboards_page` removed.
- [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/195086) from GitLab Ultimate to GitLab Premium in 18.2.
{{< /history >}}
To help us improve the Value Streams Dashboard, share feedback about your experience in this [survey](https://gitlab.fra1.qualtrics.com/jfe/form/SV_50guMGNU2HhLeT4).
For more information, see the [Value Stream Management category direction page](https://about.gitlab.com/direction/plan/value_stream_management/).
The Value Streams Dashboard is a customizable dashboard you can use to identify trends, patterns, and opportunities for digital transformation improvements.
The centralized UI in the Value Streams Dashboard acts as the single source of truth (SSOT), where all stakeholders can access and view the same set of metrics that are relevant to the organization.
The Value Streams Dashboard includes panels that visualize the following metrics:
- [DORA metrics](dora_metrics.md)
- [Value Stream Analytics (VSA) - flow metrics](../group/value_stream_analytics/_index.md)
- [Vulnerabilities](https://gitlab.com/gitlab-org/gitlab/-/security/vulnerability_report) metrics
- [GitLab Duo Code Suggestions](../project/repository/code_suggestions/_index.md)
With the Value Streams Dashboard, you can:
- Track and compare the metrics listed previously over a period of time.
- Identify downward trends early on.
- Understand security exposure.
- Drill down into individual projects or metrics to take actions for improvement.
- Understand the impact of adding AI to the software development lifecycle (SDLC) and demonstrate the return on investment (ROI) of investments in GitLab Duo.
For a click-through demo, see [the Value Stream Management product tour](https://gitlab.navattic.com/vsm).
To view the Value Streams Dashboard as an analytics dashboard for a group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Analytics dashboards**.
1. From the list of available dashboards, select **Value Streams Dashboard**.
{{< alert type="note" >}}
Data displayed on the Value Streams Dashboard is continuously collected in the backend.
If you upgrade to the Ultimate tier, you get access to historical data, and can view metrics about past GitLab usage and performance.
{{< /alert >}}
## Panels
The Value Streams Dashboard panels have a default configuration, but you can also [customize the dashboard panels](#customize-dashboard-panels).
### Overview
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/439699) in GitLab 16.7 [with a flag](../../administration/feature_flags/_index.md) named `group_analytics_dashboard_dynamic_vsd`. Disabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/432185) in GitLab 17.0.
- Feature flag `group_analytics_dashboard_dynamic_vsd` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/441206) in GitLab 17.0.
{{< /history >}}
The Overview panel provides a holistic view of the top-level namespace activity by visualizing key DevOps metrics.
The panel displays metrics for:
- Subgroups
- Projects
- Users
- Issues
- Merge requests
- Pipelines
Data displayed in the Overview panel is collected by batch processing. GitLab stores record counts for each subgroup in the database, then aggregates the record counts to provide metrics for the top-level group.
Data is aggregated monthly, around the end of the month, on a best-effort basis depending on the load on GitLab systems.
For more information, see [epic 10417](https://gitlab.com/groups/gitlab-org/-/epics/10417#iterations-path).
{{< alert type="note" >}}
To view metrics on the Overview panel, the [background aggregation](#enable-or-disable-overview-background-aggregation) must be enabled.
{{< /alert >}}
### DevSecOps metrics comparison
{{< history >}}
- Contributor count metric at the group level [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/433353) to GitLab.com in GitLab 16.9.
- Contributor count metric at the project level [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/474119) to GitLab.com in GitLab 18.0.
{{< /history >}}
The DevSecOps metrics comparison panels display metrics for a group or project
in the month-to-date, last month, the month before, and the past 180 days.
These visualizations help you understand whether the key DevSecOps metrics improve month over month. The Value Stream Dashboard displays three DevSecOps metric comparison panels:
- Lifecycle metrics
- DORA metrics (Ultimate only)
- Security metrics (Ultimate only)
In each comparison panel, you can:
- Compare the performance between groups, projects, and teams at a glance.
- Identify the teams and projects that are the largest value contributors, overperforming, or underperforming.
- Drill down the metrics for further analysis.
When you hover over a metric, a tooltip displays an explanation of the metric and a link to the related documentation page.
The monthly values also indicate a percentage increase or decrease compared to the previous month.
The sparkline for the past six months represents value trends over this time period, not the percentage change rate.
The sparkline color ranges from blue to green, where green indicates a positive trend, and blue indicates a negative trend.
Sparklines help you identify patterns in metric trends (such as seasonal changes) over time.
#### Filter panels by label
Label filters are appended as query parameters to the URL of the drill-down report of each eligible metric and automatically applied.
If a comparison panel from the configuration file is enabled with `filters.labels`, the drill-down links inherit the labels from the panel filter.
```yaml
panels:
- title: 'Group dora metrics'
visualization: vsd_dora_metrics_table
queryOverrides:
namespace: my-dora-group
filters:
labels:
- in_development
- in_review
```
{{< alert type="note" >}}
Only labels that exactly match the specified filters are applied.
{{< /alert >}}
### DORA Performers score
{{< details >}}
- Tier: Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386843) in GitLab 16.3 [with a flag](../../administration/feature_flags/_index.md) named `dora_performers_score_panel`. Disabled by default.
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/439737) in GitLab 16.9.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/440694) in GitLab 16.11. Feature flag `dora_performers_score_panel` removed.
{{< /history >}}
The [DORA](dora_metrics.md) Performers score panel is a group-level bar chart that visualizes the status of the organization's DevOps performance levels across different projects for the last full calendar month.
The chart is a breakdown of your project's DORA scores, [categorized](https://cloud.google.com/blog/products/devops-sre/dora-2022-accelerate-state-of-devops-report-now-out) as high, medium, or low.
The chart aggregates all the child projects in the group.
The chart bars display the total number of projects per score category, calculated monthly.
To exclude data from the chart (for example, **Not included**), in the legend select the series you want to exclude.
Hovering over each bar reveals a dialog that explains the score's definition.
For example, if a project has a high score for deployment frequency (velocity), it means that the project has one or more deploys to production per day.
| Metric | High | Medium | Low | Description |
|-------------------------|------|---------|------|-------------|
| Deployment frequency | ≥30 | 1-29 | \<1 | The number of deploys to production per day |
| Lead time for changes | ≤7 | 8-29 | ≥30 | The number of days to go from code committed to code successfully running in production |
| Time to restore service | ≤1 | 2-6 | ≥7 | The number of days to restore service when a service incident or a defect that impacts users occurs |
| Change failure rate | ≤15% | 16%-44% | ≥45% | The percentage of changes to production resulted in degraded service |
To learn more, see the blog post [Inside DORA Performers score in GitLab Value Streams Dashboard](https://about.gitlab.com/blog/2024/01/18/inside-dora-performers-score-in-gitlab-value-streams-dashboard/).
#### Filter the panel by project topic
When you customize dashboards with a YAML configuration,
you can filter the displayed projects by assigned [topics](../project/project_topics.md).
```yaml
panels:
- title: 'My dora performers scores'
visualization: dora_performers_score
queryOverrides:
namespace: group/my-custom-group
filters:
projectTopics:
- JavaScript
- Vue.js
```
If multiple topics are provided, all topics must match for the project to be included in the results.
### Projects by DORA metric
{{< details >}}
- Tier: Ultimate
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/408516) in GitLab 17.7.
{{< /history >}}
The **Projects by [DORA](dora_metrics.md) metric** panel is a group-level table that lists the status of the organization's DevOps performance levels across projects.
The table lists all projects with their DORA metrics, aggregating data from child projects in groups and subgroups.
The metrics are aggregated for the last full calendar month.
You can sort the projects by metric values, helping you identify high, medium, and low-performing projects.
For further investigation, you can select a project name to drill down into that project's page.
## Enable or disable overview background aggregation
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120610) in GitLab 16.1 [with a flag](../../administration/feature_flags/_index.md) named `value_stream_dashboard_on_off_setting`. Disabled by default.
- [Enabled on GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130704) in GitLab 16.4.
- [Feature flag `value_stream_dashboard_on_off_setting` removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/134619) in GitLab 16.6.
{{< /history >}}
To enable or disable the overview count aggregation for the Value Streams Dashboard:
1. On the left sidebar, select **Search or go to** and find your group.
This group must be at the top level.
1. Select **Settings > Analytics**.
1. In **Value Streams Dashboard**, select or clear the **Enable overview background aggregation for Value Streams Dashboard** checkbox.
To retrieve aggregated usage counts in the group, use the [GraphQL API](../../api/graphql/reference/_index.md#groupvaluestreamdashboardusageoverview).
## View the Value Streams Dashboard
Prerequisites:
- You must have at least the Reporter role for the group or project.
- [Overview background aggregation](#enable-or-disable-overview-background-aggregation) must be enabled.
- To view the contributor count metric in the comparison panel, you must [set up ClickHouse](../../integration/clickhouse.md).
- To track deployment to production, the group or project must have an environment in the [production deployment tier](../../ci/environments/_index.md#deployment-tier-of-environments).
- To measure the cycle time, [issues must be crosslinked from commit messages](../../user/project/issues/crosslinking_issues.md#from-commit-messages).
### For groups
To view the Value Streams Dashboard for a group:
- From Analytics Dashboards:
1. On the group left sidebar, select **Search or go to** and find your group.
1. Select **Analyze > Analytics Dashboards**.
- From Value Stream Analytics:
1. On the left sidebar, select **Search or go to** and find your project or group.
1. Select **Analyze > Value stream analytics**.
1. Below the **Filter results** text box, in the **Lifecycle metrics** row, select **Value Streams Dashboard / DORA**.
1. Optional. To open the new page, append this path `/analytics/dashboards/value_streams_dashboard` to the group URL (for example, `https://gitlab.com/groups/gitlab-org/-/analytics/dashboards/value_streams_dashboard`).
### For projects
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137483) in GitLab 16.7 [with a flag](../../administration/feature_flags/_index.md) named `project_analytics_dashboard_dynamic_vsd`. Disabled by default.
- Feature flag `project_analytics_dashboard_dynamic_vsd` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/441207) in GitLab 17.5.
{{< /history >}}
To view the Value Streams Dashboard as an analytics dashboard for a project:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Analyze > Analytics dashboards**.
1. From the list of available dashboards, select **Value Streams Dashboard**.
## Schedule reports
You can schedule reports using the CI/CD component
[Value Streams Dashboard Scheduled Reports tool](https://gitlab.com/components/vsd-reports-generator).
This tool saves time and effort by eliminating the need to manually search for the right dashboard with the relevant data, so that you can focus on analyzing insights.
By scheduling reports, you can ensure that the decision-makers in your organization receive proactive, timely, and relevant information.
The Scheduled Reports tool collects metrics from projects or groups through the public GitLab GraphQL API,
then builds a report using [GitLab Flavored Markdown](../markdown.md),
and opens an issue in a specified project.
The issue includes a comparison metrics table in Markdown format.
See an [example scheduled report](https://gitlab.com/components/vsd-reports-generator#example-for-monthly-executive-value-streams-report). To learn more, see the blog post [New Scheduled Reports Generation tool simplifies value stream management](https://about.gitlab.com/blog/2024/06/20/new-scheduled-reports-generation-tool-simplifies-value-stream-management/).
## Customize dashboard panels
You can customize the Value Streams Dashboard and configure what subgroups and projects to include in the page.
To customize the default content of the page, you need to create a YAML configuration file in a project of your choice.
In this file, you can define various settings and parameters, such as title, description, and number of panels and labels filters.
The file is schema-driven and managed with version control systems like Git.
This enables tracking and maintaining a history of configuration changes, reverting to previous versions if necessary, and collaborating effectively with team members.
Query parameters can still be used to override the YAML configuration.
Before you customize the dashboard panels, you must select a project to store your YAML configuration file.
Prerequisites:
- You must have at least the Maintainer role for the group.
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > Analytics**.
1. Select the project where you would like to store your YAML configuration file.
1. Select **Save changes**.
After you have set up the project, set up the configuration file:
1. On the left sidebar, select **Search or go to** and find the project you selected in the previous step.
1. In the default branch, create the configuration file: `.gitlab/analytics/dashboards/value_streams/value_streams.yaml`.
1. In the `value_streams.yaml` configuration file, fill in the configuration options:
| Field | Description |
|--------------------------------------------|-------------|
| `title` | Custom name for the panel |
| `queryOverrides` (formerly `data`) | Overrides data query parameters specific to each visualization. |
| `namespace` (subfield of `queryOverrides`) | Group or project path to use for the panel |
| `filters` (subfield of `queryOverrides`) | Filters the query for each visualization type. See [supported visualizations](#supported-visualization-filters). |
| `visualization` | The type of visualization to be rendered. Supported options are `dora_chart`, `dora_performers_score`, and `usage_overview`. |
| `gridAttributes` | The size and positioning of the panel |
| `xPos` (subfield of `gridAttributes`) | Horizontal position of the panel |
| `yPos` (subfield of `gridAttributes`) | Vertical position of the panel |
| `width` (subfield of `gridAttributes`) | Width of the panel (max. 12) |
| `height` (subfield of `gridAttributes`) | Height of the panel |
```yaml
# version - The latest version of the analytics dashboard schema
version: '2'
# title - Change the title of the Value Streams Dashboard.
title: 'Custom Dashboard title'
# description - Change the description of the Value Streams Dashboard. [optional]
description: 'Custom description'
# panels - List of panels that contain panel settings.
# title - Change the title of the panel.
# visualization - The type of visualization to be rendered
# gridAttributes - The size and positioning of the panel
# queryOverrides.namespace - The Group or Project path to use for the chart panel
# queryOverrides.filters.excludeMetrics - Hide rows by metric ID from the chart panel.
# queryOverrides.filters.labels -
# Only show results for data that matches the queried label(s). If multiple labels are provided,
# only a single label needs to match for the data to be included in the results.
# Compatible metrics (other metrics will be automatically excluded):
# * lead_time
# * cycle_time
# * issues
# * issues_completed
# * merge_request_throughput
panels:
- title: 'Group usage overview'
visualization: usage_overview
queryOverrides:
namespace: group
filters:
include:
- groups
- projects
gridAttributes:
yPos: 1
xPos: 1
height: 1
width: 12
- title: 'Group dora and issue metrics'
visualization: dora_chart
queryOverrides:
namespace: group
filters:
excludeMetrics:
- deployment_frequency
- deploys
labels:
- in_development
- in_review
gridAttributes:
yPos: 2
xPos: 1
height: 12
width: 12
- title: 'My dora performers scores'
visualization: dora_performers_score
queryOverrides:
namespace: group/my-project
filters:
projectTopics:
- ruby
- javasript
gridAttributes:
yPos: 26
xPos: 1
height: 12
width: 12
```
### Supported visualization filters
The `filters` subfield on the `queryOverrides` field can be used to customize the data displayed in a panel.
#### DevSecOps metrics comparison panel filters
Filters for the `dora_chart` visualization.
| Filter | Description | Supported values |
|------------------|----------------------------------------------|------------------|
| `excludeMetrics` | Hides rows by metric ID from the chart panel | `deployment_frequency`, `lead_time_for_changes`,`time_to_restore_service`, `change_failure_rate`, `lead_time`, `cycle_time`, `issues`, `issues_completed`, `deploys`, `merge_request_throughput`, `median_time_to_merge`, `contributor_count`, `vulnerability_critical`, `vulnerability_high` |
| `labels` | Filters data by labels | Any available group label. Label filtering is supported by the following metrics: `lead_time`, `cycle_time`, `issues`, `issues_completed`, `merge_request_throughput`, `median_time_to_merge`. |
#### DORA Performers score panel filters
Filters for the `dora_performers_score` visualization.
| Filter | Description | Supported values |
|-----------------|-------------------------------------------------------------------------------------------|------------------|
| `projectTopics` | Filters the projects shown based on their assigned [topics](../project/project_topics.md) | Any available group topic |
#### Usage overview panel filters
Filters for the `usage_overview` visualization.
##### Group and subgroup namespaces
| Filter | Description | Supported values |
|-----------|----------------------------------------------------------------|------------------|
| `include` | Limits the metrics returned, by default displays all available | `groups`, `projects`, `issues`, `merge_requests`, `pipelines`, `users` |
##### Project namespaces
| Filter | Description | Supported values |
|-----------|----------------------------------------------------------------|------------------|
| `include` | Limits the metrics returned, by default displays all available | `issues`, `merge_requests`, `pipelines` |
## Dashboard metrics and drill-down reports
| Metric | ID | Description | Drill-down report | Documentation page |
|------------------------------------|----------------------------|-------------|-------------------|--------------------|
| Deployment frequency | `deployment_frequency` | Average number of deployments to production per day. This metric measures how often value is delivered to end users. | [Deployment frequency tab](https://gitlab.com/groups/gitlab-org/-/analytics/ci_cd?tab=deployment-frequency) | [Deployment frequency](dora_metrics.md#deployment-frequency) |
| Lead time for changes | `lead_time_for_changes` | The time to successfully deliver a commit into production. This metric reflects the efficiency of CI/CD pipelines. | [Lead time tab](https://gitlab.com/groups/gitlab-org/-/analytics/ci_cd?tab=lead-time) | [Lead time for changes](dora_metrics.md#lead-time-for-changes) |
| Time to restore service | `time_to_restore_service` | The time it takes an organization to recover from a failure in production. | [Time to restore service tab](https://gitlab.com/groups/gitlab-org/-/analytics/ci_cd?tab=time-to-restore-service) | [Time to restore service](dora_metrics.md#time-to-restore-service) |
| Change failure rate | `change_failure_rate` | Percentage of deployments that cause an incident in production. | [Change failure rate tab](https://gitlab.com/groups/gitlab-org/-/analytics/ci_cd?tab=change-failure-rate) | [Change failure rate](dora_metrics.md#change-failure-rate) |
| Lead time | `lead_time` | Median time from issue created to issue closed. | [Value Stream Analytics](https://gitlab.com/groups/gitlab-org/-/analytics/value_stream_analytics) | [View the lead time and cycle time for issues](../group/value_stream_analytics/_index.md#lifecycle-metrics) |
| Cycle time | `cycle_time` | Median time from the earliest commit of a linked issue's merge request to when that issue is closed. | [VSA overview](https://gitlab.com/groups/gitlab-org/-/analytics/value_stream_analytics) | [View the lead time and cycle time for issues](../group/value_stream_analytics/_index.md#lifecycle-metrics) |
| Issues created | `issues` | Number of new issues created. | [Issue Analytics](https://gitlab.com/groups/gitlab-org/-/issues_analytics) | [Issue Analytics](../group/issues_analytics/_index.md) |
| Issues closed | `issues_completed` | Number of issues closed by month. | [Issue Analytics](https://gitlab.com/groups/gitlab-org/-/issues_analytics) | [Issue Analytics](../group/issues_analytics/_index.md) |
| Number of deploys | `deploys` | Total number of deploys to production. | [Merge Request Analytics](https://gitlab.com/gitlab-org/gitlab/-/analytics/merge_request_analytics) | [Merge request analytics](merge_request_analytics.md) |
| Merge request throughput | `merge_request_throughput` | The number of merge requests merged by month. | [Groups Productivity analytics](productivity_analytics.md), [Projects Merge Request Analytics](https://gitlab.com/gitlab-org/gitlab/-/analytics/merge_request_analytics) | [Groups Productivity analytics](productivity_analytics.md) [Projects Merge request analytics](merge_request_analytics.md) |
| Median time to merge | `median_time_to_merge` | Median time between merge request created and merge request merged. | [Groups Productivity analytics](productivity_analytics.md), [Projects Merge Request Analytics](https://gitlab.com/gitlab-org/gitlab/-/analytics/merge_request_analytics) | [Groups Productivity analytics](productivity_analytics.md) [Projects Merge request analytics](merge_request_analytics.md) |
| Contributor count | `contributor_count` | Number of monthly unique users with contributions in the group. | [Contribution Analytics](https://gitlab.com/groups/gitlab-org/-/contribution_analytics) | [User contribution events](../profile/contributions_calendar.md#user-contribution-events) |
| Critical vulnerabilities over time | `vulnerability_critical` | Critical vulnerabilities over time in project or group | [Vulnerability report](https://gitlab.com/gitlab-org/gitlab/-/security/vulnerability_report) | [Vulnerability report](../application_security/vulnerability_report/_index.md) |
| High vulnerabilities over time | `vulnerability_high` | High vulnerabilities over time in project or group | [Vulnerability report](https://gitlab.com/gitlab-org/gitlab/-/security/vulnerability_report) | [Vulnerability report](../application_security/vulnerability_report/_index.md) |
## Metrics with Jira
The following metrics do not depend on using Jira:
- DORA Deployment frequency
- DORA Lead time for changes
- Number of deploys
- Merge request throughput
- Median time to merge
- Vulnerabilities
|
https://docs.gitlab.com/user/discussions
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/_index.md
|
2025-08-13
|
doc/user/discussions
|
[
"doc",
"user",
"discussions"
] |
_index.md
|
Create
|
Code Review
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Comments and threads
|
Mentions, locked discussions, internal notes, and thread resolution.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Comments and threads on Wiki pages [introduced](https://gitlab.com/groups/gitlab-org/-/epics/14461) in GitLab 17.7 [with a flag](../../administration/feature_flags/_index.md) named `wiki_comments`. Disabled by default.
- Comments and threads on Wiki pages [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/502847) in GitLab 17.9. Feature flag `wiki_comments` removed.
{{< /history >}}
GitLab encourages communication through comments, threads, and
[suggesting changes for code](../project/merge_requests/reviews/suggestions.md).
Comments support [Markdown](../markdown.md) and [quick actions](../project/quick_actions.md).
Two types of comments are available:
- A standard comment.
- A comment in a thread, which you can [resolve](../project/merge_requests/_index.md#resolve-a-thread).
You can [suggest code changes](../project/merge_requests/reviews/suggestions.md) in your commit diff comment,
which the user can accept through the user interface.
## Places you can add comments
You can create comments in places like:
- Commit diffs.
- Commits.
- Designs.
- Epics.
- Issues.
- Merge requests.
- Snippets.
- Tasks.
- OKRs.
- Wiki pages.
Each object can have as many as 5,000 comments.
## Mentions
You can mention a user or a group (including [subgroups](../group/subgroups/_index.md#mention-subgroups)) in your GitLab
instance with `@username` or `@groupname`. GitLab notifies all mentioned users with to-do items and emails.
Users can change this setting for themselves in the [notification settings](../profile/notifications.md).
You can quickly see which comments involve you, because GitLab highlights
mentions for yourself (the current, authenticated user) in a different color.
### Mentioning all members
{{< history >}}
- [Flag](../../administration/feature_flags/_index.md) named `disable_all_mention` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110586) in GitLab 16.1. Disabled by default. [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/18442).
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
Avoid mentioning `@all` in comments and descriptions. `@all` mentions more than
just the participants of the project, issue, or merge request, but all members
of that project's parent group. All these users receive an email notification
and a to-do item, and might interpret it as spam.
When you enable this feature flag, typing `@all` in comments and descriptions
results in plain text instead of mentioning all users.
When you disable this feature, existing `@all` mentions in the Markdown texts are unchanged,
and remain as links. Only future `@all` mentions appear as plain text.
Notifications and mentions can be disabled in
[a group's settings](../group/manage.md#disable-email-notifications).
### Mention a group in an issue or merge request
When you mention a group in a comment, every member of the group gets a to-do item
added to their to-do list.
1. On the left sidebar, select **Search or go to** and find your project.
1. For merge requests, select **Code > Merge requests**, and find your merge request.
1. For issues, select **Plan > Issues**, and find your issue.
1. In a comment, type `@` followed by the user, group, or subgroup namespace.
For example, `@alex`, `@alex-team`, or `@alex-team/marketing`.
1. Select **Comment**.
GitLab creates a to-do item for all the group and subgroup members.
For more information on mentioning subgroups, see [Mention subgroups](../group/subgroups/_index.md#mention-subgroups).
## Add a comment to a merge request diff
When you add comments to a merge request diff, these comments persist, even when you:
- Force-push after a rebase.
- Amend a commit.
To add a commit diff comment:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Code > Merge requests**, and find your merge request.
1. Select the **Commits** tab, then select the commit message.
1. By the line you want to comment on, hover over the line number and select **Comment** ({{< icon name="comment" >}}).
You can select multiple lines by dragging the **Comment** ({{< icon name="comment" >}}) icon.
1. Enter your comment.
1. To add your comment immediately, select **Add comment now**, or use the keyboard shortcut:
- macOS: <kbd>Shift</kbd> + <kbd>Command</kbd> + <kbd>Enter</kbd>
- All other OSes: <kbd>Shift</kbd> + <kbd>Control</kbd> + <kbd>Enter</kbd>
1. To leave your comment unpublished until you finish a review, select **Start a review**, or use the keyboard shortcut:
- macOS: <kbd>Command</kbd> + <kbd>Enter</kbd>
- All other OSes: <kbd>Control</kbd> + <kbd>Enter</kbd>
The comment displays on the merge request's **Overview** tab.
The comment is not displayed on your project's **Code > Commits** page.
{{< alert type="note" >}}
When your comment contains a reference to a commit included in the merge request,
it's converted to a link in the context of the merge request.
For example, `28719b171a056960dfdc0012b625d0b47b123196` becomes `28719b17` that links to
`https://gitlab.example.com/example-group/example-project/-/merge_requests/12345/diffs?commit_id=28719b171a056960dfdc0012b625d0b47b123196`.
{{< /alert >}}
## Reply to a comment by sending email
If you have ["reply by email"](../../administration/reply_by_email.md) configured,
you can reply to comments by sending an email.
- When you reply to a standard comment, it creates another standard comment.
- When you reply to a threaded comment, it creates a reply in the thread.
- When you [send an email to an issue email address](../project/issues/managing_issues.md#copy-issue-email-address),
it creates a standard comment.
You can use [Markdown](../markdown.md) and [quick actions](../project/quick_actions.md) in your email replies.
## Edit a comment
You can edit your own comment at any time.
Anyone with at least the Maintainer role can also edit a comment made by someone else.
To edit a comment:
1. On the comment, select **Edit comment** ({{< icon name="pencil" >}}).
1. Make your edits.
1. Select **Save changes**.
### Edit a comment to add a mention
By default, when you mention a user, GitLab [creates a to-do item](../todos.md#actions-that-create-to-do-items)
for them, and sends them a [notification email](../profile/notifications.md).
If you edit an existing comment to add a user mention that wasn't there before, GitLab:
- Creates a to-do item for the mentioned user.
- Does not send a notification email.
## Prevent comments by locking the discussion
You can prevent public comments in an issue or merge request.
When you do, only project members can add and edit comments.
Prerequisites:
- In merge requests, you must have at least the Developer role.
- In issues, you must have at least the Reporter role.
To lock an issue or merge request:
1. On the left sidebar, select **Search or go to** and find your project.
1. For merge requests, select **Code > Merge requests**, and find your merge request.
1. For issues, select **Plan > Issues**, and find your issue.
1. In the upper-right corner, select **Merge request actions** or **Issue actions**
({{< icon name="ellipsis_v" >}}), then select **Lock discussion**.
GitLab adds a system note to the page details.
You must unlock all locked discussions in closed issues or merge requests before you can
reopen the issue or merge request.
## Comments on confidential items
Only users with permission to access a confidential item receive notifications for comments on the item.
If the item was not previously confidential, users without access may appear as participants. These users do not receive notifications while the item is confidential.
Who can be notified:
- Users assigned to the item, regardless of role.
- Users who authored the item, if they have at least the Guest role.
- Users with at least a Planner role in the group or project the item belongs to.
## Add an internal note
{{< history >}}
- Internal comments [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/142003) for merge requests in GitLab 16.9.
{{< /history >}}
Use internal notes to protect information added to a public issue, epic, or merge request.
Internal notes differ from public comments:
- Only project members with least the Reporter role can view the internal note.
- You can't convert internal notes to regular comments.
- All replies to internal notes are also internal.
- Internal notes display an **Internal note** badge and are shown in a different
color than public comments:
Prerequisites:
- You must have at least the Reporter role for the project.
To add an internal note:
1. On the issue, epic, or merge request, in the **Comment** text box, enter a comment.
1. Below the comment, select **Make this an internal note**.
1. Select **Add internal note**.
You can also mark an entire [issue as confidential](../project/issues/confidential_issues.md),
or create [confidential merge requests](../project/merge_requests/confidential.md).
## Show only comments
In discussions with many comments, filter the discussion to show only comments or history of
changes ([system notes](../project/system_notes.md)). System notes include changes to the description, mentions in other GitLab
objects, or changes to labels, assignees, and the milestone.
GitLab saves your preference, and applies it to every issue, merge request, or epic you view.
1. On a merge request, issue, or epic, select the **Overview** tab.
1. On the right side of the page, from the **Sort or filter** dropdown list, select a filter:
- **Show all activity**: Display all user comments and system notes.
- **Show comments only**: Display only user comments.
- **Show history only**: Display only activity notes.
## Change activity sort order
Reverse the default order and interact with the activity feed sorted by most recent items
at the top. GitLab saves your preference in local storage and applies it to every issue,
merge request, or epic you view. Issues and epics share the same sorting preference, while merge requests maintain their own separate preference.
To change the activity sort order:
1. Open an issue, or open the **Overview** tab in a merge request or epic.
1. Scroll down to the **Activity** heading.
1. On the right side of the page, change the sort order:
- **Issues and epics**: From the **Sort or filter** dropdown list, select **Newest first** or **Oldest first** (default).
- **Merge requests**: Use the sort direction arrow button to toggle between **Sort direction: Ascending** (oldest first, default) or **Sort direction: Descending (newest first)**.
## View description change history
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can see changes to the description listed in the history.
To compare the changes, select **Compare with previous version**.
## Assign an issue to the commenting user
You can assign an issue to a user who made a comment.
1. In the comment, select the **More Actions** ({{< icon name="ellipsis_v" >}}) menu.
1. Select **Assign to comment author**.
1. To unassign the commenter, select the button again.
## Create a thread by replying to a standard comment
When you reply to a standard comment, you create a thread.
Prerequisites:
- You must have at least the Guest role.
- You must be in an issue, merge request, or epic. Threads in commits and snippets are not supported.
To create a thread by replying to a comment:
1. In the upper-right corner of the comment, select **Reply to comment** ({{< icon name="reply" >}})
to display the reply section.
1. Enter your reply.
1. Select **Reply** or **Add comment now** (depending on where in the UI you are replying).
GitLab converts the top comment to a thread.
## Create a thread without replying to a comment
You can create a thread without replying to a standard comment.
Prerequisites:
- You must have at least the Guest role.
- You must be in an issue, merge request, commit, or snippet.
To create a thread:
1. Enter a comment.
1. Below the comment, to the right of **Comment**, select the down arrow ({{< icon name="chevron-down" >}}).
1. From the list, select **Start thread**.
1. Select **Start thread** again.
## Resolve a thread
{{< history >}}
- Resolvable threads for issues [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31114) in GitLab 16.3 [with a flag](../../administration/feature_flags/_index.md) named `resolvable_issue_threads`. Disabled by default.
- Resolvable threads for issues [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/31114) in GitLab 16.4.
- Resolvable threads for issues [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/31114) in GitLab 16.7. Feature flag `resolvable_issue_threads` removed.
- Resolvable threads for tasks, objectives, and key results [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/458818) in GitLab 17.3.
- Resolvable threads for epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/458818) in GitLab 17.5. [The new look for epics](../group/epics/_index.md#epics-as-work-items) must be enabled.
- Resolvable threads for epics [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/468310) in GitLab 18.1.
{{< /history >}}
You can resolve a thread when you want to finish a conversation.
Prerequisites:
- You must be in an epic, issue, task, objective, key result, or merge request.
- You must have at least the Developer role or be the author of the issue or merge request.
To resolve a thread:
1. Go to the thread.
1. Do one of the following:
- In the upper-right corner of the original comment, select **Resolve thread** ({{< icon name="check-circle" >}}).
- Below the last reply, in the **Reply** field, select **Resolve thread**.
- Below the last reply, in the **Reply** field, enter text, select the **Resolve thread** checkbox, and select **Add comment now**.
Additionally, in merge requests, you can [do more with threads](../project/merge_requests/_index.md#resolve-a-thread),
such as:
- Move open threads to a new issue.
- Prevent merging until all threads are resolved.
## Summarize issue discussions with Duo Chat
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Enterprise, GitLab Duo with Amazon Q
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- LLM for GitLab Self-Managed, GitLab Dedicated: Anthropic [Claude 3.5 Sonnet](https://console.cloud.google.com/vertex-ai/publishers/anthropic/model-garden/claude-3-5-sonnet)
- LLM for GitLab.com: Anthropic [Claude 3.7 Sonnet](https://console.cloud.google.com/vertex-ai/publishers/anthropic/model-garden/claude-3-7-sonnet)
- LLM for Amazon Q: Amazon Q Developer
- Available on [GitLab Duo with self-hosted models](../../administration/gitlab_duo_self_hosted/_index.md): Yes
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10344) in GitLab 16.0 as an [experiment](../../policy/development_stages_support.md#experiment).
- [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/454550) to GitLab Duo and promoted to [beta](../../policy/development_stages_support.md#beta) in GitLab 17.3 [with a flag](../../administration/feature_flags/_index.md) named `summarize_notes_with_duo`. Disabled by default.
- [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/162122) in GitLab 17.4.
- Changed to require GitLab Duo add-on in GitLab 17.6 and later.
- Changed to include Premium in GitLab 18.0.
{{< /history >}}
Generate a summary of discussions on an issue.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> [Watch an overview](https://www.youtube.com/watch?v=IcdxLfTIUgc)
<!-- Video published on 2024-03-28 -->
Prerequisites:
- You must have permission to view the issue.
To generate a summary of issue discussions:
1. In an issue, scroll to the **Activity** section.
1. Select **View summary**.
The comments in the issue are summarized in as many as 10 list items.
You can ask follow up questions based on the response.
Data usage: When you use this feature, the text of all comments on the issue are sent to
the large language model.
|
---
stage: Create
group: Code Review
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Mentions, locked discussions, internal notes, and thread resolution.
title: Comments and threads
breadcrumbs:
- doc
- user
- discussions
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Comments and threads on Wiki pages [introduced](https://gitlab.com/groups/gitlab-org/-/epics/14461) in GitLab 17.7 [with a flag](../../administration/feature_flags/_index.md) named `wiki_comments`. Disabled by default.
- Comments and threads on Wiki pages [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/502847) in GitLab 17.9. Feature flag `wiki_comments` removed.
{{< /history >}}
GitLab encourages communication through comments, threads, and
[suggesting changes for code](../project/merge_requests/reviews/suggestions.md).
Comments support [Markdown](../markdown.md) and [quick actions](../project/quick_actions.md).
Two types of comments are available:
- A standard comment.
- A comment in a thread, which you can [resolve](../project/merge_requests/_index.md#resolve-a-thread).
You can [suggest code changes](../project/merge_requests/reviews/suggestions.md) in your commit diff comment,
which the user can accept through the user interface.
## Places you can add comments
You can create comments in places like:
- Commit diffs.
- Commits.
- Designs.
- Epics.
- Issues.
- Merge requests.
- Snippets.
- Tasks.
- OKRs.
- Wiki pages.
Each object can have as many as 5,000 comments.
## Mentions
You can mention a user or a group (including [subgroups](../group/subgroups/_index.md#mention-subgroups)) in your GitLab
instance with `@username` or `@groupname`. GitLab notifies all mentioned users with to-do items and emails.
Users can change this setting for themselves in the [notification settings](../profile/notifications.md).
You can quickly see which comments involve you, because GitLab highlights
mentions for yourself (the current, authenticated user) in a different color.
### Mentioning all members
{{< history >}}
- [Flag](../../administration/feature_flags/_index.md) named `disable_all_mention` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110586) in GitLab 16.1. Disabled by default. [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/18442).
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
Avoid mentioning `@all` in comments and descriptions. `@all` mentions more than
just the participants of the project, issue, or merge request, but all members
of that project's parent group. All these users receive an email notification
and a to-do item, and might interpret it as spam.
When you enable this feature flag, typing `@all` in comments and descriptions
results in plain text instead of mentioning all users.
When you disable this feature, existing `@all` mentions in the Markdown texts are unchanged,
and remain as links. Only future `@all` mentions appear as plain text.
Notifications and mentions can be disabled in
[a group's settings](../group/manage.md#disable-email-notifications).
### Mention a group in an issue or merge request
When you mention a group in a comment, every member of the group gets a to-do item
added to their to-do list.
1. On the left sidebar, select **Search or go to** and find your project.
1. For merge requests, select **Code > Merge requests**, and find your merge request.
1. For issues, select **Plan > Issues**, and find your issue.
1. In a comment, type `@` followed by the user, group, or subgroup namespace.
For example, `@alex`, `@alex-team`, or `@alex-team/marketing`.
1. Select **Comment**.
GitLab creates a to-do item for all the group and subgroup members.
For more information on mentioning subgroups, see [Mention subgroups](../group/subgroups/_index.md#mention-subgroups).
## Add a comment to a merge request diff
When you add comments to a merge request diff, these comments persist, even when you:
- Force-push after a rebase.
- Amend a commit.
To add a commit diff comment:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Code > Merge requests**, and find your merge request.
1. Select the **Commits** tab, then select the commit message.
1. By the line you want to comment on, hover over the line number and select **Comment** ({{< icon name="comment" >}}).
You can select multiple lines by dragging the **Comment** ({{< icon name="comment" >}}) icon.
1. Enter your comment.
1. To add your comment immediately, select **Add comment now**, or use the keyboard shortcut:
- macOS: <kbd>Shift</kbd> + <kbd>Command</kbd> + <kbd>Enter</kbd>
- All other OSes: <kbd>Shift</kbd> + <kbd>Control</kbd> + <kbd>Enter</kbd>
1. To leave your comment unpublished until you finish a review, select **Start a review**, or use the keyboard shortcut:
- macOS: <kbd>Command</kbd> + <kbd>Enter</kbd>
- All other OSes: <kbd>Control</kbd> + <kbd>Enter</kbd>
The comment displays on the merge request's **Overview** tab.
The comment is not displayed on your project's **Code > Commits** page.
{{< alert type="note" >}}
When your comment contains a reference to a commit included in the merge request,
it's converted to a link in the context of the merge request.
For example, `28719b171a056960dfdc0012b625d0b47b123196` becomes `28719b17` that links to
`https://gitlab.example.com/example-group/example-project/-/merge_requests/12345/diffs?commit_id=28719b171a056960dfdc0012b625d0b47b123196`.
{{< /alert >}}
## Reply to a comment by sending email
If you have ["reply by email"](../../administration/reply_by_email.md) configured,
you can reply to comments by sending an email.
- When you reply to a standard comment, it creates another standard comment.
- When you reply to a threaded comment, it creates a reply in the thread.
- When you [send an email to an issue email address](../project/issues/managing_issues.md#copy-issue-email-address),
it creates a standard comment.
You can use [Markdown](../markdown.md) and [quick actions](../project/quick_actions.md) in your email replies.
## Edit a comment
You can edit your own comment at any time.
Anyone with at least the Maintainer role can also edit a comment made by someone else.
To edit a comment:
1. On the comment, select **Edit comment** ({{< icon name="pencil" >}}).
1. Make your edits.
1. Select **Save changes**.
### Edit a comment to add a mention
By default, when you mention a user, GitLab [creates a to-do item](../todos.md#actions-that-create-to-do-items)
for them, and sends them a [notification email](../profile/notifications.md).
If you edit an existing comment to add a user mention that wasn't there before, GitLab:
- Creates a to-do item for the mentioned user.
- Does not send a notification email.
## Prevent comments by locking the discussion
You can prevent public comments in an issue or merge request.
When you do, only project members can add and edit comments.
Prerequisites:
- In merge requests, you must have at least the Developer role.
- In issues, you must have at least the Reporter role.
To lock an issue or merge request:
1. On the left sidebar, select **Search or go to** and find your project.
1. For merge requests, select **Code > Merge requests**, and find your merge request.
1. For issues, select **Plan > Issues**, and find your issue.
1. In the upper-right corner, select **Merge request actions** or **Issue actions**
({{< icon name="ellipsis_v" >}}), then select **Lock discussion**.
GitLab adds a system note to the page details.
You must unlock all locked discussions in closed issues or merge requests before you can
reopen the issue or merge request.
## Comments on confidential items
Only users with permission to access a confidential item receive notifications for comments on the item.
If the item was not previously confidential, users without access may appear as participants. These users do not receive notifications while the item is confidential.
Who can be notified:
- Users assigned to the item, regardless of role.
- Users who authored the item, if they have at least the Guest role.
- Users with at least a Planner role in the group or project the item belongs to.
## Add an internal note
{{< history >}}
- Internal comments [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/142003) for merge requests in GitLab 16.9.
{{< /history >}}
Use internal notes to protect information added to a public issue, epic, or merge request.
Internal notes differ from public comments:
- Only project members with least the Reporter role can view the internal note.
- You can't convert internal notes to regular comments.
- All replies to internal notes are also internal.
- Internal notes display an **Internal note** badge and are shown in a different
color than public comments:
Prerequisites:
- You must have at least the Reporter role for the project.
To add an internal note:
1. On the issue, epic, or merge request, in the **Comment** text box, enter a comment.
1. Below the comment, select **Make this an internal note**.
1. Select **Add internal note**.
You can also mark an entire [issue as confidential](../project/issues/confidential_issues.md),
or create [confidential merge requests](../project/merge_requests/confidential.md).
## Show only comments
In discussions with many comments, filter the discussion to show only comments or history of
changes ([system notes](../project/system_notes.md)). System notes include changes to the description, mentions in other GitLab
objects, or changes to labels, assignees, and the milestone.
GitLab saves your preference, and applies it to every issue, merge request, or epic you view.
1. On a merge request, issue, or epic, select the **Overview** tab.
1. On the right side of the page, from the **Sort or filter** dropdown list, select a filter:
- **Show all activity**: Display all user comments and system notes.
- **Show comments only**: Display only user comments.
- **Show history only**: Display only activity notes.
## Change activity sort order
Reverse the default order and interact with the activity feed sorted by most recent items
at the top. GitLab saves your preference in local storage and applies it to every issue,
merge request, or epic you view. Issues and epics share the same sorting preference, while merge requests maintain their own separate preference.
To change the activity sort order:
1. Open an issue, or open the **Overview** tab in a merge request or epic.
1. Scroll down to the **Activity** heading.
1. On the right side of the page, change the sort order:
- **Issues and epics**: From the **Sort or filter** dropdown list, select **Newest first** or **Oldest first** (default).
- **Merge requests**: Use the sort direction arrow button to toggle between **Sort direction: Ascending** (oldest first, default) or **Sort direction: Descending (newest first)**.
## View description change history
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can see changes to the description listed in the history.
To compare the changes, select **Compare with previous version**.
## Assign an issue to the commenting user
You can assign an issue to a user who made a comment.
1. In the comment, select the **More Actions** ({{< icon name="ellipsis_v" >}}) menu.
1. Select **Assign to comment author**.
1. To unassign the commenter, select the button again.
## Create a thread by replying to a standard comment
When you reply to a standard comment, you create a thread.
Prerequisites:
- You must have at least the Guest role.
- You must be in an issue, merge request, or epic. Threads in commits and snippets are not supported.
To create a thread by replying to a comment:
1. In the upper-right corner of the comment, select **Reply to comment** ({{< icon name="reply" >}})
to display the reply section.
1. Enter your reply.
1. Select **Reply** or **Add comment now** (depending on where in the UI you are replying).
GitLab converts the top comment to a thread.
## Create a thread without replying to a comment
You can create a thread without replying to a standard comment.
Prerequisites:
- You must have at least the Guest role.
- You must be in an issue, merge request, commit, or snippet.
To create a thread:
1. Enter a comment.
1. Below the comment, to the right of **Comment**, select the down arrow ({{< icon name="chevron-down" >}}).
1. From the list, select **Start thread**.
1. Select **Start thread** again.
## Resolve a thread
{{< history >}}
- Resolvable threads for issues [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31114) in GitLab 16.3 [with a flag](../../administration/feature_flags/_index.md) named `resolvable_issue_threads`. Disabled by default.
- Resolvable threads for issues [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/31114) in GitLab 16.4.
- Resolvable threads for issues [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/31114) in GitLab 16.7. Feature flag `resolvable_issue_threads` removed.
- Resolvable threads for tasks, objectives, and key results [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/458818) in GitLab 17.3.
- Resolvable threads for epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/458818) in GitLab 17.5. [The new look for epics](../group/epics/_index.md#epics-as-work-items) must be enabled.
- Resolvable threads for epics [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/468310) in GitLab 18.1.
{{< /history >}}
You can resolve a thread when you want to finish a conversation.
Prerequisites:
- You must be in an epic, issue, task, objective, key result, or merge request.
- You must have at least the Developer role or be the author of the issue or merge request.
To resolve a thread:
1. Go to the thread.
1. Do one of the following:
- In the upper-right corner of the original comment, select **Resolve thread** ({{< icon name="check-circle" >}}).
- Below the last reply, in the **Reply** field, select **Resolve thread**.
- Below the last reply, in the **Reply** field, enter text, select the **Resolve thread** checkbox, and select **Add comment now**.
Additionally, in merge requests, you can [do more with threads](../project/merge_requests/_index.md#resolve-a-thread),
such as:
- Move open threads to a new issue.
- Prevent merging until all threads are resolved.
## Summarize issue discussions with Duo Chat
{{< details >}}
- Tier: Premium, Ultimate
- Add-on: GitLab Duo Enterprise, GitLab Duo with Amazon Q
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- LLM for GitLab Self-Managed, GitLab Dedicated: Anthropic [Claude 3.5 Sonnet](https://console.cloud.google.com/vertex-ai/publishers/anthropic/model-garden/claude-3-5-sonnet)
- LLM for GitLab.com: Anthropic [Claude 3.7 Sonnet](https://console.cloud.google.com/vertex-ai/publishers/anthropic/model-garden/claude-3-7-sonnet)
- LLM for Amazon Q: Amazon Q Developer
- Available on [GitLab Duo with self-hosted models](../../administration/gitlab_duo_self_hosted/_index.md): Yes
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10344) in GitLab 16.0 as an [experiment](../../policy/development_stages_support.md#experiment).
- [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/454550) to GitLab Duo and promoted to [beta](../../policy/development_stages_support.md#beta) in GitLab 17.3 [with a flag](../../administration/feature_flags/_index.md) named `summarize_notes_with_duo`. Disabled by default.
- [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/162122) in GitLab 17.4.
- Changed to require GitLab Duo add-on in GitLab 17.6 and later.
- Changed to include Premium in GitLab 18.0.
{{< /history >}}
Generate a summary of discussions on an issue.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> [Watch an overview](https://www.youtube.com/watch?v=IcdxLfTIUgc)
<!-- Video published on 2024-03-28 -->
Prerequisites:
- You must have permission to view the issue.
To generate a summary of issue discussions:
1. In an issue, scroll to the **Activity** section.
1. Select **View summary**.
The comments in the issue are summarized in as many as 10 list items.
You can ask follow up questions based on the response.
Data usage: When you use this feature, the text of all comments on the issue are sent to
the large language model.
|
https://docs.gitlab.com/user/user_passwords
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/user_passwords.md
|
2025-08-13
|
doc/user/profile
|
[
"doc",
"user",
"profile"
] |
user_passwords.md
|
Software Supply Chain Security
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
User passwords
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
If you use a password to sign in to GitLab, a strong password is very important. A weak or guessable password makes it
easier for unauthorized people to sign in to your account.
Some organizations require you to meet certain requirements when choosing a password.
Improve the security of your account with [two-factor authentication](account/two_factor_authentication.md).
## Choose your password
You can choose a password when you [create a user account](account/create_accounts.md).
If you register your account using an external authentication and
authorization provider, you do not need to choose a password. GitLab
[sets a random, unique, and secure password for you](../../security/passwords_for_integrated_authentication_methods.md).
## Change your password
{{< history >}}
- Password reset emails sent to any verified email address [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16311) in GitLab 16.1.
{{< /history >}}
You can change your password. GitLab enforces [password requirements](#password-requirements) when you choose your new
password.
### Change a known password
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Password**.
1. In the **Current password** text box, enter your current password.
1. In the **New password** and **Password confirmation** text box, enter your new password.
1. Select **Save password**.
### Change an unknown password
If you do not know your current password, select **Forgot your password?**
from the GitLab sign-in page and complete the form.
If you enter a verified email address for an existing account, GitLab sends a password reset email.
If the provided email address isn't associated with an existing account, no email is sent.
In both situations, you are redirected to the sign-in page and see the following message:
```plaintext
If your email address exists in our database, you will receive a password recovery link at your email address in a few minutes.
```
{{< alert type="note" >}}
Your account can have more than one verified email address, and any email address
associated with your account can be verified. However, only the primary email address
can be used to sign in once the password is reset.
{{< /alert >}}
## Password requirements
Your passwords must meet a set of requirements when:
- You choose a password during registration.
- You choose a new password using the forgotten password reset flow.
- You change your password proactively.
- You change your password after it expires.
- An administrator creates your account.
- An administrator updates your account.
By default GitLab enforces the following password requirements:
- Minimum and maximum password lengths. For example,
see [the settings for GitLab.com](../gitlab_com/_index.md#password-requirements).
- Disallowing [weak passwords](#block-weak-passwords).
GitLab Self-Managed instances can configure the following additional password requirements:
- [Password minimum and maximum length limits](../../security/password_length_limits.md).
- [Password complexity requirements](../../administration/settings/sign_up_restrictions.md#password-complexity-requirements).
## Block weak passwords
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23610) in GitLab 15.4 [with a flag](../../administration/feature_flags/_index.md) named `block_weak_passwords`, weak passwords aren't accepted. Disabled by default on GitLab Self-Managed.
- [Enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/363445) on GitLab.com in GitLab 15.6.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/363445) and enabled on GitLab Self-Managed in GitLab 15.7. Feature flag `block_weak_passwords` removed.
{{< /history >}}
GitLab disallows weak passwords. Your password is considered weak when it:
- Matches one of 4500+ known, breached passwords.
- Contains part of your name, username, or email address.
- Contains a predictable word (for example, `gitlab` or `devops`).
Weak passwords are rejected with the error message: **Password must not contain commonly used combinations of words and letters**.
|
---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: User passwords
breadcrumbs:
- doc
- user
- profile
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
If you use a password to sign in to GitLab, a strong password is very important. A weak or guessable password makes it
easier for unauthorized people to sign in to your account.
Some organizations require you to meet certain requirements when choosing a password.
Improve the security of your account with [two-factor authentication](account/two_factor_authentication.md).
## Choose your password
You can choose a password when you [create a user account](account/create_accounts.md).
If you register your account using an external authentication and
authorization provider, you do not need to choose a password. GitLab
[sets a random, unique, and secure password for you](../../security/passwords_for_integrated_authentication_methods.md).
## Change your password
{{< history >}}
- Password reset emails sent to any verified email address [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16311) in GitLab 16.1.
{{< /history >}}
You can change your password. GitLab enforces [password requirements](#password-requirements) when you choose your new
password.
### Change a known password
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Password**.
1. In the **Current password** text box, enter your current password.
1. In the **New password** and **Password confirmation** text box, enter your new password.
1. Select **Save password**.
### Change an unknown password
If you do not know your current password, select **Forgot your password?**
from the GitLab sign-in page and complete the form.
If you enter a verified email address for an existing account, GitLab sends a password reset email.
If the provided email address isn't associated with an existing account, no email is sent.
In both situations, you are redirected to the sign-in page and see the following message:
```plaintext
If your email address exists in our database, you will receive a password recovery link at your email address in a few minutes.
```
{{< alert type="note" >}}
Your account can have more than one verified email address, and any email address
associated with your account can be verified. However, only the primary email address
can be used to sign in once the password is reset.
{{< /alert >}}
## Password requirements
Your passwords must meet a set of requirements when:
- You choose a password during registration.
- You choose a new password using the forgotten password reset flow.
- You change your password proactively.
- You change your password after it expires.
- An administrator creates your account.
- An administrator updates your account.
By default GitLab enforces the following password requirements:
- Minimum and maximum password lengths. For example,
see [the settings for GitLab.com](../gitlab_com/_index.md#password-requirements).
- Disallowing [weak passwords](#block-weak-passwords).
GitLab Self-Managed instances can configure the following additional password requirements:
- [Password minimum and maximum length limits](../../security/password_length_limits.md).
- [Password complexity requirements](../../administration/settings/sign_up_restrictions.md#password-complexity-requirements).
## Block weak passwords
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23610) in GitLab 15.4 [with a flag](../../administration/feature_flags/_index.md) named `block_weak_passwords`, weak passwords aren't accepted. Disabled by default on GitLab Self-Managed.
- [Enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/363445) on GitLab.com in GitLab 15.6.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/363445) and enabled on GitLab Self-Managed in GitLab 15.7. Feature flag `block_weak_passwords` removed.
{{< /history >}}
GitLab disallows weak passwords. Your password is considered weak when it:
- Matches one of 4500+ known, breached passwords.
- Contains part of your name, username, or email address.
- Contains a predictable word (for example, `gitlab` or `devops`).
Weak passwords are rejected with the error message: **Password must not contain commonly used combinations of words and letters**.
|
https://docs.gitlab.com/user/comment_templates
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/comment_templates.md
|
2025-08-13
|
doc/user/profile
|
[
"doc",
"user",
"profile"
] |
comment_templates.md
|
Create
|
Code Review
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Comment templates
|
Build templates for text frequently used in comments, and share those templates with your project or group.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Feature flag `saved_replies` [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119468) in GitLab 16.0.
- [Feature flag `saved_replies` removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123363) in GitLab 16.6.
- Saved replies for groups [introduced](https://gitlab.com/groups/gitlab-org/-/epics/12669) in GitLab 16.11 [with a flag](../../administration/feature_flags/_index.md) named `group_saved_replies_flag`. Disabled by default.
- Saved replies for groups [enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/440817) on GitLab.com and GitLab Self-Managed in GitLab 16.11.
- Saved replies for groups [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/504028) in GitLab 17.8. Feature flag `group_saved_replies_flag` removed.
- Saved replies for projects [introduced](https://gitlab.com/groups/gitlab-org/-/epics/12669) in GitLab 17.0 [with a flag](../../administration/feature_flags/_index.md) named `project_saved_replies_flag`. Enabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/504028) in GitLab 17.8. Feature flag `project_saved_replies_flag` removed.
{{< /history >}}
With comment templates, create and reuse text for any text area in:
- Merge requests, including diffs.
- Issues, including design management comments.
- Epics.
- Work items.
Comment templates can be small, like approving a merge request and unassigning yourself from it,
or large, like chunks of boilerplate text you use frequently:
## Use comment templates in a text area
To include the text of a comment template in your comment:
1. In the editor toolbar for your comment, select **Comment templates** ({{< icon name="comment-lines" >}}).
1. Select your desired comment template.
## Create comment templates
You can create comment templates for your own use, or to share with all members of a group.
To create a comment template for your own use:
1. On the left sidebar, select your avatar.
1. From the dropdown list, select **Preferences**.
1. On the left sidebar, select **Comment templates** ({{< icon name="comment-lines" >}}).
1. Select **Add new**.
1. Provide a **Name** for your comment template.
1. Enter the **Content** of your reply. You can use any formatting you use in
other GitLab text areas.
1. Select **Save**, and the page reloads with your comment template shown.
### For a group
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
To create a comment template shared with all members of a group:
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}), then select **Manage group comment templates**.
1. Select **Add new**.
1. Provide a **Name** for your comment template.
1. Enter the **Content** of your reply. You can use any formatting you use in
other GitLab text areas.
1. Select **Save**, and the page reloads with your comment template shown.
### For a project
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
To create a comment template shared with all members of a project:
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}), then select **Manage project comment templates**.
1. Select **Add new**.
1. Provide a **Name** for your comment template.
1. Enter the **Content** of your reply. You can use any formatting you use in
other GitLab text areas.
1. Select **Save**, and the page reloads with your comment template shown.
## View comment templates
To see existing comment templates:
1. On the left sidebar, select your avatar.
1. From the dropdown list, select **Preferences**.
1. On the left sidebar, select **Comment templates** ({{< icon name="comment-lines" >}}).
1. Scroll to **Comment templates**.
### For a group
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}).
1. Select **Manage group comment templates**.
### For a project
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}).
1. Select **Manage project comment templates**.
## Edit or delete comment templates
To edit or delete an existing comment template:
1. On the left sidebar, select your avatar.
1. From the dropdown list, select **Preferences**.
1. On the left sidebar, select **Comment templates** ({{< icon name="comment-lines" >}}).
1. Scroll to **Comment templates**, and identify the comment template you want to edit.
1. To edit, select **Edit** ({{< icon name="pencil" >}}).
1. To delete, select **Delete** ({{< icon name="remove" >}}), then select **Delete** again on the dialog.
### For a group
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}), then select **Manage group comment templates**.
1. To edit, select **Edit** ({{< icon name="pencil" >}}).
1. To delete, select **Delete** ({{< icon name="remove" >}}), then select **Delete** again on the dialog.
### For a project
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}), then select **Manage project comment templates**.
1. To edit, select **Edit** ({{< icon name="pencil" >}}).
1. To delete, select **Delete** ({{< icon name="remove" >}}), then select **Delete** again on the dialog.
|
---
stage: Create
group: Code Review
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Build templates for text frequently used in comments, and share those
templates with your project or group.
title: Comment templates
breadcrumbs:
- doc
- user
- profile
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Feature flag `saved_replies` [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119468) in GitLab 16.0.
- [Feature flag `saved_replies` removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123363) in GitLab 16.6.
- Saved replies for groups [introduced](https://gitlab.com/groups/gitlab-org/-/epics/12669) in GitLab 16.11 [with a flag](../../administration/feature_flags/_index.md) named `group_saved_replies_flag`. Disabled by default.
- Saved replies for groups [enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/440817) on GitLab.com and GitLab Self-Managed in GitLab 16.11.
- Saved replies for groups [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/504028) in GitLab 17.8. Feature flag `group_saved_replies_flag` removed.
- Saved replies for projects [introduced](https://gitlab.com/groups/gitlab-org/-/epics/12669) in GitLab 17.0 [with a flag](../../administration/feature_flags/_index.md) named `project_saved_replies_flag`. Enabled by default.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/504028) in GitLab 17.8. Feature flag `project_saved_replies_flag` removed.
{{< /history >}}
With comment templates, create and reuse text for any text area in:
- Merge requests, including diffs.
- Issues, including design management comments.
- Epics.
- Work items.
Comment templates can be small, like approving a merge request and unassigning yourself from it,
or large, like chunks of boilerplate text you use frequently:
## Use comment templates in a text area
To include the text of a comment template in your comment:
1. In the editor toolbar for your comment, select **Comment templates** ({{< icon name="comment-lines" >}}).
1. Select your desired comment template.
## Create comment templates
You can create comment templates for your own use, or to share with all members of a group.
To create a comment template for your own use:
1. On the left sidebar, select your avatar.
1. From the dropdown list, select **Preferences**.
1. On the left sidebar, select **Comment templates** ({{< icon name="comment-lines" >}}).
1. Select **Add new**.
1. Provide a **Name** for your comment template.
1. Enter the **Content** of your reply. You can use any formatting you use in
other GitLab text areas.
1. Select **Save**, and the page reloads with your comment template shown.
### For a group
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
To create a comment template shared with all members of a group:
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}), then select **Manage group comment templates**.
1. Select **Add new**.
1. Provide a **Name** for your comment template.
1. Enter the **Content** of your reply. You can use any formatting you use in
other GitLab text areas.
1. Select **Save**, and the page reloads with your comment template shown.
### For a project
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
To create a comment template shared with all members of a project:
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}), then select **Manage project comment templates**.
1. Select **Add new**.
1. Provide a **Name** for your comment template.
1. Enter the **Content** of your reply. You can use any formatting you use in
other GitLab text areas.
1. Select **Save**, and the page reloads with your comment template shown.
## View comment templates
To see existing comment templates:
1. On the left sidebar, select your avatar.
1. From the dropdown list, select **Preferences**.
1. On the left sidebar, select **Comment templates** ({{< icon name="comment-lines" >}}).
1. Scroll to **Comment templates**.
### For a group
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}).
1. Select **Manage group comment templates**.
### For a project
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}).
1. Select **Manage project comment templates**.
## Edit or delete comment templates
To edit or delete an existing comment template:
1. On the left sidebar, select your avatar.
1. From the dropdown list, select **Preferences**.
1. On the left sidebar, select **Comment templates** ({{< icon name="comment-lines" >}}).
1. Scroll to **Comment templates**, and identify the comment template you want to edit.
1. To edit, select **Edit** ({{< icon name="pencil" >}}).
1. To delete, select **Delete** ({{< icon name="remove" >}}), then select **Delete** again on the dialog.
### For a group
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}), then select **Manage group comment templates**.
1. To edit, select **Edit** ({{< icon name="pencil" >}}).
1. To delete, select **Delete** ({{< icon name="remove" >}}), then select **Delete** again on the dialog.
### For a project
{{< details >}}
- Tier: Premium, Ultimate
{{< /details >}}
1. In the editor toolbar for a comment, select **Comment templates**
({{< icon name="comment-lines" >}}), then select **Manage project comment templates**.
1. To edit, select **Edit** ({{< icon name="pencil" >}}).
1. To delete, select **Delete** ({{< icon name="remove" >}}), then select **Delete** again on the dialog.
|
https://docs.gitlab.com/user/preferences
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/preferences.md
|
2025-08-13
|
doc/user/profile
|
[
"doc",
"user",
"profile"
] |
preferences.md
|
none
|
unassigned
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Profile preferences
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can update your preferences to change the look and feel of GitLab.
## Change the mode
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28252) in GitLab 13.1.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/524846) from experiment to beta in GitLab 17.11.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/470413) from **Appearance** to **Mode** in GitLab 18.1.
{{< /history >}}
You can change the color mode of the interface to be light, dark, or automatically update based on device preferences.
To change the appearance:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. In the **Mode** section, select an option.
1. Select **Save changes**.
## Change the navigation theme
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/470413) from **Color theme** to **Navigation theme** in GitLab 18.1.
{{< /history >}}
You can change the navigation theme of the GitLab UI. These colors are displayed on the left sidebar.
Using individual navigation themes might help you differentiate between your different
GitLab instances.
To change the navigation theme:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. In the **Navigation** section, select a theme.
## Change the syntax highlighting theme
{{< history >}}
- Changing the default syntax highlighting theme for authenticated and unauthenticated users [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25129) in GitLab 15.1.
{{< /history >}}
Syntax highlighting is a feature in code editors and IDEs. The highlighter assigns a color to each type of code, such as strings and comments.
To change the syntax highlighting theme:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. In the **Syntax highlighting** section, select a theme.
1. Select **Save changes**.
To view the updated syntax highlighting theme, refresh your project's page.
To customize the syntax highlighting theme, you can also [use the Application settings API](../../api/settings.md#available-settings). Use `default_syntax_highlighting_theme` and `default_dark_syntax_highlighting_theme` to change the syntax highlighting colors on a more
granular level.
If these steps do not work, your programming language might not be supported by the syntax highlighters.
For more information, view [Rouge Ruby Library](https://github.com/rouge-ruby/rouge) for guidance on code files and Snippets. View [Monaco Editor](https://microsoft.github.io/monaco-editor/) and [Monarch](https://microsoft.github.io/monaco-editor/monarch.html) for guidance on the Web IDE.
## Change the diff colors
Diffs use two different background colors to show changes between versions of code. By default, the original file is in red, and the changes are in green.
To change the diff colors:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Diffs** section.
1. Select a color or enter a color code.
1. Select **Save changes**.
To change back to the default colors, clear the **Color for removed lines** and **Color for added lines** text boxes and select **Save changes**.
## Behavior
Use the **Behavior** section to customize the behavior of the system layout and default views. You can change your layout width and choose the default content for your homepage, group and project overview pages. You have options to customize appearance and function, like whitespace rendering, file display, and text automation.
### Change the layout width on the UI
You can stretch content on the GitLab UI to fill the entire page. By default, page content is fixed at 1280 pixels wide.
To change the layout width of your UI:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Under **Layout width**, choose **Fixed** or **Fluid**.
1. Select **Save changes**.
### Set the default text editor
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423104) in GitLab 17.7.
- Default for new users [set to rich text editor](https://gitlab.com/gitlab-org/gitlab/-/issues/536611) in 18.2.
{{< /history >}}
By default, all new users see the **Rich text editor** when editing content.
You can change the default editor for editing content in GitLab.
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Under **Default text editor**, enssure the **Enable default text editor** checkbox is selected.
1. Choose either **Rich text editor** or **Plain text editor** as your default.
1. Select **Save changes**.
### Choose your homepage
{{< history >}}
- [Homepage options changed](https://gitlab.com/groups/gitlab-org/-/epics/13066) in GitLab 17.9 [with a flag](../../administration/feature_flags/_index.md) named `your_work_projects_vue`. Disabled by default.
- [Homepage option changes generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/465889) in GitLab 17.10. Feature flag `your_work_projects_vue` removed.
{{< /history >}}
Control what page you view when you select the GitLab logo ({{< icon name="tanuki" >}}). You can set your homepage to be Your Contributed Projects (default), Your Groups, Your Activity, and other content.
To choose your homepage view:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. From the **Homepage** dropdown list, select an option.
1. Select **Save changes**.
### Customize default content on your group overview page
You can change the main content on your group overview page. Your group overview page is the page that shows when you select **Groups** on the left sidebar. You can customize the default content for your group overview page to the:
- Details Dashboard (default), which includes an overview of group activities and projects.
- Security Dashboard, which might include group security policies and other security topics.
For more information, view [Groups](../group/_index.md).
To change the default content on your group overview page:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. From the **Group overview content** dropdown list, select an option.
1. Select **Save changes**.
### Customize default content on your project overview page
Your project overview page is the page you view when you select **Project overview** on the left sidebar. You can set your main project overview page to the Activity page, the README file, and other content.
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. From the **Project overview content** dropdown list, select an option.
1. Select **Save changes**.
### Hide shortcut buttons
Shortcut buttons precede the list of files on a project's overview page. These buttons provide links to parts of a project, such as the README file or license agreements.
To hide shortcut buttons on the project overview page:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Clear the **Show shortcut buttons above files on project overview** checkbox.
1. Select **Save changes**.
### Show whitespace characters in the Web IDE
Whitespace characters are any blank characters in a text, such as spaces and indentations. You might use whitespace to structure content in code. If your programming language is sensitive to whitespaces, the Web IDE can detect changes to them.
To render whitespace in the Web IDE:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Render whitespace characters in the Web IDE** checkbox.
1. Select **Save changes**.
You can view changes to whitespace in diffs.
To view diffs on the Web IDE, follow these steps:
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. Under the **Changes** tab, select your file.
### Show whitespace changes in diffs
View changes to whitespace in diff files. For more information on whitespaces, view the previous task.
To view changes to whitespace in diffs:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Show whitespace changes in diffs** checkbox.
1. Select **Save changes**.
For more information on diffs, view [Change the diff colors](#change-the-diff-colors).
### Show one file per page in a merge request
The **Changes** tab lets you view all file changes in a merge request on one page.
Instead, you can choose to view one file at a time.
To show one file per page on the **Changes** tab:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Show one file at a time on merge request's Changes tab** checkbox.
1. Select **Save changes**.
Then, to move between files on the **Changes** tab, below each file, select the **Previous** and **Next** buttons.
### Auto-enclose characters
Automatically add the corresponding closing character to text when you type the opening character. For example, you can automatically insert a closing bracket when you type an opening bracket. This setting works only in description and comment boxes and for the following characters: `**"`, `'`, ```, `(`, `[`, `{`, `<`, `*`, `_**`.
To auto-enclose characters in description and comment boxes:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Surround text selection when typing quotes or brackets** checkbox.
1. Select **Save changes**.
In a description or comment box, you can now type a word, highlight it, then type an
opening character. Instead of replacing the text, the closing character is added to the end.
### Automate new list items
Create a new list item when you press <kbd>Enter</kbd> in a list in description and comment boxes.
To add a new list item when you press the <kbd>Enter</kbd> key:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Automatically add new list items** checkbox.
1. Select **Save changes**.
### Maintain cursor indentation
Maintain the indentation when you press <kbd>Enter</kbd>. The cursor on the new line is automatically indented the same as the previous line. This setting works only in description and comment boxes.
To add a new list item when you press the <kbd>Enter</kbd> key:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Maintain cursor indentation** checkbox.
1. Select **Save changes**.
### Change the tab width
Change the default size of tabs in diffs, blobs, and snippets. The Web IDE, file editor, and Markdown editor do not support this feature.
To adjust the default tab width:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. For **Tab width**, enter a value.
1. Select **Save changes**.
## Localization
Change localization settings such as your language, calendar start day, and time preferences.
### Change your display language on the GitLab UI
GitLab supports multiple languages on the UI.
To choose a language for the GitLab UI:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Localization** section.
1. Under **Language**, select an option.
1. Select **Save changes**.
You might need to refresh your page to view the updated language.
### Customize your contribution calendar start day
Choose which day of the week the contribution calendar starts with. The contribution calendar shows project contributions over the past year. You can view this calendar on each user profile. To access your user profile:
- On the left sidebar, select your avatar > select your name or username.
To change your contribution calendar start day:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Localization** section.
1. Under **First day of the week**, select an option.
1. Select **Save changes**.
After you change your calendar start day, refresh your user profile page.
### Show exact times instead of relative times
Customize the format used to display times of activities on your group and project overview pages and user profiles. You can display times in a:
- Relative format, for example `30 minutes ago`.
- Absolute format, for example `September 3, 2022, 3:57 PM`.
To use exact times on the GitLab UI:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Time preferences** section.
1. Clear the **Use relative times** checkbox.
1. Select **Save changes**.
### Customize time format
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15206) in GitLab 16.6.
{{< /history >}}
You can customize the format used to display times of activities on your group and project overview pages and user
profiles. You can display times as:
- 12 hour format. For example: `2:34 PM`.
- 24 hour format. For example: `14:34`.
You can also follow your system's setting.
To customize the time format:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Time preferences** section.
1. Under **Time format**, select either the **System**, **12-hour**, or **24-hour** option.
1. Select **Save changes**.
<!--- start_remove The following content will be removed on remove_date: '2026-02-20' -->
## Disable exact code search (deprecated)
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed
- Status: Beta
{{< /details >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/554933) in GitLab 18.3
and is planned for removal in 18.6.
{{< /alert >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105049) as a [beta](../../policy/development_stages_support.md#beta) in GitLab 15.9 [with flags](../../administration/feature_flags/_index.md) named `index_code_with_zoekt` and `search_code_with_zoekt`. Disabled by default.
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/388519) in GitLab 16.6.
- Feature flags `index_code_with_zoekt` and `search_code_with_zoekt` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148378) in GitLab 17.1.
{{< /history >}}
{{< alert type="warning" >}}
This feature is in [beta](../../policy/development_stages_support.md#beta) and subject to change without notice.
For more information, see [epic 9404](https://gitlab.com/groups/gitlab-org/-/epics/9404).
{{< /alert >}}
Prerequisites:
- For [GitLab Self-Managed](../../subscriptions/self_managed/_index.md), an administrator must
[enable exact code search](../../integration/exact_code_search/zoekt.md#enable-exact-code-search).
To disable [exact code search](../search/exact_code_search.md) in user preferences:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Exact code search** section.
1. Clear the **Enable exact code search** checkbox.
1. Select **Save changes**.
<!--- end_remove -->
## User identities in CI job JSON web tokens
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387537) in GitLab 16.0.
{{< /history >}}
CI/CD jobs generate JSON web tokens, which can include a list of your external identities.
Instead of making separate API calls to get individual accounts, you can find your user identities in a single authentication token.
External identities are not included by default.
To enable including external identities, see [Token payload](../../ci/secrets/id_token_authentication.md#token-payload).
## Control follower engagement
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325558) in GitLab 16.0.
{{< /history >}}
Turn off the ability to follow or be followed by other GitLab users. By default, your user profile, including your name and profile photo, is public in the **Following** tabs of other users. When you deactivate this setting:
- GitLab deletes all of your followers and followed connections.
- GitLab automatically removes your user profile from the pages of each connection.
To remove the ability to be followed by and follow other users:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Clear the **Enable follow users** checkbox.
1. Select **Save changes**.
To access your **Followers** and **Following** tabs:
- On the left sidebar, select your avatar > select your name or username.
- Select **Followers** or **Following**.
## Integrate your GitLab instance with third-party services
Give third-party services access to enhance the GitLab experience.
### Integrate your GitLab instance with Gitpod
Configure your GitLab instance with Gitpod when you want to launch and manage code directly from your GitLab browser. Gitpod automatically prepares and builds development environments for your projects.
To integrate with Gitpod:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Find the **Integrations** section.
1. Select the **Enable Gitpod integration** checkbox.
1. Select **Save changes**.
### Integrate your GitLab instance with Sourcegraph
GitLab supports Sourcegraph integration for all public projects on GitLab.
To integrate with Sourcegraph:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Find the **Integrations** section.
1. Select the **Enable integrated code intelligence on code views** checkbox.
1. Select **Save changes**.
You must be the administrator of the GitLab instance to configure GitLab with Sourcegraph.
### Integrate with the extension marketplace
{{< details >}}
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/151352) as a [beta](../../policy/development_stages_support.md#beta) in GitLab 17.0 [with flags](../../administration/feature_flags/_index.md) named `web_ide_oauth` and `web_ide_extensions_marketplace`. Disabled by default.
- `web_ide_oauth` [enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/163181) in GitLab 17.4.
- `web_ide_extensions_marketplace` [enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/459028) in GitLab 17.4.
- `web_ide_oauth` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/167464) in GitLab 17.5.
- Enabled by default for [workspaces](../workspace/_index.md) in GitLab 17.6. Workspaces do not require any feature flags for the extension marketplace to be available.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/508996) the `vscode_extension_marketplace_settings` [feature flag](../../administration/feature_flags/_index.md) in GitLab 17.10. Disabled by default.
- `web_ide_extensions_marketplace` [enabled on GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/184662), and `vscode_extension_marketplace_settings` [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/184662) in GitLab 17.11.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192659) in GitLab 18.1. Feature flags `web_ide_extensions_marketplace` and `vscode_extension_marketplace_settings` removed.
{{< /history >}}
You can use the extension marketplace to search and
[manage extensions](../project/web_ide/_index.md#manage-extensions) for the [Web IDE](../project/web_ide/_index.md) and [workspaces](../workspace/_index.md).
For third-party extensions, you must enable the marketplace in user preferences.
Prerequisites:
- In the **Admin** area, a GitLab administrator must
[enable the extension marketplace](../../administration/settings/vscode_extension_marketplace.md).
To enable the extension marketplace for the Web IDE and workspaces:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Integrations** section.
1. Select the **Enable extension marketplace** checkbox.
1. In the third-party extension acknowledgment, select **I understand**.
1. Select **Save changes**.
|
---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Profile preferences
breadcrumbs:
- doc
- user
- profile
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can update your preferences to change the look and feel of GitLab.
## Change the mode
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28252) in GitLab 13.1.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/524846) from experiment to beta in GitLab 17.11.
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/470413) from **Appearance** to **Mode** in GitLab 18.1.
{{< /history >}}
You can change the color mode of the interface to be light, dark, or automatically update based on device preferences.
To change the appearance:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. In the **Mode** section, select an option.
1. Select **Save changes**.
## Change the navigation theme
{{< history >}}
- [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/470413) from **Color theme** to **Navigation theme** in GitLab 18.1.
{{< /history >}}
You can change the navigation theme of the GitLab UI. These colors are displayed on the left sidebar.
Using individual navigation themes might help you differentiate between your different
GitLab instances.
To change the navigation theme:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. In the **Navigation** section, select a theme.
## Change the syntax highlighting theme
{{< history >}}
- Changing the default syntax highlighting theme for authenticated and unauthenticated users [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25129) in GitLab 15.1.
{{< /history >}}
Syntax highlighting is a feature in code editors and IDEs. The highlighter assigns a color to each type of code, such as strings and comments.
To change the syntax highlighting theme:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. In the **Syntax highlighting** section, select a theme.
1. Select **Save changes**.
To view the updated syntax highlighting theme, refresh your project's page.
To customize the syntax highlighting theme, you can also [use the Application settings API](../../api/settings.md#available-settings). Use `default_syntax_highlighting_theme` and `default_dark_syntax_highlighting_theme` to change the syntax highlighting colors on a more
granular level.
If these steps do not work, your programming language might not be supported by the syntax highlighters.
For more information, view [Rouge Ruby Library](https://github.com/rouge-ruby/rouge) for guidance on code files and Snippets. View [Monaco Editor](https://microsoft.github.io/monaco-editor/) and [Monarch](https://microsoft.github.io/monaco-editor/monarch.html) for guidance on the Web IDE.
## Change the diff colors
Diffs use two different background colors to show changes between versions of code. By default, the original file is in red, and the changes are in green.
To change the diff colors:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Diffs** section.
1. Select a color or enter a color code.
1. Select **Save changes**.
To change back to the default colors, clear the **Color for removed lines** and **Color for added lines** text boxes and select **Save changes**.
## Behavior
Use the **Behavior** section to customize the behavior of the system layout and default views. You can change your layout width and choose the default content for your homepage, group and project overview pages. You have options to customize appearance and function, like whitespace rendering, file display, and text automation.
### Change the layout width on the UI
You can stretch content on the GitLab UI to fill the entire page. By default, page content is fixed at 1280 pixels wide.
To change the layout width of your UI:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Under **Layout width**, choose **Fixed** or **Fluid**.
1. Select **Save changes**.
### Set the default text editor
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423104) in GitLab 17.7.
- Default for new users [set to rich text editor](https://gitlab.com/gitlab-org/gitlab/-/issues/536611) in 18.2.
{{< /history >}}
By default, all new users see the **Rich text editor** when editing content.
You can change the default editor for editing content in GitLab.
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Under **Default text editor**, enssure the **Enable default text editor** checkbox is selected.
1. Choose either **Rich text editor** or **Plain text editor** as your default.
1. Select **Save changes**.
### Choose your homepage
{{< history >}}
- [Homepage options changed](https://gitlab.com/groups/gitlab-org/-/epics/13066) in GitLab 17.9 [with a flag](../../administration/feature_flags/_index.md) named `your_work_projects_vue`. Disabled by default.
- [Homepage option changes generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/465889) in GitLab 17.10. Feature flag `your_work_projects_vue` removed.
{{< /history >}}
Control what page you view when you select the GitLab logo ({{< icon name="tanuki" >}}). You can set your homepage to be Your Contributed Projects (default), Your Groups, Your Activity, and other content.
To choose your homepage view:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. From the **Homepage** dropdown list, select an option.
1. Select **Save changes**.
### Customize default content on your group overview page
You can change the main content on your group overview page. Your group overview page is the page that shows when you select **Groups** on the left sidebar. You can customize the default content for your group overview page to the:
- Details Dashboard (default), which includes an overview of group activities and projects.
- Security Dashboard, which might include group security policies and other security topics.
For more information, view [Groups](../group/_index.md).
To change the default content on your group overview page:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. From the **Group overview content** dropdown list, select an option.
1. Select **Save changes**.
### Customize default content on your project overview page
Your project overview page is the page you view when you select **Project overview** on the left sidebar. You can set your main project overview page to the Activity page, the README file, and other content.
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. From the **Project overview content** dropdown list, select an option.
1. Select **Save changes**.
### Hide shortcut buttons
Shortcut buttons precede the list of files on a project's overview page. These buttons provide links to parts of a project, such as the README file or license agreements.
To hide shortcut buttons on the project overview page:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Clear the **Show shortcut buttons above files on project overview** checkbox.
1. Select **Save changes**.
### Show whitespace characters in the Web IDE
Whitespace characters are any blank characters in a text, such as spaces and indentations. You might use whitespace to structure content in code. If your programming language is sensitive to whitespaces, the Web IDE can detect changes to them.
To render whitespace in the Web IDE:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Render whitespace characters in the Web IDE** checkbox.
1. Select **Save changes**.
You can view changes to whitespace in diffs.
To view diffs on the Web IDE, follow these steps:
1. On the left sidebar, select **Source Control** ({{< icon name="branch" >}}).
1. Under the **Changes** tab, select your file.
### Show whitespace changes in diffs
View changes to whitespace in diff files. For more information on whitespaces, view the previous task.
To view changes to whitespace in diffs:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Show whitespace changes in diffs** checkbox.
1. Select **Save changes**.
For more information on diffs, view [Change the diff colors](#change-the-diff-colors).
### Show one file per page in a merge request
The **Changes** tab lets you view all file changes in a merge request on one page.
Instead, you can choose to view one file at a time.
To show one file per page on the **Changes** tab:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Show one file at a time on merge request's Changes tab** checkbox.
1. Select **Save changes**.
Then, to move between files on the **Changes** tab, below each file, select the **Previous** and **Next** buttons.
### Auto-enclose characters
Automatically add the corresponding closing character to text when you type the opening character. For example, you can automatically insert a closing bracket when you type an opening bracket. This setting works only in description and comment boxes and for the following characters: `**"`, `'`, ```, `(`, `[`, `{`, `<`, `*`, `_**`.
To auto-enclose characters in description and comment boxes:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Surround text selection when typing quotes or brackets** checkbox.
1. Select **Save changes**.
In a description or comment box, you can now type a word, highlight it, then type an
opening character. Instead of replacing the text, the closing character is added to the end.
### Automate new list items
Create a new list item when you press <kbd>Enter</kbd> in a list in description and comment boxes.
To add a new list item when you press the <kbd>Enter</kbd> key:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Automatically add new list items** checkbox.
1. Select **Save changes**.
### Maintain cursor indentation
Maintain the indentation when you press <kbd>Enter</kbd>. The cursor on the new line is automatically indented the same as the previous line. This setting works only in description and comment boxes.
To add a new list item when you press the <kbd>Enter</kbd> key:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. Select the **Maintain cursor indentation** checkbox.
1. Select **Save changes**.
### Change the tab width
Change the default size of tabs in diffs, blobs, and snippets. The Web IDE, file editor, and Markdown editor do not support this feature.
To adjust the default tab width:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section.
1. For **Tab width**, enter a value.
1. Select **Save changes**.
## Localization
Change localization settings such as your language, calendar start day, and time preferences.
### Change your display language on the GitLab UI
GitLab supports multiple languages on the UI.
To choose a language for the GitLab UI:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Localization** section.
1. Under **Language**, select an option.
1. Select **Save changes**.
You might need to refresh your page to view the updated language.
### Customize your contribution calendar start day
Choose which day of the week the contribution calendar starts with. The contribution calendar shows project contributions over the past year. You can view this calendar on each user profile. To access your user profile:
- On the left sidebar, select your avatar > select your name or username.
To change your contribution calendar start day:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Localization** section.
1. Under **First day of the week**, select an option.
1. Select **Save changes**.
After you change your calendar start day, refresh your user profile page.
### Show exact times instead of relative times
Customize the format used to display times of activities on your group and project overview pages and user profiles. You can display times in a:
- Relative format, for example `30 minutes ago`.
- Absolute format, for example `September 3, 2022, 3:57 PM`.
To use exact times on the GitLab UI:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Time preferences** section.
1. Clear the **Use relative times** checkbox.
1. Select **Save changes**.
### Customize time format
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15206) in GitLab 16.6.
{{< /history >}}
You can customize the format used to display times of activities on your group and project overview pages and user
profiles. You can display times as:
- 12 hour format. For example: `2:34 PM`.
- 24 hour format. For example: `14:34`.
You can also follow your system's setting.
To customize the time format:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Time preferences** section.
1. Under **Time format**, select either the **System**, **12-hour**, or **24-hour** option.
1. Select **Save changes**.
<!--- start_remove The following content will be removed on remove_date: '2026-02-20' -->
## Disable exact code search (deprecated)
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed
- Status: Beta
{{< /details >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/554933) in GitLab 18.3
and is planned for removal in 18.6.
{{< /alert >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105049) as a [beta](../../policy/development_stages_support.md#beta) in GitLab 15.9 [with flags](../../administration/feature_flags/_index.md) named `index_code_with_zoekt` and `search_code_with_zoekt`. Disabled by default.
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/388519) in GitLab 16.6.
- Feature flags `index_code_with_zoekt` and `search_code_with_zoekt` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148378) in GitLab 17.1.
{{< /history >}}
{{< alert type="warning" >}}
This feature is in [beta](../../policy/development_stages_support.md#beta) and subject to change without notice.
For more information, see [epic 9404](https://gitlab.com/groups/gitlab-org/-/epics/9404).
{{< /alert >}}
Prerequisites:
- For [GitLab Self-Managed](../../subscriptions/self_managed/_index.md), an administrator must
[enable exact code search](../../integration/exact_code_search/zoekt.md#enable-exact-code-search).
To disable [exact code search](../search/exact_code_search.md) in user preferences:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Exact code search** section.
1. Clear the **Enable exact code search** checkbox.
1. Select **Save changes**.
<!--- end_remove -->
## User identities in CI job JSON web tokens
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387537) in GitLab 16.0.
{{< /history >}}
CI/CD jobs generate JSON web tokens, which can include a list of your external identities.
Instead of making separate API calls to get individual accounts, you can find your user identities in a single authentication token.
External identities are not included by default.
To enable including external identities, see [Token payload](../../ci/secrets/id_token_authentication.md#token-payload).
## Control follower engagement
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325558) in GitLab 16.0.
{{< /history >}}
Turn off the ability to follow or be followed by other GitLab users. By default, your user profile, including your name and profile photo, is public in the **Following** tabs of other users. When you deactivate this setting:
- GitLab deletes all of your followers and followed connections.
- GitLab automatically removes your user profile from the pages of each connection.
To remove the ability to be followed by and follow other users:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Clear the **Enable follow users** checkbox.
1. Select **Save changes**.
To access your **Followers** and **Following** tabs:
- On the left sidebar, select your avatar > select your name or username.
- Select **Followers** or **Following**.
## Integrate your GitLab instance with third-party services
Give third-party services access to enhance the GitLab experience.
### Integrate your GitLab instance with Gitpod
Configure your GitLab instance with Gitpod when you want to launch and manage code directly from your GitLab browser. Gitpod automatically prepares and builds development environments for your projects.
To integrate with Gitpod:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Find the **Integrations** section.
1. Select the **Enable Gitpod integration** checkbox.
1. Select **Save changes**.
### Integrate your GitLab instance with Sourcegraph
GitLab supports Sourcegraph integration for all public projects on GitLab.
To integrate with Sourcegraph:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Find the **Integrations** section.
1. Select the **Enable integrated code intelligence on code views** checkbox.
1. Select **Save changes**.
You must be the administrator of the GitLab instance to configure GitLab with Sourcegraph.
### Integrate with the extension marketplace
{{< details >}}
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/151352) as a [beta](../../policy/development_stages_support.md#beta) in GitLab 17.0 [with flags](../../administration/feature_flags/_index.md) named `web_ide_oauth` and `web_ide_extensions_marketplace`. Disabled by default.
- `web_ide_oauth` [enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/163181) in GitLab 17.4.
- `web_ide_extensions_marketplace` [enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/459028) in GitLab 17.4.
- `web_ide_oauth` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/167464) in GitLab 17.5.
- Enabled by default for [workspaces](../workspace/_index.md) in GitLab 17.6. Workspaces do not require any feature flags for the extension marketplace to be available.
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/508996) the `vscode_extension_marketplace_settings` [feature flag](../../administration/feature_flags/_index.md) in GitLab 17.10. Disabled by default.
- `web_ide_extensions_marketplace` [enabled on GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/184662), and `vscode_extension_marketplace_settings` [enabled on GitLab.com and GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/184662) in GitLab 17.11.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/192659) in GitLab 18.1. Feature flags `web_ide_extensions_marketplace` and `vscode_extension_marketplace_settings` removed.
{{< /history >}}
You can use the extension marketplace to search and
[manage extensions](../project/web_ide/_index.md#manage-extensions) for the [Web IDE](../project/web_ide/_index.md) and [workspaces](../workspace/_index.md).
For third-party extensions, you must enable the marketplace in user preferences.
Prerequisites:
- In the **Admin** area, a GitLab administrator must
[enable the extension marketplace](../../administration/settings/vscode_extension_marketplace.md).
To enable the extension marketplace for the Web IDE and workspaces:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. Go to the **Integrations** section.
1. Select the **Enable extension marketplace** checkbox.
1. In the third-party extension acknowledgment, select **I understand**.
1. Select **Save changes**.
|
https://docs.gitlab.com/user/achievements
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/achievements.md
|
2025-08-13
|
doc/user/profile
|
[
"doc",
"user",
"profile"
] |
achievements.md
|
Tenant Scale
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Achievements
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed
- Status: Experiment
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113156) in GitLab 15.10 [with a flag](../../administration/feature_flags/_index.md) named `achievements`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
On GitLab Self-Managed, by default this feature is not available. To make it available,
an administrator can [enable the feature flag](../../administration/feature_flags/_index.md) named `achievements`.
{{< /alert >}}
Achievements are a way to reward users for their activity on GitLab.
As a namespace maintainer or owner, you can create custom achievements for specific contributions. You can award these
achievements to users or revoke them based on defined criteria.
As a user, you can collect achievements to highlight your contributions to different projects or groups on your profile.
An achievement consists of a name, a description, and an avatar.
Achievements are considered to be owned by the user. They are visible regardless of the visibility setting of the namespace that created the Achievement.
This feature is an experiment.
For more information about planned work, see [epic 9429](https://gitlab.com/groups/gitlab-org/-/epics/9429).
Tell us about your use cases by leaving comments in the epic.
## Types of achievement
Programmatically, there is only one way to create, award, revoke, or delete achievements.
Practically, you can differentiate between achievements that are awarded:
- Once and irrevocable. For example, a "First contribution merged" achievement.
- Once and revocable. For example, a "Core team member" achievement.
- Multiple times. For example, a "Contributor of the month" achievement.
## View group achievements
To view all available and awarded achievements for a group:
- Go to `https://gitlab.com/groups/<group-path>/-/achievements`.
The page displays a list of achievements and the members who were awarded the achievement.
## View a user's achievements
You can view a user's achievements on their profile page.
Prerequisites:
- The user profile must be public.
To view a user's achievements:
1. Go to the user's profile page.
1. Below the user's avatar, see their achievements.
1. To view details about an achievement, hover over it.
It displays the following information:
- Name of the achievement
- Description of the achievement
- Date when the achievement was awarded to the user
- Namespace that awarded the achievement if the user is a member of the namespace or the namespace is public
To retrieve a list of a user's achievements, query the [`user` GraphQL type](../../api/graphql/reference/_index.md#user).
```graphql
query {
user(username: "<username>") {
userAchievements {
nodes {
achievement {
name
description
avatarUrl
namespace {
fullPath
name
}
}
}
}
}
}
```
## Create an achievement
You can create custom achievements to award for specific contributions.
Prerequisites:
- You must have the Maintainer or Owner role for the namespace.
To create an achievement:
- In the UI:
1. On the [Achievements page](#view-group-achievements), select **New achievement**.
1. Enter a name for the achievement.
1. Optional. Enter a description and upload an avatar for the achievement.
1. Select **Save changes**.
- With the GraphQL API, call the [`achievementsCreate` GraphQL mutation](../../api/graphql/reference/_index.md#mutationachievementscreate):
```graphql
mutation achievementsCreate($file: Upload!) {
achievementsCreate(
input: {
namespaceId: "gid://gitlab/Namespace/<namespace id>",
name: "<name>",
description: "<description>",
avatar: $file}
) {
errors
achievement {
id
name
description
avatarUrl
}
}
}
```
To supply the avatar file, call the mutation using `curl`:
```shell
curl "https://gitlab.com/api/graphql" \
-H "Authorization: Bearer <your-pat-token>" \
-H "Content-Type: multipart/form-data" \
-F operations='{ "query": "mutation ($file: Upload!) { achievementsCreate(input: { namespaceId: \"gid://gitlab/Namespace/<namespace-id>\", name: \"<name>\", description: \"<description>\", avatar: $file }) { achievement { id name description avatarUrl } } }", "variables": { "file": null } }' \
-F map='{ "0": ["variables.file"] }' \
-F 0='@/path/to/your/file.jpg'
```
When successful, the response returns the achievement ID:
```shell
{"data":{"achievementsCreate":{"achievement":{"id":"gid://gitlab/Achievements::Achievement/1","name":"<name>","description":"<description>","avatarUrl":"https://gitlab.com/uploads/-/system/achievements/achievement/avatar/1/file.jpg"}}}}
```
## Update an achievement
You can change the name, description, and avatar of an achievement at any time.
Prerequisites:
- You must have the Maintainer or Owner role for the namespace.
To update an achievement, call the [`achievementsUpdate` GraphQL mutation](../../api/graphql/reference/_index.md#mutationachievementsupdate).
```graphql
mutation achievementsUpdate($file: Upload!) {
achievementsUpdate(
input: {
achievementId: "gid://gitlab/Achievements::Achievement/<achievement id>",
name: "<new name>",
description: "<new description>",
avatar: $file}
) {
errors
achievement {
id
name
description
avatarUrl
}
}
}
```
## Award an achievement
You can award an achievement to a user to recognize their contributions.
The user receives an email notification when they are awarded an achievement.
Prerequisites:
- You must have the Maintainer or Owner role for the namespace.
To award an achievement to a user, call the [`achievementsAward` GraphQL mutation](../../api/graphql/reference/_index.md#mutationachievementsaward).
```graphql
mutation {
achievementsAward(input: {
achievementId: "gid://gitlab/Achievements::Achievement/<achievement id>",
userId: "gid://gitlab/User/<user id>" }) {
userAchievement {
id
achievement {
id
name
}
user {
id
username
}
}
errors
}
}
```
## Revoke an achievement
You can revoke a user's achievement if you consider the user no longer meets the awarding criteria.
Prerequisites:
- You must have the Maintainer or Owner role for the namespace.
To revoke an achievement, call the [`achievementsRevoke` GraphQL mutation](../../api/graphql/reference/_index.md#mutationachievementsrevoke).
```graphql
mutation {
achievementsRevoke(input: {
userAchievementId: "gid://gitlab/Achievements::UserAchievement/<user achievement id>" }) {
userAchievement {
id
achievement {
id
name
}
user {
id
username
}
revokedAt
}
errors
}
}
```
## Delete an awarded achievement
If you awarded an achievement to a user by mistake, you can delete it.
Prerequisites:
- You must have the Owner role for the namespace.
To delete an awarded achievement, call the [`userAchievementsDelete` GraphQL mutation](../../api/graphql/reference/_index.md#mutationuserachievementsdelete).
```graphql
mutation {
userAchievementsDelete(input: {
userAchievementId: "gid://gitlab/Achievements::UserAchievement/<user achievement id>" }) {
userAchievement {
id
achievement {
id
name
}
user {
id
username
}
}
errors
}
}
```
## Delete an achievement
If you consider you no longer need an achievement, you can delete it.
This deletes all related awarded and revoked instances of the achievement.
Prerequisites:
- You must have the Maintainer or Owner role for the namespace.
To delete an achievement, call the [`achievementsDelete` GraphQL mutation](../../api/graphql/reference/_index.md#mutationachievementsdelete).
```graphql
mutation {
achievementsDelete(input: {
achievementId: "gid://gitlab/Achievements::Achievement/<achievement id>" }) {
achievement {
id
name
}
errors
}
}
```
## Hide achievements
If you don't want to display achievements on your profile, you can opt out. To do this:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Main settings** section, clear the **Display achievements on your profile** checkbox.
1. Select **Update profile settings**.
## Change visibility of specific achievements
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/161225) in GitLab 17.3.
{{< /history >}}
If you don't want to display all achievements on your profile, you can change the visibility of specific achievements.
To hide one of your achievements, call the [`userAchievementsUpdate` GraphQL mutation](../../api/graphql/reference/_index.md#mutationuserachievementsupdate).
```graphql
mutation {
userAchievementsUpdate(input: {
userAchievementId: "gid://gitlab/Achievements::UserAchievement/<user achievement id>"
showOnProfile: false
}) {
userAchievement {
id
showOnProfile
}
errors
}
}
```
To show one of your achievements again, call the same mutation with the value `true` for the `showOnProfile` argument.
## Reorder achievements
By default, achievements on your profile are displayed in ascending order by awarded date.
To change the order of your achievements, call the [`userAchievementPrioritiesUpdate` GraphQL mutation](../../api/graphql/reference/_index.md#mutationuserachievementprioritiesupdate)
with an ordered list of all prioritized achievements.
```graphql
mutation {
userAchievementPrioritiesUpdate(input: {
userAchievementIds: ["gid://gitlab/Achievements::UserAchievement/<first user achievement id>", "gid://gitlab/Achievements::UserAchievement/<second user achievement id>"],
}) {
userAchievements {
id
priority
}
errors
}
}
```
|
---
stage: Tenant Scale
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Achievements
breadcrumbs:
- doc
- user
- profile
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed
- Status: Experiment
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113156) in GitLab 15.10 [with a flag](../../administration/feature_flags/_index.md) named `achievements`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
On GitLab Self-Managed, by default this feature is not available. To make it available,
an administrator can [enable the feature flag](../../administration/feature_flags/_index.md) named `achievements`.
{{< /alert >}}
Achievements are a way to reward users for their activity on GitLab.
As a namespace maintainer or owner, you can create custom achievements for specific contributions. You can award these
achievements to users or revoke them based on defined criteria.
As a user, you can collect achievements to highlight your contributions to different projects or groups on your profile.
An achievement consists of a name, a description, and an avatar.
Achievements are considered to be owned by the user. They are visible regardless of the visibility setting of the namespace that created the Achievement.
This feature is an experiment.
For more information about planned work, see [epic 9429](https://gitlab.com/groups/gitlab-org/-/epics/9429).
Tell us about your use cases by leaving comments in the epic.
## Types of achievement
Programmatically, there is only one way to create, award, revoke, or delete achievements.
Practically, you can differentiate between achievements that are awarded:
- Once and irrevocable. For example, a "First contribution merged" achievement.
- Once and revocable. For example, a "Core team member" achievement.
- Multiple times. For example, a "Contributor of the month" achievement.
## View group achievements
To view all available and awarded achievements for a group:
- Go to `https://gitlab.com/groups/<group-path>/-/achievements`.
The page displays a list of achievements and the members who were awarded the achievement.
## View a user's achievements
You can view a user's achievements on their profile page.
Prerequisites:
- The user profile must be public.
To view a user's achievements:
1. Go to the user's profile page.
1. Below the user's avatar, see their achievements.
1. To view details about an achievement, hover over it.
It displays the following information:
- Name of the achievement
- Description of the achievement
- Date when the achievement was awarded to the user
- Namespace that awarded the achievement if the user is a member of the namespace or the namespace is public
To retrieve a list of a user's achievements, query the [`user` GraphQL type](../../api/graphql/reference/_index.md#user).
```graphql
query {
user(username: "<username>") {
userAchievements {
nodes {
achievement {
name
description
avatarUrl
namespace {
fullPath
name
}
}
}
}
}
}
```
## Create an achievement
You can create custom achievements to award for specific contributions.
Prerequisites:
- You must have the Maintainer or Owner role for the namespace.
To create an achievement:
- In the UI:
1. On the [Achievements page](#view-group-achievements), select **New achievement**.
1. Enter a name for the achievement.
1. Optional. Enter a description and upload an avatar for the achievement.
1. Select **Save changes**.
- With the GraphQL API, call the [`achievementsCreate` GraphQL mutation](../../api/graphql/reference/_index.md#mutationachievementscreate):
```graphql
mutation achievementsCreate($file: Upload!) {
achievementsCreate(
input: {
namespaceId: "gid://gitlab/Namespace/<namespace id>",
name: "<name>",
description: "<description>",
avatar: $file}
) {
errors
achievement {
id
name
description
avatarUrl
}
}
}
```
To supply the avatar file, call the mutation using `curl`:
```shell
curl "https://gitlab.com/api/graphql" \
-H "Authorization: Bearer <your-pat-token>" \
-H "Content-Type: multipart/form-data" \
-F operations='{ "query": "mutation ($file: Upload!) { achievementsCreate(input: { namespaceId: \"gid://gitlab/Namespace/<namespace-id>\", name: \"<name>\", description: \"<description>\", avatar: $file }) { achievement { id name description avatarUrl } } }", "variables": { "file": null } }' \
-F map='{ "0": ["variables.file"] }' \
-F 0='@/path/to/your/file.jpg'
```
When successful, the response returns the achievement ID:
```shell
{"data":{"achievementsCreate":{"achievement":{"id":"gid://gitlab/Achievements::Achievement/1","name":"<name>","description":"<description>","avatarUrl":"https://gitlab.com/uploads/-/system/achievements/achievement/avatar/1/file.jpg"}}}}
```
## Update an achievement
You can change the name, description, and avatar of an achievement at any time.
Prerequisites:
- You must have the Maintainer or Owner role for the namespace.
To update an achievement, call the [`achievementsUpdate` GraphQL mutation](../../api/graphql/reference/_index.md#mutationachievementsupdate).
```graphql
mutation achievementsUpdate($file: Upload!) {
achievementsUpdate(
input: {
achievementId: "gid://gitlab/Achievements::Achievement/<achievement id>",
name: "<new name>",
description: "<new description>",
avatar: $file}
) {
errors
achievement {
id
name
description
avatarUrl
}
}
}
```
## Award an achievement
You can award an achievement to a user to recognize their contributions.
The user receives an email notification when they are awarded an achievement.
Prerequisites:
- You must have the Maintainer or Owner role for the namespace.
To award an achievement to a user, call the [`achievementsAward` GraphQL mutation](../../api/graphql/reference/_index.md#mutationachievementsaward).
```graphql
mutation {
achievementsAward(input: {
achievementId: "gid://gitlab/Achievements::Achievement/<achievement id>",
userId: "gid://gitlab/User/<user id>" }) {
userAchievement {
id
achievement {
id
name
}
user {
id
username
}
}
errors
}
}
```
## Revoke an achievement
You can revoke a user's achievement if you consider the user no longer meets the awarding criteria.
Prerequisites:
- You must have the Maintainer or Owner role for the namespace.
To revoke an achievement, call the [`achievementsRevoke` GraphQL mutation](../../api/graphql/reference/_index.md#mutationachievementsrevoke).
```graphql
mutation {
achievementsRevoke(input: {
userAchievementId: "gid://gitlab/Achievements::UserAchievement/<user achievement id>" }) {
userAchievement {
id
achievement {
id
name
}
user {
id
username
}
revokedAt
}
errors
}
}
```
## Delete an awarded achievement
If you awarded an achievement to a user by mistake, you can delete it.
Prerequisites:
- You must have the Owner role for the namespace.
To delete an awarded achievement, call the [`userAchievementsDelete` GraphQL mutation](../../api/graphql/reference/_index.md#mutationuserachievementsdelete).
```graphql
mutation {
userAchievementsDelete(input: {
userAchievementId: "gid://gitlab/Achievements::UserAchievement/<user achievement id>" }) {
userAchievement {
id
achievement {
id
name
}
user {
id
username
}
}
errors
}
}
```
## Delete an achievement
If you consider you no longer need an achievement, you can delete it.
This deletes all related awarded and revoked instances of the achievement.
Prerequisites:
- You must have the Maintainer or Owner role for the namespace.
To delete an achievement, call the [`achievementsDelete` GraphQL mutation](../../api/graphql/reference/_index.md#mutationachievementsdelete).
```graphql
mutation {
achievementsDelete(input: {
achievementId: "gid://gitlab/Achievements::Achievement/<achievement id>" }) {
achievement {
id
name
}
errors
}
}
```
## Hide achievements
If you don't want to display achievements on your profile, you can opt out. To do this:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Main settings** section, clear the **Display achievements on your profile** checkbox.
1. Select **Update profile settings**.
## Change visibility of specific achievements
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/161225) in GitLab 17.3.
{{< /history >}}
If you don't want to display all achievements on your profile, you can change the visibility of specific achievements.
To hide one of your achievements, call the [`userAchievementsUpdate` GraphQL mutation](../../api/graphql/reference/_index.md#mutationuserachievementsupdate).
```graphql
mutation {
userAchievementsUpdate(input: {
userAchievementId: "gid://gitlab/Achievements::UserAchievement/<user achievement id>"
showOnProfile: false
}) {
userAchievement {
id
showOnProfile
}
errors
}
}
```
To show one of your achievements again, call the same mutation with the value `true` for the `showOnProfile` argument.
## Reorder achievements
By default, achievements on your profile are displayed in ascending order by awarded date.
To change the order of your achievements, call the [`userAchievementPrioritiesUpdate` GraphQL mutation](../../api/graphql/reference/_index.md#mutationuserachievementprioritiesupdate)
with an ordered list of all prioritized achievements.
```graphql
mutation {
userAchievementPrioritiesUpdate(input: {
userAchievementIds: ["gid://gitlab/Achievements::UserAchievement/<first user achievement id>", "gid://gitlab/Achievements::UserAchievement/<second user achievement id>"],
}) {
userAchievements {
id
priority
}
errors
}
}
```
|
https://docs.gitlab.com/user/profile
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/_index.md
|
2025-08-13
|
doc/user/profile
|
[
"doc",
"user",
"profile"
] |
_index.md
|
Software Supply Chain Security
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
User account
|
Profile settings, preferences, authentication, and notifications.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Each GitLab account has a user profile, which contains information about you and your GitLab activity.
Your profile also includes settings, which you use to customize your GitLab experience.
## Access your user profile
{{< history >}}
- Accessing the profile with the user ID was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/185387) in GitLab 17.11.
{{< /history >}}
To access your profile:
1. On the left sidebar, select your avatar.
1. Select your name or username.
You can also access a users' profile page by using the ID instead of the username at `https://gitlab.example.com/-/u/<id>`.
For example, if your username is `gitlab-user` has an ID `12345`, you can access the profile page either at
`https://gitlab.example.com/gitlab-user` or `https://gitlab.example.com/-/u/12345`.
## Find the user ID
You might need the user ID if you want to interact with it using the [GitLab API](../../api/_index.md).
To find the user ID:
1. Go to the users' profile page.
1. On the profile page, in the upper-right corner, select **Actions** ({{< icon name="ellipsis_v" >}}).
1. Select **Copy user ID**.
## Access your user settings
To access your user settings:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
## Generate or change your Support PIN
GitLab Support may ask for a personal identification number (PIN) to validate your identity.
The PIN expires seven days after creation.
To generate a new Support PIN:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Account**.
1. Select **Generate New PIN**.
## Access your Support Pin
If you've created a Support Pin previously,
the PIN is accessible in your profile and expires seven days after creation.
To access your Support PIN:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Account**.
## Change your username
Your username has a unique [namespace](../namespace/_index.md),
which is updated when you change your username. Before you change your username, read about
[how redirects behave](../project/repository/_index.md#repository-path-changes).
If you do not want to update the namespace, you can create a new user or group and transfer projects to it instead.
Prerequisites:
- Your namespace must not:
- Contain a project with [Container Registry](../packages/container_registry/_index.md) tags.
- Have a project that hosts [GitLab Pages](../project/pages/_index.md).
- Your username:
- Must be between 2 and 255 characters in length.
- Must only include non-accented letters, digits, `_`, `-`, and `.`.
- Must not:
- Start with `_`, `-`, or `.`.
- Contain emoji.
- End with `.` or `.<reserved file extension>`, for example `jon.png`, `jon.git` or `jon.atom`. However,
`jonpng` is valid.
To change your username:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Account**.
1. In the **Change username** section, enter a new username as the path.
1. Select **Update username**.
## Add emails to your user profile
To add a new email address to your account:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Emails**.
1. Select **Add new email**.
1. In the **Email** text box, enter the new email.
1. Select **Add email address**.
1. Verify your email address with the verification email received.
The new email address is added as a secondary email address.
You can use secondary email addresses to reset passwords but not to authenticate.
You can update your [primary email address](#change-your-primary-email).
{{< alert type="note" >}}
[Making your email non-public](#set-your-public-email) does not prevent it from being used for commit matching,
[project imports](../project/import/_index.md), and [group migrations](../group/import/_index.md).
{{< /alert >}}
## Delete email addresses from your user profile
{{< history >}}
- Automatic deletion of unverified secondary email addresses [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/151562) in GitLab 17.0.
{{< /history >}}
You can delete a secondary email address from your account. You cannot delete your
primary email address.
If the deleted email address is used for any user emails, those user emails are
sent to the primary email address instead.
Unverified secondary email addresses are automatically deleted after three days.
{{< alert type="note" >}}
Because of [issue 438600](https://gitlab.com/gitlab-org/gitlab/-/issues/438600), group notifications are still sent to
the deleted email address.
{{< /alert >}}
To delete an email address from your account:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Emails**.
1. Select **Delete** ({{< icon name="remove" >}}) and confirm you want to **Remove**.
You can also [use the API to delete a secondary email address](../../api/user_email_addresses.md#delete-an-email-address).
## Make your user profile page private
You can make your user profile visible to only you and GitLab administrators.
{{< alert type="note" >}}
A GitLab administrator can [disable](../../administration/settings/account_and_limit_settings.md#prevent-users-from-making-their-profiles-private) this setting, forcing all profiles to be made public.
{{< /alert >}}
To make your profile private:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. Select the **Private profile** checkbox.
1. Select **Update profile settings**.
The following is hidden from your user profile page (`https://gitlab.example.com/username`):
- Atom feed
- Date when account was created
- Tabs for activity, groups, contributed projects, personal projects, starred projects, snippets
{{< alert type="note" >}}
Making your user profile page private does not hide all your public resources from
the REST or GraphQL APIs. For example, the email address associated with your commit
signature is accessible unless you [use an automatically-generated private commit email](#use-an-automatically-generated-private-commit-email).
{{< /alert >}}
### User visibility
The public page of a user, located at `/username`, is always visible whether you are signed-in or
not.
When visiting the public page of a user, you can only see the projects which you have privileges to.
If the [public level is restricted](../../administration/settings/visibility_and_access_controls.md#restrict-visibility-levels),
user profiles are only visible to authenticated users.
## Add details to your profile with a README
You can add more information to your profile page with a README file. When you populate
the README file with information, it's included on your profile page.
### From a new project
To create a new project and add its README to your profile:
1. On the left sidebar, at the top, select **Create new** ({{< icon name="plus" >}}) and **New project/repository**.
1. Select **Create blank project**.
1. Enter the project details:
- In the **Project name** field, enter the name for your new project.
- In the **Project URL** field, select your GitLab username.
- In the **Project slug** field, enter your GitLab username.
All of these fields are case-sensitive. If your username has capital letters, enter it into the project slug field with the capitals included.
1. For **Visibility Level**, select **Public**.
1. For **Project Configuration**, ensure **Initialize repository with a README** is selected.
1. Select **Create project**.
1. Create a README file inside this project. The file can be any valid [README or index file](../project/repository/files/_index.md#readme-and-index-files).
1. Populate the README file with [Markdown](../markdown.md), or another [supported markup language](../project/repository/files/_index.md#supported-markup-languages).
GitLab displays the contents of your README below your contribution graph.
### From an existing project
To add the README from an existing project to your profile,
[update the path](../project/working_with_projects.md#rename-a-repository) of the project
to match your username.
## Add external accounts to your user profile page
{{< history >}}
- Mastodon user account [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132892) in GitLab 16.6 [with a flag](../feature_flags.md) named `mastodon_social_ui`. Disabled by default.
- Mastodon user account [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/428163) in GitLab 16.7. Feature flag `mastodon_social_ui` removed.
- Ability to verify Mastodon account using your GitLab user profile [added](https://gitlab.com/gitlab-org/gitlab/-/issues/433391) in GitLab 17.4 [with a flag](../feature_flags.md) named `verify_mastodon_user`. Disabled by default.
{{< /history >}}
You can add links to certain other external accounts you might have, like Discord and X (formerly Twitter).
They can help other users connect with you on other platforms.
To add links to other accounts:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Main settings** section, add your:
- Discord [user ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-).
- LinkedIn profile name.
- Bluesky [did:plc identifier](https://atproto.com/specs/did). To find your identifier, [resolve your user handle](https://bsky.social/xrpc/com.atproto.identity.resolveHandle?handle=USER_HANDLE).
- Mastodon handle. In GitLab 17.4 and later, you can use your [GitLab profile](#access-your-user-profile) to verify your Mastodon account.
- Discord username.
- X (formerly Twitter) @username.
- [ORCID](https://orcid.org/).
Your user ID or username must be 500 characters or less.
1. Select **Update profile settings**.
## Show private contributions on your user profile page
In the user contribution calendar graph and recent activity list, you can see your [contribution actions](contributions_calendar.md#user-contribution-events) to private projects.
To show private contributions:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Main settings** section, select the **Include private contributions on my profile** checkbox.
1. Select **Update profile settings**.
## Add your gender pronouns
You can add your gender pronouns to your GitLab account to be displayed next to
your name in your profile.
To specify your pronouns:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Pronouns** text box, enter your pronouns. The text must be 50 characters or less.
1. Select **Update profile settings**.
## Add your name pronunciation
You can add your name pronunciation to your GitLab account. This is displayed in your profile, below
your name.
To add your name pronunciation:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Pronunciation** text box, enter how your name is pronounced. The pronunciation must be plain text and 255 characters or less.
1. Select **Update profile settings**.
## Set your status
Set your status to let others know your availability. Others can see your status when they hover over your avatar, name, or username. Your status is publicly visible even if you've [made your user profile page private](#make-your-user-profile-page-private).
Your status consists of the following elements. You can use each separately to indicate your status.
- An emoji to indicate your status.
- A message that describes your availability. You can include emoji codes like `:palm_tree:` or `:bulb:`. Maximum of 100 characters.
- A checkbox that adds a `Busy` badge to your status.
To set your current status:
1. On the left sidebar, select your avatar.
1. Select **Set status**. If you've previously set a status, select **Edit status** instead.
1. Optional. Enter a status message.
1. Optional. Select the **Set yourself as busy** checkbox.
1. Optional. Select a value from the **Clear status after** dropdown list.
1. Select **Set status**.
Your status is updated. You can also set your status from the [user settings](#access-your-user-settings) page or with the [Users API](../../api/users.md#set-your-user-status).
## Set your time zone
You can set your local time zone to:
- Display your local time on your profile, and in places where hovering over your name shows information about you.
- Align your contribution calendar with your local time to better reflect when your contributions were made
To set your time zone:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Time settings** section, select your time zone from the dropdown list.
## Change the email displayed on your commits
A commit email is an email address displayed in every Git-related action carried out through the GitLab interface.
Any of your own verified email addresses can be used as the commit email.
Your primary email is used by default.
To change your commit email:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Commit email** dropdown list, select an email address.
1. Select **Update profile settings**.
## Change your primary email
Your primary email is the default email address for your login, commit email, and notification email.
To change your primary email:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Email** field, enter your new email address.
1. Select **Update profile settings**.
1. Optional. Select the confirmation email if you have not previously added this email to your GitLab.com account.
## Set your public email
You can select one of your [configured email addresses](#add-emails-to-your-user-profile) to be displayed on your public profile:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Public email** field, select one of the available email addresses.
1. Select **Update profile settings**.
### Use an automatically-generated private commit email
GitLab provides an automatically-generated private commit email address,
so you can keep your email information private.
To use a private commit email:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Commit email** dropdown list, select **Use a private email**.
1. Select **Update profile settings**.
Every Git-related action uses the private commit email.
To stay fully anonymous, you can also copy the private commit email
and configure it on your local machine by using the following command:
```shell
git config --global user.email <your email address>
```
## Follow users
You can follow or unfollow users from either:
- Their [user profiles](#access-your-user-profile).
- The small popover that appears when you hover over a user's name ([introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/76050)
in GitLab 15.0).
In [GitLab 15.5 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/360755),
the maximum number of users you can follow is 300.
In [GitLab 16.10 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/441774),
blocked users don't appear in the followers list on user profiles.
### Disable following and being followed by other users
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325558) in GitLab 16.0 [with a flag](../feature_flags.md) named `disable_follow_users`.
- [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/420620) in GitLab 16.3.
{{< /history >}}
You can disable following and being followed by other users.
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. Select **Preferences**.
1. Clear the **Enable follow users** checkbox.
1. Select **Save changes**.
{{< alert type="note" >}}
When this feature is being disabled, all current followed/following connections are deleted.
{{< /alert >}}
## View a user's activity
GitLab tracks [user contribution activity](contributions_calendar.md).
To view a user's activity:
1. Go to the user's profile.
1. In the GitLab menu, select **Activity**.
A list of **Most Recent Activity** contributions is displayed.
## View your activity
To view your activity:
1. On the left sidebar, select **Search or go to**.
1. Select **Your work**.
1. Select **Activity**.
1. Optional. To filter your activity by contribution type, in the **Your Activity** tab, select a tab:
- **All**: All contributions you made in your groups and projects.
- **Push events**: Push events you made in your projects.
- **Merge events**: Merge requests you accepted in your projects.
- **Issue events**: Issues you opened and closed in your projects.
- **Comments**: Comments you posted in your projects.
- **Wiki**: Wiki pages you created and updated in your projects.
- **Designs**: Designs you added, updated, and removed in your projects.
- **Team**: Projects you joined and left.
## Sign-in services
Instead of using a regular username and password to sign in to GitLab, you can use a sign-in service instead.
### Connect a sign-in service
To connect a sign-in service to use for signing in to GitLab:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. Select **Account**.
1. Locate the **Service sign-in** section.
1. Under the **Connected Accounts** section, select the button that corresponds with the service you want to sign in
with.
1. Follow the instructions for the selected service to start signing in with it.
### Disconnect a sign-in service
To disconnect a sign-in service used for signing in to GitLab:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. Select **Account**.
1. Locate the **Service sign-in** section.
1. Under the **Connected Accounts** section, select **Disconnect** next to the button that corresponds with the service
you no longer want to sign in with.
## Session duration
### Stay signed in for one week
By default, you are signed out of GitLab after seven days (10080 minutes) of inactivity or until you close your browser
window, whichever comes first.
GitLab administrators can
[change this default](../../administration/settings/account_and_limit_settings.md#customize-the-default-session-duration).
### Stay signed in indefinitely
{{< history >}}
- Ability to turn the **Remember me** setting on and off [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369133) in GitLab 16.0.
{{< /history >}}
To remain signed in indefinitely, select the **Remember me** checkbox on the GitLab sign-in page.
You remain signed in because, although the server sets a session time of one week, your browser stores a secure token
that enables automatic reauthentication.
GitLab administrators can [turn off the **Remember me** setting](../../administration/settings/account_and_limit_settings.md#session-duration) for environments
that require sessions to expire periodically for security or compliance purposes.
### Cookies used for sign-in
When you sign in, three cookies are set:
- A session cookie called `_gitlab_session`.
This cookie has no set expiration date. However, it expires based on its `session_expire_delay`.
- A session cookie called `gitlab_user`.
This cookie is used by the [marketing site](https://about.gitlab.com/) to determine if a user has an active GitLab session. No user information is passed to the cookie and it expires two weeks from login.
- A persistent cookie called `remember_user_token`, which is set only if you selected **Remember me** on the sign-in page.
When you close your browser, the `_gitlab_session` and `gitlab_user` cookies are usually cleared client-side.
When it expires or isn't available, GitLab:
- Uses the `remember_user_token` cookie to get you a new `_gitlab_session` cookie and keep you signed in, even if you close your browser.
- Sets the `gitlab_user` to `true`.
When both the `remember_user_token` and `_gitlab_session` cookies are gone or expired, you must sign in again.
{{< alert type="note" >}}
When any session is signed out, or when a session is revoked
from the [active sessions list](active_sessions.md), all **Remember me** tokens are revoked.
While other sessions remain active, the **Remember me** feature doesn't restore
a session if the browser is closed or the existing session expires.
{{< /alert >}}
## Related topics
- [Create users](account/create_accounts.md)
- [Sign in to your GitLab account](../../administration/auth/_index.md)
- [Change your password](user_passwords.md)
- Receive emails for:
- [Sign-ins from unknown IP addresses or devices](notifications.md#notifications-for-unknown-sign-ins)
- [Attempted sign-ins using incorrect verification codes](notifications.md#notifications-for-attempted-sign-ins-using-incorrect-verification-codes)
- Manage applications that can [use GitLab as an OAuth provider](../../integration/oauth_provider.md)
- Manage [personal access tokens](personal_access_tokens.md) to access your account through the API and authorized applications
- Manage [SSH keys](../ssh.md) to access your account by using SSH
- [Change the syntax highlighting theme](preferences.md#change-the-syntax-highlighting-theme)
- [View your active sessions](active_sessions.md) and revoke any of them if necessary
|
---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: User account
description: Profile settings, preferences, authentication, and notifications.
breadcrumbs:
- doc
- user
- profile
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Each GitLab account has a user profile, which contains information about you and your GitLab activity.
Your profile also includes settings, which you use to customize your GitLab experience.
## Access your user profile
{{< history >}}
- Accessing the profile with the user ID was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/185387) in GitLab 17.11.
{{< /history >}}
To access your profile:
1. On the left sidebar, select your avatar.
1. Select your name or username.
You can also access a users' profile page by using the ID instead of the username at `https://gitlab.example.com/-/u/<id>`.
For example, if your username is `gitlab-user` has an ID `12345`, you can access the profile page either at
`https://gitlab.example.com/gitlab-user` or `https://gitlab.example.com/-/u/12345`.
## Find the user ID
You might need the user ID if you want to interact with it using the [GitLab API](../../api/_index.md).
To find the user ID:
1. Go to the users' profile page.
1. On the profile page, in the upper-right corner, select **Actions** ({{< icon name="ellipsis_v" >}}).
1. Select **Copy user ID**.
## Access your user settings
To access your user settings:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
## Generate or change your Support PIN
GitLab Support may ask for a personal identification number (PIN) to validate your identity.
The PIN expires seven days after creation.
To generate a new Support PIN:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Account**.
1. Select **Generate New PIN**.
## Access your Support Pin
If you've created a Support Pin previously,
the PIN is accessible in your profile and expires seven days after creation.
To access your Support PIN:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Account**.
## Change your username
Your username has a unique [namespace](../namespace/_index.md),
which is updated when you change your username. Before you change your username, read about
[how redirects behave](../project/repository/_index.md#repository-path-changes).
If you do not want to update the namespace, you can create a new user or group and transfer projects to it instead.
Prerequisites:
- Your namespace must not:
- Contain a project with [Container Registry](../packages/container_registry/_index.md) tags.
- Have a project that hosts [GitLab Pages](../project/pages/_index.md).
- Your username:
- Must be between 2 and 255 characters in length.
- Must only include non-accented letters, digits, `_`, `-`, and `.`.
- Must not:
- Start with `_`, `-`, or `.`.
- Contain emoji.
- End with `.` or `.<reserved file extension>`, for example `jon.png`, `jon.git` or `jon.atom`. However,
`jonpng` is valid.
To change your username:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Account**.
1. In the **Change username** section, enter a new username as the path.
1. Select **Update username**.
## Add emails to your user profile
To add a new email address to your account:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Emails**.
1. Select **Add new email**.
1. In the **Email** text box, enter the new email.
1. Select **Add email address**.
1. Verify your email address with the verification email received.
The new email address is added as a secondary email address.
You can use secondary email addresses to reset passwords but not to authenticate.
You can update your [primary email address](#change-your-primary-email).
{{< alert type="note" >}}
[Making your email non-public](#set-your-public-email) does not prevent it from being used for commit matching,
[project imports](../project/import/_index.md), and [group migrations](../group/import/_index.md).
{{< /alert >}}
## Delete email addresses from your user profile
{{< history >}}
- Automatic deletion of unverified secondary email addresses [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/151562) in GitLab 17.0.
{{< /history >}}
You can delete a secondary email address from your account. You cannot delete your
primary email address.
If the deleted email address is used for any user emails, those user emails are
sent to the primary email address instead.
Unverified secondary email addresses are automatically deleted after three days.
{{< alert type="note" >}}
Because of [issue 438600](https://gitlab.com/gitlab-org/gitlab/-/issues/438600), group notifications are still sent to
the deleted email address.
{{< /alert >}}
To delete an email address from your account:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Emails**.
1. Select **Delete** ({{< icon name="remove" >}}) and confirm you want to **Remove**.
You can also [use the API to delete a secondary email address](../../api/user_email_addresses.md#delete-an-email-address).
## Make your user profile page private
You can make your user profile visible to only you and GitLab administrators.
{{< alert type="note" >}}
A GitLab administrator can [disable](../../administration/settings/account_and_limit_settings.md#prevent-users-from-making-their-profiles-private) this setting, forcing all profiles to be made public.
{{< /alert >}}
To make your profile private:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. Select the **Private profile** checkbox.
1. Select **Update profile settings**.
The following is hidden from your user profile page (`https://gitlab.example.com/username`):
- Atom feed
- Date when account was created
- Tabs for activity, groups, contributed projects, personal projects, starred projects, snippets
{{< alert type="note" >}}
Making your user profile page private does not hide all your public resources from
the REST or GraphQL APIs. For example, the email address associated with your commit
signature is accessible unless you [use an automatically-generated private commit email](#use-an-automatically-generated-private-commit-email).
{{< /alert >}}
### User visibility
The public page of a user, located at `/username`, is always visible whether you are signed-in or
not.
When visiting the public page of a user, you can only see the projects which you have privileges to.
If the [public level is restricted](../../administration/settings/visibility_and_access_controls.md#restrict-visibility-levels),
user profiles are only visible to authenticated users.
## Add details to your profile with a README
You can add more information to your profile page with a README file. When you populate
the README file with information, it's included on your profile page.
### From a new project
To create a new project and add its README to your profile:
1. On the left sidebar, at the top, select **Create new** ({{< icon name="plus" >}}) and **New project/repository**.
1. Select **Create blank project**.
1. Enter the project details:
- In the **Project name** field, enter the name for your new project.
- In the **Project URL** field, select your GitLab username.
- In the **Project slug** field, enter your GitLab username.
All of these fields are case-sensitive. If your username has capital letters, enter it into the project slug field with the capitals included.
1. For **Visibility Level**, select **Public**.
1. For **Project Configuration**, ensure **Initialize repository with a README** is selected.
1. Select **Create project**.
1. Create a README file inside this project. The file can be any valid [README or index file](../project/repository/files/_index.md#readme-and-index-files).
1. Populate the README file with [Markdown](../markdown.md), or another [supported markup language](../project/repository/files/_index.md#supported-markup-languages).
GitLab displays the contents of your README below your contribution graph.
### From an existing project
To add the README from an existing project to your profile,
[update the path](../project/working_with_projects.md#rename-a-repository) of the project
to match your username.
## Add external accounts to your user profile page
{{< history >}}
- Mastodon user account [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132892) in GitLab 16.6 [with a flag](../feature_flags.md) named `mastodon_social_ui`. Disabled by default.
- Mastodon user account [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/428163) in GitLab 16.7. Feature flag `mastodon_social_ui` removed.
- Ability to verify Mastodon account using your GitLab user profile [added](https://gitlab.com/gitlab-org/gitlab/-/issues/433391) in GitLab 17.4 [with a flag](../feature_flags.md) named `verify_mastodon_user`. Disabled by default.
{{< /history >}}
You can add links to certain other external accounts you might have, like Discord and X (formerly Twitter).
They can help other users connect with you on other platforms.
To add links to other accounts:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Main settings** section, add your:
- Discord [user ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-).
- LinkedIn profile name.
- Bluesky [did:plc identifier](https://atproto.com/specs/did). To find your identifier, [resolve your user handle](https://bsky.social/xrpc/com.atproto.identity.resolveHandle?handle=USER_HANDLE).
- Mastodon handle. In GitLab 17.4 and later, you can use your [GitLab profile](#access-your-user-profile) to verify your Mastodon account.
- Discord username.
- X (formerly Twitter) @username.
- [ORCID](https://orcid.org/).
Your user ID or username must be 500 characters or less.
1. Select **Update profile settings**.
## Show private contributions on your user profile page
In the user contribution calendar graph and recent activity list, you can see your [contribution actions](contributions_calendar.md#user-contribution-events) to private projects.
To show private contributions:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Main settings** section, select the **Include private contributions on my profile** checkbox.
1. Select **Update profile settings**.
## Add your gender pronouns
You can add your gender pronouns to your GitLab account to be displayed next to
your name in your profile.
To specify your pronouns:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Pronouns** text box, enter your pronouns. The text must be 50 characters or less.
1. Select **Update profile settings**.
## Add your name pronunciation
You can add your name pronunciation to your GitLab account. This is displayed in your profile, below
your name.
To add your name pronunciation:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Pronunciation** text box, enter how your name is pronounced. The pronunciation must be plain text and 255 characters or less.
1. Select **Update profile settings**.
## Set your status
Set your status to let others know your availability. Others can see your status when they hover over your avatar, name, or username. Your status is publicly visible even if you've [made your user profile page private](#make-your-user-profile-page-private).
Your status consists of the following elements. You can use each separately to indicate your status.
- An emoji to indicate your status.
- A message that describes your availability. You can include emoji codes like `:palm_tree:` or `:bulb:`. Maximum of 100 characters.
- A checkbox that adds a `Busy` badge to your status.
To set your current status:
1. On the left sidebar, select your avatar.
1. Select **Set status**. If you've previously set a status, select **Edit status** instead.
1. Optional. Enter a status message.
1. Optional. Select the **Set yourself as busy** checkbox.
1. Optional. Select a value from the **Clear status after** dropdown list.
1. Select **Set status**.
Your status is updated. You can also set your status from the [user settings](#access-your-user-settings) page or with the [Users API](../../api/users.md#set-your-user-status).
## Set your time zone
You can set your local time zone to:
- Display your local time on your profile, and in places where hovering over your name shows information about you.
- Align your contribution calendar with your local time to better reflect when your contributions were made
To set your time zone:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Time settings** section, select your time zone from the dropdown list.
## Change the email displayed on your commits
A commit email is an email address displayed in every Git-related action carried out through the GitLab interface.
Any of your own verified email addresses can be used as the commit email.
Your primary email is used by default.
To change your commit email:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Commit email** dropdown list, select an email address.
1. Select **Update profile settings**.
## Change your primary email
Your primary email is the default email address for your login, commit email, and notification email.
To change your primary email:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Email** field, enter your new email address.
1. Select **Update profile settings**.
1. Optional. Select the confirmation email if you have not previously added this email to your GitLab.com account.
## Set your public email
You can select one of your [configured email addresses](#add-emails-to-your-user-profile) to be displayed on your public profile:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Public email** field, select one of the available email addresses.
1. Select **Update profile settings**.
### Use an automatically-generated private commit email
GitLab provides an automatically-generated private commit email address,
so you can keep your email information private.
To use a private commit email:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Commit email** dropdown list, select **Use a private email**.
1. Select **Update profile settings**.
Every Git-related action uses the private commit email.
To stay fully anonymous, you can also copy the private commit email
and configure it on your local machine by using the following command:
```shell
git config --global user.email <your email address>
```
## Follow users
You can follow or unfollow users from either:
- Their [user profiles](#access-your-user-profile).
- The small popover that appears when you hover over a user's name ([introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/76050)
in GitLab 15.0).
In [GitLab 15.5 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/360755),
the maximum number of users you can follow is 300.
In [GitLab 16.10 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/441774),
blocked users don't appear in the followers list on user profiles.
### Disable following and being followed by other users
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325558) in GitLab 16.0 [with a flag](../feature_flags.md) named `disable_follow_users`.
- [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/420620) in GitLab 16.3.
{{< /history >}}
You can disable following and being followed by other users.
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. Select **Preferences**.
1. Clear the **Enable follow users** checkbox.
1. Select **Save changes**.
{{< alert type="note" >}}
When this feature is being disabled, all current followed/following connections are deleted.
{{< /alert >}}
## View a user's activity
GitLab tracks [user contribution activity](contributions_calendar.md).
To view a user's activity:
1. Go to the user's profile.
1. In the GitLab menu, select **Activity**.
A list of **Most Recent Activity** contributions is displayed.
## View your activity
To view your activity:
1. On the left sidebar, select **Search or go to**.
1. Select **Your work**.
1. Select **Activity**.
1. Optional. To filter your activity by contribution type, in the **Your Activity** tab, select a tab:
- **All**: All contributions you made in your groups and projects.
- **Push events**: Push events you made in your projects.
- **Merge events**: Merge requests you accepted in your projects.
- **Issue events**: Issues you opened and closed in your projects.
- **Comments**: Comments you posted in your projects.
- **Wiki**: Wiki pages you created and updated in your projects.
- **Designs**: Designs you added, updated, and removed in your projects.
- **Team**: Projects you joined and left.
## Sign-in services
Instead of using a regular username and password to sign in to GitLab, you can use a sign-in service instead.
### Connect a sign-in service
To connect a sign-in service to use for signing in to GitLab:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. Select **Account**.
1. Locate the **Service sign-in** section.
1. Under the **Connected Accounts** section, select the button that corresponds with the service you want to sign in
with.
1. Follow the instructions for the selected service to start signing in with it.
### Disconnect a sign-in service
To disconnect a sign-in service used for signing in to GitLab:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. Select **Account**.
1. Locate the **Service sign-in** section.
1. Under the **Connected Accounts** section, select **Disconnect** next to the button that corresponds with the service
you no longer want to sign in with.
## Session duration
### Stay signed in for one week
By default, you are signed out of GitLab after seven days (10080 minutes) of inactivity or until you close your browser
window, whichever comes first.
GitLab administrators can
[change this default](../../administration/settings/account_and_limit_settings.md#customize-the-default-session-duration).
### Stay signed in indefinitely
{{< history >}}
- Ability to turn the **Remember me** setting on and off [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369133) in GitLab 16.0.
{{< /history >}}
To remain signed in indefinitely, select the **Remember me** checkbox on the GitLab sign-in page.
You remain signed in because, although the server sets a session time of one week, your browser stores a secure token
that enables automatic reauthentication.
GitLab administrators can [turn off the **Remember me** setting](../../administration/settings/account_and_limit_settings.md#session-duration) for environments
that require sessions to expire periodically for security or compliance purposes.
### Cookies used for sign-in
When you sign in, three cookies are set:
- A session cookie called `_gitlab_session`.
This cookie has no set expiration date. However, it expires based on its `session_expire_delay`.
- A session cookie called `gitlab_user`.
This cookie is used by the [marketing site](https://about.gitlab.com/) to determine if a user has an active GitLab session. No user information is passed to the cookie and it expires two weeks from login.
- A persistent cookie called `remember_user_token`, which is set only if you selected **Remember me** on the sign-in page.
When you close your browser, the `_gitlab_session` and `gitlab_user` cookies are usually cleared client-side.
When it expires or isn't available, GitLab:
- Uses the `remember_user_token` cookie to get you a new `_gitlab_session` cookie and keep you signed in, even if you close your browser.
- Sets the `gitlab_user` to `true`.
When both the `remember_user_token` and `_gitlab_session` cookies are gone or expired, you must sign in again.
{{< alert type="note" >}}
When any session is signed out, or when a session is revoked
from the [active sessions list](active_sessions.md), all **Remember me** tokens are revoked.
While other sessions remain active, the **Remember me** feature doesn't restore
a session if the browser is closed or the existing session expires.
{{< /alert >}}
## Related topics
- [Create users](account/create_accounts.md)
- [Sign in to your GitLab account](../../administration/auth/_index.md)
- [Change your password](user_passwords.md)
- Receive emails for:
- [Sign-ins from unknown IP addresses or devices](notifications.md#notifications-for-unknown-sign-ins)
- [Attempted sign-ins using incorrect verification codes](notifications.md#notifications-for-attempted-sign-ins-using-incorrect-verification-codes)
- Manage applications that can [use GitLab as an OAuth provider](../../integration/oauth_provider.md)
- Manage [personal access tokens](personal_access_tokens.md) to access your account through the API and authorized applications
- Manage [SSH keys](../ssh.md) to access your account by using SSH
- [Change the syntax highlighting theme](preferences.md#change-the-syntax-highlighting-theme)
- [View your active sessions](active_sessions.md) and revoke any of them if necessary
|
https://docs.gitlab.com/user/contributions_calendar
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/contributions_calendar.md
|
2025-08-13
|
doc/user/profile
|
[
"doc",
"user",
"profile"
] |
contributions_calendar.md
|
Tenant Scale
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Contributions calendar
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The contributions calendar displays a [user's events](#user-contribution-events) from the past 12 months.
This includes contributions made in forked and [private](#show-private-contributions-on-your-user-profile-page) repositories.
The gradient color of the tiles represents the number of contributions made per day. The gradient ranges from blank (0 contributions) to dark blue (more than 30 contributions).
{{< alert type="note" >}}
The contribution calendar only displays contributions from the last 12 months, but issue [24264](https://gitlab.com/gitlab-org/gitlab/-/issues/24264) proposes to change this to more than 12 months. General improvements to the user profile are proposed in issue [8488](https://gitlab.com/groups/gitlab-org/-/epics/8488).
{{< /alert >}}
For a comprehensive view of all group members' contribution events, you can use [contribution analytics](../group/contribution_analytics/_index.md).
## User contribution events
GitLab tracks the following contribution events:
| Event | Contribution |
| ----- | ------------ |
| `approved` | Merge request |
| `closed` | [Epic](../group/epics/_index.md), Issue, Merge request, Milestone, Work item |
| `commented` on any `Noteable` record. | Alert, Commit, Design, Issue, Merge request, Snippet |
| `created` | Design, Epic, Issue, Merge request, Milestone, Project, Wiki page, Work item |
| `destroyed` | Design, Milestone, Wiki page |
| `expired` | Project membership |
| `joined` | Project membership |
| `left` | Project membership |
| `merged` | Merge request |
| `pushed` commits to (or deleted commits from) a repository, individually or in bulk. | Project |
| `reopened` | Epic, Issue, Merge request, Milestone |
| `updated` | Design, Wiki page |
### View daily contributions
To view your daily contributions:
1. On the left sidebar, select your avatar.
1. Select your name from the dropdown list.
1. In the contributions calendar:
- To view the number of contributions for a specific day, hover over a tile.
- To view all contributions for a specific day, select a tile. A list displays all contributions and the time they were made.
### Show private contributions on your user profile page
The contributions calendar graph and recent activity list displays your
[contribution actions](#user-contribution-events) to private projects.
To view private contributions:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Main settings** section, select the **Include private contributions on my profile** checkbox.
1. Select **Update profile settings**.
## User activity
### Follow a user's activity
You can follow users whose activity you're interested in.
In [GitLab 15.5 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/360755),
the maximum number of users you can follow is 300.
To follow a user, either:
- From a user's profile, select **Follow**.
- Hover over a user's name, and select **Follow** ([introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/76050)
in GitLab 15.0).
To view the activity of users you follow:
1. In the GitLab menu, select **Activity**.
1. Select the **Followed users** tab.
### Retrieve user activity as a feed
GitLab provides RSS feeds of user activity. To subscribe to the
RSS feed of a user's activity:
1. Go to the [user's profile](_index.md#access-your-user-profile).
1. In the upper-right corner, select the feed symbol ({{< icon name="rss" >}}) to display the results as an RSS feed in Atom format.
The URL of the result contains both a feed token, and
the user's activity that you're authorized to view.
You can add this URL to your feed reader.
### Reset the user activity feed token
Feed tokens are sensitive and can reveal information from confidential issues.
If you think your feed token has been exposed, you should reset it.
To reset your feed token:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Access tokens**.
1. Scroll down. In the **Feed token** section, select the
**reset this token** link.
1. On the confirmation dialog, select **OK**.
A new token is generated.
### Event time period limit
GitLab removes user activity events older than 3 years from the events table for performance reasons.
|
---
stage: Tenant Scale
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Contributions calendar
breadcrumbs:
- doc
- user
- profile
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The contributions calendar displays a [user's events](#user-contribution-events) from the past 12 months.
This includes contributions made in forked and [private](#show-private-contributions-on-your-user-profile-page) repositories.
The gradient color of the tiles represents the number of contributions made per day. The gradient ranges from blank (0 contributions) to dark blue (more than 30 contributions).
{{< alert type="note" >}}
The contribution calendar only displays contributions from the last 12 months, but issue [24264](https://gitlab.com/gitlab-org/gitlab/-/issues/24264) proposes to change this to more than 12 months. General improvements to the user profile are proposed in issue [8488](https://gitlab.com/groups/gitlab-org/-/epics/8488).
{{< /alert >}}
For a comprehensive view of all group members' contribution events, you can use [contribution analytics](../group/contribution_analytics/_index.md).
## User contribution events
GitLab tracks the following contribution events:
| Event | Contribution |
| ----- | ------------ |
| `approved` | Merge request |
| `closed` | [Epic](../group/epics/_index.md), Issue, Merge request, Milestone, Work item |
| `commented` on any `Noteable` record. | Alert, Commit, Design, Issue, Merge request, Snippet |
| `created` | Design, Epic, Issue, Merge request, Milestone, Project, Wiki page, Work item |
| `destroyed` | Design, Milestone, Wiki page |
| `expired` | Project membership |
| `joined` | Project membership |
| `left` | Project membership |
| `merged` | Merge request |
| `pushed` commits to (or deleted commits from) a repository, individually or in bulk. | Project |
| `reopened` | Epic, Issue, Merge request, Milestone |
| `updated` | Design, Wiki page |
### View daily contributions
To view your daily contributions:
1. On the left sidebar, select your avatar.
1. Select your name from the dropdown list.
1. In the contributions calendar:
- To view the number of contributions for a specific day, hover over a tile.
- To view all contributions for a specific day, select a tile. A list displays all contributions and the time they were made.
### Show private contributions on your user profile page
The contributions calendar graph and recent activity list displays your
[contribution actions](#user-contribution-events) to private projects.
To view private contributions:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. In the **Main settings** section, select the **Include private contributions on my profile** checkbox.
1. Select **Update profile settings**.
## User activity
### Follow a user's activity
You can follow users whose activity you're interested in.
In [GitLab 15.5 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/360755),
the maximum number of users you can follow is 300.
To follow a user, either:
- From a user's profile, select **Follow**.
- Hover over a user's name, and select **Follow** ([introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/76050)
in GitLab 15.0).
To view the activity of users you follow:
1. In the GitLab menu, select **Activity**.
1. Select the **Followed users** tab.
### Retrieve user activity as a feed
GitLab provides RSS feeds of user activity. To subscribe to the
RSS feed of a user's activity:
1. Go to the [user's profile](_index.md#access-your-user-profile).
1. In the upper-right corner, select the feed symbol ({{< icon name="rss" >}}) to display the results as an RSS feed in Atom format.
The URL of the result contains both a feed token, and
the user's activity that you're authorized to view.
You can add this URL to your feed reader.
### Reset the user activity feed token
Feed tokens are sensitive and can reveal information from confidential issues.
If you think your feed token has been exposed, you should reset it.
To reset your feed token:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Access tokens**.
1. Scroll down. In the **Feed token** section, select the
**reset this token** link.
1. On the confirmation dialog, select **OK**.
A new token is generated.
### Event time period limit
GitLab removes user activity events older than 3 years from the events table for performance reasons.
|
https://docs.gitlab.com/user/active_sessions
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/active_sessions.md
|
2025-08-13
|
doc/user/profile
|
[
"doc",
"user",
"profile"
] |
active_sessions.md
|
none
|
unassigned
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Active sessions
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
GitLab lists all devices that have logged into your account. You can
review the sessions, and revoke any you don't recognize.
## List all active sessions
To list all active sessions:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Active sessions**.
## Active sessions limit
GitLab allows users to have up to 100 active sessions at once. If the number of active sessions
exceeds 100, the oldest ones are deleted.
## Revoke a session
To revoke an active session:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Active sessions**.
1. Select **Revoke** next to a session. The current session cannot be revoked, as this would sign you out of GitLab.
{{< alert type="note" >}}
When any session is revoked all **Remember me** tokens for all
devices are revoked. For details about **Remember me**, see
[cookies used for sign-in](_index.md#cookies-used-for-sign-in).
{{< /alert >}}
## Revoke sessions through the Rails console
You can also revoke user sessions through the Rails console. You can use this to revoke
multiple sessions at the same time.
### Revoke all sessions for all users
To revoke all sessions for all users:
1. [Start a Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session).
1. Optional. List all active sessions with the following command:
```ruby
ActiveSession.list(User.all)
1. Revoke all sessions with the following command:
```ruby
ActiveSession.destroy_all
```
1. Verify sessions are closed with the following command:
```ruby
# Show all users with active sessions
puts "=== Currently Logged In Users ==="
User.find_each do |user|
sessions = ActiveSession.list(user)
if sessions.any?
puts "\n#{user.username} (#{user.name}):"
sessions.each do |session|
puts " - IP: #{session.ip_address}, Browser: #{session.browser}, Last active: #{session.updated_at}"
end
end
end
```
### Revoke all sessions for a user
To revoke all sessions for a specific user:
1. [Start a Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session).
1. Find the user with the following commands:
- By username:
```ruby
user = User.find_by_username 'exampleuser'
```
- By user ID:
```ruby
user = User.find(123)
```
- By email address:
```ruby
user = User.find_by(email: 'user@example.com')
```
1. Optional. List all active sessions for the user with the following command:
```ruby
ActiveSession.list(user)
```
1. Revoke all sessions with the following command:
```ruby
ActiveSession.list(user).each { |session| ActiveSession.destroy_session(user, session.session_private_id) }
```
1. Verify all sessions are closed with the following command:
```ruby
# If all sessions are closed, returns an empty array.
ActiveSession.list(user)
```
|
---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Active sessions
breadcrumbs:
- doc
- user
- profile
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
GitLab lists all devices that have logged into your account. You can
review the sessions, and revoke any you don't recognize.
## List all active sessions
To list all active sessions:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Active sessions**.
## Active sessions limit
GitLab allows users to have up to 100 active sessions at once. If the number of active sessions
exceeds 100, the oldest ones are deleted.
## Revoke a session
To revoke an active session:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Active sessions**.
1. Select **Revoke** next to a session. The current session cannot be revoked, as this would sign you out of GitLab.
{{< alert type="note" >}}
When any session is revoked all **Remember me** tokens for all
devices are revoked. For details about **Remember me**, see
[cookies used for sign-in](_index.md#cookies-used-for-sign-in).
{{< /alert >}}
## Revoke sessions through the Rails console
You can also revoke user sessions through the Rails console. You can use this to revoke
multiple sessions at the same time.
### Revoke all sessions for all users
To revoke all sessions for all users:
1. [Start a Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session).
1. Optional. List all active sessions with the following command:
```ruby
ActiveSession.list(User.all)
1. Revoke all sessions with the following command:
```ruby
ActiveSession.destroy_all
```
1. Verify sessions are closed with the following command:
```ruby
# Show all users with active sessions
puts "=== Currently Logged In Users ==="
User.find_each do |user|
sessions = ActiveSession.list(user)
if sessions.any?
puts "\n#{user.username} (#{user.name}):"
sessions.each do |session|
puts " - IP: #{session.ip_address}, Browser: #{session.browser}, Last active: #{session.updated_at}"
end
end
end
```
### Revoke all sessions for a user
To revoke all sessions for a specific user:
1. [Start a Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session).
1. Find the user with the following commands:
- By username:
```ruby
user = User.find_by_username 'exampleuser'
```
- By user ID:
```ruby
user = User.find(123)
```
- By email address:
```ruby
user = User.find_by(email: 'user@example.com')
```
1. Optional. List all active sessions for the user with the following command:
```ruby
ActiveSession.list(user)
```
1. Revoke all sessions with the following command:
```ruby
ActiveSession.list(user).each { |session| ActiveSession.destroy_session(user, session.session_private_id) }
```
1. Verify all sessions are closed with the following command:
```ruby
# If all sessions are closed, returns an empty array.
ActiveSession.list(user)
```
|
https://docs.gitlab.com/user/service_accounts
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/service_accounts.md
|
2025-08-13
|
doc/user/profile
|
[
"doc",
"user",
"profile"
] |
service_accounts.md
|
Software Supply Chain Security
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Service accounts
|
Machine user, rate limits, and personal access tokens.
|
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Service accounts are user accounts that represent non-human entities rather than individual people.
You can use service accounts to perform automated actions, access data, or run scheduled processes.
Service accounts are commonly used in pipelines or third-party integrations where credentials must
remain stable and unaffected by changes in human user membership.
There are two types of service accounts:
- Instance service accounts: Available to an entire GitLab instance, but must still be added to
groups and projects like a human user. Only available on GitLab Self-Managed and GitLab Dedicated.
- Group service accounts: Owned by a specific top-level group and can inherit membership to
subgroups and projects like a human user.
You authenticate as a service account with a [personal access token](personal_access_tokens.md).
Service accounts have the same abilities as human users, and can perform actions
like interacting with [package and container registries](../packages/_index.md),
performing [Git operations](personal_access_tokens.md#clone-repository-using-personal-access-token),
and accessing the API.
Service accounts:
- Do not use a seat.
- Cannot sign in to GitLab through the UI.
- Are identified in the group and project membership as service accounts.
- Do not receive notification emails without [adding a custom email address](../../api/service_accounts.md#create-an-instance-service-account).
- Are not [billable users](../../subscriptions/manage_users_and_seats.md#billable-users) or [internal users](../../administration/internal_users.md).
- Cannot be used with [trial versions](https://gitlab.com/-/trial_registrations/new?glm_source=docs.gitlab.com&glm_content=free-user-limit-faq/ee/user/free_user_limit.html) of GitLab.com.
- Can be used with trial versions of GitLab Self-Managed and GitLab Dedicated.
You can also manage service accounts through the API.
- For instance service accounts, use the [service account users API](../../api/service_accounts.md).
- For group service accounts, use the [group service accounts API](../../api/service_accounts.md).
## Prerequisites
- On GitLab.com, you must have the Owner role in a top-level group.
- On GitLab Self-Managed or GitLab Dedicated you must either:
- Be an administrator for the instance.
- Have the Owner role in a top-level group and be [allowed to create service accounts](../../administration/settings/account_and_limit_settings.md#allow-top-level-group-owners-to-create-service-accounts).
## View and manage service accounts
{{< history >}}
- Introduced for GitLab.com in GitLab 17.11
{{< /history >}}
The service accounts page displays information about service accounts in your top-level group or instance. Each top-level group and GitLab Self-Managed instance has a separate service accounts page. From these pages, you can:
- View all service accounts for your group or instance.
- Delete a service account.
- Edit a service account's name or username.
- Manage personal access tokens for a service account.
{{< tabs >}}
{{< tab title="Instance-wide service accounts" >}}
To view service accounts for the entire instance:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > Service accounts**.
{{< /tab >}}
{{< tab title="Group service accounts" >}}
To view service accounts for a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > Service accounts**.
{{< /tab >}}
{{< /tabs >}}
### Create a service account
{{< history >}}
- Introduced for GitLab.com in GitLab 16.3
- Top-level group owners can create Service accounts [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/163726) in GitLab 17.5 [with a feature flag](../../administration/feature_flags/_index.md) named `allow_top_level_group_owners_to_create_service_accounts` for GitLab Self-Managed. Disabled by default.
- Top-level group owners can create Service accounts [generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/172502) in GitLab 17.6. Feature flag `allow_top_level_group_owners_to_create_service_accounts` removed.
{{< /history >}}
On GitLab.com, you can create service accounts owned by a top-level group.
By default, on GitLab Self-Managed and GitLab Dedicated, only administrators can create service
accounts. You can [allow top-level group Owners to create service accounts](../../administration/settings/account_and_limit_settings.md#allow-top-level-group-owners-to-create-service-accounts).
The number of service accounts you can create is limited by your license:
- On GitLab Free, you cannot create service accounts.
- On GitLab Premium, you can create one service account for every paid seat.
- On GitLab Ultimate, you can create an unlimited number of service accounts.
To create a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Select **Add service account**.
1. Enter a name for the service account. A username is automatically generated based on the name. You can modify the username if needed.
1. Select **Create service account**.
### Edit a service account
You can edit the name or username of a service account.
To edit a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Edit**.
1. Edit the name or username for the service account.
1. Select **Save changes**.
### Service account access to groups and projects
Service accounts are similar to [external users](../../administration/external_users.md). When first
created, they have limited access to groups and projects. To give a service account access to
resources, you must add it to each group or project.
There is no limit to the number of service accounts you can add to a group or project. Service accounts
can have different roles in each group, subgroup, or project they are a member of.
On GitLab.com, service accounts for groups can only belong to a single top-level group.
You can manage service account access to groups and projects the same way you manage access for
human users. For more information, see
[groups](../group/_index.md#add-users-to-a-group) and [members of a project](../project/members/_index.md#add-users-to-a-project).
You can also manage group and project assignments with the [members API](../../api/members.md).
### Delete a service account
When you delete a service account, any contributions made by the account are retained and ownership
is transfered to a system-wide ghost user account. These contributions can include activity such as
merge requests, issues, projects, and groups.
To delete a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Delete account**.
1. Enter the name of the service account.
1. Select **Delete user**.
You can also delete the service account and any contributions made by the account. These
contributions can include activity such as merge requests, issues, groups, and projects.
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Delete account and contributions**.
1. Enter the name of the service account.
1. Select **Delete user and contributions**.
You can also delete service accounts through the API.
- For instance service accounts, use the [users API](../../api/users.md#delete-a-user).
- For group service accounts, use the [group service accounts API](../../api/service_accounts.md#delete-a-group-service-account).
## View and manage personal access tokens for a service account
The personal access tokens page displays information about the personal access tokens associated with a service account in your top-level group or instance. From these pages, you can:
- Filter, sort, and view details about personal access tokens.
- Rotate personal access tokens.
- Revoke personal access tokens.
You can also manage personal access tokens for service accounts through the API.
- For instance service accounts, use the [personal access tokens API](../../api/personal_access_tokens.md).
- For group service accounts, use the [group service accounts API](../../api/service_accounts.md).
To view the personal access tokens page for a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Manage access tokens**.
### Create a personal access token for a service account
To use a service account, you must create a personal access token to authenticate requests.
To create a personal access token for a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Manage access tokens**.
1. Select **Add new token**.
1. In **Token name**, enter a name for the token.
1. Optional. In **Token description**, enter a description for the token.
1. In **Expiration date**, enter an expiration date for the token.
- The token expires on that date at midnight UTC. A token with the expiration date of 2024-01-01 expires at 00:00:00 UTC on 2024-01-01.
- If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
- By default, this date can be a maximum of 365 days later than the current date. In GitLab 17.6 or later, you can [extend this limit to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901).
1. Select the [desired scopes](personal_access_tokens.md#personal-access-token-scopes).
1. Select **Create personal access token**.
### Rotate a personal access token
You can rotate a personal access token to invalidate the current token and generate a new value.
{{< alert type="warning" >}}
This cannot be undone. Any services that rely on the rotated token will stop working.
{{< /alert >}}
To rotate a personal access token for a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Manage access tokens**.
1. Next to an active token, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}).
1. Select **Rotate**.
1. On the confirmation dialog, select **Rotate**.
### Revoke a personal access token
You can rotate a personal access token to invalidate the current token.
{{< alert type="warning" >}}
This cannot be undone. Any services that rely on the revoked token will stop working.
{{< /alert >}}
To revoke a personal access token for a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Manage access tokens**.
1. Next to an active token, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}).
1. Select **Revoke**.
1. On the confirmation dialog, select **Revoke**.
## Rate limits
[Rate limits](../../security/rate_limits.md) apply to service accounts:
- On GitLab.com, [GitLab.com-specific rate limits](../gitlab_com/_index.md#rate-limits-on-gitlabcom) apply.
- On GitLab Self-Managed and GitLab Dedicated, these rate limits apply:
- [Configurable rate limits](../../security/rate_limits.md#configurable-limits)
- [Non-configurable rate limits](../../security/rate_limits.md#non-configurable-limits)
## Related topics
- [Billable users](../../subscriptions/manage_users_and_seats.md#billable-users)
- [Associated records](account/delete_account.md#associated-records)
- [Project access tokens - bot users](../project/settings/project_access_tokens.md#bot-users-for-projects)
- [Group access tokens - bot users](../group/settings/group_access_tokens.md#bot-users-for-groups)
- [Internal users](../../administration/internal_users.md)
|
---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Service accounts
description: Machine user, rate limits, and personal access tokens.
breadcrumbs:
- doc
- user
- profile
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Service accounts are user accounts that represent non-human entities rather than individual people.
You can use service accounts to perform automated actions, access data, or run scheduled processes.
Service accounts are commonly used in pipelines or third-party integrations where credentials must
remain stable and unaffected by changes in human user membership.
There are two types of service accounts:
- Instance service accounts: Available to an entire GitLab instance, but must still be added to
groups and projects like a human user. Only available on GitLab Self-Managed and GitLab Dedicated.
- Group service accounts: Owned by a specific top-level group and can inherit membership to
subgroups and projects like a human user.
You authenticate as a service account with a [personal access token](personal_access_tokens.md).
Service accounts have the same abilities as human users, and can perform actions
like interacting with [package and container registries](../packages/_index.md),
performing [Git operations](personal_access_tokens.md#clone-repository-using-personal-access-token),
and accessing the API.
Service accounts:
- Do not use a seat.
- Cannot sign in to GitLab through the UI.
- Are identified in the group and project membership as service accounts.
- Do not receive notification emails without [adding a custom email address](../../api/service_accounts.md#create-an-instance-service-account).
- Are not [billable users](../../subscriptions/manage_users_and_seats.md#billable-users) or [internal users](../../administration/internal_users.md).
- Cannot be used with [trial versions](https://gitlab.com/-/trial_registrations/new?glm_source=docs.gitlab.com&glm_content=free-user-limit-faq/ee/user/free_user_limit.html) of GitLab.com.
- Can be used with trial versions of GitLab Self-Managed and GitLab Dedicated.
You can also manage service accounts through the API.
- For instance service accounts, use the [service account users API](../../api/service_accounts.md).
- For group service accounts, use the [group service accounts API](../../api/service_accounts.md).
## Prerequisites
- On GitLab.com, you must have the Owner role in a top-level group.
- On GitLab Self-Managed or GitLab Dedicated you must either:
- Be an administrator for the instance.
- Have the Owner role in a top-level group and be [allowed to create service accounts](../../administration/settings/account_and_limit_settings.md#allow-top-level-group-owners-to-create-service-accounts).
## View and manage service accounts
{{< history >}}
- Introduced for GitLab.com in GitLab 17.11
{{< /history >}}
The service accounts page displays information about service accounts in your top-level group or instance. Each top-level group and GitLab Self-Managed instance has a separate service accounts page. From these pages, you can:
- View all service accounts for your group or instance.
- Delete a service account.
- Edit a service account's name or username.
- Manage personal access tokens for a service account.
{{< tabs >}}
{{< tab title="Instance-wide service accounts" >}}
To view service accounts for the entire instance:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > Service accounts**.
{{< /tab >}}
{{< tab title="Group service accounts" >}}
To view service accounts for a top-level group:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > Service accounts**.
{{< /tab >}}
{{< /tabs >}}
### Create a service account
{{< history >}}
- Introduced for GitLab.com in GitLab 16.3
- Top-level group owners can create Service accounts [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/163726) in GitLab 17.5 [with a feature flag](../../administration/feature_flags/_index.md) named `allow_top_level_group_owners_to_create_service_accounts` for GitLab Self-Managed. Disabled by default.
- Top-level group owners can create Service accounts [generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/172502) in GitLab 17.6. Feature flag `allow_top_level_group_owners_to_create_service_accounts` removed.
{{< /history >}}
On GitLab.com, you can create service accounts owned by a top-level group.
By default, on GitLab Self-Managed and GitLab Dedicated, only administrators can create service
accounts. You can [allow top-level group Owners to create service accounts](../../administration/settings/account_and_limit_settings.md#allow-top-level-group-owners-to-create-service-accounts).
The number of service accounts you can create is limited by your license:
- On GitLab Free, you cannot create service accounts.
- On GitLab Premium, you can create one service account for every paid seat.
- On GitLab Ultimate, you can create an unlimited number of service accounts.
To create a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Select **Add service account**.
1. Enter a name for the service account. A username is automatically generated based on the name. You can modify the username if needed.
1. Select **Create service account**.
### Edit a service account
You can edit the name or username of a service account.
To edit a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Edit**.
1. Edit the name or username for the service account.
1. Select **Save changes**.
### Service account access to groups and projects
Service accounts are similar to [external users](../../administration/external_users.md). When first
created, they have limited access to groups and projects. To give a service account access to
resources, you must add it to each group or project.
There is no limit to the number of service accounts you can add to a group or project. Service accounts
can have different roles in each group, subgroup, or project they are a member of.
On GitLab.com, service accounts for groups can only belong to a single top-level group.
You can manage service account access to groups and projects the same way you manage access for
human users. For more information, see
[groups](../group/_index.md#add-users-to-a-group) and [members of a project](../project/members/_index.md#add-users-to-a-project).
You can also manage group and project assignments with the [members API](../../api/members.md).
### Delete a service account
When you delete a service account, any contributions made by the account are retained and ownership
is transfered to a system-wide ghost user account. These contributions can include activity such as
merge requests, issues, projects, and groups.
To delete a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Delete account**.
1. Enter the name of the service account.
1. Select **Delete user**.
You can also delete the service account and any contributions made by the account. These
contributions can include activity such as merge requests, issues, groups, and projects.
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Delete account and contributions**.
1. Enter the name of the service account.
1. Select **Delete user and contributions**.
You can also delete service accounts through the API.
- For instance service accounts, use the [users API](../../api/users.md#delete-a-user).
- For group service accounts, use the [group service accounts API](../../api/service_accounts.md#delete-a-group-service-account).
## View and manage personal access tokens for a service account
The personal access tokens page displays information about the personal access tokens associated with a service account in your top-level group or instance. From these pages, you can:
- Filter, sort, and view details about personal access tokens.
- Rotate personal access tokens.
- Revoke personal access tokens.
You can also manage personal access tokens for service accounts through the API.
- For instance service accounts, use the [personal access tokens API](../../api/personal_access_tokens.md).
- For group service accounts, use the [group service accounts API](../../api/service_accounts.md).
To view the personal access tokens page for a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Manage access tokens**.
### Create a personal access token for a service account
To use a service account, you must create a personal access token to authenticate requests.
To create a personal access token for a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Manage access tokens**.
1. Select **Add new token**.
1. In **Token name**, enter a name for the token.
1. Optional. In **Token description**, enter a description for the token.
1. In **Expiration date**, enter an expiration date for the token.
- The token expires on that date at midnight UTC. A token with the expiration date of 2024-01-01 expires at 00:00:00 UTC on 2024-01-01.
- If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
- By default, this date can be a maximum of 365 days later than the current date. In GitLab 17.6 or later, you can [extend this limit to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901).
1. Select the [desired scopes](personal_access_tokens.md#personal-access-token-scopes).
1. Select **Create personal access token**.
### Rotate a personal access token
You can rotate a personal access token to invalidate the current token and generate a new value.
{{< alert type="warning" >}}
This cannot be undone. Any services that rely on the rotated token will stop working.
{{< /alert >}}
To rotate a personal access token for a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Manage access tokens**.
1. Next to an active token, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}).
1. Select **Rotate**.
1. On the confirmation dialog, select **Rotate**.
### Revoke a personal access token
You can rotate a personal access token to invalidate the current token.
{{< alert type="warning" >}}
This cannot be undone. Any services that rely on the revoked token will stop working.
{{< /alert >}}
To revoke a personal access token for a service account:
1. Go to the [Service accounts](#view-and-manage-service-accounts) page.
1. Identify a service account.
1. Select the vertical ellipsis ({{< icon name="ellipsis_v" >}}) > **Manage access tokens**.
1. Next to an active token, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}).
1. Select **Revoke**.
1. On the confirmation dialog, select **Revoke**.
## Rate limits
[Rate limits](../../security/rate_limits.md) apply to service accounts:
- On GitLab.com, [GitLab.com-specific rate limits](../gitlab_com/_index.md#rate-limits-on-gitlabcom) apply.
- On GitLab Self-Managed and GitLab Dedicated, these rate limits apply:
- [Configurable rate limits](../../security/rate_limits.md#configurable-limits)
- [Non-configurable rate limits](../../security/rate_limits.md#non-configurable-limits)
## Related topics
- [Billable users](../../subscriptions/manage_users_and_seats.md#billable-users)
- [Associated records](account/delete_account.md#associated-records)
- [Project access tokens - bot users](../project/settings/project_access_tokens.md#bot-users-for-projects)
- [Group access tokens - bot users](../group/settings/group_access_tokens.md#bot-users-for-groups)
- [Internal users](../../administration/internal_users.md)
|
https://docs.gitlab.com/user/personal_access_tokens
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/personal_access_tokens.md
|
2025-08-13
|
doc/user/profile
|
[
"doc",
"user",
"profile"
] |
personal_access_tokens.md
|
Software Supply Chain Security
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Personal access tokens
|
Use personal access tokens to authenticate with the GitLab API or Git over HTTPS. Includes creation, rotation, revocation, scopes, and expiration settings.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Personal access tokens can be an alternative to [OAuth2](../../api/oauth2.md) and used to:
- Authenticate with the [GitLab API](../../api/rest/authentication.md#personalprojectgroup-access-tokens).
- Authenticate with Git using HTTP Basic Authentication.
In both cases, you authenticate with a personal access token in place of your password. Username is not evaluated as part of the authentication process.
Personal access tokens are:
- Required when [two-factor authentication (2FA)](account/two_factor_authentication.md) or
[SAML](../../integration/saml.md#password-generation-for-users-created-through-saml) is enabled.
- Used with a GitLab username to authenticate with GitLab features that require usernames. For example,
[GitLab-managed Terraform state backend](../infrastructure/iac/terraform_state.md#use-your-gitlab-backend-as-a-remote-data-source)
and [Docker container registry](../packages/container_registry/authenticate_with_container_registry.md),
- Similar to [project access tokens](../project/settings/project_access_tokens.md) and [group access tokens](../group/settings/group_access_tokens.md), but are attached
to a user rather than a project or group.
{{< alert type="note" >}}
Though required, GitLab usernames are ignored when authenticating with a personal access token.
There is an [issue for tracking](https://gitlab.com/gitlab-org/gitlab/-/issues/212953) to make GitLab
use the username.
{{< /alert >}}
For examples of how you can use a personal access token to authenticate with the API, see the [API documentation](../../api/rest/authentication.md#personalprojectgroup-access-tokens).
Alternately, GitLab administrators can use the API to create [impersonation tokens](../../api/rest/authentication.md#impersonation-tokens).
Use impersonation tokens to automate authentication as a specific user.
## Create a personal access token
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/348660) in GitLab 15.3, default expiration of 30 days is populated in the UI.
- Ability to create non-expiring personal access tokens [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/392855) in GitLab 16.0.
- Maximum allowable lifetime limit [extended to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901) in GitLab 17.6 [with a flag](../feature_flags.md) named `buffered_token_expiration_limit`. Disabled by default.
- Personal access token description [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/443819) in GitLab 17.7.
{{< /history >}}
{{< alert type="flag" >}}
The availability of the extended maximum allowable lifetime limit is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
{{< alert type="warning" >}}
The ability to create personal access tokens without an expiry date was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/369122) in GitLab 15.4 and [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/392855) in GitLab 16.0. For more information on when personal access tokens expire and expiry dates are added to existing tokens, see the documentation on [access token expiration](#access-token-expiration).
{{< /alert >}}
You can create as many personal access tokens as you like.
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Access tokens**.
1. Select **Add new token**.
1. In **Token name**, enter a name for the token.
1. Optional. In **Token description**, enter a description for the token.
1. In **Expiration date**, enter an expiration date for the token.
- The token expires on that date at midnight UTC. A token with the expiration date of 2024-01-01 expires at 00:00:00 UTC on 2024-01-01.
- If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
- By default, this date can be a maximum of 365 days later than the current date. In GitLab 17.6 or later, you can [extend this limit to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901).
1. Select the [desired scopes](#personal-access-token-scopes).
1. Select **Create personal access token**.
Save the personal access token somewhere safe. After you leave the page,
you no longer have access to the token.
### Prefill personal access token details
You can prefill the details of the personal access token by appending the name, description, and
list of scopes to the URL. For example:
```plaintext
https://gitlab.example.com/-/user_settings/personal_access_tokens?name=Example+Access+token&description=My+description&scopes=api,read_user
```
{{< alert type="warning" >}}
Personal access tokens must be treated carefully. Read our [token security considerations](../../security/tokens/_index.md#security-considerations)
for guidance on managing personal access tokens (for example, setting a short expiry and using minimal scopes).
{{< /alert >}}
## Revoke or rotate a personal access token
{{< history >}}
- Ability to use the UI to rotate a personal access token [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241523) in GitLab 17.7.
- [Updated UI](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194582) in GitLab 18.1.
{{< /history >}}
At any time, you can use the UI to revoke or, in GitLab 17.7 and later, rotate a personal access token.
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Access tokens**.
1. Next to an active token, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}).
1. Select **Revoke** ({{< icon name="remove" >}}) or **Rotate** ({{< icon name="retry" >}}).
1. On the confirmation dialog, select **Revoke** or **Rotate**.
{{< alert type="warning" >}}
These actions cannot be undone. Any tools that rely on a revoked or rotated access token will stop working.
{{< /alert >}}
## Disable personal access tokens
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Prerequisites:
- You must be an administrator.
Depending on your GitLab version, you can use either the application settings API
or the Admin UI to disable personal access tokens.
### Use the application settings API
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384201) in GitLab 15.7.
{{< /history >}}
In GitLab 15.7 and later, you can use the [`disable_personal_access_tokens` attribute in the application settings API](../../api/settings.md#available-settings) to disable personal access tokens.
{{< alert type="note" >}}
After you have used the API to disable personal access tokens, those tokens cannot be used in subsequent API calls to manage this setting. To re-enable personal access tokens, you must use the [GitLab Rails console](../../administration/operations/rails_console.md). You can also upgrade to GitLab 17.3 or later so you can use the Admin UI instead.
{{< /alert >}}
### Use the Admin UI
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/436991) in GitLab 17.3.
{{< /history >}}
In GitLab 17.3 and later, you can use the Admin UI to disable personal access tokens:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > General**.
1. Expand **Visibility and access controls**.
1. Select the **Disable personal access tokens** checkbox.
1. Select **Save changes**.
### Disable personal access tokens for enterprise users
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369504) in GitLab 16.11 [with a flag](../../administration/feature_flags/_index.md) named `enterprise_disable_personal_access_tokens`. Disabled by default.
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/369504) in GitLab 17.2
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/369504) in GitLab 17.3 . Feature flag `enterprise_disable_personal_access_tokens` removed.
{{< /history >}}
Prerequisites:
- You must have the Owner role for the group that the enterprise user belongs to.
Disabling the personal access tokens of a group's [enterprise users](../enterprise_user/_index.md):
- Stops the enterprise users from creating new personal access tokens. This behavior applies
even if an enterprise user is also an administrator of the group.
- Disables the existing personal access tokens of the enterprise users.
{{< alert type="warning" >}}
Disabling personal access tokens for enterprise users does not disable personal access tokens for [service accounts](service_accounts.md).
{{< /alert >}}
To disable the enterprise users' personal access tokens:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand **Permissions and group features**.
1. Under **Personal access tokens**, select **Disable personal access tokens**.
1. Select **Save changes**.
When you delete or block an enterprise user account, their personal access tokens are automatically revoked.
## View token usage information
{{< history >}}
- In GitLab 16.0 and earlier, token usage information is updated every 24 hours.
- The frequency of token usage information updates [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/410168) in GitLab 16.1 from 24 hours to 10 minutes.
- Ability to view IP addresses [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/428577) in GitLab 17.8 [with a flag](../../administration/feature_flags/_index.md) named `pat_ip`. Enabled by default in 17.9.
- Ability to view IP addresses made [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/513302) in GitLab 17.10. Feature flag `pat_ip` removed.
{{< /history >}}
Token usage information updates periodically. The time the token was last used updates every 10 minutes, and the most recently used IP address updates every minute. GitLab considers a token used when the token:
- Authenticates with the [REST](../../api/rest/_index.md) or [GraphQL](../../api/graphql/_index.md) APIs.
- Performs a Git operation.
To view the last time a token was used, and the IP addresses from where the token was used:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Access tokens**.
1. In the **Active personal access tokens** area, view the **Last Used** date and **Last Used IPs** for
the relevant token. **Last Used IPs** shows the last five distinct IP addresses.
## Personal access token scopes
{{< history >}}
- Personal access tokens no longer being able to access container or package registries [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387721) in GitLab 16.0.
- `k8s_proxy` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/422408) in GitLab 16.4 [with a flag](../../administration/feature_flags/_index.md) named `k8s_proxy_pat`. Enabled by default.
- Feature flag `k8s_proxy_pat` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131518) in GitLab 16.5.
- `read_service_ping` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/42692#note_1222832412) in GitLab 17.1.
- `manage_runner` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/460721) in GitLab 17.1.
- `self_rotate` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/178111) in GitLab 17.9. Enabled by default.
{{< /history >}}
A personal access token can perform actions based on the assigned scopes.
| Scope | Access |
|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `api` | Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry. Also grants complete read/write access to the registry and repository using Git over HTTP. |
| `read_user` | Grants read-only access to the authenticated user's profile through the `/user` API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under [`/users`](../../api/users.md). |
| `read_api` | Grants read access to the API, including all groups and projects, the container registry, and the package registry. |
| `read_repository` | Grants read-only access to repositories on private projects using Git-over-HTTP or the Repository Files API. |
| `write_repository` | Grants read-write access to repositories on private projects using Git-over-HTTP (not using the API). |
| `read_registry` | Grants read-only (pull) access to [container registry](../packages/container_registry/_index.md) images if a project is private and authorization is required. Available only when the container registry is enabled. |
| `write_registry` | Grants read-write (push) access to [container registry](../packages/container_registry/_index.md) images if a project is private and authorization is required. Available only when the container registry is enabled. |
| `read_virtual_registry` | If a project is private and authorization is required, grants read-only (pull) access to container images through the [dependency proxy](../packages/dependency_proxy/_index.md). Available only when the dependency proxy is enabled. |
| `write_virtual_registry` | If a project is private and authorization is required, grants read (pull), write (push), and delete access to container images through the [dependency proxy](../packages/dependency_proxy/_index.md). Available only when the dependency proxy is enabled. |
| `sudo` | Grants permission to perform API actions as any user in the system, when authenticated as an administrator. |
| `admin_mode` | Grants permission to perform API actions when [Admin Mode](../../administration/settings/sign_in_restrictions.md#admin-mode) is enabled. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107875) in GitLab 15.8. Available only to administrators on GitLab Self-Managed instances. |
| `create_runner` | Grants permission to create runners. |
| `manage_runner` | Grants permission to manage runners. |
| `ai_features` | This scope:<br>- Grants permission to perform API actions for features like GitLab Duo, Code Suggestions API and Duo Chat API.<br>- Does not work for GitLab Self-Managed versions 16.5, 16.6, and 16.7.<br>For GitLab Duo plugin for JetBrains, this scope:<br>- Supports users with AI features enabled in the GitLab Duo plugin for JetBrains.<br>- Addresses a security vulnerability in JetBrains IDE plugins that could expose personal access tokens.<br>- Is designed to minimize potential risks for GitLab Duo plugin users by limiting the impact of compromised tokens.<br>For all other extensions, see the individual scope requirements in their documentation. |
| `k8s_proxy` | Grants permission to perform Kubernetes API calls using the agent for Kubernetes. |
| `self_rotate` | Grants permission to rotate this token using the [personal access token API](../../api/personal_access_tokens.md#rotate-a-personal-access-token). Does not allow rotation of other tokens. |
| `read_service_ping`| Grant access to download Service Ping payload through the API when authenticated as an admin use. |
{{< alert type="warning" >}}
If you enabled [external authorization](../../administration/settings/external_authorization.md), personal access tokens cannot access container or package registries. If you use personal access tokens to access these registries, this measure breaks this use of these tokens. Disable external authorization to use personal access tokens with container or package registries.
{{< /alert >}}
## Access token expiration
{{< history >}}
- Maximum token lifetime of 400 days [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241523) in GitLab 17.6 [with a flag](../feature_flags.md) named `buffered_token_expiration_limit`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of the extended maximum allowable lifetime limit is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
Personal access tokens expire on the date you define, at midnight, 00:00 AM UTC. A token with the expiration date of 2024-01-01 expires at 00:00:00 UTC on 2024-01-01.
- GitLab runs a check at 1:00 AM UTC every day to identify personal access tokens that expire soon. The owners of these tokens are [notified by email](#personal-access-token-expiry-emails).
- GitLab runs a check at 02:00 AM UTC every day to identify personal access tokens that expire on the current date. The owners of these tokens are notified by email.
- In GitLab Ultimate, administrators can
[limit the allowable lifetime of access tokens](../../administration/settings/account_and_limit_settings.md#limit-the-lifetime-of-access-tokens). If not set, the maximum allowable lifetime of a personal access token is 365 days. In GitLab 17.6 or later, you can [extend this limit to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901).
- In GitLab Free and Premium, the maximum allowable lifetime of a personal access token is 365 days. In GitLab 17.6 or later, you can [extend this limit to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901).
- If you do not set an expiry date when creating a personal access token, the expiry date is set to the
[maximum allowed lifetime for the token](../../administration/settings/account_and_limit_settings.md#limit-the-lifetime-of-access-tokens).
If the maximum allowed lifetime is not set, the default expiry date is 365 days from the date of creation.
Whether your existing personal access tokens have expiry dates automatically applied
depends on what GitLab offering you have, and when you upgraded to GitLab 16.0 or later:
- On GitLab.com, during the 16.0 milestone, existing personal access tokens without
an expiry date were automatically given an expiry date of 365 days later than the current date.
- On GitLab Self-Managed, if you upgraded from GitLab 15.11 or earlier to GitLab 16.0 or later:
- On or before July 23, 2024, existing personal access tokens without an expiry
date were automatically given an expiry date of 365 days later than the current date.
This change is a breaking change.
- On or after July 24, 2024, existing personal access tokens without an expiry
date did not have an expiry date set.
On GitLab Self-Managed, if you do a new install of one of the following GitLab
versions, your existing personal access tokens do not have expiry dates
automatically applied:
- 16.0.9
- 16.1.7
- 16.2.10
- 16.3.8
- 16.4.6
- 16.5.9
- 16.6.9
- 16.7.9
- 16.8.9
- 16.9.10
- 16.10.9
- 16.11.7
- 17.0.5
- 17.1.3
- 17.2.1
### Personal access token expiry emails
{{< history >}}
- 60 and 30 day expiry notifications [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/464040) in GitLab 17.6 [with a flag](../../administration/feature_flags/_index.md) named `expiring_pats_30d_60d_notifications`. Disabled by default.
- 60 and 30 day notifications [generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173792) in GitLab 17.7. Feature flag `expiring_pats_30d_60d_notifications` removed.
{{< /history >}}
GitLab runs a check every day at 1:00 AM UTC to identify personal access tokens that are expiring in the near future. The owners of these tokens are notified by email when these tokens expire in a certain number of days. The number of days differs depending on the version of GitLab:
- In GitLab 17.6 and later, personal access token owners are notified by email when the check identifies their personal access tokens as expiring in the next 60 days. An additional email is sent when the check identifies their group access tokens as expiring in the next 30 days.
- Personal access token owners are notified by email when the check identifies their group access tokens as expiring in the next seven days.
### Personal access token expiry calendar
You can subscribe to an iCalendar endpoint which contains events at the expiry date for each token. After signing in, this endpoint is available at `/-/user_settings/personal_access_tokens.ics`.
### Create a service account personal access token with no expiry date
You can [create a personal access token for a service account](../../api/service_accounts.md#create-a-personal-access-token-for-a-group-service-account) with no expiry date. These personal access tokens never expire, unlike non-service account personal access tokens.
{{< alert type="note" >}}
Allowing personal access tokens for service accounts to be created with no expiry date only affects tokens created after you change this setting. It does not affect existing tokens.
{{< /alert >}}
#### GitLab.com
Prerequisites:
- You must have the Owner role for the top-level group.
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General > Permissions and group features**.
1. Clear the **Service account token expiration** checkbox.
You can now create personal access tokens for a service account user with no expiry date.
#### GitLab Self-Managed
Prerequisites:
- You must be an administrator for your GitLab Self-Managed instance.
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > General**.
1. Expand **Account and limit**.
1. Clear the **Service account token expiration** checkbox.
You can now create personal access tokens for a service account user with no expiry date.
## Use DPoP with personal access tokens
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/181053) in GitLab 17.10 [with a flag](../../administration/feature_flags/_index.md) named `dpop_authentication`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.
{{< /alert >}}
Demonstrating Proof of Possession (DPoP) enhances the security of your personal access tokens,
and minimizes the effects of unintended token leaks. When you enable this feature on your
account, all REST and GraphQL API requests containing a PAT must also provide a signed DPoP header. Creating a
signed DPoP header requires your corresponding private SSH key.
{{< alert type="note" >}}
If you enable this feature, all API requests without a valid DPoP header return a `DpopValidationError` error.
DPoP header is not required for Git operations over HTTPS that include an access token.
{{< /alert >}}
Prerequisites:
- You must [add at least one public SSH key](../ssh.md#add-an-ssh-key-to-your-gitlab-account)
to your account, with a **Usage type** of **Signing** or **Authentication & Signing**.
- Your SSH key type must be RSA.
- You must have installed and configured the [GitLab CLI](../../editor_extensions/gitlab_cli/_index.md)
for your GitLab account.
To require DPoP on all calls to the REST and GraphQL APIs:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Access Tokens**.
1. Go to the **Use Demonstrating Proof of Possession (DPoP)** section, and select **Enable DPoP**.
1. Select **Save changes**.
1. To generate a DPoP header with the [GitLab CLI](../../editor_extensions/gitlab_cli/_index.md),
run this command in your terminal. Replace `<your_access_token>` with your access token, and `~/.ssh/id_rsa`
with the location of your private key:
```shell
glab auth dpop-gen --pat "<your_access_token>" --private-key ~/.ssh/id_rsa
```
The DPoP header you generated in the CLI can be used:
- With the REST API:
```shell
curl --header "Private-Token: <your_access_token>" \
--header "DPoP: <dpop-from-glab>" \
"https://gitlab.example.com/api/v4/projects"
```
- With GraphQL:
```shell
curl --request POST \
--header "Content-Type: application/json" \
--header "Private-Token: <your_access_token>" \
--header "DPoP: <dpop-from-glab>" \
--data '{
"query": "query { currentUser { id } }"
}' \
"https://gitlab.example.com/api/graphql"
```
To learn more about DPoP, see the blueprint
[Sender Constraining Personal Access Tokens](https://gitlab.com/gitlab-com/gl-security/product-security/appsec/security-feature-blueprints/-/tree/main/sender_constraining_access_tokens).
## Create a personal access token programmatically
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can create a predetermined personal access token
as part of your tests or automation.
Prerequisites:
- You need sufficient access to run a
[Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session)
for your GitLab instance.
To create a personal access token programmatically:
1. Open a Rails console:
```shell
sudo gitlab-rails console
```
1. Run the following commands to reference the username, the token, and the scopes.
The token must be 20 characters long. The scopes must be valid and are visible
[in the source code](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/auth.rb).
For example, to create a token that belongs to a user with username `automation-bot` and expires in a year:
```ruby
user = User.find_by_username('automation-bot')
token = user.personal_access_tokens.create(scopes: ['read_user', 'read_repository'], name: 'Automation token', expires_at: 365.days.from_now)
token.set_token('token-string-here123')
token.save!
```
This code can be shortened into a single-line shell command by using the
[Rails runner](../../administration/operations/rails_console.md#using-the-rails-runner):
```shell
sudo gitlab-rails runner "token = User.find_by_username('automation-bot').personal_access_tokens.create(scopes: ['read_user', 'read_repository'], name: 'Automation token', expires_at: 365.days.from_now); token.set_token('token-string-here123'); token.save!"
```
## Revoke a personal access token programmatically
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can programmatically revoke a personal access token
as part of your tests or automation.
Prerequisites:
- You need sufficient access to run a [Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session)
for your GitLab instance.
To revoke a token programmatically:
1. Open a Rails console:
```shell
sudo gitlab-rails console
```
1. To revoke a token of `token-string-here123`, run the following commands:
```ruby
token = PersonalAccessToken.find_by_token('token-string-here123')
token.revoke!
```
This code can be shortened into a single-line shell command using the
[Rails runner](../../administration/operations/rails_console.md#using-the-rails-runner):
```shell
sudo gitlab-rails runner "PersonalAccessToken.find_by_token('token-string-here123').revoke!"
```
## Clone repository using personal access token
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To clone a repository when SSH is disabled, clone it using a personal access token by running the following command:
```shell
git clone https://<username>:<personal_token>@gitlab.com/gitlab-org/gitlab.git
```
This method saves your personal access token in your bash history. To avoid this, run the following command:
```shell
git clone https://<username>@gitlab.com/gitlab-org/gitlab.git
```
When asked for your password for `https://gitlab.com`, enter your personal access token.
The `username` in the `clone` command:
- Can be any string value.
- Must not be an empty string.
Remember this if you set up an automation pipeline that depends on authentication.
## Troubleshooting
### Unrevoke a personal access token
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
If a personal access token is revoked accidentally by any method, administrators can unrevoke that token. By default, a daily job deletes revoked tokens at 1:00 AM system time.
{{< alert type="warning" >}}
Running the following commands changes data directly. This could be damaging if not done correctly, or under the right conditions. You should first run these commands in a test environment with a backup of the instance ready to be restored, just in case.
{{< /alert >}}
1. Open a [Rails console](../../administration/operations/rails_console.md#starting-a-rails-console-session).
1. Unrevoke the token:
```ruby
token = PersonalAccessToken.find_by_token('<token_string>')
token.update!(revoked:false)
```
For example, to unrevoke a token of `token-string-here123`:
```ruby
token = PersonalAccessToken.find_by_token('token-string-here123')
token.update!(revoked:false)
```
## Alternatives to personal access tokens
For Git over HTTPS, an alternative to personal access tokens is to use an [OAuth credential helper](account/two_factor_authentication.md#oauth-credential-helpers).
|
---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Use personal access tokens to authenticate with the GitLab API or Git
over HTTPS. Includes creation, rotation, revocation, scopes, and expiration settings.
title: Personal access tokens
breadcrumbs:
- doc
- user
- profile
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Personal access tokens can be an alternative to [OAuth2](../../api/oauth2.md) and used to:
- Authenticate with the [GitLab API](../../api/rest/authentication.md#personalprojectgroup-access-tokens).
- Authenticate with Git using HTTP Basic Authentication.
In both cases, you authenticate with a personal access token in place of your password. Username is not evaluated as part of the authentication process.
Personal access tokens are:
- Required when [two-factor authentication (2FA)](account/two_factor_authentication.md) or
[SAML](../../integration/saml.md#password-generation-for-users-created-through-saml) is enabled.
- Used with a GitLab username to authenticate with GitLab features that require usernames. For example,
[GitLab-managed Terraform state backend](../infrastructure/iac/terraform_state.md#use-your-gitlab-backend-as-a-remote-data-source)
and [Docker container registry](../packages/container_registry/authenticate_with_container_registry.md),
- Similar to [project access tokens](../project/settings/project_access_tokens.md) and [group access tokens](../group/settings/group_access_tokens.md), but are attached
to a user rather than a project or group.
{{< alert type="note" >}}
Though required, GitLab usernames are ignored when authenticating with a personal access token.
There is an [issue for tracking](https://gitlab.com/gitlab-org/gitlab/-/issues/212953) to make GitLab
use the username.
{{< /alert >}}
For examples of how you can use a personal access token to authenticate with the API, see the [API documentation](../../api/rest/authentication.md#personalprojectgroup-access-tokens).
Alternately, GitLab administrators can use the API to create [impersonation tokens](../../api/rest/authentication.md#impersonation-tokens).
Use impersonation tokens to automate authentication as a specific user.
## Create a personal access token
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/348660) in GitLab 15.3, default expiration of 30 days is populated in the UI.
- Ability to create non-expiring personal access tokens [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/392855) in GitLab 16.0.
- Maximum allowable lifetime limit [extended to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901) in GitLab 17.6 [with a flag](../feature_flags.md) named `buffered_token_expiration_limit`. Disabled by default.
- Personal access token description [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/443819) in GitLab 17.7.
{{< /history >}}
{{< alert type="flag" >}}
The availability of the extended maximum allowable lifetime limit is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
{{< alert type="warning" >}}
The ability to create personal access tokens without an expiry date was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/369122) in GitLab 15.4 and [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/392855) in GitLab 16.0. For more information on when personal access tokens expire and expiry dates are added to existing tokens, see the documentation on [access token expiration](#access-token-expiration).
{{< /alert >}}
You can create as many personal access tokens as you like.
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Access tokens**.
1. Select **Add new token**.
1. In **Token name**, enter a name for the token.
1. Optional. In **Token description**, enter a description for the token.
1. In **Expiration date**, enter an expiration date for the token.
- The token expires on that date at midnight UTC. A token with the expiration date of 2024-01-01 expires at 00:00:00 UTC on 2024-01-01.
- If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
- By default, this date can be a maximum of 365 days later than the current date. In GitLab 17.6 or later, you can [extend this limit to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901).
1. Select the [desired scopes](#personal-access-token-scopes).
1. Select **Create personal access token**.
Save the personal access token somewhere safe. After you leave the page,
you no longer have access to the token.
### Prefill personal access token details
You can prefill the details of the personal access token by appending the name, description, and
list of scopes to the URL. For example:
```plaintext
https://gitlab.example.com/-/user_settings/personal_access_tokens?name=Example+Access+token&description=My+description&scopes=api,read_user
```
{{< alert type="warning" >}}
Personal access tokens must be treated carefully. Read our [token security considerations](../../security/tokens/_index.md#security-considerations)
for guidance on managing personal access tokens (for example, setting a short expiry and using minimal scopes).
{{< /alert >}}
## Revoke or rotate a personal access token
{{< history >}}
- Ability to use the UI to rotate a personal access token [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241523) in GitLab 17.7.
- [Updated UI](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/194582) in GitLab 18.1.
{{< /history >}}
At any time, you can use the UI to revoke or, in GitLab 17.7 and later, rotate a personal access token.
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Access tokens**.
1. Next to an active token, select the vertical ellipsis ({{< icon name="ellipsis_v" >}}).
1. Select **Revoke** ({{< icon name="remove" >}}) or **Rotate** ({{< icon name="retry" >}}).
1. On the confirmation dialog, select **Revoke** or **Rotate**.
{{< alert type="warning" >}}
These actions cannot be undone. Any tools that rely on a revoked or rotated access token will stop working.
{{< /alert >}}
## Disable personal access tokens
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Prerequisites:
- You must be an administrator.
Depending on your GitLab version, you can use either the application settings API
or the Admin UI to disable personal access tokens.
### Use the application settings API
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384201) in GitLab 15.7.
{{< /history >}}
In GitLab 15.7 and later, you can use the [`disable_personal_access_tokens` attribute in the application settings API](../../api/settings.md#available-settings) to disable personal access tokens.
{{< alert type="note" >}}
After you have used the API to disable personal access tokens, those tokens cannot be used in subsequent API calls to manage this setting. To re-enable personal access tokens, you must use the [GitLab Rails console](../../administration/operations/rails_console.md). You can also upgrade to GitLab 17.3 or later so you can use the Admin UI instead.
{{< /alert >}}
### Use the Admin UI
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/436991) in GitLab 17.3.
{{< /history >}}
In GitLab 17.3 and later, you can use the Admin UI to disable personal access tokens:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > General**.
1. Expand **Visibility and access controls**.
1. Select the **Disable personal access tokens** checkbox.
1. Select **Save changes**.
### Disable personal access tokens for enterprise users
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369504) in GitLab 16.11 [with a flag](../../administration/feature_flags/_index.md) named `enterprise_disable_personal_access_tokens`. Disabled by default.
- [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/369504) in GitLab 17.2
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/369504) in GitLab 17.3 . Feature flag `enterprise_disable_personal_access_tokens` removed.
{{< /history >}}
Prerequisites:
- You must have the Owner role for the group that the enterprise user belongs to.
Disabling the personal access tokens of a group's [enterprise users](../enterprise_user/_index.md):
- Stops the enterprise users from creating new personal access tokens. This behavior applies
even if an enterprise user is also an administrator of the group.
- Disables the existing personal access tokens of the enterprise users.
{{< alert type="warning" >}}
Disabling personal access tokens for enterprise users does not disable personal access tokens for [service accounts](service_accounts.md).
{{< /alert >}}
To disable the enterprise users' personal access tokens:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General**.
1. Expand **Permissions and group features**.
1. Under **Personal access tokens**, select **Disable personal access tokens**.
1. Select **Save changes**.
When you delete or block an enterprise user account, their personal access tokens are automatically revoked.
## View token usage information
{{< history >}}
- In GitLab 16.0 and earlier, token usage information is updated every 24 hours.
- The frequency of token usage information updates [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/410168) in GitLab 16.1 from 24 hours to 10 minutes.
- Ability to view IP addresses [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/428577) in GitLab 17.8 [with a flag](../../administration/feature_flags/_index.md) named `pat_ip`. Enabled by default in 17.9.
- Ability to view IP addresses made [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/513302) in GitLab 17.10. Feature flag `pat_ip` removed.
{{< /history >}}
Token usage information updates periodically. The time the token was last used updates every 10 minutes, and the most recently used IP address updates every minute. GitLab considers a token used when the token:
- Authenticates with the [REST](../../api/rest/_index.md) or [GraphQL](../../api/graphql/_index.md) APIs.
- Performs a Git operation.
To view the last time a token was used, and the IP addresses from where the token was used:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Access tokens**.
1. In the **Active personal access tokens** area, view the **Last Used** date and **Last Used IPs** for
the relevant token. **Last Used IPs** shows the last five distinct IP addresses.
## Personal access token scopes
{{< history >}}
- Personal access tokens no longer being able to access container or package registries [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387721) in GitLab 16.0.
- `k8s_proxy` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/422408) in GitLab 16.4 [with a flag](../../administration/feature_flags/_index.md) named `k8s_proxy_pat`. Enabled by default.
- Feature flag `k8s_proxy_pat` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131518) in GitLab 16.5.
- `read_service_ping` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/42692#note_1222832412) in GitLab 17.1.
- `manage_runner` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/460721) in GitLab 17.1.
- `self_rotate` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/178111) in GitLab 17.9. Enabled by default.
{{< /history >}}
A personal access token can perform actions based on the assigned scopes.
| Scope | Access |
|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `api` | Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry. Also grants complete read/write access to the registry and repository using Git over HTTP. |
| `read_user` | Grants read-only access to the authenticated user's profile through the `/user` API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under [`/users`](../../api/users.md). |
| `read_api` | Grants read access to the API, including all groups and projects, the container registry, and the package registry. |
| `read_repository` | Grants read-only access to repositories on private projects using Git-over-HTTP or the Repository Files API. |
| `write_repository` | Grants read-write access to repositories on private projects using Git-over-HTTP (not using the API). |
| `read_registry` | Grants read-only (pull) access to [container registry](../packages/container_registry/_index.md) images if a project is private and authorization is required. Available only when the container registry is enabled. |
| `write_registry` | Grants read-write (push) access to [container registry](../packages/container_registry/_index.md) images if a project is private and authorization is required. Available only when the container registry is enabled. |
| `read_virtual_registry` | If a project is private and authorization is required, grants read-only (pull) access to container images through the [dependency proxy](../packages/dependency_proxy/_index.md). Available only when the dependency proxy is enabled. |
| `write_virtual_registry` | If a project is private and authorization is required, grants read (pull), write (push), and delete access to container images through the [dependency proxy](../packages/dependency_proxy/_index.md). Available only when the dependency proxy is enabled. |
| `sudo` | Grants permission to perform API actions as any user in the system, when authenticated as an administrator. |
| `admin_mode` | Grants permission to perform API actions when [Admin Mode](../../administration/settings/sign_in_restrictions.md#admin-mode) is enabled. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107875) in GitLab 15.8. Available only to administrators on GitLab Self-Managed instances. |
| `create_runner` | Grants permission to create runners. |
| `manage_runner` | Grants permission to manage runners. |
| `ai_features` | This scope:<br>- Grants permission to perform API actions for features like GitLab Duo, Code Suggestions API and Duo Chat API.<br>- Does not work for GitLab Self-Managed versions 16.5, 16.6, and 16.7.<br>For GitLab Duo plugin for JetBrains, this scope:<br>- Supports users with AI features enabled in the GitLab Duo plugin for JetBrains.<br>- Addresses a security vulnerability in JetBrains IDE plugins that could expose personal access tokens.<br>- Is designed to minimize potential risks for GitLab Duo plugin users by limiting the impact of compromised tokens.<br>For all other extensions, see the individual scope requirements in their documentation. |
| `k8s_proxy` | Grants permission to perform Kubernetes API calls using the agent for Kubernetes. |
| `self_rotate` | Grants permission to rotate this token using the [personal access token API](../../api/personal_access_tokens.md#rotate-a-personal-access-token). Does not allow rotation of other tokens. |
| `read_service_ping`| Grant access to download Service Ping payload through the API when authenticated as an admin use. |
{{< alert type="warning" >}}
If you enabled [external authorization](../../administration/settings/external_authorization.md), personal access tokens cannot access container or package registries. If you use personal access tokens to access these registries, this measure breaks this use of these tokens. Disable external authorization to use personal access tokens with container or package registries.
{{< /alert >}}
## Access token expiration
{{< history >}}
- Maximum token lifetime of 400 days [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241523) in GitLab 17.6 [with a flag](../feature_flags.md) named `buffered_token_expiration_limit`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of the extended maximum allowable lifetime limit is controlled by a feature flag.
For more information, see the history.
{{< /alert >}}
Personal access tokens expire on the date you define, at midnight, 00:00 AM UTC. A token with the expiration date of 2024-01-01 expires at 00:00:00 UTC on 2024-01-01.
- GitLab runs a check at 1:00 AM UTC every day to identify personal access tokens that expire soon. The owners of these tokens are [notified by email](#personal-access-token-expiry-emails).
- GitLab runs a check at 02:00 AM UTC every day to identify personal access tokens that expire on the current date. The owners of these tokens are notified by email.
- In GitLab Ultimate, administrators can
[limit the allowable lifetime of access tokens](../../administration/settings/account_and_limit_settings.md#limit-the-lifetime-of-access-tokens). If not set, the maximum allowable lifetime of a personal access token is 365 days. In GitLab 17.6 or later, you can [extend this limit to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901).
- In GitLab Free and Premium, the maximum allowable lifetime of a personal access token is 365 days. In GitLab 17.6 or later, you can [extend this limit to 400 days](https://gitlab.com/gitlab-org/gitlab/-/issues/461901).
- If you do not set an expiry date when creating a personal access token, the expiry date is set to the
[maximum allowed lifetime for the token](../../administration/settings/account_and_limit_settings.md#limit-the-lifetime-of-access-tokens).
If the maximum allowed lifetime is not set, the default expiry date is 365 days from the date of creation.
Whether your existing personal access tokens have expiry dates automatically applied
depends on what GitLab offering you have, and when you upgraded to GitLab 16.0 or later:
- On GitLab.com, during the 16.0 milestone, existing personal access tokens without
an expiry date were automatically given an expiry date of 365 days later than the current date.
- On GitLab Self-Managed, if you upgraded from GitLab 15.11 or earlier to GitLab 16.0 or later:
- On or before July 23, 2024, existing personal access tokens without an expiry
date were automatically given an expiry date of 365 days later than the current date.
This change is a breaking change.
- On or after July 24, 2024, existing personal access tokens without an expiry
date did not have an expiry date set.
On GitLab Self-Managed, if you do a new install of one of the following GitLab
versions, your existing personal access tokens do not have expiry dates
automatically applied:
- 16.0.9
- 16.1.7
- 16.2.10
- 16.3.8
- 16.4.6
- 16.5.9
- 16.6.9
- 16.7.9
- 16.8.9
- 16.9.10
- 16.10.9
- 16.11.7
- 17.0.5
- 17.1.3
- 17.2.1
### Personal access token expiry emails
{{< history >}}
- 60 and 30 day expiry notifications [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/464040) in GitLab 17.6 [with a flag](../../administration/feature_flags/_index.md) named `expiring_pats_30d_60d_notifications`. Disabled by default.
- 60 and 30 day notifications [generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173792) in GitLab 17.7. Feature flag `expiring_pats_30d_60d_notifications` removed.
{{< /history >}}
GitLab runs a check every day at 1:00 AM UTC to identify personal access tokens that are expiring in the near future. The owners of these tokens are notified by email when these tokens expire in a certain number of days. The number of days differs depending on the version of GitLab:
- In GitLab 17.6 and later, personal access token owners are notified by email when the check identifies their personal access tokens as expiring in the next 60 days. An additional email is sent when the check identifies their group access tokens as expiring in the next 30 days.
- Personal access token owners are notified by email when the check identifies their group access tokens as expiring in the next seven days.
### Personal access token expiry calendar
You can subscribe to an iCalendar endpoint which contains events at the expiry date for each token. After signing in, this endpoint is available at `/-/user_settings/personal_access_tokens.ics`.
### Create a service account personal access token with no expiry date
You can [create a personal access token for a service account](../../api/service_accounts.md#create-a-personal-access-token-for-a-group-service-account) with no expiry date. These personal access tokens never expire, unlike non-service account personal access tokens.
{{< alert type="note" >}}
Allowing personal access tokens for service accounts to be created with no expiry date only affects tokens created after you change this setting. It does not affect existing tokens.
{{< /alert >}}
#### GitLab.com
Prerequisites:
- You must have the Owner role for the top-level group.
1. On the left sidebar, select **Search or go to** and find your group.
1. Select **Settings > General > Permissions and group features**.
1. Clear the **Service account token expiration** checkbox.
You can now create personal access tokens for a service account user with no expiry date.
#### GitLab Self-Managed
Prerequisites:
- You must be an administrator for your GitLab Self-Managed instance.
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > General**.
1. Expand **Account and limit**.
1. Clear the **Service account token expiration** checkbox.
You can now create personal access tokens for a service account user with no expiry date.
## Use DPoP with personal access tokens
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/181053) in GitLab 17.10 [with a flag](../../administration/feature_flags/_index.md) named `dpop_authentication`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.
{{< /alert >}}
Demonstrating Proof of Possession (DPoP) enhances the security of your personal access tokens,
and minimizes the effects of unintended token leaks. When you enable this feature on your
account, all REST and GraphQL API requests containing a PAT must also provide a signed DPoP header. Creating a
signed DPoP header requires your corresponding private SSH key.
{{< alert type="note" >}}
If you enable this feature, all API requests without a valid DPoP header return a `DpopValidationError` error.
DPoP header is not required for Git operations over HTTPS that include an access token.
{{< /alert >}}
Prerequisites:
- You must [add at least one public SSH key](../ssh.md#add-an-ssh-key-to-your-gitlab-account)
to your account, with a **Usage type** of **Signing** or **Authentication & Signing**.
- Your SSH key type must be RSA.
- You must have installed and configured the [GitLab CLI](../../editor_extensions/gitlab_cli/_index.md)
for your GitLab account.
To require DPoP on all calls to the REST and GraphQL APIs:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Access Tokens**.
1. Go to the **Use Demonstrating Proof of Possession (DPoP)** section, and select **Enable DPoP**.
1. Select **Save changes**.
1. To generate a DPoP header with the [GitLab CLI](../../editor_extensions/gitlab_cli/_index.md),
run this command in your terminal. Replace `<your_access_token>` with your access token, and `~/.ssh/id_rsa`
with the location of your private key:
```shell
glab auth dpop-gen --pat "<your_access_token>" --private-key ~/.ssh/id_rsa
```
The DPoP header you generated in the CLI can be used:
- With the REST API:
```shell
curl --header "Private-Token: <your_access_token>" \
--header "DPoP: <dpop-from-glab>" \
"https://gitlab.example.com/api/v4/projects"
```
- With GraphQL:
```shell
curl --request POST \
--header "Content-Type: application/json" \
--header "Private-Token: <your_access_token>" \
--header "DPoP: <dpop-from-glab>" \
--data '{
"query": "query { currentUser { id } }"
}' \
"https://gitlab.example.com/api/graphql"
```
To learn more about DPoP, see the blueprint
[Sender Constraining Personal Access Tokens](https://gitlab.com/gitlab-com/gl-security/product-security/appsec/security-feature-blueprints/-/tree/main/sender_constraining_access_tokens).
## Create a personal access token programmatically
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can create a predetermined personal access token
as part of your tests or automation.
Prerequisites:
- You need sufficient access to run a
[Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session)
for your GitLab instance.
To create a personal access token programmatically:
1. Open a Rails console:
```shell
sudo gitlab-rails console
```
1. Run the following commands to reference the username, the token, and the scopes.
The token must be 20 characters long. The scopes must be valid and are visible
[in the source code](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/auth.rb).
For example, to create a token that belongs to a user with username `automation-bot` and expires in a year:
```ruby
user = User.find_by_username('automation-bot')
token = user.personal_access_tokens.create(scopes: ['read_user', 'read_repository'], name: 'Automation token', expires_at: 365.days.from_now)
token.set_token('token-string-here123')
token.save!
```
This code can be shortened into a single-line shell command by using the
[Rails runner](../../administration/operations/rails_console.md#using-the-rails-runner):
```shell
sudo gitlab-rails runner "token = User.find_by_username('automation-bot').personal_access_tokens.create(scopes: ['read_user', 'read_repository'], name: 'Automation token', expires_at: 365.days.from_now); token.set_token('token-string-here123'); token.save!"
```
## Revoke a personal access token programmatically
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can programmatically revoke a personal access token
as part of your tests or automation.
Prerequisites:
- You need sufficient access to run a [Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session)
for your GitLab instance.
To revoke a token programmatically:
1. Open a Rails console:
```shell
sudo gitlab-rails console
```
1. To revoke a token of `token-string-here123`, run the following commands:
```ruby
token = PersonalAccessToken.find_by_token('token-string-here123')
token.revoke!
```
This code can be shortened into a single-line shell command using the
[Rails runner](../../administration/operations/rails_console.md#using-the-rails-runner):
```shell
sudo gitlab-rails runner "PersonalAccessToken.find_by_token('token-string-here123').revoke!"
```
## Clone repository using personal access token
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To clone a repository when SSH is disabled, clone it using a personal access token by running the following command:
```shell
git clone https://<username>:<personal_token>@gitlab.com/gitlab-org/gitlab.git
```
This method saves your personal access token in your bash history. To avoid this, run the following command:
```shell
git clone https://<username>@gitlab.com/gitlab-org/gitlab.git
```
When asked for your password for `https://gitlab.com`, enter your personal access token.
The `username` in the `clone` command:
- Can be any string value.
- Must not be an empty string.
Remember this if you set up an automation pipeline that depends on authentication.
## Troubleshooting
### Unrevoke a personal access token
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
If a personal access token is revoked accidentally by any method, administrators can unrevoke that token. By default, a daily job deletes revoked tokens at 1:00 AM system time.
{{< alert type="warning" >}}
Running the following commands changes data directly. This could be damaging if not done correctly, or under the right conditions. You should first run these commands in a test environment with a backup of the instance ready to be restored, just in case.
{{< /alert >}}
1. Open a [Rails console](../../administration/operations/rails_console.md#starting-a-rails-console-session).
1. Unrevoke the token:
```ruby
token = PersonalAccessToken.find_by_token('<token_string>')
token.update!(revoked:false)
```
For example, to unrevoke a token of `token-string-here123`:
```ruby
token = PersonalAccessToken.find_by_token('token-string-here123')
token.update!(revoked:false)
```
## Alternatives to personal access tokens
For Git over HTTPS, an alternative to personal access tokens is to use an [OAuth credential helper](account/two_factor_authentication.md#oauth-credential-helpers).
|
https://docs.gitlab.com/user/notifications
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/notifications.md
|
2025-08-13
|
doc/user/profile
|
[
"doc",
"user",
"profile"
] |
notifications.md
|
Growth
|
Engagement
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Notification emails
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Enhanced email styling [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78604) in GitLab 14.9 [with a feature flag](../../administration/feature_flags/_index.md) named `enhanced_notify_css`. Disabled by default.
- Enhanced email styling [enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/355907) in GitLab 14.9.
- Enhanced email styling [enabled on GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/355907) in GitLab 15.0.
- Enhanced email styling [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/355907) in GitLab 18.3. Feature flag `enhanced_notify_css` removed.
- Product marketing emails [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/418137) in GitLab 16.6.
{{< /history >}}
Stay informed about what's happening in GitLab with email notifications.
You can receive updates about activity in issues, merge requests, epics, and designs.
For the tool that GitLab administrators can use to send messages to users, read
[Email from GitLab](../../administration/email_from_gitlab.md).
In GitLab 17.2 and later, [notifications are rate limited](../../security/rate_limits.md#notification-emails)
per 24 hours per project or group per user.
## Who receives notifications
When notifications are enabled for an issue, merge request, or epic, GitLab notifies you of actions
that happen there.
You might receive notifications for one of the following reasons:
- You participate in an issue, merge request, epic, or design. You become a participant when you comment
or edit, or someone mentions <sup>1</sup> you.
- You've [enabled notifications in an issue, merge request, or epic](#notifications-on-issues-merge-requests-and-epics).
- You've configured notifications for the [project](#change-level-of-project-notifications) or [group](#group-notifications).
- You're subscribed to group or project pipeline notifications through the pipeline emails [integration](../project/integrations/_index.md).
GitLab does not send a notification when:
- The account is a project bot.
- The account is a service account with default email address.
- The account is blocked (banned) or deactivated.
- [A comment is edited to include a user mention](../discussions/_index.md#edit-a-comment-to-add-a-mention).
- An administrator has blocked notifications.
## Global notification settings
Your global notification settings are the default settings, unless you specify
different settings for a project or a group.
For example, you might want to be notified about all activity in a specific project.
For other projects, you only want to be notified when you are mentioned by name.
These notification settings apply only to you. They do not affect the notifications received by
anyone else.
### Edit notification settings
To edit your notification settings:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. On the left sidebar, select **Notifications**.
1. In **Global notification email**, enter the email address your notifications are sent to.
Defaults to your primary email address.
1. For **Global notification level**, select the default [notification level](#notification-levels)
to apply to your notifications.
1. Select the **Receive notifications about your own activity** checkbox to receive
notifications about your own activity. Not selected by default.
### Notification levels
For each project and group you can select one of the following levels:
| Level | Description |
| ----------- | ----------- |
| Global | Your default global settings apply. |
| Watch | Receive notifications for [most activity](#events-not-included-in-the-watch-level). |
| Participate | Receive notifications for threads you have participated in. |
| On mention | Receive notifications when you are [mentioned](../discussions/_index.md#mentions) in a comment. |
| Disabled | Receive no notifications. |
| Custom | Receive notifications for selected events and threads you have participated in. |
### Notification scope
You can tune the scope of your notifications by selecting different notification levels for each
project and group.
Notification scope is applied from the broadest to most specific levels:
- Your global, or _default_, notification level applies if you
have not selected a notification level for the project or group in which the activity occurred.
- Your group setting overrides your default setting.
- Your project setting overrides the group setting.
When you set the notification level to **Global** for a project or subgroup, it does not directly inherit your global notification settings.
Instead, it goes up the hierarchy and inherits the next non-global notification level that is configured, in the following order:
1. The project setting.
1. The parent group setting.
1. The ancestor groups' settings (going up the hierarchy).
1. The global notification setting as the final fallback setting.
For example, you set your default global notification setting to **Watch**, and your group and project notification levels as follows:
```mermaid
%%{init: { "fontFamily": "GitLab Sans", 'theme':'neutral' }}%%
flowchart TD
accTitle: Notification hierarchy
accDescr: Example of a group, subgroup, and project
N[Default/global notification level set to Watch]
N --> A
A[Group A: Notification level set to Global]
A-. Inherits Watch level .-> N
A --> B[Subgroup B: Notification level set to Participate]
B --> C[Project C: Notification level set to Global]
C-. Inherits Participate level .-> B
```
Project C inherits the **Participate** notification level from subgroup B.
It does not inherit the **Watch** notification level from your global notification settings.
### Group notifications
You can select a notification level and email address for each group.
#### Change level of group notifications
To select a notification level for a group, use either of these methods:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. On the left sidebar, select **Notifications**.
1. Locate the group in the **Groups** section.
1. Select the desired [notification level](#notification-levels).
Or:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select the notification dropdown list, next to the bell icon ({{< icon name="notifications" >}}).
1. Select the desired [notification level](#notification-levels).
#### Change email address used for group notifications
You can select an email address to receive notifications for each group you belong to.
You can use group notifications, for example, if you work freelance, and want to keep email about clients' projects separate.
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. On the left sidebar, select **Notifications**.
1. Locate the group in the **Groups** section.
1. Select the desired email address.
### Change level of project notifications
To help you stay up to date, you can select a notification level for each project.
To select a notification level for a project, use either of these methods:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. On the left sidebar, select **Notifications**.
1. Locate the project in the **Projects** section.
1. Select the desired [notification level](#notification-levels).
Or:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select the notification dropdown list, next to the bell icon ({{< icon name="notifications" >}}).
1. Select the desired [notification level](#notification-levels).
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
To learn how to be notified when a new release is available, watch [Notification for releases](https://www.youtube.com/watch?v=qyeNkGgqmH4).
## Notification events
Users are notified of the following events:
<!-- The table is sorted first by recipient, then alphabetically. -->
| Event | Sent to | Settings level |
|------------------------------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| New release | Project members | Custom notification. |
| Project moved | Project members | Any other than disabled. |
| Email changed | User | Security email, always sent. |
| Group access level changed | User | Sent when user group access level is changed. |
| New email address added | User | Security email, sent to primary email address. |
| New email address added | User | Security email, sent to newly-added email address. |
| New SAML/SCIM user provisioned | User | Sent when a user is provisioned through SAML/SCIM. |
| New SSH key added | User | Security email, always sent. |
| New user created | User | Sent on user creation, except for OmniAuth (LDAP). |
| Password changed | User | Security email, always sent when user changes their own password. |
| Password changed by administrator | User | Security email, always sent when an administrator changes the password of another user. |
| Personal access tokens expiring soon | User | Security email, always sent. |
| Personal access tokens have been created | User | Security email, always sent. |
| Personal access tokens have expired | User | Security email, always sent. |
| Personal access token has been revoked | User | Security email, always sent. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/98911) in GitLab 15.5. |
| Project deploy tokens expiring soon | Project owners and maintainers | Security email, always sent. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/512197) in GitLab 18.3. |
| Personal access token has been rotated | User | Security email, always sent. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/199360) in GitLab 18.3. |
| Group access tokens expiring soon | Direct Group Owners | Security email, always sent. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367705) in GitLab 16.4. |
| Project access tokens expiring soon | Direct Project Owners and Maintainers | Security email, always sent. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367706) in GitLab 16.4. |
| Project access level changed | User | Sent when user project access level is changed. |
| SSH key has expired | User | Security email, always sent. |
| Two-factor authentication disabled | User | Security email, always sent. |
| User added to group | User | Sent when user is added to group. |
| User added to project | User | Sent when user is added to project. |
| Group access expired | Group members | Sent when user's access to a group expires in seven days. _[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12704) in GitLab 16.3._ |
| Project access expired | Project members | Sent when user's access to a project expires in seven days. _[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12704) in GitLab 16.3._ |
| Group scheduled for deletion | Group Owners | Sent when group is scheduled for deletion. _[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/522883) in GitLab 17.11_ |
| Project scheduled for deletion | Project Owners | Sent when project is scheduled for deletion. _[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/522883) in GitLab 17.11_ |
## Notifications on issues, merge requests, and epics
You also receive notifications for events happening on
issues, merge requests, and epics.
### Who receives notifications on issues, merge requests, and epics
In issues, merge requests, and epics, for most events, the notification is sent to:
- Participants:
- The author and assignee.
- Authors of comments.
- Anyone [mentioned](../discussions/_index.md#mentions) by username in the title
or description.
- Anyone mentioned by username in a comment if their notification level is "Participating" or higher.
- Watchers: users with notification level "Watch" ([with some exceptions](#events-not-included-in-the-watch-level)).
- Subscribers: anyone who manually subscribed to notifications.
- Custom: users with notification level "Custom" who turned on notifications for a fitting type of events.
To minimize the number of notifications that do not require any action, eligible
approvers are not notified for all the activities in their projects.
To get notified about all events, change your user notification settings to **Custom** and select
all the options.
#### Events not included in the Watch level
If you set the notification level to **Watch**, you get notified about almost all events, with
these exceptions:
- Somebody pushes to a merge request.
- Issue is due the next day.
- Pipeline succeeds.
- Merge request that you're eligible to approve is created.
Issue [501083](https://gitlab.com/gitlab-org/gitlab/-/issues/501083) tracks adding these events to
the **Watch** level.
### Edit notification settings for issues, merge requests, and epics
To toggle notifications on an issue, merge request, or epic: on the right sidebar,
select the vertical ellipsis ({{< icon name="ellipsis_v" >}}), then turn on or off the **Notifications** toggle.
#### Moved notifications
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132678) in GitLab 16.5 [with a flag](../../administration/feature_flags/_index.md) named `notifications_todos_buttons`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag. For more information, see the history. Enabling this feature flag moves the notifications and to-do item buttons to the upper-right corner of the page.
{{< /alert >}}
When you **turn on** notifications, you start receiving notifications on each update, even if you
haven't participated in the discussion.
When you turn notifications on in an epic, you aren't automatically subscribed to the issues linked
to the epic.
When you **turn off** notifications, you stop receiving notifications for updates.
Turning this toggle off only unsubscribes you from updates related to this issue, merge request, or epic.
Learn how to [opt out of all emails from GitLab](#opt-out-of-all-gitlab-emails).
### Notification events on issues, merge requests, and epics
{{< history >}}
- Service account pipeline notifications [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/178740) in GitLab 18.1.
{{< /history >}}
The following table presents the events that generate notifications for issues, merge requests, and
epics:
<!-- For issue due timing source, see 'issue_due_scheduler_worker' in https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/initializers/1_settings.rb -->
| Type | Event | Sent to |
|------|-------|---------|
| Epic | Closed | Subscribers and participants. |
| Epic | New | Anyone mentioned by username in the description, with notification level "Mention" or higher. |
| Epic | New note | Participants, Watchers, Subscribers, and Custom notification level with this event selected. Also anyone mentioned by username in the comment, with notification level "Mention" or higher. |
| Epic | Reopened | Subscribers and participants. |
| Issue | Closed | Subscribers and participants. |
| Issue | Due tomorrow. The notification is sent at 00:50 in the server's time zone (for GitLab.com this is UTC) for open issues with a due date of the next calendar day. | Participants and Custom notification level with this event selected. |
| Issue | Milestone changed | Subscribers and participants. |
| Issue | Milestone removed | Subscribers and participants. |
| Issue | New | Anyone mentioned by username in the description, with notification level "Mention" or higher. |
| Issue | New note | Participants, Watchers, Subscribers, and Custom notification level with this event selected. Also anyone mentioned by username in the comment, with notification level "Mention" or higher. |
| Issue | Title or description changed | Any new mentions by username. |
| Issue | Reassigned | Participants, Watchers, Subscribers, Custom notification level with this event selected, and the old assignee. |
| Issue | Reopened | Subscribers and participants. |
| Merge Request | Closed | Subscribers and participants. |
| Merge Request | Conflict | Author and any user that has set the merge request to auto-merge. |
| Merge Request | [Marked as ready](../project/merge_requests/drafts.md) | Watchers and participants. |
| Merge Request | Merged | Subscribers and participants. |
| Merge Request | Merged when pipeline succeeds | Author, Participants, Watchers, Subscribers, and Custom notification level with this event selected. Custom notification level is ignored for Author, Watchers and Subscribers. |
| Merge Request | Milestone changed | Subscribers and participants. |
| Merge Request | Milestone removed | Subscribers and participants. |
| Merge Request | New | Anyone mentioned by username in the description, with notification level "Mention" or higher. |
| Merge Request | New note | Participants, Watchers, Subscribers, and Custom notification level with this event selected. Also anyone mentioned by username in the comment, with notification level "Mention" or higher. |
| Merge Request | Pushed | Participants and Custom notification level with this event selected. |
| Merge Request | Reassigned | Participants, Watchers, Subscribers, Custom notification level with this event selected, and the old assignee. |
| Merge Request | Review requested | Participants, Watchers, Subscribers, Custom notification level with this event selected, and the old reviewer. |
| Merge Request | Reopened | Subscribers and participants. |
| Merge Request | Title or description changed | Any new mentions by username. |
| Merge Request | Merge request you're [eligible to approve](../project/merge_requests/approvals/rules.md#eligible-approvers) is created | Custom notification level with this event selected. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12855) in GitLab 16.7. [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/465347) from "Added as approver" in GitLab 17.11. |
| Pipeline | Failed | The author of the pipeline. |
| Pipeline | Fixed | The author of the pipeline. Enabled by default. |
| Pipeline | Successful | The author of the pipeline, with Custom notification level for successful pipelines. If the pipeline failed previously, a "Fixed pipeline" message is sent for the first successful pipeline after the failure, and then a "Successful pipeline" message for any further successful pipelines. |
| Pipeline by service account | Failed | Custom notification level for failed pipelines triggered by service accounts. |
| Pipeline by service account | Fixed | Custom notification level for fixed pipelines triggered by service accounts. |
| Pipeline by service account | Successful | Custom notification level for successful pipelines triggered by service accounts. |
By default, you don't receive notifications for issues, merge requests, or epics created by yourself.
To always receive notifications on your own issues, merge requests, and so on, turn on
[notifications about your own activity](#global-notification-settings).
## Notifications for unknown sign-ins
{{< history >}}
- Listing the full name and username of the signed-in user [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225183) in GitLab 15.10.
- Geographic location [added](https://gitlab.com/gitlab-org/gitlab/-/issues/296128) in GitLab 17.5.
{{< /history >}}
{{< alert type="note" >}}
This feature is enabled by default for GitLab Self-Managed instances. Administrators may disable this feature
through the [Sign-in restrictions](../../administration/settings/sign_in_restrictions.md#email-notification-for-unknown-sign-ins) section of the UI.
The feature is always enabled on GitLab.com.
{{< /alert >}}
When a user successfully signs in from a previously unknown IP address or device,
GitLab notifies the user by email. In this way, GitLab proactively alerts users of potentially
malicious or unauthorized sign-ins. This notification email includes the:
- Hostname.
- User's name and username.
- IP address.
- Geographic location.
- Date and time of sign-in.
GitLab uses several methods to identify a known sign-in. All methods must fail for a notification email to be sent.
- Last sign-in IP: The current sign-in IP address is checked against the last sign-in
IP address.
- Current active sessions: If the user has an existing active session from the
same IP address. See [Active sessions](active_sessions.md).
- Cookie: After successful sign in, an encrypted cookie is stored in the browser.
This cookie is set to expire 14 days after the last successful sign in.
## Notifications for attempted sign-ins using incorrect verification codes
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/374740) in GitLab 15.5.
{{< /history >}}
GitLab sends you an email notification if it detects an attempt to sign in to your account using a wrong two-factor
authentication (2FA) code. This can help you detect that a bad actor gained access to your username and password, and is trying
to brute force 2FA.
## Notifications on designs
Email notifications are sent to the participants when someone comments on a design.
The participants are:
- Authors of the design (can be multiple people if different authors have uploaded different versions of the design).
- Authors of comments on the design.
- Anyone that is [mentioned](../discussions/_index.md#mentions) in a comment on the design.
## Notifications on group or project access expiration
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12704) in GitLab 16.3.
{{< /history >}}
GitLab sends an email notification if a user's access to a group or project expires in seven days.
This reminds group or project members to extend their access duration if they want to.
## Opt out of all GitLab emails
If you no longer wish to receive any email notifications:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. On the left sidebar, select **Notifications**.
1. Set your **Global notification level** to **Disabled**.
1. Clear the **Receive notifications about your own activity** checkbox.
1. If you belong to any groups or projects, set their notification setting to **Global** or
**Disabled**.
On GitLab Self-Managed instances, even after doing this, your instance administrator
[can still email you](../../administration/email_from_gitlab.md).
## Unsubscribe from notification emails
You can unsubscribe from notification emails from GitLab on a per-resource basis (for example a specific issue).
### Using the unsubscribe link
Every notification email from GitLab contains an unsubscribe link at the bottom.
To unsubscribe:
1. Select the unsubscribe link in the email.
1. If you are signed in to GitLab in your browser, you are unsubscribed immediately.
1. If you are not signed in, you need to confirm the action.
### Using an email client or other software
Your email client might show an **Unsubscribe** button when you view an email from GitLab.
To unsubscribe, select this button.
Notification emails from GitLab contain special headers.
These headers allow supported email clients and other software
to unsubscribe users automatically. Here's an example:
```plaintext
List-Unsubscribe: <https://gitlab.com/-/sent_notifications/[REDACTED]/unsubscribe>,<mailto:incoming+[REDACTED]-unsubscribe@incoming.gitlab.com>
List-Unsubscribe-Post: List-Unsubscribe=One-Click
```
The `List-Unsubscribe` header has two entries:
- A link for software to send a `POST` request.
This action directly unsubscribes the user from the resource.
Sending a `GET` request to this link shows a confirmation dialog instead of unsubscribing.
- An email address for software to send an unsubscribe email.
The content of the email is ignored.
## Email headers you can use to filter email
Notification email messages include GitLab-specific headers. To better manage your notifications,
you can filter the notification emails based on the content of these headers.
For example, you could filter all emails from a specific project where you are being assigned a
merge request or an issue.
The following table lists all GitLab-specific email headers:
| Header | Description |
|-------------------------------|-------------|
| `List-Id` | The path of the project in an RFC 2919 mailing list identifier. You can use it for email organization with filters. |
| `X-GitLab-(Resource)-ID` | The ID of the resource the notification is for. The resource, for example, can be `Issue`, `MergeRequest`, `Commit`, or another such resource. |
| `X-GitLab-(Resource)-State` | The state of the resource the notification is for. The resource can be, for example, `Issue` or `MergeRequest`. The value can be `opened`, `closed`, `merged`, or `locked`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130967) in GitLab 16.4. |
| `X-GitLab-ConfidentialIssue` | The boolean value indicating issue confidentiality for notifications. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/222908) in GitLab 16.0. |
| `X-GitLab-Discussion-ID` | The ID of the thread the comment belongs to, in notification emails for comments. |
| `X-GitLab-Group-Id` | The group's ID. Only present on notification emails for [epics](../group/epics/_index.md). |
| `X-GitLab-Group-Path` | The group's path. Only present on notification emails for [epics](../group/epics/_index.md). |
| `X-GitLab-NotificationReason` | The reason for the notification. [See possible values](#x-gitlab-notificationreason). |
| `X-GitLab-Pipeline-Id` | The ID of the pipeline the notification is for, in notification emails for pipelines. |
| `X-GitLab-Project-Id` | The project's ID. |
| `X-GitLab-Project-Path` | The project's path. |
| `X-GitLab-Project` | The name of the project the notification belongs to. |
| `X-GitLab-Reply-Key` | A unique token to support reply by email. |
### X-GitLab-NotificationReason
The `X-GitLab-NotificationReason` header contains the reason for the notification.
The value is one of the following, in order of priority:
- `own_activity`
- `assigned`
- `review_requested`
- `mentioned`
- `subscribed`
The reason for the notification is also included in the footer of the notification email.
For example, an email with the reason `assigned` has this sentence in the footer:
```plaintext
You are receiving this email because you have been assigned an item on <configured GitLab hostname>.
```
#### On-call alerts notifications
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
An [on-call alert](../../operations/incident_management/oncall_schedules.md)
notification email can have one of [the alert's](../../operations/incident_management/alerts.md) statuses:
- `alert_triggered`
- `alert_acknowledged`
- `alert_resolved`
- `alert_ignored`
#### Incident escalation notifications
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
An [incident escalation](../../operations/incident_management/escalation_policies.md)
notification email can have one of [the incident's](../../operations/incident_management/incidents.md) status:
- `incident_triggered`
- `incident_acknowledged`
- `incident_resolved`
- `incident_ignored`
Expanding the list of events included in the `X-GitLab-NotificationReason` header is tracked in
[issue 20689](https://gitlab.com/gitlab-org/gitlab/-/issues/20689).
## Troubleshooting
### Pull a list of recipients for notifications
If you want to pull a list of recipients to receive notifications from a project
(mainly used for troubleshooting custom notifications),
in a Rails console, run `sudo gitlab-rails c` and be sure to update the project name:
```plaintext
project = Project.find_by_full_path '<project_name>'
merge_request = project.merge_requests.find_by(iid: 1)
current_user = User.first
recipients = NotificationRecipients::BuildService.build_recipients(merge_request, current_user, action: "push_to"); recipients.count
recipients.each { |notify| puts notify.user.username }
```
### Notifications about failed pipeline that doesn't exist
If you receive notifications (through email or Slack) regarding a failed pipeline that no longer
exists, double-check to see if you have any duplicate GitLab instances that could have triggered the
message.
### Email notifications are enabled, but not received
If you've enabled email notifications in GitLab, but users aren't receiving notifications as expected, ensure that
your email provider isn't blocking emails from your GitLab instance. Many email providers (like Outlook) block emails
coming from lesser-known self-managed mail server IP addresses. To verify, attempt to send an email
directly from the SMTP server for your instance. For example, a test email from Sendmail might look something like:
```plaintext
# (echo subject: test; echo) | $(which sendmail) -v -Am -i <valid email address>
```
If your email provider is blocking the message, you might get output like the following (depending on your email provider and SMTP server):
```plaintext
Diagnostic-Code: smtp; 550 5.7.1 Unfortunately, messages from [xx.xx.xx.xx]
weren't sent. For more information, please go to
http://go.microsoft.com/fwlink/?LinkID=526655 (http://go.microsoft.com/fwlink/?LinkID=526655) AS(900)
```
Usually this issue can be resolved by adding the IP address of your SMTP server to your
mail provider's allowlist. Check your mail provider's documentation for instructions.
|
---
stage: Growth
group: Engagement
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Notification emails
breadcrumbs:
- doc
- user
- profile
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Enhanced email styling [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78604) in GitLab 14.9 [with a feature flag](../../administration/feature_flags/_index.md) named `enhanced_notify_css`. Disabled by default.
- Enhanced email styling [enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/355907) in GitLab 14.9.
- Enhanced email styling [enabled on GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/355907) in GitLab 15.0.
- Enhanced email styling [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/355907) in GitLab 18.3. Feature flag `enhanced_notify_css` removed.
- Product marketing emails [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/418137) in GitLab 16.6.
{{< /history >}}
Stay informed about what's happening in GitLab with email notifications.
You can receive updates about activity in issues, merge requests, epics, and designs.
For the tool that GitLab administrators can use to send messages to users, read
[Email from GitLab](../../administration/email_from_gitlab.md).
In GitLab 17.2 and later, [notifications are rate limited](../../security/rate_limits.md#notification-emails)
per 24 hours per project or group per user.
## Who receives notifications
When notifications are enabled for an issue, merge request, or epic, GitLab notifies you of actions
that happen there.
You might receive notifications for one of the following reasons:
- You participate in an issue, merge request, epic, or design. You become a participant when you comment
or edit, or someone mentions <sup>1</sup> you.
- You've [enabled notifications in an issue, merge request, or epic](#notifications-on-issues-merge-requests-and-epics).
- You've configured notifications for the [project](#change-level-of-project-notifications) or [group](#group-notifications).
- You're subscribed to group or project pipeline notifications through the pipeline emails [integration](../project/integrations/_index.md).
GitLab does not send a notification when:
- The account is a project bot.
- The account is a service account with default email address.
- The account is blocked (banned) or deactivated.
- [A comment is edited to include a user mention](../discussions/_index.md#edit-a-comment-to-add-a-mention).
- An administrator has blocked notifications.
## Global notification settings
Your global notification settings are the default settings, unless you specify
different settings for a project or a group.
For example, you might want to be notified about all activity in a specific project.
For other projects, you only want to be notified when you are mentioned by name.
These notification settings apply only to you. They do not affect the notifications received by
anyone else.
### Edit notification settings
To edit your notification settings:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. On the left sidebar, select **Notifications**.
1. In **Global notification email**, enter the email address your notifications are sent to.
Defaults to your primary email address.
1. For **Global notification level**, select the default [notification level](#notification-levels)
to apply to your notifications.
1. Select the **Receive notifications about your own activity** checkbox to receive
notifications about your own activity. Not selected by default.
### Notification levels
For each project and group you can select one of the following levels:
| Level | Description |
| ----------- | ----------- |
| Global | Your default global settings apply. |
| Watch | Receive notifications for [most activity](#events-not-included-in-the-watch-level). |
| Participate | Receive notifications for threads you have participated in. |
| On mention | Receive notifications when you are [mentioned](../discussions/_index.md#mentions) in a comment. |
| Disabled | Receive no notifications. |
| Custom | Receive notifications for selected events and threads you have participated in. |
### Notification scope
You can tune the scope of your notifications by selecting different notification levels for each
project and group.
Notification scope is applied from the broadest to most specific levels:
- Your global, or _default_, notification level applies if you
have not selected a notification level for the project or group in which the activity occurred.
- Your group setting overrides your default setting.
- Your project setting overrides the group setting.
When you set the notification level to **Global** for a project or subgroup, it does not directly inherit your global notification settings.
Instead, it goes up the hierarchy and inherits the next non-global notification level that is configured, in the following order:
1. The project setting.
1. The parent group setting.
1. The ancestor groups' settings (going up the hierarchy).
1. The global notification setting as the final fallback setting.
For example, you set your default global notification setting to **Watch**, and your group and project notification levels as follows:
```mermaid
%%{init: { "fontFamily": "GitLab Sans", 'theme':'neutral' }}%%
flowchart TD
accTitle: Notification hierarchy
accDescr: Example of a group, subgroup, and project
N[Default/global notification level set to Watch]
N --> A
A[Group A: Notification level set to Global]
A-. Inherits Watch level .-> N
A --> B[Subgroup B: Notification level set to Participate]
B --> C[Project C: Notification level set to Global]
C-. Inherits Participate level .-> B
```
Project C inherits the **Participate** notification level from subgroup B.
It does not inherit the **Watch** notification level from your global notification settings.
### Group notifications
You can select a notification level and email address for each group.
#### Change level of group notifications
To select a notification level for a group, use either of these methods:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. On the left sidebar, select **Notifications**.
1. Locate the group in the **Groups** section.
1. Select the desired [notification level](#notification-levels).
Or:
1. On the left sidebar, select **Search or go to** and find your group.
1. Select the notification dropdown list, next to the bell icon ({{< icon name="notifications" >}}).
1. Select the desired [notification level](#notification-levels).
#### Change email address used for group notifications
You can select an email address to receive notifications for each group you belong to.
You can use group notifications, for example, if you work freelance, and want to keep email about clients' projects separate.
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. On the left sidebar, select **Notifications**.
1. Locate the group in the **Groups** section.
1. Select the desired email address.
### Change level of project notifications
To help you stay up to date, you can select a notification level for each project.
To select a notification level for a project, use either of these methods:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. On the left sidebar, select **Notifications**.
1. Locate the project in the **Projects** section.
1. Select the desired [notification level](#notification-levels).
Or:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select the notification dropdown list, next to the bell icon ({{< icon name="notifications" >}}).
1. Select the desired [notification level](#notification-levels).
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
To learn how to be notified when a new release is available, watch [Notification for releases](https://www.youtube.com/watch?v=qyeNkGgqmH4).
## Notification events
Users are notified of the following events:
<!-- The table is sorted first by recipient, then alphabetically. -->
| Event | Sent to | Settings level |
|------------------------------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| New release | Project members | Custom notification. |
| Project moved | Project members | Any other than disabled. |
| Email changed | User | Security email, always sent. |
| Group access level changed | User | Sent when user group access level is changed. |
| New email address added | User | Security email, sent to primary email address. |
| New email address added | User | Security email, sent to newly-added email address. |
| New SAML/SCIM user provisioned | User | Sent when a user is provisioned through SAML/SCIM. |
| New SSH key added | User | Security email, always sent. |
| New user created | User | Sent on user creation, except for OmniAuth (LDAP). |
| Password changed | User | Security email, always sent when user changes their own password. |
| Password changed by administrator | User | Security email, always sent when an administrator changes the password of another user. |
| Personal access tokens expiring soon | User | Security email, always sent. |
| Personal access tokens have been created | User | Security email, always sent. |
| Personal access tokens have expired | User | Security email, always sent. |
| Personal access token has been revoked | User | Security email, always sent. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/98911) in GitLab 15.5. |
| Project deploy tokens expiring soon | Project owners and maintainers | Security email, always sent. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/512197) in GitLab 18.3. |
| Personal access token has been rotated | User | Security email, always sent. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/199360) in GitLab 18.3. |
| Group access tokens expiring soon | Direct Group Owners | Security email, always sent. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367705) in GitLab 16.4. |
| Project access tokens expiring soon | Direct Project Owners and Maintainers | Security email, always sent. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367706) in GitLab 16.4. |
| Project access level changed | User | Sent when user project access level is changed. |
| SSH key has expired | User | Security email, always sent. |
| Two-factor authentication disabled | User | Security email, always sent. |
| User added to group | User | Sent when user is added to group. |
| User added to project | User | Sent when user is added to project. |
| Group access expired | Group members | Sent when user's access to a group expires in seven days. _[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12704) in GitLab 16.3._ |
| Project access expired | Project members | Sent when user's access to a project expires in seven days. _[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12704) in GitLab 16.3._ |
| Group scheduled for deletion | Group Owners | Sent when group is scheduled for deletion. _[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/522883) in GitLab 17.11_ |
| Project scheduled for deletion | Project Owners | Sent when project is scheduled for deletion. _[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/522883) in GitLab 17.11_ |
## Notifications on issues, merge requests, and epics
You also receive notifications for events happening on
issues, merge requests, and epics.
### Who receives notifications on issues, merge requests, and epics
In issues, merge requests, and epics, for most events, the notification is sent to:
- Participants:
- The author and assignee.
- Authors of comments.
- Anyone [mentioned](../discussions/_index.md#mentions) by username in the title
or description.
- Anyone mentioned by username in a comment if their notification level is "Participating" or higher.
- Watchers: users with notification level "Watch" ([with some exceptions](#events-not-included-in-the-watch-level)).
- Subscribers: anyone who manually subscribed to notifications.
- Custom: users with notification level "Custom" who turned on notifications for a fitting type of events.
To minimize the number of notifications that do not require any action, eligible
approvers are not notified for all the activities in their projects.
To get notified about all events, change your user notification settings to **Custom** and select
all the options.
#### Events not included in the Watch level
If you set the notification level to **Watch**, you get notified about almost all events, with
these exceptions:
- Somebody pushes to a merge request.
- Issue is due the next day.
- Pipeline succeeds.
- Merge request that you're eligible to approve is created.
Issue [501083](https://gitlab.com/gitlab-org/gitlab/-/issues/501083) tracks adding these events to
the **Watch** level.
### Edit notification settings for issues, merge requests, and epics
To toggle notifications on an issue, merge request, or epic: on the right sidebar,
select the vertical ellipsis ({{< icon name="ellipsis_v" >}}), then turn on or off the **Notifications** toggle.
#### Moved notifications
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132678) in GitLab 16.5 [with a flag](../../administration/feature_flags/_index.md) named `notifications_todos_buttons`. Disabled by default.
{{< /history >}}
{{< alert type="flag" >}}
The availability of this feature is controlled by a feature flag. For more information, see the history. Enabling this feature flag moves the notifications and to-do item buttons to the upper-right corner of the page.
{{< /alert >}}
When you **turn on** notifications, you start receiving notifications on each update, even if you
haven't participated in the discussion.
When you turn notifications on in an epic, you aren't automatically subscribed to the issues linked
to the epic.
When you **turn off** notifications, you stop receiving notifications for updates.
Turning this toggle off only unsubscribes you from updates related to this issue, merge request, or epic.
Learn how to [opt out of all emails from GitLab](#opt-out-of-all-gitlab-emails).
### Notification events on issues, merge requests, and epics
{{< history >}}
- Service account pipeline notifications [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/178740) in GitLab 18.1.
{{< /history >}}
The following table presents the events that generate notifications for issues, merge requests, and
epics:
<!-- For issue due timing source, see 'issue_due_scheduler_worker' in https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/initializers/1_settings.rb -->
| Type | Event | Sent to |
|------|-------|---------|
| Epic | Closed | Subscribers and participants. |
| Epic | New | Anyone mentioned by username in the description, with notification level "Mention" or higher. |
| Epic | New note | Participants, Watchers, Subscribers, and Custom notification level with this event selected. Also anyone mentioned by username in the comment, with notification level "Mention" or higher. |
| Epic | Reopened | Subscribers and participants. |
| Issue | Closed | Subscribers and participants. |
| Issue | Due tomorrow. The notification is sent at 00:50 in the server's time zone (for GitLab.com this is UTC) for open issues with a due date of the next calendar day. | Participants and Custom notification level with this event selected. |
| Issue | Milestone changed | Subscribers and participants. |
| Issue | Milestone removed | Subscribers and participants. |
| Issue | New | Anyone mentioned by username in the description, with notification level "Mention" or higher. |
| Issue | New note | Participants, Watchers, Subscribers, and Custom notification level with this event selected. Also anyone mentioned by username in the comment, with notification level "Mention" or higher. |
| Issue | Title or description changed | Any new mentions by username. |
| Issue | Reassigned | Participants, Watchers, Subscribers, Custom notification level with this event selected, and the old assignee. |
| Issue | Reopened | Subscribers and participants. |
| Merge Request | Closed | Subscribers and participants. |
| Merge Request | Conflict | Author and any user that has set the merge request to auto-merge. |
| Merge Request | [Marked as ready](../project/merge_requests/drafts.md) | Watchers and participants. |
| Merge Request | Merged | Subscribers and participants. |
| Merge Request | Merged when pipeline succeeds | Author, Participants, Watchers, Subscribers, and Custom notification level with this event selected. Custom notification level is ignored for Author, Watchers and Subscribers. |
| Merge Request | Milestone changed | Subscribers and participants. |
| Merge Request | Milestone removed | Subscribers and participants. |
| Merge Request | New | Anyone mentioned by username in the description, with notification level "Mention" or higher. |
| Merge Request | New note | Participants, Watchers, Subscribers, and Custom notification level with this event selected. Also anyone mentioned by username in the comment, with notification level "Mention" or higher. |
| Merge Request | Pushed | Participants and Custom notification level with this event selected. |
| Merge Request | Reassigned | Participants, Watchers, Subscribers, Custom notification level with this event selected, and the old assignee. |
| Merge Request | Review requested | Participants, Watchers, Subscribers, Custom notification level with this event selected, and the old reviewer. |
| Merge Request | Reopened | Subscribers and participants. |
| Merge Request | Title or description changed | Any new mentions by username. |
| Merge Request | Merge request you're [eligible to approve](../project/merge_requests/approvals/rules.md#eligible-approvers) is created | Custom notification level with this event selected. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12855) in GitLab 16.7. [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/465347) from "Added as approver" in GitLab 17.11. |
| Pipeline | Failed | The author of the pipeline. |
| Pipeline | Fixed | The author of the pipeline. Enabled by default. |
| Pipeline | Successful | The author of the pipeline, with Custom notification level for successful pipelines. If the pipeline failed previously, a "Fixed pipeline" message is sent for the first successful pipeline after the failure, and then a "Successful pipeline" message for any further successful pipelines. |
| Pipeline by service account | Failed | Custom notification level for failed pipelines triggered by service accounts. |
| Pipeline by service account | Fixed | Custom notification level for fixed pipelines triggered by service accounts. |
| Pipeline by service account | Successful | Custom notification level for successful pipelines triggered by service accounts. |
By default, you don't receive notifications for issues, merge requests, or epics created by yourself.
To always receive notifications on your own issues, merge requests, and so on, turn on
[notifications about your own activity](#global-notification-settings).
## Notifications for unknown sign-ins
{{< history >}}
- Listing the full name and username of the signed-in user [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225183) in GitLab 15.10.
- Geographic location [added](https://gitlab.com/gitlab-org/gitlab/-/issues/296128) in GitLab 17.5.
{{< /history >}}
{{< alert type="note" >}}
This feature is enabled by default for GitLab Self-Managed instances. Administrators may disable this feature
through the [Sign-in restrictions](../../administration/settings/sign_in_restrictions.md#email-notification-for-unknown-sign-ins) section of the UI.
The feature is always enabled on GitLab.com.
{{< /alert >}}
When a user successfully signs in from a previously unknown IP address or device,
GitLab notifies the user by email. In this way, GitLab proactively alerts users of potentially
malicious or unauthorized sign-ins. This notification email includes the:
- Hostname.
- User's name and username.
- IP address.
- Geographic location.
- Date and time of sign-in.
GitLab uses several methods to identify a known sign-in. All methods must fail for a notification email to be sent.
- Last sign-in IP: The current sign-in IP address is checked against the last sign-in
IP address.
- Current active sessions: If the user has an existing active session from the
same IP address. See [Active sessions](active_sessions.md).
- Cookie: After successful sign in, an encrypted cookie is stored in the browser.
This cookie is set to expire 14 days after the last successful sign in.
## Notifications for attempted sign-ins using incorrect verification codes
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/374740) in GitLab 15.5.
{{< /history >}}
GitLab sends you an email notification if it detects an attempt to sign in to your account using a wrong two-factor
authentication (2FA) code. This can help you detect that a bad actor gained access to your username and password, and is trying
to brute force 2FA.
## Notifications on designs
Email notifications are sent to the participants when someone comments on a design.
The participants are:
- Authors of the design (can be multiple people if different authors have uploaded different versions of the design).
- Authors of comments on the design.
- Anyone that is [mentioned](../discussions/_index.md#mentions) in a comment on the design.
## Notifications on group or project access expiration
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12704) in GitLab 16.3.
{{< /history >}}
GitLab sends an email notification if a user's access to a group or project expires in seven days.
This reminds group or project members to extend their access duration if they want to.
## Opt out of all GitLab emails
If you no longer wish to receive any email notifications:
1. On the left sidebar, select your avatar.
1. Select **Preferences**.
1. On the left sidebar, select **Notifications**.
1. Set your **Global notification level** to **Disabled**.
1. Clear the **Receive notifications about your own activity** checkbox.
1. If you belong to any groups or projects, set their notification setting to **Global** or
**Disabled**.
On GitLab Self-Managed instances, even after doing this, your instance administrator
[can still email you](../../administration/email_from_gitlab.md).
## Unsubscribe from notification emails
You can unsubscribe from notification emails from GitLab on a per-resource basis (for example a specific issue).
### Using the unsubscribe link
Every notification email from GitLab contains an unsubscribe link at the bottom.
To unsubscribe:
1. Select the unsubscribe link in the email.
1. If you are signed in to GitLab in your browser, you are unsubscribed immediately.
1. If you are not signed in, you need to confirm the action.
### Using an email client or other software
Your email client might show an **Unsubscribe** button when you view an email from GitLab.
To unsubscribe, select this button.
Notification emails from GitLab contain special headers.
These headers allow supported email clients and other software
to unsubscribe users automatically. Here's an example:
```plaintext
List-Unsubscribe: <https://gitlab.com/-/sent_notifications/[REDACTED]/unsubscribe>,<mailto:incoming+[REDACTED]-unsubscribe@incoming.gitlab.com>
List-Unsubscribe-Post: List-Unsubscribe=One-Click
```
The `List-Unsubscribe` header has two entries:
- A link for software to send a `POST` request.
This action directly unsubscribes the user from the resource.
Sending a `GET` request to this link shows a confirmation dialog instead of unsubscribing.
- An email address for software to send an unsubscribe email.
The content of the email is ignored.
## Email headers you can use to filter email
Notification email messages include GitLab-specific headers. To better manage your notifications,
you can filter the notification emails based on the content of these headers.
For example, you could filter all emails from a specific project where you are being assigned a
merge request or an issue.
The following table lists all GitLab-specific email headers:
| Header | Description |
|-------------------------------|-------------|
| `List-Id` | The path of the project in an RFC 2919 mailing list identifier. You can use it for email organization with filters. |
| `X-GitLab-(Resource)-ID` | The ID of the resource the notification is for. The resource, for example, can be `Issue`, `MergeRequest`, `Commit`, or another such resource. |
| `X-GitLab-(Resource)-State` | The state of the resource the notification is for. The resource can be, for example, `Issue` or `MergeRequest`. The value can be `opened`, `closed`, `merged`, or `locked`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130967) in GitLab 16.4. |
| `X-GitLab-ConfidentialIssue` | The boolean value indicating issue confidentiality for notifications. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/222908) in GitLab 16.0. |
| `X-GitLab-Discussion-ID` | The ID of the thread the comment belongs to, in notification emails for comments. |
| `X-GitLab-Group-Id` | The group's ID. Only present on notification emails for [epics](../group/epics/_index.md). |
| `X-GitLab-Group-Path` | The group's path. Only present on notification emails for [epics](../group/epics/_index.md). |
| `X-GitLab-NotificationReason` | The reason for the notification. [See possible values](#x-gitlab-notificationreason). |
| `X-GitLab-Pipeline-Id` | The ID of the pipeline the notification is for, in notification emails for pipelines. |
| `X-GitLab-Project-Id` | The project's ID. |
| `X-GitLab-Project-Path` | The project's path. |
| `X-GitLab-Project` | The name of the project the notification belongs to. |
| `X-GitLab-Reply-Key` | A unique token to support reply by email. |
### X-GitLab-NotificationReason
The `X-GitLab-NotificationReason` header contains the reason for the notification.
The value is one of the following, in order of priority:
- `own_activity`
- `assigned`
- `review_requested`
- `mentioned`
- `subscribed`
The reason for the notification is also included in the footer of the notification email.
For example, an email with the reason `assigned` has this sentence in the footer:
```plaintext
You are receiving this email because you have been assigned an item on <configured GitLab hostname>.
```
#### On-call alerts notifications
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
An [on-call alert](../../operations/incident_management/oncall_schedules.md)
notification email can have one of [the alert's](../../operations/incident_management/alerts.md) statuses:
- `alert_triggered`
- `alert_acknowledged`
- `alert_resolved`
- `alert_ignored`
#### Incident escalation notifications
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
An [incident escalation](../../operations/incident_management/escalation_policies.md)
notification email can have one of [the incident's](../../operations/incident_management/incidents.md) status:
- `incident_triggered`
- `incident_acknowledged`
- `incident_resolved`
- `incident_ignored`
Expanding the list of events included in the `X-GitLab-NotificationReason` header is tracked in
[issue 20689](https://gitlab.com/gitlab-org/gitlab/-/issues/20689).
## Troubleshooting
### Pull a list of recipients for notifications
If you want to pull a list of recipients to receive notifications from a project
(mainly used for troubleshooting custom notifications),
in a Rails console, run `sudo gitlab-rails c` and be sure to update the project name:
```plaintext
project = Project.find_by_full_path '<project_name>'
merge_request = project.merge_requests.find_by(iid: 1)
current_user = User.first
recipients = NotificationRecipients::BuildService.build_recipients(merge_request, current_user, action: "push_to"); recipients.count
recipients.each { |notify| puts notify.user.username }
```
### Notifications about failed pipeline that doesn't exist
If you receive notifications (through email or Slack) regarding a failed pipeline that no longer
exists, double-check to see if you have any duplicate GitLab instances that could have triggered the
message.
### Email notifications are enabled, but not received
If you've enabled email notifications in GitLab, but users aren't receiving notifications as expected, ensure that
your email provider isn't blocking emails from your GitLab instance. Many email providers (like Outlook) block emails
coming from lesser-known self-managed mail server IP addresses. To verify, attempt to send an email
directly from the SMTP server for your instance. For example, a test email from Sendmail might look something like:
```plaintext
# (echo subject: test; echo) | $(which sendmail) -v -Am -i <valid email address>
```
If your email provider is blocking the message, you might get output like the following (depending on your email provider and SMTP server):
```plaintext
Diagnostic-Code: smtp; 550 5.7.1 Unfortunately, messages from [xx.xx.xx.xx]
weren't sent. For more information, please go to
http://go.microsoft.com/fwlink/?LinkID=526655 (http://go.microsoft.com/fwlink/?LinkID=526655) AS(900)
```
Usually this issue can be resolved by adding the IP address of your SMTP server to your
mail provider's allowlist. Check your mail provider's documentation for instructions.
|
https://docs.gitlab.com/user/profile/delete_account
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/profile/delete_account.md
|
2025-08-13
|
doc/user/profile/account
|
[
"doc",
"user",
"profile",
"account"
] |
delete_account.md
|
Software Supply Chain Security
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Deleting a user account
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Users can be deleted from a GitLab instance, either by:
- The user themselves.
- An administrator.
{{< alert type="note" >}}
Deleting a user deletes all projects in that user namespace.
{{< /alert >}}
## Delete your own account
{{< history >}}
- Delay between a user deleting their own account and deletion of the user record introduced in GitLab 16.0 [with a flag](../../../administration/feature_flags/_index.md) named `delay_delete_own_user`. Enabled by default on GitLab.com.
{{< /history >}}
{{< alert type="flag" >}}
- On GitLab.com, this feature is available.
- On GitLab Dedicated, this feature is not available.
- On GitLab Self-Managed, the availability of this feature is controlled by the `delay_user_account_self_deletion` application setting and is disabled by default. Use the [Application settings API](../../../api/settings.md) to enable the
`delay_user_account_self_deletion` setting for the instance.
{{< /alert >}}
On GitLab.com, it takes seven days from when you delete your own account to when your account is deleted. During this time:
- That user is [blocked](../../../administration/moderate_users.md#block-a-user).
- You cannot create a new account with the same username.
{{< alert type="note" >}}
After the seven day time period is finished, any user can create a user account with that previously used username. Therefore, you should not assume that you will be able to create a new account with that username after the seven days, because it might be taken.
{{< /alert >}}
You can [create a new account with the same email address](#create-a-new-account-with-the-same-email-address)
if you remove that email address from your account first.
The following are deleted within an hour:
- Accounts with no issues, comments, notes, merge requests, or snippets.
- Accounts under paid namespaces.
As a user, to delete your own account:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Account**.
1. Select **Delete account**.
If you cannot delete your own account, submit a [personal data request](https://support.gitlab.io/personal-data-request/)
to ask for your account and data to be removed from GitLab.
### Create a new account with the same email address
On GitLab.com, during the [time between you deleting your own account and your account getting deleted](#delete-your-own-account),
you cannot create a new account with the same email address or username.
To create a new account with the same email address, before you delete your account:
1. [Add a secondary email address](../_index.md#add-emails-to-your-user-profile)
to your account.
1. [Change your primary email](../_index.md#change-your-primary-email) to this
new secondary email address.
1. [Remove the now-secondary email address](../_index.md#delete-email-addresses-from-your-user-profile)
from your account.
1. [Delete your own account](#delete-your-own-account).
You can now [create a new account](create_accounts.md) with the same email address as your original
primary email address.
## Delete users and user contributions
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
As an administrator, to delete a user account:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Overview > Users**.
1. Select a user.
1. Under the **Account** tab, select:
- **Delete user** to delete only the user but maintain their [associated records](#associated-records). You can't use this option if
the selected user is the sole owner of any groups.
- **Delete user and contributions** to delete the user and their associated records. This option also removes all groups (and
projects within these groups) where the user is the sole direct Owner of a group. Inherited ownership doesn't apply.
{{< alert type="warning" >}}
Using the **Delete user and contributions** option may result in removing more data than intended. See
[associated records](#associated-records) for additional details.
{{< /alert >}}
### Associated records
When deleting users, you can either:
- Delete just the user, but move contributions to a system-wide "Ghost User":
- The `@ghost` acts as a container for all deleted users' contributions.
- The user's profile and personal projects are deleted, instead of moved to the Ghost User.
- Delete the user and their contributions, including:
- Abuse reports.
- Emoji reactions.
- Groups of which the user is the only user with the Owner role.
- Personal access tokens.
- Epics.
- Issues.
- Merge requests.
- Snippets.
- [Notes and comments](../../../api/notes.md)
on other users' [commits](../../project/repository/_index.md#commit-changes-to-a-repository),
[epics](../../group/epics/_index.md),
[issues](../../project/issues/_index.md),
[merge requests](../../project/merge_requests/_index.md)
and [snippets](../../snippets.md).
In both cases, commits retain [user information](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects#_git_commit_objects)
and therefore data integrity within a [Git repository](../../project/repository/_index.md).
An alternative to deleting is [blocking a user](../../../administration/moderate_users.md#block-a-user).
When a user is deleted from an [abuse report](../../../administration/review_abuse_reports.md) or spam log, these associated
records are always removed.
The deleting associated records option can be requested in the [API](../../../api/users.md#delete-a-user) as well as
the **Admin** area.
{{< alert type="warning" >}}
User approvals are associated with a user ID. Other user contributions do not have an associated user ID. When you delete a user and their contributions are moved to a "Ghost User", the approval contributions refer to a missing or invalid user ID. Instead of deleting users, consider [blocking](../../../administration/moderate_users.md#block-a-user), [banning](../../../administration/moderate_users.md#ban-a-user), or [deactivating](../../../administration/moderate_users.md#deactivate-a-user) them.
{{< /alert >}}
## Delete the root account on a GitLab Self-Managed instance
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="warning" >}}
The root account is the most privileged account on the system. Deleting the root account might result in losing access to the instance [**Admin** area](../../../administration/admin_area.md) if there is no other administrator available on the instance.
{{< /alert >}}
You can delete the root account using either the UI or the [GitLab Rails console](../../../administration/operations/rails_console.md).
Before you delete the root account:
1. If you have created any [project](../../project/settings/project_access_tokens.md) or [personal access tokens](../personal_access_tokens.md) for the root account and use them in your workflow, transfer any necessary permissions or ownership from the root account to the new administrator.
1. [Back up your GitLab Self-Managed instance](../../../administration/backup_restore/backup_gitlab.md).
1. Consider [deactivating](../../../administration/moderate_users.md#deactivate-a-user) or [blocking](../../../administration/moderate_users.md#block-and-unblock-users) the root account instead.
### Use the UI
Prerequisites:
- You must be an administrator for the GitLab Self-Managed instance.
To delete the root account:
1. In the **Admin** area, [create a new user with administrator access](create_accounts.md#create-a-user-in-the-admin-area). This ensures that you maintain administrator access to the instance whilst mitigating the risks associated with deleting the root account.
1. [Delete the root account](#delete-users-and-user-contributions).
### Use the GitLab Rails console
{{< alert type="warning" >}}
Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore.
{{< /alert >}}
Prerequisites:
- You must have access to the GitLab Rails console.
To delete the root account, in the Rails console:
1. Give another existing user administrator access:
```ruby
user = User.find(username: 'Username') # or use User.find_by(email: 'email@example.com') to find by email
user.admin = true
user.save!
```
This ensures that you maintain administrator access to the instance whilst mitigating the risks associated with deleting the root account.
1. To delete the root account, do either of the following:
- Block the root account:
```ruby
# This needs to be a current admin user
current_user = User.find(username: 'Username')
# This is the root user we want to block
user = User.find(username: 'Username')
::Users::BlockService.new(current_user).execute(user)
```
- Deactivate the root user:
```ruby
# This needs to be a current admin user
current_user = User.find(username: 'Username')
# This is the root user we want to deactivate
user = User.find(username: 'Username')
::Users::DeactivateService.new(current_user, skip_authorization: true).execute(user)
```
## Troubleshooting
### Deleting a user results in a PostgreSQL null value error
There is [a known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/349411) that results
in users not being deleted, and the following error generated:
```plaintext
ERROR: null value in column "user_id" violates not-null constraint
```
The error can be found in the [PostgreSQL log](../../../administration/logs/_index.md#postgresql-logs) and
in the **Retries** section of the [background jobs view](../../../administration/admin_area.md#background-jobs) in the **Admin** area.
If the user being deleted used the [iterations](../../group/iterations/_index.md) feature, such
as adding an issue to an iteration, you must use
[the workaround documented in the issue](https://gitlab.com/gitlab-org/gitlab/-/issues/349411#workaround)
to delete the user.
|
---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Deleting a user account
breadcrumbs:
- doc
- user
- profile
- account
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Users can be deleted from a GitLab instance, either by:
- The user themselves.
- An administrator.
{{< alert type="note" >}}
Deleting a user deletes all projects in that user namespace.
{{< /alert >}}
## Delete your own account
{{< history >}}
- Delay between a user deleting their own account and deletion of the user record introduced in GitLab 16.0 [with a flag](../../../administration/feature_flags/_index.md) named `delay_delete_own_user`. Enabled by default on GitLab.com.
{{< /history >}}
{{< alert type="flag" >}}
- On GitLab.com, this feature is available.
- On GitLab Dedicated, this feature is not available.
- On GitLab Self-Managed, the availability of this feature is controlled by the `delay_user_account_self_deletion` application setting and is disabled by default. Use the [Application settings API](../../../api/settings.md) to enable the
`delay_user_account_self_deletion` setting for the instance.
{{< /alert >}}
On GitLab.com, it takes seven days from when you delete your own account to when your account is deleted. During this time:
- That user is [blocked](../../../administration/moderate_users.md#block-a-user).
- You cannot create a new account with the same username.
{{< alert type="note" >}}
After the seven day time period is finished, any user can create a user account with that previously used username. Therefore, you should not assume that you will be able to create a new account with that username after the seven days, because it might be taken.
{{< /alert >}}
You can [create a new account with the same email address](#create-a-new-account-with-the-same-email-address)
if you remove that email address from your account first.
The following are deleted within an hour:
- Accounts with no issues, comments, notes, merge requests, or snippets.
- Accounts under paid namespaces.
As a user, to delete your own account:
1. On the left sidebar, select your avatar.
1. Select **Edit profile**.
1. On the left sidebar, select **Account**.
1. Select **Delete account**.
If you cannot delete your own account, submit a [personal data request](https://support.gitlab.io/personal-data-request/)
to ask for your account and data to be removed from GitLab.
### Create a new account with the same email address
On GitLab.com, during the [time between you deleting your own account and your account getting deleted](#delete-your-own-account),
you cannot create a new account with the same email address or username.
To create a new account with the same email address, before you delete your account:
1. [Add a secondary email address](../_index.md#add-emails-to-your-user-profile)
to your account.
1. [Change your primary email](../_index.md#change-your-primary-email) to this
new secondary email address.
1. [Remove the now-secondary email address](../_index.md#delete-email-addresses-from-your-user-profile)
from your account.
1. [Delete your own account](#delete-your-own-account).
You can now [create a new account](create_accounts.md) with the same email address as your original
primary email address.
## Delete users and user contributions
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
As an administrator, to delete a user account:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Overview > Users**.
1. Select a user.
1. Under the **Account** tab, select:
- **Delete user** to delete only the user but maintain their [associated records](#associated-records). You can't use this option if
the selected user is the sole owner of any groups.
- **Delete user and contributions** to delete the user and their associated records. This option also removes all groups (and
projects within these groups) where the user is the sole direct Owner of a group. Inherited ownership doesn't apply.
{{< alert type="warning" >}}
Using the **Delete user and contributions** option may result in removing more data than intended. See
[associated records](#associated-records) for additional details.
{{< /alert >}}
### Associated records
When deleting users, you can either:
- Delete just the user, but move contributions to a system-wide "Ghost User":
- The `@ghost` acts as a container for all deleted users' contributions.
- The user's profile and personal projects are deleted, instead of moved to the Ghost User.
- Delete the user and their contributions, including:
- Abuse reports.
- Emoji reactions.
- Groups of which the user is the only user with the Owner role.
- Personal access tokens.
- Epics.
- Issues.
- Merge requests.
- Snippets.
- [Notes and comments](../../../api/notes.md)
on other users' [commits](../../project/repository/_index.md#commit-changes-to-a-repository),
[epics](../../group/epics/_index.md),
[issues](../../project/issues/_index.md),
[merge requests](../../project/merge_requests/_index.md)
and [snippets](../../snippets.md).
In both cases, commits retain [user information](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects#_git_commit_objects)
and therefore data integrity within a [Git repository](../../project/repository/_index.md).
An alternative to deleting is [blocking a user](../../../administration/moderate_users.md#block-a-user).
When a user is deleted from an [abuse report](../../../administration/review_abuse_reports.md) or spam log, these associated
records are always removed.
The deleting associated records option can be requested in the [API](../../../api/users.md#delete-a-user) as well as
the **Admin** area.
{{< alert type="warning" >}}
User approvals are associated with a user ID. Other user contributions do not have an associated user ID. When you delete a user and their contributions are moved to a "Ghost User", the approval contributions refer to a missing or invalid user ID. Instead of deleting users, consider [blocking](../../../administration/moderate_users.md#block-a-user), [banning](../../../administration/moderate_users.md#ban-a-user), or [deactivating](../../../administration/moderate_users.md#deactivate-a-user) them.
{{< /alert >}}
## Delete the root account on a GitLab Self-Managed instance
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="warning" >}}
The root account is the most privileged account on the system. Deleting the root account might result in losing access to the instance [**Admin** area](../../../administration/admin_area.md) if there is no other administrator available on the instance.
{{< /alert >}}
You can delete the root account using either the UI or the [GitLab Rails console](../../../administration/operations/rails_console.md).
Before you delete the root account:
1. If you have created any [project](../../project/settings/project_access_tokens.md) or [personal access tokens](../personal_access_tokens.md) for the root account and use them in your workflow, transfer any necessary permissions or ownership from the root account to the new administrator.
1. [Back up your GitLab Self-Managed instance](../../../administration/backup_restore/backup_gitlab.md).
1. Consider [deactivating](../../../administration/moderate_users.md#deactivate-a-user) or [blocking](../../../administration/moderate_users.md#block-and-unblock-users) the root account instead.
### Use the UI
Prerequisites:
- You must be an administrator for the GitLab Self-Managed instance.
To delete the root account:
1. In the **Admin** area, [create a new user with administrator access](create_accounts.md#create-a-user-in-the-admin-area). This ensures that you maintain administrator access to the instance whilst mitigating the risks associated with deleting the root account.
1. [Delete the root account](#delete-users-and-user-contributions).
### Use the GitLab Rails console
{{< alert type="warning" >}}
Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore.
{{< /alert >}}
Prerequisites:
- You must have access to the GitLab Rails console.
To delete the root account, in the Rails console:
1. Give another existing user administrator access:
```ruby
user = User.find(username: 'Username') # or use User.find_by(email: 'email@example.com') to find by email
user.admin = true
user.save!
```
This ensures that you maintain administrator access to the instance whilst mitigating the risks associated with deleting the root account.
1. To delete the root account, do either of the following:
- Block the root account:
```ruby
# This needs to be a current admin user
current_user = User.find(username: 'Username')
# This is the root user we want to block
user = User.find(username: 'Username')
::Users::BlockService.new(current_user).execute(user)
```
- Deactivate the root user:
```ruby
# This needs to be a current admin user
current_user = User.find(username: 'Username')
# This is the root user we want to deactivate
user = User.find(username: 'Username')
::Users::DeactivateService.new(current_user, skip_authorization: true).execute(user)
```
## Troubleshooting
### Deleting a user results in a PostgreSQL null value error
There is [a known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/349411) that results
in users not being deleted, and the following error generated:
```plaintext
ERROR: null value in column "user_id" violates not-null constraint
```
The error can be found in the [PostgreSQL log](../../../administration/logs/_index.md#postgresql-logs) and
in the **Retries** section of the [background jobs view](../../../administration/admin_area.md#background-jobs) in the **Admin** area.
If the user being deleted used the [iterations](../../group/iterations/_index.md) feature, such
as adding an issue to an iteration, you must use
[the workaround documented in the issue](https://gitlab.com/gitlab-org/gitlab/-/issues/349411#workaround)
to delete the user.
|
https://docs.gitlab.com/user/profile/create_accounts
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/profile/create_accounts.md
|
2025-08-13
|
doc/user/profile/account
|
[
"doc",
"user",
"profile",
"account"
] |
create_accounts.md
|
Fulfillment
|
Provision
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Create users
|
Create user accounts in GitLab.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
User accounts form the foundation of GitLab collaboration. Every person who needs access to your GitLab
projects requires an account. User accounts control access permissions, track contributions, and maintain
security across your instance.
You can create user accounts in GitLab in different ways:
- Self-registration for teams who value autonomy
- Admin-driven creation for controlled onboarding
- Authentication integration for enterprise environments
- Console access for automation and bulk operations
You can also use the [users API endpoint](../../../api/users.md#create-a-user) to automatically create users.
Choose the right method based on your organization's size, security requirements, and workflows.
## Create a user on the sign-in page
By default, any user visiting your GitLab instance can register for an account.
If you have previously [disabled this setting](../../../administration/settings/sign_up_restrictions.md#disable-new-sign-ups), you must turn it back on.
Users can create their own accounts by either:
- Selecting the **Register now** link on the sign-in page.
- Navigating to your GitLab instance's sign-up link (for example: `https://gitlab.example.com/users/sign_up`).
## Create a user in the Admin area
Prerequisites:
- You must be an administrator for the instance.
To create a user:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Overview > Users**.
1. Select **New user**.
1. In the **Account** section, enter the required account information.
1. Optional. In the **Access** section, configure any project limits or user type settings.
1. Select **Create user**.
GitLab sends an email to the user with a sign-in link, and the user must create a password when
they first sign in. You can also directly [set a password](../../../security/reset_user_password.md#use-the-ui)
for the user.
## Create a user with an authentication integration
GitLab can automatically create user accounts through authentication integrations.
Users are created when they:
- Are provisioned through [SCIM](../../group/saml_sso/scim_setup.md) in the identity provider.
- Sign in for the first time with:
- [LDAP](../../../administration/auth/ldap/_index.md)
- [Group SAML](../../group/saml_sso/_index.md)
- An [OmniAuth provider](../../../integration/omniauth.md) that has the setting `allow_single_sign_on` turned on
## Create a user through the Rails console
{{< alert type="warning" >}}
Commands that change data can cause damage if not run correctly or under the right conditions.
Always run commands in a test environment first and have a backup instance ready to restore.
{{< /alert >}}
To create a user through the Rails console:
1. Start a [Rails console session](../../../administration/operations/rails_console.md#starting-a-rails-console-session).
1. Run the command according to your GitLab version:
{{< tabs >}}
{{< tab title="16.10 and earlier" >}}
```ruby
u = User.new(username: 'test_user', email: 'test@example.com', name: 'Test User', password: 'password', password_confirmation: 'password')
# u.assign_personal_namespace
u.skip_confirmation! # Use only if you want the user to be automatically confirmed. If you do not use this, the user receives a confirmation email.
u.save!
```
{{< /tab >}}
{{< tab title="16.11 through 17.6" >}}
```ruby
u = User.new(username: 'test_user', email: 'test@example.com', name: 'Test User', password: 'password', password_confirmation: 'password')
u.assign_personal_namespace(Organizations::Organization.default_organization)
u.skip_confirmation! # Use only if you want the user to be automatically confirmed. If you do not use this, the user receives a confirmation email.
u.save!
```
{{< /tab >}}
{{< tab title="17.7 and later" >}}
```ruby
u = Users::CreateService.new(nil,
username: 'test_user',
email: 'test@example.com',
name: 'Test User',
password: '123password',
password_confirmation: '123password',
organization_id: Organizations::Organization.first.id,
skip_confirmation: true
).execute
```
{{< /tab >}}
{{< /tabs >}}
|
---
stage: Fulfillment
group: Provision
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Create user accounts in GitLab.
title: Create users
breadcrumbs:
- doc
- user
- profile
- account
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
User accounts form the foundation of GitLab collaboration. Every person who needs access to your GitLab
projects requires an account. User accounts control access permissions, track contributions, and maintain
security across your instance.
You can create user accounts in GitLab in different ways:
- Self-registration for teams who value autonomy
- Admin-driven creation for controlled onboarding
- Authentication integration for enterprise environments
- Console access for automation and bulk operations
You can also use the [users API endpoint](../../../api/users.md#create-a-user) to automatically create users.
Choose the right method based on your organization's size, security requirements, and workflows.
## Create a user on the sign-in page
By default, any user visiting your GitLab instance can register for an account.
If you have previously [disabled this setting](../../../administration/settings/sign_up_restrictions.md#disable-new-sign-ups), you must turn it back on.
Users can create their own accounts by either:
- Selecting the **Register now** link on the sign-in page.
- Navigating to your GitLab instance's sign-up link (for example: `https://gitlab.example.com/users/sign_up`).
## Create a user in the Admin area
Prerequisites:
- You must be an administrator for the instance.
To create a user:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Overview > Users**.
1. Select **New user**.
1. In the **Account** section, enter the required account information.
1. Optional. In the **Access** section, configure any project limits or user type settings.
1. Select **Create user**.
GitLab sends an email to the user with a sign-in link, and the user must create a password when
they first sign in. You can also directly [set a password](../../../security/reset_user_password.md#use-the-ui)
for the user.
## Create a user with an authentication integration
GitLab can automatically create user accounts through authentication integrations.
Users are created when they:
- Are provisioned through [SCIM](../../group/saml_sso/scim_setup.md) in the identity provider.
- Sign in for the first time with:
- [LDAP](../../../administration/auth/ldap/_index.md)
- [Group SAML](../../group/saml_sso/_index.md)
- An [OmniAuth provider](../../../integration/omniauth.md) that has the setting `allow_single_sign_on` turned on
## Create a user through the Rails console
{{< alert type="warning" >}}
Commands that change data can cause damage if not run correctly or under the right conditions.
Always run commands in a test environment first and have a backup instance ready to restore.
{{< /alert >}}
To create a user through the Rails console:
1. Start a [Rails console session](../../../administration/operations/rails_console.md#starting-a-rails-console-session).
1. Run the command according to your GitLab version:
{{< tabs >}}
{{< tab title="16.10 and earlier" >}}
```ruby
u = User.new(username: 'test_user', email: 'test@example.com', name: 'Test User', password: 'password', password_confirmation: 'password')
# u.assign_personal_namespace
u.skip_confirmation! # Use only if you want the user to be automatically confirmed. If you do not use this, the user receives a confirmation email.
u.save!
```
{{< /tab >}}
{{< tab title="16.11 through 17.6" >}}
```ruby
u = User.new(username: 'test_user', email: 'test@example.com', name: 'Test User', password: 'password', password_confirmation: 'password')
u.assign_personal_namespace(Organizations::Organization.default_organization)
u.skip_confirmation! # Use only if you want the user to be automatically confirmed. If you do not use this, the user receives a confirmation email.
u.save!
```
{{< /tab >}}
{{< tab title="17.7 and later" >}}
```ruby
u = Users::CreateService.new(nil,
username: 'test_user',
email: 'test@example.com',
name: 'Test User',
password: '123password',
password_confirmation: '123password',
organization_id: Organizations::Organization.first.id,
skip_confirmation: true
).execute
```
{{< /tab >}}
{{< /tabs >}}
|
https://docs.gitlab.com/user/profile/two_factor_authentication
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/profile/two_factor_authentication.md
|
2025-08-13
|
doc/user/profile/account
|
[
"doc",
"user",
"profile",
"account"
] |
two_factor_authentication.md
|
Software Supply Chain Security
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Two-factor authentication
|
Two-factor authentication (2FA) adds an extra layer of security to your GitLab account by requiring a second form of verification in addition to your password.
|
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Two-factor authentication (2FA) provides an additional level of security to your GitLab account. For others to access
your account, they would need your username and password and access to your second factor of authentication.
GitLab supports as a second factor of authentication:
- One-time password authenticators ([OTP](https://datatracker.ietf.org/doc/html/rfc6238)). When enabled, GitLab prompts
you for a code when you sign in. Codes are generated by your OTP authenticator (for example, a password
manager on one of your devices).
- WebAuthn devices. You're prompted to activate your WebAuthn device (usually by pressing a button on it) when
you supply your username and password to sign in. This performs secure authentication on your behalf.
If you set up a device, also set up an OTP so you can still access your account if you lose the device.
## Use personal access tokens with two-factor authentication
When 2FA is enabled, you can't use your password to authenticate with Git over HTTPS or the [GitLab API](../../../api/rest/_index.md).
You can use a [personal access token](../personal_access_tokens.md) instead.
## OAuth credential helpers
The following Git credential helpers authenticate to GitLab using OAuth. This is compatible with two-factor authentication. The first time you authenticate, the helper opens the web browser and GitLab asks you to authorize the app. Subsequent authentication requires no interaction.
### Git Credential Manager
[Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager) (GCM) authenticates by default using OAuth. GCM supports GitLab.com without any manual configuration. To use GCM with GitLab Self-Managed, see [GitLab support](https://github.com/GitCredentialManager/git-credential-manager/blob/main/docs/gitlab.md).
So you do not need to re-authenticate on every push, GCM supports caching as well as a variety of platform-specific credential stores that persist between sessions. This feature is useful whether you use personal access tokens or OAuth.
Git for Windows includes Git Credential Manager.
Git Credential Manager is developed primarily by GitHub, Inc. It is an open-source project and is supported by the community.
### git-credential-oauth
[git-credential-oauth](https://github.com/hickford/git-credential-oauth) supports GitLab.com and several popular public hosts without any manual configuration needed. To use with GitLab Self-Managed, see the [git-credential-oauth custom hosts documentation](https://github.com/hickford/git-credential-oauth#custom-hosts).
Many Linux distributions include git-credential-oauth as a package.
git-credential-oauth is an open-source project supported by the community.
## Enable two-factor authentication
You can enable 2FA using a:
- OTP authenticator. After you enable 2FA, back up your [recovery codes](#recovery-codes).
- WebAuthn device.
Your account email must be confirmed to enable 2FA.
### Enable a one-time password authenticator
To enable 2FA with an OTP authenticator:
1. **In GitLab**:
1. Access your [**User settings**](../_index.md#access-your-user-settings).
1. Select **Account**.
1. Select **Enable Two-factor Authentication**.
1. **On your device (usually your phone)**:
1. Install a compatible application. For example:
- Cloud-based (recommended because you can restore access if you lose the hardware device):
- [Authy](https://authy.com/).
- [Cisco Duo](https://duo.com/).
- Other (proprietary):
- [Google Authenticator](https://support.google.com/accounts/answer/1066447?hl=en).
- [Microsoft Authenticator](https://www.microsoft.com/en-us/security/mobile-authenticator-app).
- Other (Free Software)
- [Aegis Authenticator](https://getaegis.app/).
- [FreeOTP](https://freeotp.github.io/).
1. In the application, add a new entry in one of two ways:
- Scan the code displayed by GitLab with your device's camera to add the entry automatically.
- Enter the details provided to add the entry manually.
1. **In GitLab**:
1. Enter the six-digit pin number from the entry on your device into **Pin code**.
1. Enter your current password.
1. Select **Submit**.
If you entered the correct pin, GitLab displays a list of [recovery codes](#recovery-codes). Download them and keep them
in a safe place.
### Enable a one-time password authenticator using FortiAuthenticator
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="flag" >}}
On GitLab Self-Managed, by default this feature is not available. To make it available per user, an administrator can
[enable the feature flag](../../../administration/feature_flags/_index.md) named `forti_authenticator`.
On GitLab.com and GitLab Dedicated, this feature is not available.
{{< /alert >}}
You can use FortiAuthenticator as an OTP provider in GitLab. Users must:
- Exist in both FortiAuthenticator and GitLab with the same username.
- Have FortiToken configured in FortiAuthenticator.
You need a username and access token for FortiAuthenticator. The `access_token` shown below is the FortAuthenticator
access key. To get the token, see the REST API Solution Guide at
[Fortinet Document Library](https://docs.fortinet.com/document/fortiauthenticator/6.2.0/rest-api-solution-guide/158294/the-fortiauthenticator-api).
Tested with FortAuthenticator version 6.2.0.
Configure FortiAuthenticator in GitLab. On your GitLab server:
1. Open the configuration file.
For Linux package installations:
```shell
sudo editor /etc/gitlab/gitlab.rb
```
For self-compiled installations:
```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
1. Add the provider configuration.
For Linux package installations:
```ruby
gitlab_rails['forti_authenticator_enabled'] = true
gitlab_rails['forti_authenticator_host'] = 'forti_authenticator.example.com'
gitlab_rails['forti_authenticator_port'] = 443
gitlab_rails['forti_authenticator_username'] = '<some_username>'
gitlab_rails['forti_authenticator_access_token'] = 's3cr3t'
```
For self-compiled installations:
```yaml
forti_authenticator:
enabled: true
host: forti_authenticator.example.com
port: 443
username: <some_username>
access_token: s3cr3t
```
1. Save the configuration file.
1. [Reconfigure](../../../administration/restart_gitlab.md#reconfigure-a-linux-package-installation)
(Linux package installations) or [restart](../../../administration/restart_gitlab.md#self-compiled-installations)
(self-compiled installations).
### Enable a one-time password authenticator using Cisco Duo
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15760) in GitLab 15.10.
{{< /history >}}
You can use Cisco Duo as an OTP provider in GitLab.
DUO® is a registered trademark of Cisco Systems, Inc., and/or its affiliates in the United States and certain other countries.
#### Prerequisites
To use Cisco Duo as an OTP provider:
- Your account must exist in both Cisco Duo and GitLab, with the same username in both applications.
- You must have [configured Cisco Duo](https://admin.duosecurity.com/) and have an integration key, secret key, and API hostname.
For more information, see the [Cisco Duo API documentation](https://duo.com/docs/authapi).
GitLab 15.10 has been tested with Cisco Duo version D261.14
#### Configure Cisco Duo in GitLab
On your GitLab server:
1. Open the configuration file.
For Linux package installations:
```shell
sudo editor /etc/gitlab/gitlab.rb
```
For self-compiled installations:
```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
1. Add the provider configuration.
For Linux package installations:
```ruby
gitlab_rails['duo_auth_enabled'] = false
gitlab_rails['duo_auth_integration_key'] = '<duo_integration_key_value>'
gitlab_rails['duo_auth_secret_key'] = '<duo_secret_key_value>'
gitlab_rails['duo_auth_hostname'] = '<duo_api_hostname>'
```
For self-compiled installations:
```yaml
duo_auth:
enabled: true
hostname: <duo_api_hostname>
integration_key: <duo_integration_key_value>
secret_key: <duo_secret_key_value>
```
1. Save the configuration file.
1. For Linux package installations, [reconfigure GitLab](../../../administration/restart_gitlab.md#reconfigure-a-linux-package-installation).
For self-compiled installations, [restart GitLab](../../../administration/restart_gitlab.md#self-compiled-installations).
### Enable a one-time password authenticator using FortiToken Cloud
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="flag" >}}
On GitLab Self-Managed, by default this feature is not available. To make it available per user, an administrator can
[enable the feature flag](../../../administration/feature_flags/_index.md) named `forti_token_cloud`.
On GitLab.com and GitLab Dedicated, this feature is not available.
This feature is not ready for production use.
{{< /alert >}}
You can use FortiToken Cloud as an OTP provider in GitLab. Users must:
- Exist in both FortiToken Cloud and GitLab with the same username.
- Have FortiToken configured in FortiToken Cloud.
You need a `client_id` and `client_secret` to configure FortiToken Cloud. To get these, see the REST API Guide at
[Fortinet Document Library](https://docs.fortinet.com/document/fortitoken-cloud/latest/rest-api/456035/overview).
Configure FortiToken Cloud in GitLab. On your GitLab server:
1. Open the configuration file.
For Linux package installations:
```shell
sudo editor /etc/gitlab/gitlab.rb
```
For self-compiled installations:
```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
1. Add the provider configuration.
For Linux package installations:
```ruby
gitlab_rails['forti_token_cloud_enabled'] = true
gitlab_rails['forti_token_cloud_client_id'] = '<your_fortinet_cloud_client_id>'
gitlab_rails['forti_token_cloud_client_secret'] = '<your_fortinet_cloud_client_secret>'
```
For self-compiled installations:
```yaml
forti_token_cloud:
enabled: true
client_id: YOUR_FORTI_TOKEN_CLOUD_CLIENT_ID
client_secret: YOUR_FORTI_TOKEN_CLOUD_CLIENT_SECRET
```
1. Save the configuration file.
1. [Reconfigure](../../../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) (Linux package installations) or
[restart](../../../administration/restart_gitlab.md#self-compiled-installations) (self-compiled installations).
### Set up a WebAuthn device
{{< history >}}
- Optional one-time password authentication for WebAuthn devices [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/378844) in GitLab 15.10 [with a feature flag](../../../administration/feature_flags/_index.md) named `webauthn_without_totp`.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/396931) in GitLab 17.6. Feature flag `webauthn_without_totp` removed.
{{< /history >}}
WebAuthn is [supported by](https://caniuse.com/#search=webauthn) the following:
- Desktop browsers:
- Chrome
- Edge
- Firefox
- Opera
- Safari
- Mobile browsers:
- Chrome for Android
- Firefox for Android
- iOS Safari (since iOS 13.3)
To set up 2FA with a WebAuthn-compatible device:
1. Optional. [Set up an OTP authenticator](#enable-a-one-time-password-authenticator).
1. Access your [**User settings**](../_index.md#access-your-user-settings).
1. Select **Account**.
1. Select **Enable Two-Factor Authentication**.
1. Plug in your WebAuthn device.
1. Enter a device name and in GitLab 15.10 and later, your GitLab account password.
You might not need to enter this password if you have signed in through your
identity provider.
1. Select **Set up New WebAuthn Device**.
1. Depending on your device, you might have to press a button or touch a sensor.
You should receive a message indicating that you successfully set up your device.
When you set up 2FA with a WebAuthn-compatible device, that device is linked to
a specific browser on a specific computer. Depending on the browser and WebAuthn
device, you might be able to configure settings to use the WebAuthn device on a
different browser or computer.
If this is the first time you have set up 2FA, you
must [download recovery codes](#recovery-codes) so you can recover access to your
account if you lose access.
{{< alert type="warning" >}}
You can lose access to your account if you clear your browser data.
{{< /alert >}}
## Recovery codes
Immediately after successfully enabling 2FA with an OTP authenticator, you're prompted to download
a set of generated recovery codes. If you ever lose access to your OTP authenticator, you can use one of
these recovery codes to sign in to your account.
{{< alert type="warning" >}}
Each code can be used only once to sign in to your account.
{{< /alert >}}
You should copy and print the codes, or use **Download codes** to download them for storage in a safe
place. If you choose to download them, the file is called `gitlab-recovery-codes.txt`.
{{< alert type="note" >}}
- Recovery codes are not generated for WebAuthn devices.
- `gitlab-sshd` is not suitable for regenerating recovery codes.
{{< /alert >}}
If you lose the recovery codes, or want to generate new ones, you can use either:
- The [2FA account settings](#regenerate-two-factor-authentication-recovery-codes) page.
- [SSH](two_factor_authentication_troubleshooting.md#generate-new-recovery-codes-using-ssh).
### Regenerate two-factor authentication recovery codes
To regenerate 2FA recovery codes, you need access to a desktop browser:
1. Access your [**User settings**](../_index.md#access-your-user-settings).
1. Select **Account > Two-Factor Authentication (2FA)**.
1. If you've already configured 2FA, select **Manage two-factor authentication**.
1. In the **Disable two-factor authentication** section, select **Regenerate recovery codes**.
1. On the dialog, enter your current password and select **Regenerate recovery codes**.
{{< alert type="note" >}}
If you regenerate 2FA recovery codes, save them. You can't use any previously created 2FA codes.
{{< /alert >}}
## Sign in with two-factor authentication enabled
Signing in with 2FA enabled is only slightly different than the typical sign-in process. Enter your username and password
and you're presented with a second prompt, depending on which type of 2FA you've enabled.
### Sign in using a one-time password authenticator
When asked, enter the pin from your OTP authenticator or a recovery code to sign in.
### Sign in using a WebAuthn device
In supported browsers, you should be automatically prompted to activate your WebAuthn device (for example, by touching
or pressing its button) after entering your credentials.
A message displays indicating that your device responded to the authentication request and you're automatically signed
in.
## Disable two-factor authentication
{{< history >}}
- Ability to disable OTP authenticator and WebAuthn devices individually or simultaneously [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393419) in GitLab 17.6.
{{< /history >}}
You can disable the OTP authenticator and WebAuthn devices individually or simultaneously. To disable them simultaneously:
1. Access your [**User settings**](../_index.md#access-your-user-settings).
1. Select **Account**.
1. Select **Manage two-factor authentication**.
1. In the **Disable two-factor authentication** section, select **Disable two-factor authentication**.
1. On the dialog, enter your current password and select **Disable two-factor authentication**.
This clears all your 2FA registrations, including mobile applications and WebAuthn devices.
## Information for GitLab administrators
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
- Take care that 2FA keeps working after [restoring a GitLab backup](../../../administration/backup_restore/_index.md).
- To ensure 2FA authorizes correctly with an OTP server, synchronize your GitLab
server's time using a service like NTP. Otherwise, authorization can always fail because of time differences.
- The GitLab WebAuthn implementation does not work when the GitLab instance is accessed from multiple hostnames
or FQDNs. Each WebAuthn registration is linked to the current hostname at the time of registration, and
cannot be used for other hostnames or FQDNs.
For example, if a user is trying to access a GitLab instance from `first.host.xyz` and `second.host.xyz`:
- The user signs in by using `first.host.xyz` and registers their WebAuthn key.
- The user signs out and attempts to sign in by using `first.host.xyz` - WebAuthn authentication succeeds.
- The user signs out and attempts to sign in by using `second.host.xyz` - WebAuthn authentication fails, because
the WebAuthn key has only been registered on `first.host.xyz`.
- To enforce 2FA at the system or group levels see, [Enforce two-factor authentication](../../../security/two_factor_authentication.md).
|
---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
gitlab_dedicated: true
description: Two-factor authentication (2FA) adds an extra layer of security to your
GitLab account by requiring a second form of verification in addition to your password.
title: Two-factor authentication
breadcrumbs:
- doc
- user
- profile
- account
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Two-factor authentication (2FA) provides an additional level of security to your GitLab account. For others to access
your account, they would need your username and password and access to your second factor of authentication.
GitLab supports as a second factor of authentication:
- One-time password authenticators ([OTP](https://datatracker.ietf.org/doc/html/rfc6238)). When enabled, GitLab prompts
you for a code when you sign in. Codes are generated by your OTP authenticator (for example, a password
manager on one of your devices).
- WebAuthn devices. You're prompted to activate your WebAuthn device (usually by pressing a button on it) when
you supply your username and password to sign in. This performs secure authentication on your behalf.
If you set up a device, also set up an OTP so you can still access your account if you lose the device.
## Use personal access tokens with two-factor authentication
When 2FA is enabled, you can't use your password to authenticate with Git over HTTPS or the [GitLab API](../../../api/rest/_index.md).
You can use a [personal access token](../personal_access_tokens.md) instead.
## OAuth credential helpers
The following Git credential helpers authenticate to GitLab using OAuth. This is compatible with two-factor authentication. The first time you authenticate, the helper opens the web browser and GitLab asks you to authorize the app. Subsequent authentication requires no interaction.
### Git Credential Manager
[Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager) (GCM) authenticates by default using OAuth. GCM supports GitLab.com without any manual configuration. To use GCM with GitLab Self-Managed, see [GitLab support](https://github.com/GitCredentialManager/git-credential-manager/blob/main/docs/gitlab.md).
So you do not need to re-authenticate on every push, GCM supports caching as well as a variety of platform-specific credential stores that persist between sessions. This feature is useful whether you use personal access tokens or OAuth.
Git for Windows includes Git Credential Manager.
Git Credential Manager is developed primarily by GitHub, Inc. It is an open-source project and is supported by the community.
### git-credential-oauth
[git-credential-oauth](https://github.com/hickford/git-credential-oauth) supports GitLab.com and several popular public hosts without any manual configuration needed. To use with GitLab Self-Managed, see the [git-credential-oauth custom hosts documentation](https://github.com/hickford/git-credential-oauth#custom-hosts).
Many Linux distributions include git-credential-oauth as a package.
git-credential-oauth is an open-source project supported by the community.
## Enable two-factor authentication
You can enable 2FA using a:
- OTP authenticator. After you enable 2FA, back up your [recovery codes](#recovery-codes).
- WebAuthn device.
Your account email must be confirmed to enable 2FA.
### Enable a one-time password authenticator
To enable 2FA with an OTP authenticator:
1. **In GitLab**:
1. Access your [**User settings**](../_index.md#access-your-user-settings).
1. Select **Account**.
1. Select **Enable Two-factor Authentication**.
1. **On your device (usually your phone)**:
1. Install a compatible application. For example:
- Cloud-based (recommended because you can restore access if you lose the hardware device):
- [Authy](https://authy.com/).
- [Cisco Duo](https://duo.com/).
- Other (proprietary):
- [Google Authenticator](https://support.google.com/accounts/answer/1066447?hl=en).
- [Microsoft Authenticator](https://www.microsoft.com/en-us/security/mobile-authenticator-app).
- Other (Free Software)
- [Aegis Authenticator](https://getaegis.app/).
- [FreeOTP](https://freeotp.github.io/).
1. In the application, add a new entry in one of two ways:
- Scan the code displayed by GitLab with your device's camera to add the entry automatically.
- Enter the details provided to add the entry manually.
1. **In GitLab**:
1. Enter the six-digit pin number from the entry on your device into **Pin code**.
1. Enter your current password.
1. Select **Submit**.
If you entered the correct pin, GitLab displays a list of [recovery codes](#recovery-codes). Download them and keep them
in a safe place.
### Enable a one-time password authenticator using FortiAuthenticator
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="flag" >}}
On GitLab Self-Managed, by default this feature is not available. To make it available per user, an administrator can
[enable the feature flag](../../../administration/feature_flags/_index.md) named `forti_authenticator`.
On GitLab.com and GitLab Dedicated, this feature is not available.
{{< /alert >}}
You can use FortiAuthenticator as an OTP provider in GitLab. Users must:
- Exist in both FortiAuthenticator and GitLab with the same username.
- Have FortiToken configured in FortiAuthenticator.
You need a username and access token for FortiAuthenticator. The `access_token` shown below is the FortAuthenticator
access key. To get the token, see the REST API Solution Guide at
[Fortinet Document Library](https://docs.fortinet.com/document/fortiauthenticator/6.2.0/rest-api-solution-guide/158294/the-fortiauthenticator-api).
Tested with FortAuthenticator version 6.2.0.
Configure FortiAuthenticator in GitLab. On your GitLab server:
1. Open the configuration file.
For Linux package installations:
```shell
sudo editor /etc/gitlab/gitlab.rb
```
For self-compiled installations:
```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
1. Add the provider configuration.
For Linux package installations:
```ruby
gitlab_rails['forti_authenticator_enabled'] = true
gitlab_rails['forti_authenticator_host'] = 'forti_authenticator.example.com'
gitlab_rails['forti_authenticator_port'] = 443
gitlab_rails['forti_authenticator_username'] = '<some_username>'
gitlab_rails['forti_authenticator_access_token'] = 's3cr3t'
```
For self-compiled installations:
```yaml
forti_authenticator:
enabled: true
host: forti_authenticator.example.com
port: 443
username: <some_username>
access_token: s3cr3t
```
1. Save the configuration file.
1. [Reconfigure](../../../administration/restart_gitlab.md#reconfigure-a-linux-package-installation)
(Linux package installations) or [restart](../../../administration/restart_gitlab.md#self-compiled-installations)
(self-compiled installations).
### Enable a one-time password authenticator using Cisco Duo
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15760) in GitLab 15.10.
{{< /history >}}
You can use Cisco Duo as an OTP provider in GitLab.
DUO® is a registered trademark of Cisco Systems, Inc., and/or its affiliates in the United States and certain other countries.
#### Prerequisites
To use Cisco Duo as an OTP provider:
- Your account must exist in both Cisco Duo and GitLab, with the same username in both applications.
- You must have [configured Cisco Duo](https://admin.duosecurity.com/) and have an integration key, secret key, and API hostname.
For more information, see the [Cisco Duo API documentation](https://duo.com/docs/authapi).
GitLab 15.10 has been tested with Cisco Duo version D261.14
#### Configure Cisco Duo in GitLab
On your GitLab server:
1. Open the configuration file.
For Linux package installations:
```shell
sudo editor /etc/gitlab/gitlab.rb
```
For self-compiled installations:
```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
1. Add the provider configuration.
For Linux package installations:
```ruby
gitlab_rails['duo_auth_enabled'] = false
gitlab_rails['duo_auth_integration_key'] = '<duo_integration_key_value>'
gitlab_rails['duo_auth_secret_key'] = '<duo_secret_key_value>'
gitlab_rails['duo_auth_hostname'] = '<duo_api_hostname>'
```
For self-compiled installations:
```yaml
duo_auth:
enabled: true
hostname: <duo_api_hostname>
integration_key: <duo_integration_key_value>
secret_key: <duo_secret_key_value>
```
1. Save the configuration file.
1. For Linux package installations, [reconfigure GitLab](../../../administration/restart_gitlab.md#reconfigure-a-linux-package-installation).
For self-compiled installations, [restart GitLab](../../../administration/restart_gitlab.md#self-compiled-installations).
### Enable a one-time password authenticator using FortiToken Cloud
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="flag" >}}
On GitLab Self-Managed, by default this feature is not available. To make it available per user, an administrator can
[enable the feature flag](../../../administration/feature_flags/_index.md) named `forti_token_cloud`.
On GitLab.com and GitLab Dedicated, this feature is not available.
This feature is not ready for production use.
{{< /alert >}}
You can use FortiToken Cloud as an OTP provider in GitLab. Users must:
- Exist in both FortiToken Cloud and GitLab with the same username.
- Have FortiToken configured in FortiToken Cloud.
You need a `client_id` and `client_secret` to configure FortiToken Cloud. To get these, see the REST API Guide at
[Fortinet Document Library](https://docs.fortinet.com/document/fortitoken-cloud/latest/rest-api/456035/overview).
Configure FortiToken Cloud in GitLab. On your GitLab server:
1. Open the configuration file.
For Linux package installations:
```shell
sudo editor /etc/gitlab/gitlab.rb
```
For self-compiled installations:
```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
1. Add the provider configuration.
For Linux package installations:
```ruby
gitlab_rails['forti_token_cloud_enabled'] = true
gitlab_rails['forti_token_cloud_client_id'] = '<your_fortinet_cloud_client_id>'
gitlab_rails['forti_token_cloud_client_secret'] = '<your_fortinet_cloud_client_secret>'
```
For self-compiled installations:
```yaml
forti_token_cloud:
enabled: true
client_id: YOUR_FORTI_TOKEN_CLOUD_CLIENT_ID
client_secret: YOUR_FORTI_TOKEN_CLOUD_CLIENT_SECRET
```
1. Save the configuration file.
1. [Reconfigure](../../../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) (Linux package installations) or
[restart](../../../administration/restart_gitlab.md#self-compiled-installations) (self-compiled installations).
### Set up a WebAuthn device
{{< history >}}
- Optional one-time password authentication for WebAuthn devices [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/378844) in GitLab 15.10 [with a feature flag](../../../administration/feature_flags/_index.md) named `webauthn_without_totp`.
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/396931) in GitLab 17.6. Feature flag `webauthn_without_totp` removed.
{{< /history >}}
WebAuthn is [supported by](https://caniuse.com/#search=webauthn) the following:
- Desktop browsers:
- Chrome
- Edge
- Firefox
- Opera
- Safari
- Mobile browsers:
- Chrome for Android
- Firefox for Android
- iOS Safari (since iOS 13.3)
To set up 2FA with a WebAuthn-compatible device:
1. Optional. [Set up an OTP authenticator](#enable-a-one-time-password-authenticator).
1. Access your [**User settings**](../_index.md#access-your-user-settings).
1. Select **Account**.
1. Select **Enable Two-Factor Authentication**.
1. Plug in your WebAuthn device.
1. Enter a device name and in GitLab 15.10 and later, your GitLab account password.
You might not need to enter this password if you have signed in through your
identity provider.
1. Select **Set up New WebAuthn Device**.
1. Depending on your device, you might have to press a button or touch a sensor.
You should receive a message indicating that you successfully set up your device.
When you set up 2FA with a WebAuthn-compatible device, that device is linked to
a specific browser on a specific computer. Depending on the browser and WebAuthn
device, you might be able to configure settings to use the WebAuthn device on a
different browser or computer.
If this is the first time you have set up 2FA, you
must [download recovery codes](#recovery-codes) so you can recover access to your
account if you lose access.
{{< alert type="warning" >}}
You can lose access to your account if you clear your browser data.
{{< /alert >}}
## Recovery codes
Immediately after successfully enabling 2FA with an OTP authenticator, you're prompted to download
a set of generated recovery codes. If you ever lose access to your OTP authenticator, you can use one of
these recovery codes to sign in to your account.
{{< alert type="warning" >}}
Each code can be used only once to sign in to your account.
{{< /alert >}}
You should copy and print the codes, or use **Download codes** to download them for storage in a safe
place. If you choose to download them, the file is called `gitlab-recovery-codes.txt`.
{{< alert type="note" >}}
- Recovery codes are not generated for WebAuthn devices.
- `gitlab-sshd` is not suitable for regenerating recovery codes.
{{< /alert >}}
If you lose the recovery codes, or want to generate new ones, you can use either:
- The [2FA account settings](#regenerate-two-factor-authentication-recovery-codes) page.
- [SSH](two_factor_authentication_troubleshooting.md#generate-new-recovery-codes-using-ssh).
### Regenerate two-factor authentication recovery codes
To regenerate 2FA recovery codes, you need access to a desktop browser:
1. Access your [**User settings**](../_index.md#access-your-user-settings).
1. Select **Account > Two-Factor Authentication (2FA)**.
1. If you've already configured 2FA, select **Manage two-factor authentication**.
1. In the **Disable two-factor authentication** section, select **Regenerate recovery codes**.
1. On the dialog, enter your current password and select **Regenerate recovery codes**.
{{< alert type="note" >}}
If you regenerate 2FA recovery codes, save them. You can't use any previously created 2FA codes.
{{< /alert >}}
## Sign in with two-factor authentication enabled
Signing in with 2FA enabled is only slightly different than the typical sign-in process. Enter your username and password
and you're presented with a second prompt, depending on which type of 2FA you've enabled.
### Sign in using a one-time password authenticator
When asked, enter the pin from your OTP authenticator or a recovery code to sign in.
### Sign in using a WebAuthn device
In supported browsers, you should be automatically prompted to activate your WebAuthn device (for example, by touching
or pressing its button) after entering your credentials.
A message displays indicating that your device responded to the authentication request and you're automatically signed
in.
## Disable two-factor authentication
{{< history >}}
- Ability to disable OTP authenticator and WebAuthn devices individually or simultaneously [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393419) in GitLab 17.6.
{{< /history >}}
You can disable the OTP authenticator and WebAuthn devices individually or simultaneously. To disable them simultaneously:
1. Access your [**User settings**](../_index.md#access-your-user-settings).
1. Select **Account**.
1. Select **Manage two-factor authentication**.
1. In the **Disable two-factor authentication** section, select **Disable two-factor authentication**.
1. On the dialog, enter your current password and select **Disable two-factor authentication**.
This clears all your 2FA registrations, including mobile applications and WebAuthn devices.
## Information for GitLab administrators
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
- Take care that 2FA keeps working after [restoring a GitLab backup](../../../administration/backup_restore/_index.md).
- To ensure 2FA authorizes correctly with an OTP server, synchronize your GitLab
server's time using a service like NTP. Otherwise, authorization can always fail because of time differences.
- The GitLab WebAuthn implementation does not work when the GitLab instance is accessed from multiple hostnames
or FQDNs. Each WebAuthn registration is linked to the current hostname at the time of registration, and
cannot be used for other hostnames or FQDNs.
For example, if a user is trying to access a GitLab instance from `first.host.xyz` and `second.host.xyz`:
- The user signs in by using `first.host.xyz` and registers their WebAuthn key.
- The user signs out and attempts to sign in by using `first.host.xyz` - WebAuthn authentication succeeds.
- The user signs out and attempts to sign in by using `second.host.xyz` - WebAuthn authentication fails, because
the WebAuthn key has only been registered on `first.host.xyz`.
- To enforce 2FA at the system or group levels see, [Enforce two-factor authentication](../../../security/two_factor_authentication.md).
|
https://docs.gitlab.com/user/profile/two_factor_authentication_troubleshooting
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/profile/two_factor_authentication_troubleshooting.md
|
2025-08-13
|
doc/user/profile/account
|
[
"doc",
"user",
"profile",
"account"
] |
two_factor_authentication_troubleshooting.md
|
Software Supply Chain Security
|
Authentication
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Troubleshooting two-factor authentication
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
## Error: `HTTP Basic: Access denied. If a password was provided for Git authentication ...`
When making a request, you might get an error that states:
```plaintext
HTTP Basic: Access denied. If a password was provided for Git authentication,
the password was incorrect or you're required to use a token instead of a password.
If a token was provided, it was either incorrect, expired, or improperly scoped.
```
This error occurs when:
- You have enabled 2FA and attempted to authenticate with a username and password.
- You have not enabled 2FA and attempted to authenticate with an incorrect username or password.
- You have not enabled 2FA and the [enforce 2FA for all users](../../../security/two_factor_authentication.md#enforce-2fa-for-all-users) setting is active.
- You have not enabled 2FA and the [password authentication enabled for Git over HTTP(S)](../../../administration/settings/sign_in_restrictions.md#password-authentication-enabled)
setting is not active.
To resolve this error:
- Use a [personal access token](../personal_access_tokens.md) with the correct scopes:
- For Git requests over HTTP(S): `read_repository` or `write_repository`
- For [GitLab container registry](../../packages/container_registry/authenticate_with_container_registry.md)
requests: `read_registry` or `write_registry`
- For [dependency proxy](../../packages/dependency_proxy/_index.md#authenticate-with-the-dependency-proxy-for-container-images)
requests: `read_registry` and `write_registry`
- If you configured LDAP, use an [LDAP password](../../../administration/auth/ldap/_index.md).
- Use an [OAuth credential helper](two_factor_authentication.md#oauth-credential-helpers).
## Error: `invalid pin code`
An `invalid pin code` error can indicate that there is a time sync issue between the authentication
application and the GitLab instance itself.
To resolve this issue, turn on time synchronization for the device that generates your 2FA codes.
{{< tabs >}}
{{< tab title="Android" >}}
1. Go to **Settings > System > Date & time**.
1. Turn on **Set time automatically**. If the setting is already on, turn it off, wait a few seconds, and turn it on again.
{{< /tab >}}
{{< tab title="iOS" >}}
1. Go to **Settings > General > Date & Time**.
1. Turn on **Set Automatically**. If the setting is already on, turn it off, wait a few seconds, and turn it on again.
{{< /tab >}}
{{< /tabs >}}
## Error: `Permission denied (publickey)` when generating recovery codes
You might get an error that states `Permission denied (publickey)`.
This issue occurs if you are using a non-default SSH key pair file path and attempt to
[generate recovery codes using SSH](two_factor_authentication_troubleshooting.md#generate-new-recovery-codes-using-ssh).
To resolve this, [configure SSH to point to a different directory](../../ssh.md#configure-ssh-to-point-to-a-different-directory) using `ssh-agent`.
## Recovery options and 2FA reset
If you have enabled 2FA and cannot generate codes, use one of the following methods to access your
account:
### Use a recovery code
When you enabled 2FA, GitLab provided you with a series of recovery codes. You can use these codes to sign in to your account.
To use a recovery code:
1. On the GitLab sign-in page, enter your username or email, and password.
1. When prompted for a two-factor code, enter a recovery code.
After you use a recovery code, you cannot use the same code again.
Your other recovery codes remain valid.
### Generate new recovery codes using SSH
If you added an SSH key to your GitLab account, you can generate a new set of recovery codes with SSH:
1. In a terminal, run:
```shell
ssh git@gitlab.com 2fa_recovery_codes
```
On GitLab Self-Managed instances, replace `gitlab.com` with the GitLab server hostname (`gitlab.example.com`).
1. On the confirmation message, enter `yes`.
1. Save the recovery codes that GitLab generates. Your previous recovery codes are no longer valid.
1. On the sign-in page, enter your username or email, and password.
1. When prompted for a two-factor code, enter one of your new recovery codes.
After signing in, immediately set up 2FA with a new device.
### Reset 2FA on your account
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
If the previous recovery options do not work, and you still cannot sign in to your account,
you can create a support request to disable 2FA for your account.
After 2FA is disabled, re-enable it as soon as possible to keep your account secure.
This service is only available for accounts with a GitLab.com subscription. For more information, see our
[blog post](https://about.gitlab.com/blog/2020/08/04/gitlab-support-no-longer-processing-mfa-resets-for-free-users/).
To create a support request:
1. Go to [GitLab Support](https://support.gitlab.com).
1. Select **Submit a Ticket**.
1. If possible, sign in to your account.
1. In the issue dropdown list, select **GitLab.com user accounts and login issues**.
1. Complete the fields in the support form.
1. Select **Submit**.
### Reset 2FA for enterprise users
If you are a top-level group Owner on a paid plan, you can disable 2FA for enterprise users.
For more information, see [disable 2FA for enterprise users](../../../security/two_factor_authentication.md#enterprise-users).
|
---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
gitlab_dedicated: true
title: Troubleshooting two-factor authentication
breadcrumbs:
- doc
- user
- profile
- account
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
## Error: `HTTP Basic: Access denied. If a password was provided for Git authentication ...`
When making a request, you might get an error that states:
```plaintext
HTTP Basic: Access denied. If a password was provided for Git authentication,
the password was incorrect or you're required to use a token instead of a password.
If a token was provided, it was either incorrect, expired, or improperly scoped.
```
This error occurs when:
- You have enabled 2FA and attempted to authenticate with a username and password.
- You have not enabled 2FA and attempted to authenticate with an incorrect username or password.
- You have not enabled 2FA and the [enforce 2FA for all users](../../../security/two_factor_authentication.md#enforce-2fa-for-all-users) setting is active.
- You have not enabled 2FA and the [password authentication enabled for Git over HTTP(S)](../../../administration/settings/sign_in_restrictions.md#password-authentication-enabled)
setting is not active.
To resolve this error:
- Use a [personal access token](../personal_access_tokens.md) with the correct scopes:
- For Git requests over HTTP(S): `read_repository` or `write_repository`
- For [GitLab container registry](../../packages/container_registry/authenticate_with_container_registry.md)
requests: `read_registry` or `write_registry`
- For [dependency proxy](../../packages/dependency_proxy/_index.md#authenticate-with-the-dependency-proxy-for-container-images)
requests: `read_registry` and `write_registry`
- If you configured LDAP, use an [LDAP password](../../../administration/auth/ldap/_index.md).
- Use an [OAuth credential helper](two_factor_authentication.md#oauth-credential-helpers).
## Error: `invalid pin code`
An `invalid pin code` error can indicate that there is a time sync issue between the authentication
application and the GitLab instance itself.
To resolve this issue, turn on time synchronization for the device that generates your 2FA codes.
{{< tabs >}}
{{< tab title="Android" >}}
1. Go to **Settings > System > Date & time**.
1. Turn on **Set time automatically**. If the setting is already on, turn it off, wait a few seconds, and turn it on again.
{{< /tab >}}
{{< tab title="iOS" >}}
1. Go to **Settings > General > Date & Time**.
1. Turn on **Set Automatically**. If the setting is already on, turn it off, wait a few seconds, and turn it on again.
{{< /tab >}}
{{< /tabs >}}
## Error: `Permission denied (publickey)` when generating recovery codes
You might get an error that states `Permission denied (publickey)`.
This issue occurs if you are using a non-default SSH key pair file path and attempt to
[generate recovery codes using SSH](two_factor_authentication_troubleshooting.md#generate-new-recovery-codes-using-ssh).
To resolve this, [configure SSH to point to a different directory](../../ssh.md#configure-ssh-to-point-to-a-different-directory) using `ssh-agent`.
## Recovery options and 2FA reset
If you have enabled 2FA and cannot generate codes, use one of the following methods to access your
account:
### Use a recovery code
When you enabled 2FA, GitLab provided you with a series of recovery codes. You can use these codes to sign in to your account.
To use a recovery code:
1. On the GitLab sign-in page, enter your username or email, and password.
1. When prompted for a two-factor code, enter a recovery code.
After you use a recovery code, you cannot use the same code again.
Your other recovery codes remain valid.
### Generate new recovery codes using SSH
If you added an SSH key to your GitLab account, you can generate a new set of recovery codes with SSH:
1. In a terminal, run:
```shell
ssh git@gitlab.com 2fa_recovery_codes
```
On GitLab Self-Managed instances, replace `gitlab.com` with the GitLab server hostname (`gitlab.example.com`).
1. On the confirmation message, enter `yes`.
1. Save the recovery codes that GitLab generates. Your previous recovery codes are no longer valid.
1. On the sign-in page, enter your username or email, and password.
1. When prompted for a two-factor code, enter one of your new recovery codes.
After signing in, immediately set up 2FA with a new device.
### Reset 2FA on your account
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
If the previous recovery options do not work, and you still cannot sign in to your account,
you can create a support request to disable 2FA for your account.
After 2FA is disabled, re-enable it as soon as possible to keep your account secure.
This service is only available for accounts with a GitLab.com subscription. For more information, see our
[blog post](https://about.gitlab.com/blog/2020/08/04/gitlab-support-no-longer-processing-mfa-resets-for-free-users/).
To create a support request:
1. Go to [GitLab Support](https://support.gitlab.com).
1. Select **Submit a Ticket**.
1. If possible, sign in to your account.
1. In the issue dropdown list, select **GitLab.com user accounts and login issues**.
1. Complete the fields in the support form.
1. Select **Submit**.
### Reset 2FA for enterprise users
If you are a top-level group Owner on a paid plan, you can disable 2FA for enterprise users.
For more information, see [disable 2FA for enterprise users](../../../security/two_factor_authentication.md#enterprise-users).
|
https://docs.gitlab.com/user/namespace
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/_index.md
|
2025-08-13
|
doc/user/namespace
|
[
"doc",
"user",
"namespace"
] |
_index.md
|
Tenant Scale
|
Organizations
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Namespaces
|
Learn more about different types of namespaces.
|
Namespaces organize projects in GitLab. Because each namespace is separate,
you can use the same project name in multiple namespaces.
When you choose a name for your namespace, keep in mind:
- [Naming rules](../reserved_names.md#rules-for-usernames-project-and-group-names-and-slugs)
- [Reserved group names](../reserved_names.md#reserved-group-names)
{{< alert type="note" >}}
Namespaces with a period (`.`) cause issues with SSL certificate validation and the source path when [publishing Terraform modules](../packages/terraform_module_registry/_index.md#publish-a-terraform-module).
{{< /alert >}}
## Types of namespaces
GitLab has two types of namespaces:
- **User**: Your personal namespace is based on your username. In a personal namespace:
- You cannot create subgroups.
- Groups you belong to do not inherit your personal namespace permissions or features.
- All the projects you create are under the scope of this namespace.
- Changes to your username also change project and namespace URLs. Before you change your username,
read about [repository redirects](../project/repository/_index.md#repository-path-changes).
- **Group**: A group or subgroup namespace is based on the group or subgroup name. In group and subgroup namespaces:
- You can create multiple subgroups to manage multiple projects.
- Subgroups inherit some of the parent group settings. You can view these in the subgroup **Settings**.
- You can configure settings specifically for each subgroup and project.
- You can manage the group or subgroup URL independently of the name.
## Determine which type of namespace you're in
To determine whether you're in a group or personal namespace, you can view the URL. For example:
| Namespace for | URL | Namespace |
| ------------- | --- | --------- |
| A user named `alex`. | `https://gitlab.example.com/alex` | `alex` |
| A group named `alex-team`. | `https://gitlab.example.com/alex-team` | `alex-team` |
| A group named `alex-team` with a subgroup named `marketing`. | `https://gitlab.example.com/alex-team/marketing` | `alex-team/marketing` |
|
---
stage: Tenant Scale
group: Organizations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Namespaces
description: Learn more about different types of namespaces.
breadcrumbs:
- doc
- user
- namespace
---
Namespaces organize projects in GitLab. Because each namespace is separate,
you can use the same project name in multiple namespaces.
When you choose a name for your namespace, keep in mind:
- [Naming rules](../reserved_names.md#rules-for-usernames-project-and-group-names-and-slugs)
- [Reserved group names](../reserved_names.md#reserved-group-names)
{{< alert type="note" >}}
Namespaces with a period (`.`) cause issues with SSL certificate validation and the source path when [publishing Terraform modules](../packages/terraform_module_registry/_index.md#publish-a-terraform-module).
{{< /alert >}}
## Types of namespaces
GitLab has two types of namespaces:
- **User**: Your personal namespace is based on your username. In a personal namespace:
- You cannot create subgroups.
- Groups you belong to do not inherit your personal namespace permissions or features.
- All the projects you create are under the scope of this namespace.
- Changes to your username also change project and namespace URLs. Before you change your username,
read about [repository redirects](../project/repository/_index.md#repository-path-changes).
- **Group**: A group or subgroup namespace is based on the group or subgroup name. In group and subgroup namespaces:
- You can create multiple subgroups to manage multiple projects.
- Subgroups inherit some of the parent group settings. You can view these in the subgroup **Settings**.
- You can configure settings specifically for each subgroup and project.
- You can manage the group or subgroup URL independently of the name.
## Determine which type of namespace you're in
To determine whether you're in a group or personal namespace, you can view the URL. For example:
| Namespace for | URL | Namespace |
| ------------- | --- | --------- |
| A user named `alex`. | `https://gitlab.example.com/alex` | `alex` |
| A group named `alex-team`. | `https://gitlab.example.com/alex-team` | `alex-team` |
| A group named `alex-team` with a subgroup named `marketing`. | `https://gitlab.example.com/alex-team/marketing` | `alex-team/marketing` |
|
https://docs.gitlab.com/user/migrating_from_gma_to_project_template
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/migrating_from_gma_to_project_template.md
|
2025-08-13
|
doc/user/clusters
|
[
"doc",
"user",
"clusters"
] |
migrating_from_gma_to_project_template.md
|
Deploy
|
Environments
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Migrate from GitLab Managed Apps to Cluster Management Projects (deprecated)
| null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The GitLab Managed Apps were deprecated in GitLab 14.0
in favor of user-controlled Cluster Management projects.
Managing your cluster applications through a project enables you a
lot more flexibility to manage your cluster than through the late GitLab Managed Apps.
To migrate to the cluster management project you need
[GitLab Runners](../../ci/runners/_index.md)
available and be familiar with [Helm](https://helm.sh/).
## Migrate to a Cluster Management Project
To migrate from GitLab Managed Apps to a Cluster Management Project,
follow the steps below.
See also [video walk-throughs](#video-walk-throughs) with examples.
1. Create a new project based on the [Cluster Management Project template](management_project_template.md#create-a-project-based-on-the-cluster-management-project-template).
1. [Install an agent](agent/install/_index.md) for this project in your cluster.
1. Set the `KUBE_CONTEXT` CI/CD variable to the newly installed agent's context, as instructed in the `.gitlab-ci.yml` from the Project Template.
1. Detect apps deployed through Helm v2 releases by using the pre-configured [`.gitlab-ci.yml`](management_project_template.md#the-gitlab-ciyml-file) file:
- In case you had overwritten the default GitLab Managed Apps namespace, edit `.gitlab-ci.yml`,
and make sure the script is receiving the correct namespace as an argument:
```yaml
script:
- gl-fail-if-helm2-releases-exist <your_custom_namespace>
```
- If you kept the default name (`gitlab-managed-apps`), then the script is already
set up.
Either way, [run a pipeline manually](../../ci/pipelines/_index.md#run-a-pipeline-manually) and read the logs of the
`detect-helm2-releases` job to know if you have any Helm v2 releases and which are they.
1. If you have no Helm v2 releases, skip this step. Otherwise, follow the official Helm documentation on
[how to migrate from Helm v2 to Helm v3](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/),
and clean up the Helm v2 releases after you are confident that they have been successfully migrated.
1. In this step you should already have only Helm v3 releases.
Uncomment from the main [`./helmfile.yaml`](management_project_template.md#the-main-helmfileyml-file) the paths for the
applications that you would like to manage with this project. Although you could uncomment all the ones you want to
managed at once, you should repeat the following steps separately for each app, so you do not get lost during
the process.
1. Edit the associated `applications/{app}/helmfiles.yaml` to match the chart version deployed
for your app. Take a GitLab Runner Helm v3 release as an example:
The following command lists the releases and their versions:
```shell
helm ls -n gitlab-managed-apps
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
runner gitlab-managed-apps 1 2021-06-09 19:36:55.739141644 +0000 UTC deployed gitlab-runner-0.28.0 13.11.0
```
Take the version from the `CHART` column which is in the format `{release}-v{chart_version}`,
then edit the `version:` attribute in the `./applications/gitlab-runner/helmfile.yaml`, so that it matches the version
you have deployed. This is a safe step to avoid upgrading versions during this migration.
Make sure you replace `gitlab-managed-apps` from the previous command if you have your apps deployed to a different
namespace.
1. Edit the `applications/{app}/values.yaml` associated with your app to match the
deployed values. For example, for GitLab Runner:
1. Copy the output of the following command (it might be big):
```shell
helm get values runner -n gitlab-managed-apps -a --output yaml
```
1. Overwrite `applications/gitlab-runner/values.yaml` with the output of the previous command.
This safe step guarantees that no unexpected default values overwrite your deployed values.
For instance, your GitLab Runner could have its `gitlabUrl` or `runnerRegistrationToken` overwritten by mistake.
1. Some apps require special attention:
- Ingress: Due to an existing [chart issue](https://github.com/helm/charts/pull/13646), you might see
`spec.clusterIP: Invalid value` when trying to run the [`./gl-helmfile`](management_project_template.md#the-gitlab-ciyml-file)
command. To work around this, after overwriting the release values in `applications/ingress/values.yaml`,
you might need to overwrite all the occurrences of `omitClusterIP: false`, setting it to `omitClusterIP: true`.
Another approach,could be to collect these IPs by running `kubectl get services -n gitlab-managed-apps`
and then overwriting each `ClusterIP` that it complains about with the value you got from that command.
- Vault: This application introduces a breaking change from the chart we used in Helm v2 to the chart
used in Helm v3. So, the only way to integrate it with this Cluster Management Project is to actually uninstall this app and accept the
chart version proposed in `applications/vault/values.yaml`.
- Cert-manager:
- For users on Kubernetes version 1.20 or later, the deprecated cert-manager v0.10 is no longer valid
and the upgrade includes a breaking change. So we suggest that you [backup and uninstall cert-manager v0.10](#backup-and-uninstall-cert-manager-v010),
and install the latest cert-manager instead. To install this version, uncomment `applications/cert-manager/helmfile.yaml`
from [`./helmfile.yaml`](management_project_template.md#the-main-helmfileyml-file).
This triggers a pipeline to install the new version.
- For users on Kubernetes versions lower than 1.20, you can stick to v0.10 by uncommenting
`applications/cert-manager-legacy/helmfile.yaml`
in your project's main Helmfile ([`./helmfile.yaml`](management_project_template.md#the-main-helmfileyml-file)).
{{< alert type="warning" >}}
Cert-manager v0.10 breaks when Kubernetes is upgraded to version 1.20 or later.
{{< /alert >}}
1. After following all the previous steps, [run a pipeline manually](../../ci/pipelines/_index.md#run-a-pipeline-manually)
and watch the `apply` job logs to see if any of your applications were successfully detected, installed, and whether they got any
unexpected updates.
Some annotation checksums are expected to be updated, as well as this attribute:
```diff
--- heritage: Tiller
+++ heritage: Tiller
```
After getting a successful pipeline, repeat these steps for any other deployed apps
you want to manage with the Cluster Management Project.
## Backup and uninstall cert-manager v0.10
1. Follow the [official docs](https://cert-manager.io/docs/devops-tips/backup/) on how to
backup your cert-manager v0.10 data.
1. Uninstall cert-manager by editing the setting all the occurrences of `installed: true` to `installed: false` in the
`applications/cert-manager/helmfile.yaml` file.
1. Search for any left-over resources by executing the following command `kubectl get Issuers,ClusterIssuers,Certificates,CertificateRequests,Orders,Challenges,Secrets,ConfigMaps -n gitlab-managed-apps | grep certmanager`.
1. For each of the resources found in the previous step, delete them with `kubectl delete -n gitlab-managed-apps {ResourceType} {ResourceName}`.
For example, if you found a resource of type `ConfigMap` named `cert-manager-controller`, delete it by executing:
`kubectl delete configmap -n gitlab-managed-apps cert-manager-controller`.
## Video walk-throughs
You can watch these videos with examples on how to migrate from GMA to a Cluster Management project:
- [Migrating from scratch using a brand new cluster management project](https://youtu.be/jCUFGWT0jS0). Also covers Helm v2 apps migration.
- [Migrating from an existing GitLab managed apps CI/CD project](https://youtu.be/U2lbBGZjZmc).
|
---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Migrate from GitLab Managed Apps to Cluster Management Projects (deprecated)
breadcrumbs:
- doc
- user
- clusters
---
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The GitLab Managed Apps were deprecated in GitLab 14.0
in favor of user-controlled Cluster Management projects.
Managing your cluster applications through a project enables you a
lot more flexibility to manage your cluster than through the late GitLab Managed Apps.
To migrate to the cluster management project you need
[GitLab Runners](../../ci/runners/_index.md)
available and be familiar with [Helm](https://helm.sh/).
## Migrate to a Cluster Management Project
To migrate from GitLab Managed Apps to a Cluster Management Project,
follow the steps below.
See also [video walk-throughs](#video-walk-throughs) with examples.
1. Create a new project based on the [Cluster Management Project template](management_project_template.md#create-a-project-based-on-the-cluster-management-project-template).
1. [Install an agent](agent/install/_index.md) for this project in your cluster.
1. Set the `KUBE_CONTEXT` CI/CD variable to the newly installed agent's context, as instructed in the `.gitlab-ci.yml` from the Project Template.
1. Detect apps deployed through Helm v2 releases by using the pre-configured [`.gitlab-ci.yml`](management_project_template.md#the-gitlab-ciyml-file) file:
- In case you had overwritten the default GitLab Managed Apps namespace, edit `.gitlab-ci.yml`,
and make sure the script is receiving the correct namespace as an argument:
```yaml
script:
- gl-fail-if-helm2-releases-exist <your_custom_namespace>
```
- If you kept the default name (`gitlab-managed-apps`), then the script is already
set up.
Either way, [run a pipeline manually](../../ci/pipelines/_index.md#run-a-pipeline-manually) and read the logs of the
`detect-helm2-releases` job to know if you have any Helm v2 releases and which are they.
1. If you have no Helm v2 releases, skip this step. Otherwise, follow the official Helm documentation on
[how to migrate from Helm v2 to Helm v3](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/),
and clean up the Helm v2 releases after you are confident that they have been successfully migrated.
1. In this step you should already have only Helm v3 releases.
Uncomment from the main [`./helmfile.yaml`](management_project_template.md#the-main-helmfileyml-file) the paths for the
applications that you would like to manage with this project. Although you could uncomment all the ones you want to
managed at once, you should repeat the following steps separately for each app, so you do not get lost during
the process.
1. Edit the associated `applications/{app}/helmfiles.yaml` to match the chart version deployed
for your app. Take a GitLab Runner Helm v3 release as an example:
The following command lists the releases and their versions:
```shell
helm ls -n gitlab-managed-apps
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
runner gitlab-managed-apps 1 2021-06-09 19:36:55.739141644 +0000 UTC deployed gitlab-runner-0.28.0 13.11.0
```
Take the version from the `CHART` column which is in the format `{release}-v{chart_version}`,
then edit the `version:` attribute in the `./applications/gitlab-runner/helmfile.yaml`, so that it matches the version
you have deployed. This is a safe step to avoid upgrading versions during this migration.
Make sure you replace `gitlab-managed-apps` from the previous command if you have your apps deployed to a different
namespace.
1. Edit the `applications/{app}/values.yaml` associated with your app to match the
deployed values. For example, for GitLab Runner:
1. Copy the output of the following command (it might be big):
```shell
helm get values runner -n gitlab-managed-apps -a --output yaml
```
1. Overwrite `applications/gitlab-runner/values.yaml` with the output of the previous command.
This safe step guarantees that no unexpected default values overwrite your deployed values.
For instance, your GitLab Runner could have its `gitlabUrl` or `runnerRegistrationToken` overwritten by mistake.
1. Some apps require special attention:
- Ingress: Due to an existing [chart issue](https://github.com/helm/charts/pull/13646), you might see
`spec.clusterIP: Invalid value` when trying to run the [`./gl-helmfile`](management_project_template.md#the-gitlab-ciyml-file)
command. To work around this, after overwriting the release values in `applications/ingress/values.yaml`,
you might need to overwrite all the occurrences of `omitClusterIP: false`, setting it to `omitClusterIP: true`.
Another approach,could be to collect these IPs by running `kubectl get services -n gitlab-managed-apps`
and then overwriting each `ClusterIP` that it complains about with the value you got from that command.
- Vault: This application introduces a breaking change from the chart we used in Helm v2 to the chart
used in Helm v3. So, the only way to integrate it with this Cluster Management Project is to actually uninstall this app and accept the
chart version proposed in `applications/vault/values.yaml`.
- Cert-manager:
- For users on Kubernetes version 1.20 or later, the deprecated cert-manager v0.10 is no longer valid
and the upgrade includes a breaking change. So we suggest that you [backup and uninstall cert-manager v0.10](#backup-and-uninstall-cert-manager-v010),
and install the latest cert-manager instead. To install this version, uncomment `applications/cert-manager/helmfile.yaml`
from [`./helmfile.yaml`](management_project_template.md#the-main-helmfileyml-file).
This triggers a pipeline to install the new version.
- For users on Kubernetes versions lower than 1.20, you can stick to v0.10 by uncommenting
`applications/cert-manager-legacy/helmfile.yaml`
in your project's main Helmfile ([`./helmfile.yaml`](management_project_template.md#the-main-helmfileyml-file)).
{{< alert type="warning" >}}
Cert-manager v0.10 breaks when Kubernetes is upgraded to version 1.20 or later.
{{< /alert >}}
1. After following all the previous steps, [run a pipeline manually](../../ci/pipelines/_index.md#run-a-pipeline-manually)
and watch the `apply` job logs to see if any of your applications were successfully detected, installed, and whether they got any
unexpected updates.
Some annotation checksums are expected to be updated, as well as this attribute:
```diff
--- heritage: Tiller
+++ heritage: Tiller
```
After getting a successful pipeline, repeat these steps for any other deployed apps
you want to manage with the Cluster Management Project.
## Backup and uninstall cert-manager v0.10
1. Follow the [official docs](https://cert-manager.io/docs/devops-tips/backup/) on how to
backup your cert-manager v0.10 data.
1. Uninstall cert-manager by editing the setting all the occurrences of `installed: true` to `installed: false` in the
`applications/cert-manager/helmfile.yaml` file.
1. Search for any left-over resources by executing the following command `kubectl get Issuers,ClusterIssuers,Certificates,CertificateRequests,Orders,Challenges,Secrets,ConfigMaps -n gitlab-managed-apps | grep certmanager`.
1. For each of the resources found in the previous step, delete them with `kubectl delete -n gitlab-managed-apps {ResourceType} {ResourceName}`.
For example, if you found a resource of type `ConfigMap` named `cert-manager-controller`, delete it by executing:
`kubectl delete configmap -n gitlab-managed-apps cert-manager-controller`.
## Video walk-throughs
You can watch these videos with examples on how to migrate from GMA to a Cluster Management project:
- [Migrating from scratch using a brand new cluster management project](https://youtu.be/jCUFGWT0jS0). Also covers Helm v2 apps migration.
- [Migrating from an existing GitLab managed apps CI/CD project](https://youtu.be/U2lbBGZjZmc).
|
https://docs.gitlab.com/user/environments
|
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user/environments.md
|
2025-08-13
|
doc/user/clusters
|
[
"doc",
"user",
"clusters"
] |
environments.md
|
Deploy
|
Environments
|
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
Cluster Environments (deprecated)
| null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Disabled on GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/353410) in GitLab 15.0.
{{< /history >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
{{< /alert >}}
{{< alert type="flag" >}}
On GitLab Self-Managed, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../../administration/feature_flags/_index.md) named `certificate_based_clusters`.
{{< /alert >}}
Cluster environments provide a consolidated view of which CI [environments](../../ci/environments/_index.md) are
deployed to the Kubernetes cluster and it:
- Shows the project and the relevant environment related to the deployment.
- Displays the status of the pods for that environment.
With cluster environments, you can gain insight into:
- Which projects are deployed to the cluster.
- How many pods are in use for each project's environment.
- The CI job that was used to deploy to that environment.
Access to cluster environments is restricted to
[group maintainers and owners](../permissions.md#group-members-permissions)
## Usage
To:
- Track environments for the cluster, you must
[deploy to a Kubernetes cluster](../project/clusters/deploy_to_cluster.md)
successfully.
- Show pod usage correctly, you must
[enable deploy boards](../project/deploy_boards.md#enabling-deploy-boards).
After you have successful deployments to your group-level or instance-level cluster:
1. Go to your group's **Kubernetes** page.
1. Select the **Environments** tab.
Only successful deployments to the cluster are included in this page.
Non-cluster environments aren't included.
|
---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Cluster Environments (deprecated)
breadcrumbs:
- doc
- user
- clusters
---
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Disabled on GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/353410) in GitLab 15.0.
{{< /history >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
{{< /alert >}}
{{< alert type="flag" >}}
On GitLab Self-Managed, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../../administration/feature_flags/_index.md) named `certificate_based_clusters`.
{{< /alert >}}
Cluster environments provide a consolidated view of which CI [environments](../../ci/environments/_index.md) are
deployed to the Kubernetes cluster and it:
- Shows the project and the relevant environment related to the deployment.
- Displays the status of the pods for that environment.
With cluster environments, you can gain insight into:
- Which projects are deployed to the cluster.
- How many pods are in use for each project's environment.
- The CI job that was used to deploy to that environment.
Access to cluster environments is restricted to
[group maintainers and owners](../permissions.md#group-members-permissions)
## Usage
To:
- Track environments for the cluster, you must
[deploy to a Kubernetes cluster](../project/clusters/deploy_to_cluster.md)
successfully.
- Show pod usage correctly, you must
[enable deploy boards](../project/deploy_boards.md#enabling-deploy-boards).
After you have successful deployments to your group-level or instance-level cluster:
1. Go to your group's **Kubernetes** page.
1. Select the **Environments** tab.
Only successful deployments to the cluster are included in this page.
Non-cluster environments aren't included.
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.