Package org.keycloak.social.google

Class GoogleIdentityProvider

java.lang.Object

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

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

org.keycloak.broker.oidc.OIDCIdentityProvider

org.keycloak.social.google.GoogleIdentityProvider

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 GoogleIdentityProvider
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	DEFAULT_SCOPE
static final String	ISSUER_URL
static final String	JWKS_URL
static final String	PROFILE_URL
static final String	TOKEN_INFO_URL
static final String	TOKEN_URL

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

EXCHANGE_PROVIDER, FEDERATED_ACCESS_TOKEN_RESPONSE, FEDERATED_ID_TOKEN, logger, SCOPE_OPENID, USER_INFO, 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
GoogleIdentityProvider(org.keycloak.models.KeycloakSession session, GoogleIdentityProviderConfig config)

Method Summary

Modifier and Type	Method	Description
protected jakarta.ws.rs.core.UriBuilder	createAuthorizationUrl(org.keycloak.broker.provider.AuthenticationRequest request)
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 String	getDefaultScopes()
protected String	getUserInfoUrl()
boolean	isAssertionReuseAllowed()
boolean	isIssuer(String issuer, jakarta.ws.rs.core.MultivaluedMap<String,String> params)
protected boolean	supportsExternalExchange()
protected org.keycloak.representations.JsonWebToken	validateToken(String encodedToken, boolean ignoreAudience)

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

authenticationFinished, backchannelLogout, backchannelLogout, callback, exchangeSessionToken, exchangeStoredToken, extractIdentity, extractIdentityFromProfile, getAllowedAudienceForJWTGrant, getAllowedClockSkew, getAssertionSignatureAlg, getFederatedIdentity, getIdentityProviderKeyWrapper, getMaxAllowedExpiration, getProfileEndpointForValidation, getusernameClaimNameForIdToken, getUsernameFromUserInfo, isAuthTimeExpired, isLimitAccessTokenExpiration, isTokenTypeSupported, isType, keycloakInitiatedBrowserLogout, parseTokenInput, preprocessFederatedIdentity, processAccessTokenResponse, refreshTokenForLogout, reloadKeys, resolveKeys, setEmailVerified, validateAuthorizationGrantAssertion, validateExternalTokenThroughUserInfo, validateJwt, 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

ISSUER_URL

public static final String ISSUER_URL

See Also:

• Constant Field Values

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

PROFILE_URL

public static final String PROFILE_URL

See Also:

• Constant Field Values

TOKEN_INFO_URL

public static final String TOKEN_INFO_URL

See Also:

• Constant Field Values

JWKS_URL

public static final String JWKS_URL

See Also:

• Constant Field Values

DEFAULT_SCOPE

public static final String DEFAULT_SCOPE

See Also:

• Constant Field Values

Constructor Details

GoogleIdentityProvider

public GoogleIdentityProvider(org.keycloak.models.KeycloakSession session,
 GoogleIdentityProviderConfig config)

Method Details

getDefaultScopes

protected String getDefaultScopes()

Overrides:

getDefaultScopes in class OIDCIdentityProvider

getUserInfoUrl

protected String getUserInfoUrl()

Overrides:

getUserInfoUrl in class OIDCIdentityProvider

supportsExternalExchange

protected boolean supportsExternalExchange()

Overrides:

supportsExternalExchange 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

createAuthorizationUrl

protected jakarta.ws.rs.core.UriBuilder createAuthorizationUrl(org.keycloak.broker.provider.AuthenticationRequest request)

Overrides:

createAuthorizationUrl in class OIDCIdentityProvider

validateToken

protected org.keycloak.representations.JsonWebToken validateToken(String encodedToken,
 boolean ignoreAudience)

Overrides:

validateToken in class OIDCIdentityProvider

isAssertionReuseAllowed

public boolean isAssertionReuseAllowed()

Specified by:

isAssertionReuseAllowed in interface org.keycloak.broker.provider.JWTAuthorizationGrantProvider<OIDCIdentityProviderConfig>

Overrides:

isAssertionReuseAllowed in class OIDCIdentityProvider