GitLab

Backend class

For Django, add this class path to AUTHENTICATION_BACKENDS. For other integrations, use the same class path in the framework-specific backend setting.

Backend name

Class path

gitlab

social_core.backends.gitlab.GitLabOAuth2

GitLab supports OAuth2 protocol.

  • Register a new application at GitLab Applications.

  • Set the callback URL to http://example.com/complete/gitlab/ replacing example.com with your domain. Drop the trailing slash if the project doesn’t use it, the URL must match the value sent.

  • Ensure to mark the read_user scope. If marking api scope too, define:

    SOCIAL_AUTH_GITLAB_SCOPE = ['api']

  • Fill the Client ID and Client Secret values from GitLab in the settings:

    SOCIAL_AUTH_GITLAB_KEY = ''
SOCIAL_AUTH_GITLAB_SECRET = ''

If your GitLab setup resides in another domain, then add the following setting:

SOCIAL_AUTH_GITLAB_API_URL = 'https://example.com'

it must be the full url to your GitLab setup.

External memberships

See External groups for opt-in extraction, group-based login restrictions, and local group synchronization. No separate extraction pipeline step is needed. When SOCIAL_AUTH_GITLAB_GROUPS_ENABLED = True, the backend automatically requests read_api unless the requested scopes already contain read_api or api. Enable the corresponding scope in your GitLab OAuth application alongside read_user; read_user alone cannot retrieve memberships.