Package org.keycloak.social.gitlab

Class GitLabIdentityProvider

java.lang.Object

org.keycloak.broker.provider.AbstractIdentityProvider<C>

org.keycloak.broker.oidc.AbstractOAuth2IdentityProvider<OIDCIdentityProviderConfig>

org.keycloak.broker.oidc.OIDCIdentityProvider

org.keycloak.social.gitlab.GitLabIdentityProvider

All Implemented Interfaces:

org.keycloak.broker.provider.ClientAssertionIdentityProvider<OIDCIdentityProviderConfig>, org.keycloak.broker.provider.ExchangeExternalToken, org.keycloak.broker.provider.ExchangeTokenToIdentityProviderToken, org.keycloak.broker.provider.IdentityProvider<OIDCIdentityProviderConfig>, org.keycloak.broker.provider.JWTAuthorizationGrantProvider<OIDCIdentityProviderConfig>, org.keycloak.broker.provider.TrustMaterialIdentityProvider<OIDCIdentityProviderConfig>, org.keycloak.broker.provider.UserAuthenticationIdentityProvider<OIDCIdentityProviderConfig>, org.keycloak.broker.social.SocialIdentityProvider<OIDCIdentityProviderConfig>, org.keycloak.provider.Provider

public class GitLabIdentityProvider
extends OIDCIdentityProvider
implements org.keycloak.broker.social.SocialIdentityProvider<OIDCIdentityProviderConfig>

Author:

Stian Thorgersen

Nested Class Summary

Nested classes/interfaces inherited from class org.keycloak.broker.oidc.OIDCIdentityProvider

OIDCIdentityProvider.OIDCEndpoint

Nested classes/interfaces inherited from class org.keycloak.broker.oidc.AbstractOAuth2IdentityProvider

AbstractOAuth2IdentityProvider.Endpoint, AbstractOAuth2IdentityProvider.OAuthResponse

Nested classes/interfaces inherited from interface org.keycloak.broker.provider.UserAuthenticationIdentityProvider

org.keycloak.broker.provider.UserAuthenticationIdentityProvider.AuthenticationCallback

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH_URL
static final String	READ_USER_SCOPE
static final String	TOKEN_URL
static final String	USER_INFO

Fields inherited from class org.keycloak.broker.oidc.OIDCIdentityProvider

EXCHANGE_PROVIDER, FEDERATED_ACCESS_TOKEN_RESPONSE, FEDERATED_ID_TOKEN, logger, SCOPE_OPENID, VALIDATED_ACCESS_TOKEN, VALIDATED_ID_TOKEN

Fields inherited from class org.keycloak.broker.oidc.AbstractOAuth2IdentityProvider

ACCESS_DENIED, ACCESS_TOKEN_EXPIRATION, FEDERATED_REFRESH_TOKEN, FEDERATED_TOKEN_EXPIRATION, mapper, OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE, OAUTH2_GRANT_TYPE_REFRESH_TOKEN, OAUTH2_PARAMETER_ACCESS_TOKEN, OAUTH2_PARAMETER_CLIENT_ID, OAUTH2_PARAMETER_CLIENT_SECRET, OAUTH2_PARAMETER_CODE, OAUTH2_PARAMETER_GRANT_TYPE, OAUTH2_PARAMETER_REDIRECT_URI, OAUTH2_PARAMETER_RESPONSE_TYPE, OAUTH2_PARAMETER_SCOPE, OAUTH2_PARAMETER_STATE

Fields inherited from class org.keycloak.broker.provider.AbstractIdentityProvider

ACCOUNT_LINK_URL, BROKER_REGISTERED_NEW_USER, session, UPDATE_PROFILE_EMAIL_CHANGED, UPDATE_PROFILE_USERNAME_CHANGED

Fields inherited from interface org.keycloak.broker.provider.UserAuthenticationIdentityProvider

EXTERNAL_IDENTITY_PROVIDER, FEDERATED_ACCESS_TOKEN

Constructor Summary

Constructors

Constructor	Description
GitLabIdentityProvider(org.keycloak.models.KeycloakSession session, OIDCIdentityProviderConfig config)

Method Summary

Modifier and Type	Method	Description
protected org.keycloak.broker.provider.BrokeredIdentityContext	exchangeExternalImpl(org.keycloak.events.EventBuilder event, jakarta.ws.rs.core.MultivaluedMap<String,String> params)	Usage with external-internal token-exchange
protected org.keycloak.broker.provider.BrokeredIdentityContext	extractIdentity(org.keycloak.representations.AccessTokenResponse tokenResponse, String accessToken, org.keycloak.representations.JsonWebToken idToken)
protected org.keycloak.broker.provider.BrokeredIdentityContext	extractIdentityFromProfile(org.keycloak.events.EventBuilder event, com.fasterxml.jackson.databind.JsonNode profile)
protected String	getProfileEndpointForValidation(org.keycloak.events.EventBuilder event)
protected String	getusernameClaimNameForIdToken()
protected String	getUsernameFromUserInfo(com.fasterxml.jackson.databind.JsonNode userInfo)
boolean	isIssuer(String issuer, jakarta.ws.rs.core.MultivaluedMap<String,String> params)
protected boolean	supportsExternalExchange()

Methods inherited from class org.keycloak.broker.oidc.OIDCIdentityProvider

