- Create a project access token
- Revoke a project access token
- Scopes for a project access token
- Enable or disable project access token creation
- Bot users for projects
- Token availability
Project access tokens
- Introduced in GitLab 13.0.
- Became available on GitLab.com in GitLab 13.5 for paid groups only.
- Feature flag removed in GitLab 13.5.
- Changed in GitLab 14.5. Default prefix added.
- Became available in trial subscriptions in GitLab 16.1. Default prefix added.
Project access tokens are similar to passwords, except you can limit access to resources, select a limited role, and provide an expiry date.
Use a project access token to authenticate:
- With the GitLab API.
- With Git, when using HTTP Basic Authentication, use:
- Any non-blank value as a username.
- The project access token as the password.
Project access tokens are similar to group access tokens and personal access tokens.
In self-managed instances, project access tokens are subject to the same maximum lifetime limits as personal access tokens if the limit is set.
You can use project access tokens:
- On GitLab SaaS: If you have the Premium or Ultimate license tier, only one project access token is available with a trial license.
- On self-managed instances of GitLab: With any license tier. If you have the Free tier, consider disabling project access tokens to lower potential abuse.
You cannot use project access tokens to create other group, project, or personal access tokens.
Project access tokens inherit the default prefix setting configured for personal access tokens.
Create a project access token
- Introduced in GitLab 15.1, Owners can select Owner role for project access tokens.
- 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 project access tokens removed in GitLab 16.0.
To create a project access token:
- On the left sidebar, select Search or go to and find your project.
- Select Settings > Access Tokens.
- Enter a name. The token name is visible to any user with permissions to view the project.
- 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 project access token.
A project access token is displayed. Save the project access token somewhere safe. After you leave or refresh the page, you can’t view it again.
Revoke a project access token
To revoke a project access token:
- On the left sidebar, select Search or go to and find your project.
- Select Settings > Access Tokens.
- Next to the project access token to revoke, select Revoke.
Scopes for a project access token
k8s_proxy introduced in GitLab 16.4 with a flag named k8s_proxy_pat. Enabled by default.
The scope determines the actions you can perform when you authenticate with a project access token.
| Scope | Description |
|---|---|
api | Grants complete read and write access to the scoped project API, including the Package Registry. |
read_api | Grants read access to the scoped project API, including the Package Registry. |
read_registry | Grants read access (pull) to the Container Registry images if a project is private and authorization is required. |
write_registry | Grants write access (push) to the Container Registry. |
read_repository | Grants read access (pull) to the repository. |
write_repository | Grants read and write access (pull and push) to the repository. |
create_runner | Grants permission to create runners in the project. |
ai_features | Grants permission to perform API actions for GitLab Duo. |
k8s_proxy | Grants permission to perform Kubernetes API calls using the agent for Kubernetes in the project. |
Enable or disable project access token creation
Introduced in GitLab 13.11.
To enable or disable project access token creation for all projects 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 Allow project and group access token creation.
Even when creation is disabled, you can still use and revoke existing project access tokens.
Bot users for projects
- Introduced in GitLab 13.0.
- Excluded from license seat use in GitLab 13.5.
Bot users for projects are GitLab-created service accounts. Each time you create a project access token, a bot user is created and added to the project. This user is not a billable user, so it does not count toward the license limit.
The bot users for projects have permissions that correspond with the selected role and scope of the project access token.
- The name is set to the name of the token.
- The username is set to
project_{project_id}_bot_{random_string}. For example,project_123_bot_4ffca233d8298ea1. - The email is set to
project_{project_id}_bot_{random_string}@noreply.{Gitlab.config.gitlab.host}. For example,project_123_bot_4ffca233d8298ea1@noreply.example.com.
API calls made with a project access token are associated with the corresponding bot user.
Bot users for projects:
- Are included in a project’s member list but cannot be modified.
- Cannot be added to any other project.
- Can have a maximum role of Owner for a project. For more information, see Create a project access token.
When the project access token is revoked:
- The bot user is deleted.
- All records are moved to a system-wide user with the username Ghost User.
See also Bot users for groups.
Token availability
More than one project access token is only available in paid subscriptions. In Premium and Ultimate trial subscriptions, only one project access token is included. For more information, see the “What is included” section of the GitLab Trial FAQ.