GitLab authentication

Authenticate the GitLab provider on gitlab.com or a self-managed instance.

The gitlab provider from repo-sdk/gitlab authenticates with a personal, project, or group access token (or an OAuth token), and targets self-managed instances via a baseUrl that includes /api/v4.

Token auth

GitLab has one token shape. A personal access token, a project access token, a group access token, and an OAuth token all work the same way — the SDK sends whichever you pass as a Bearer credential.

import { createClient } from 'repo-sdk';
import { gitlab } from 'repo-sdk/gitlab';

const client = createClient({
  provider: gitlab({ auth: { token: process.env.GITLAB_TOKEN! } }),
});

Scopes

Pick the token scope for what you’ll do:

• read_api — required for the REST operations the client uses (discovery, commits, tags, webhooks, archive downloads). Use api if you also create or update webhooks.
• read_repository — required for git clone access via repos.getCloneUrl.

Self-managed instances

For a self-managed GitLab, pass the full API base URL including the /api/v4 suffix — it is used verbatim. The default is https://gitlab.com/api/v4.

gitlab({
  auth: { token: process.env.GITLAB_TOKEN! },
  baseUrl: 'https://gitlab.example.com/api/v4',
});

Expiring tokens

auth: { tokenProvider } mints the bearer token per request, with one forced-refresh retry on 401 — see Expiring tokens for the contract.