Group access tokens

DETAILS: Offering: GitLab.com, Self-managed, GitLab Dedicated

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.
Authenticate with Git over HTTPS. Use:
- Any non-blank value as a username.
- The group access token as the password.

On GitLab.com, you can use group access tokens if you have the Premium or Ultimate license tier. Group access tokens are not available with a trial license.

On GitLab Dedicated and 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.

Consider disabling group access tokens to lower potential abuse.

Group access tokens are similar to project access tokens and personal access tokens, except they are associated with a group rather than a project or user.

In self-managed instances, group access tokens are subject to the same maximum lifetime limits as personal access tokens if the limit is set.

You cannot use group access tokens to create other group, project, or personal access tokens.

Group access tokens inherit the default prefix setting configured for personal access tokens.

Create a group access token using UI

Introduced 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 in GitLab 16.0.

WARNING: The ability to create group access tokens without an expiry date was deprecated in GitLab 15.4 and removed in GitLab 16.0. For more information on expiry dates added to existing tokens, see the documentation on access token expiration.

To create a group access token:

On the left sidebar, select Search or go to and find your group.
Select Settings > Access tokens.
Select Add new token.
Enter a name. The token name is visible to any user with permissions to view the group.
Enter an expiry date for the token:
- The token expires on that date at midnight UTC.
- 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.
- An instance-wide maximum lifetime setting can limit the maximum allowable lifetime in self-managed instances.
Select a role for the token.
Select the desired scopes.
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.

WARNING: Group access tokens are treated as internal users. If an internal user creates a group access token, that token is able to access all projects that have visibility level set to Internal.

Create a group access token using Rails console

If you are an administrator, you can create group access tokens in the Rails console:

Run the following commands in a Rails console:

# 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)
bot = 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

# 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

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 in the group.
  - Create a project pipeline in one of the group's projects.
  - Create an issue in one of the group's projects.
2. Use the group token to clone a group's project using HTTPS.

Revoke a group access token

Ability to view revoked tokens introduced in GitLab 17.3 with a flag named retain_resource_access_token_user_after_revoke. Disabled by default.

You can use either the UI or the Rails console to revoke a group access token.

In GitLab 17.3 and later, if you enable the retain_resource_access_token_user_after_revoke feature flag, you can view both active and inactive revoked group access tokens on the access tokens page. If you do not enable the feature flag, you can only view the active tokens. The inactive group access tokens table:

Contains:
- Existing tokens that have been revoked but have not yet expired. After these tokens expire, they are no longer in the table.
- Tokens created after the feature flag was enabled that have been revoked. These tokens remain in the table even after they have expired.
Does not contain:
- Tokens that have already expired or been revoked.
- Existing tokens that expire in the future or have not been revoked.

Use the UI

To revoke a group access token:

On the left sidebar, select Search or go to and find your group.
Select Settings > Access tokens.
Next to the group access token to revoke, select Revoke ({remove}).

Use the Rails console

Prerequisites:

You must be an administrator.

To revoke a group access token, run the following command in a Rails console:

bot = User.find_by(username: 'group_109_bot') # the owner of the token you want to revoke
token = bot.personal_access_tokens.last # the token you want to revoke
token.revoke!

Scopes for a group access token

k8s_proxy introduced in GitLab 16.4 with a flag named k8s_proxy_pat. Enabled by default.

Feature flag k8s_proxy_pat removed in GitLab 16.5.

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, the dependency proxy, and the package registry.
`read_api`	Grants read access to the scoped group and related project API, including the package registry.
`read_registry`	Grants read access (pull) to the container registry images if any project within a group is private and authorization is required.
`write_registry`	Grants write access (push) to the container registry. You need both read and write access to push images.
`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.

Enable or disable group access token creation

To enable or disable group access token creation for all subgroups in a top-level group:

On the left sidebar, select Search or go to and find your group.
Select Settings > General.
Expand Permissions and group features.
Under Permissions, turn on or off Users can create project access tokens and group access tokens in this group.
Select Save changes.

Even when creation is disabled, you can still use and revoke existing group access tokens.

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

Bot users for groups

Bot users for groups are GitLab-created 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, 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.
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.

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.