Skip to main content

providers/gitlab

Built-in GitLab integration.

default()​

default<P>(options): OAuthConfig<P>

Add GitLab login to your page.

Setup​

Callback URL​

https://example.com/api/auth/callback/gitlab

Configuration​

import Auth from "@auth/core"
import GitLab from "@auth/core/providers/gitlab"

const request = new Request(origin)
const response = await Auth(request, {
  providers: [GitLab({ clientId: GITLAB_CLIENT_ID, clientSecret: GITLAB_CLIENT_SECRET })],
})

Resources​

Notes​

By default, Auth.js assumes that the GitLab provider is based on the OAuth 2 specification.

tip

Enable the read_user option in scope if you want to save the users email address on sign up.

tip

The GitLab provider comes with a default configuration. To override the defaults for your use case, check out customizing a built-in OAuth provider.

Disclaimer

If you think you found a bug in the default configuration, you can open an issue.

Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec, we might not pursue a resolution. You can ask for more help in Discussions.

Type parameters​

▪ P extends GitLabProfile

Parameters​

▪ options: OAuthUserConfig<P>

Returns​

OAuthConfig<P>