Service accounts

Tier: Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

A service account is a type of machine user that is not tied to an individual human user.

A service account:

  • Does not use a licensed seat, but is not available on trial versions.
  • Is not a:
    • Billable user.
    • Bot user.
  • Is listed in group membership as a service account.
  • Cannot sign in to GitLab through the UI.

You should use service accounts in pipelines or integrations where credentials must be set up and maintained without being impacted by changes in human user membership.

You can authenticate as a service account with a personal access token. Service account users with a personal access token have the same abilities as a standard user. This includes interacting with registries and using the personal access token for Git operations.

Create a service account

The number of service accounts you can create is restricted by the number of service accounts allowed under your license:

  • On GitLab Free, service accounts are not available.
  • On GitLab Premium, you can create one service account for every paid seat you have.
  • On GitLab Ultimate, you can create an unlimited number of service accounts.

How you create an account differs depending on whether you are on GitLab.com or self-managed.

GitLab.com

Prerequisites:

  • You must have the Owner role in a top-level group.

  1. Create a service account.

    This service account is associated only with your top-level group.

  2. Create a personal access token for the service account user.

    You define the scopes for the service account by setting the scopes for the personal access token.

    Optional. You can create a personal access token with no expiry date.

    The response includes the personal access token value.

  3. Make this service account a group or project member by manually adding the service account user to the group or project.
  4. Use the returned personal access token value to authenticate as the service account user.

Self-managed GitLab

Prerequisites:

  • You must be an administrator for your self-managed instance.

  1. Create a service account.

    This service account is associated with the entire instance, not a specific group or project in the instance.

  2. Create a personal access token for the service account user.

    You define the scopes for the service account by setting the scopes for the personal access token.

    Optional. You can create a personal access token with no expiry date.

    The response includes the personal access token value.

  3. Make this service account a group or project member by manually adding the service account user to the group or project.
  4. Use the returned personal access token value to authenticate as the service account user.

Add a service account to subgroup or project

In terms of functionality, a service account is the same as an external user and has minimal access when you first create it.

You must manually add the service account to each project or group you want the account to have access to.

There is no limit to the number of service accounts you can add to a project or group.

A service account:

  • Can have different roles across multiple subgroups and projects of the same top level group.
  • On GitLab.com, only belongs to one top-level group.

Add to a subgroup or project

You can add the service account to a subgroup or project through the:

Change a service account role in a subgroup or project

You can change a service account role in a subgroup or project through the UI or the API.

To use the UI, go to the subgroup’s or project’s membership list and change the service account’s role.

To use the API, call the following endpoint: 

curl --request POST --header "PRIVATE-TOKEN: <PRIVATE-TOKEN>" \ --data "user_id=<service_account_user_id>&access_level=30" "https://gitlab.example.com/api/v4/projects/<project_id>/members"

For more information on the attributes, see the API documentation on editing a member of a group or project.

Rotate the personal access token

Prerequisites:

  • For GitLab.com, you must have the Owner role in a top-level group.
  • For self-managed GitLab, you must be an administrator for your self-managed instance.

Use the groups API to rotate the personal access token for a service account user.

Disable a service account

You cannot directly disable or delete a service account. Instead, you must:

  1. Remove the service account as a member of all subgroups and projects: 

    curl --request DELETE --header "PRIVATE-TOKEN: <access_token_id>" "https://gitlab.example.com/api/v4/groups/<group_id>/members/<service_account_id>"

    For more information, see the API documentation on removing a member from a group or project.

  2. Revoke the personal access token using the UI or the API.