authenticationFinished, backchannelLogout, backchannelLogout, callback, createAuthorizationUrl, exchangeSessionToken, exchangeStoredToken, getAllowedAudienceForJWTGrant, getAllowedClockSkew, getAssertionSignatureAlg, getDefaultScopes, getFederatedIdentity, getIdentityProviderKeyWrapper, getMaxAllowedExpiration, getUserInfoUrl, isAssertionReuseAllowed, isAuthTimeExpired, isLimitAccessTokenExpiration, isTokenTypeSupported, isType, keycloakInitiatedBrowserLogout, parseTokenInput, preprocessFederatedIdentity, processAccessTokenResponse, refreshTokenForLogout, reloadKeys, resolveKeys, setEmailVerified, validateAuthorizationGrantAssertion, validateExternalTokenThroughUserInfo, validateJwt, validateToken, validateToken, verify, verifyClientAssertion, verifySignature

Methods inherited from class org.keycloak.broker.oidc.AbstractOAuth2IdentityProvider

asJsonNode, authenticateTokenRequest, buildUserInfoRequest, doGetFederatedIdentity, exchangeExternal, exchangeExternalComplete, exchangeExternalUserInfoValidationOnly, exchangeFromToken, extractTokenFromResponse, generateToken, getAccessTokenResponseParameter, getConfig, getJsonProperty, getRefreshTokenRequest, getSignatureContext, hasExternalExchangeToken, performLogin, retrieveToken, retrieveToken, sendTokenIntrospectionRequest, supportsLongStateParameter, validateExternalTokenWithIntrospectionEndpoint

Methods inherited from class org.keycloak.broker.provider.AbstractIdentityProvider

buildTokenResponse, close, exchangeErrorResponse, exchangeNotLinked, exchangeNotLinkedNoStore, exchangeNotSupported, exchangeTokenExpired, exchangeUnsupportedRequiredType, getFederatedAccessToken, getLinkingUrl, getMarshaller, importNewUser, updateBrokeredUser, updateEmail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.broker.provider.ExchangeExternalToken

exchangeExternal, exchangeExternalComplete

Methods inherited from interface org.keycloak.broker.provider.IdentityProvider

export, getConfig, isMapperSupported, isType, reloadKeys

Methods inherited from interface org.keycloak.provider.Provider

close

Methods inherited from interface org.keycloak.broker.provider.UserAuthenticationIdentityProvider

authenticationFinished, backchannelLogout, callback, getMarshaller, importNewUser, keycloakInitiatedBrowserLogout, performLogin, preprocessFederatedIdentity, retrieveToken, retrieveToken, supportsLongStateParameter, updateBrokeredUser

Field Details

AUTH_URL

public static final String AUTH_URL

See Also:

• Constant Field Values

TOKEN_URL

public static final String TOKEN_URL

See Also:

• Constant Field Values

USER_INFO

public static final String USER_INFO

See Also:

• Constant Field Values

READ_USER_SCOPE

public static final String READ_USER_SCOPE

See Also:

• Constant Field Values

Constructor Details

GitLabIdentityProvider

public GitLabIdentityProvider(org.keycloak.models.KeycloakSession session,
 OIDCIdentityProviderConfig config)

Method Details

getUsernameFromUserInfo

protected String getUsernameFromUserInfo(com.fasterxml.jackson.databind.JsonNode userInfo)

Overrides:

getUsernameFromUserInfo in class OIDCIdentityProvider

getusernameClaimNameForIdToken

protected String getusernameClaimNameForIdToken()

Overrides:

getusernameClaimNameForIdToken in class OIDCIdentityProvider

supportsExternalExchange

protected boolean supportsExternalExchange()

Overrides:

supportsExternalExchange in class OIDCIdentityProvider

getProfileEndpointForValidation

protected String getProfileEndpointForValidation(org.keycloak.events.EventBuilder event)

Overrides:

getProfileEndpointForValidation in class OIDCIdentityProvider

isIssuer

public boolean isIssuer(String issuer,
 jakarta.ws.rs.core.MultivaluedMap<String,String> params)

Specified by:

isIssuer in interface org.keycloak.broker.provider.ExchangeExternalToken

Overrides:

isIssuer in class OIDCIdentityProvider

exchangeExternalImpl

protected org.keycloak.broker.provider.BrokeredIdentityContext exchangeExternalImpl(org.keycloak.events.EventBuilder event,
 jakarta.ws.rs.core.MultivaluedMap<String,String> params)

Description copied from class: AbstractOAuth2IdentityProvider

Usage with external-internal token-exchange

Overrides:

exchangeExternalImpl in class OIDCIdentityProvider

Parameters:

event - event builder

params - parameters of the token-exchange request

Returns:

brokered identity context with the details about user from the IDP

extractIdentityFromProfile

protected org.keycloak.broker.provider.BrokeredIdentityContext extractIdentityFromProfile(org.keycloak.events.EventBuilder event,
 com.fasterxml.jackson.databind.JsonNode profile)

Overrides:

extractIdentityFromProfile in class OIDCIdentityProvider

extractIdentity

protected org.keycloak.broker.provider.BrokeredIdentityContext extractIdentity(org.keycloak.representations.AccessTokenResponse tokenResponse,
 String accessToken,
 org.keycloak.representations.JsonWebToken idToken)
                                                                        throws IOException

Overrides:

extractIdentity in class OIDCIdentityProvider

Throws:

IOException