authentik.sources.oauth.types.gitlab

 1"""
 2GitLab OAuth Views
 3
 4See https://docs.gitlab.com/ee/integration/oauth_provider.html
 5and https://docs.gitlab.com/ee/integration/openid_connect_provider.html
 6"""
 7
 8from typing import Any
 9
10from authentik.sources.oauth.models import AuthorizationCodeAuthMethod, OAuthSource
11from authentik.sources.oauth.types.registry import SourceType, registry
12from authentik.sources.oauth.views.redirect import OAuthRedirect
13
14
15class GitLabOAuthRedirect(OAuthRedirect):
16    """GitLab OAuth2 Redirect"""
17
18    def get_additional_parameters(self, source: OAuthSource):
19        return {
20            "scope": ["read_user", "openid", "profile", "email"],
21        }
22
23
24@registry.register()
25class GitLabType(SourceType):
26    """GitLab Type definition"""
27
28    redirect_view = GitLabOAuthRedirect
29    verbose_name = "GitLab"
30    name = "gitlab"
31
32    urls_customizable = True
33
34    authorization_url = "https://gitlab.com/oauth/authorize"
35    access_token_url = "https://gitlab.com/oauth/token"  # nosec
36    profile_url = "https://gitlab.com/oauth/userinfo"
37    oidc_well_known_url = "https://gitlab.com/.well-known/openid-configuration"
38    oidc_jwks_url = "https://gitlab.com/oauth/discovery/keys"
39
40    authorization_code_auth_method = AuthorizationCodeAuthMethod.POST_BODY
41
42    def get_base_user_properties(self, info: dict[str, Any], **kwargs) -> dict[str, Any]:
43        return {
44            "username": info.get("preferred_username"),
45            "email": info.get("email"),
46            "name": info.get("name"),
47        }