Package org.keycloak.social.openshift

Class OpenshiftV4IdentityProvider

java.lang.Object

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

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

org.keycloak.social.openshift.OpenshiftV4IdentityProvider

All Implemented Interfaces:

org.keycloak.broker.provider.ExchangeExternalToken, org.keycloak.broker.provider.ExchangeTokenToIdentityProviderToken, org.keycloak.broker.provider.IdentityProvider<OpenshiftV4IdentityProviderConfig>, org.keycloak.broker.provider.UserAuthenticationIdentityProvider<OpenshiftV4IdentityProviderConfig>, org.keycloak.broker.social.SocialIdentityProvider<OpenshiftV4IdentityProviderConfig>, org.keycloak.provider.Provider

public class OpenshiftV4IdentityProvider
extends AbstractOAuth2IdentityProvider<OpenshiftV4IdentityProviderConfig>
implements org.keycloak.broker.social.SocialIdentityProvider<OpenshiftV4IdentityProviderConfig>

Identity provider for Openshift V4.

Author:

David Festal and Sebastian Łaskawiec

Nested Class Summary

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	BASE_URL
static final String	DEFAULT_SCOPE
static final String	OPENSHIFT_OAUTH_METADATA_ENDPOINT
static final String	PROFILE_RESOURCE

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

ACCESS_DENIED, ACCESS_TOKEN_EXPIRATION, FEDERATED_REFRESH_TOKEN, FEDERATED_TOKEN_EXPIRATION, logger, 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
OpenshiftV4IdentityProvider(org.keycloak.models.KeycloakSession session, OpenshiftV4IdentityProviderConfig config)

Method Summary

Modifier and Type	Method	Description
protected org.keycloak.broker.provider.BrokeredIdentityContext	doGetFederatedIdentity(String accessToken)
protected org.keycloak.broker.provider.BrokeredIdentityContext	extractIdentityFromProfile(org.keycloak.events.EventBuilder event, com.fasterxml.jackson.databind.JsonNode profile)
protected String	getDefaultScopes()
protected String	getProfileEndpointForValidation(org.keycloak.events.EventBuilder event)
protected boolean	supportsExternalExchange()

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

asJsonNode, authenticateTokenRequest, authenticationFinished, buildUserInfoRequest, callback, createAuthorizationUrl, exchangeExternal, exchangeExternalComplete, exchangeExternalImpl, exchangeExternalUserInfoValidationOnly, exchangeFromToken, exchangeSessionToken, exchangeStoredToken, extractTokenFromResponse, generateToken, getAccessTokenResponseParameter, getConfig, getFederatedIdentity, getJsonProperty, getRefreshTokenRequest, getSignatureContext, hasExternalExchangeToken, isIssuer, performLogin, retrieveToken, retrieveToken, sendTokenIntrospectionRequest, supportsLongStateParameter, validateExternalTokenThroughUserInfo, validateExternalTokenWithIntrospectionEndpoint

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

backchannelLogout, buildTokenResponse, close, exchangeErrorResponse, exchangeNotLinked, exchangeNotLinkedNoStore, exchangeNotSupported, exchangeTokenExpired, exchangeUnsupportedRequiredType, getFederatedAccessToken, getLinkingUrl, getMarshaller, importNewUser, keycloakInitiatedBrowserLogout, preprocessFederatedIdentity, setEmailVerified, 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.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

BASE_URL

public static final String BASE_URL

See Also:

• Constant Field Values

OPENSHIFT_OAUTH_METADATA_ENDPOINT

public static final String OPENSHIFT_OAUTH_METADATA_ENDPOINT

See Also:

• Constant Field Values

PROFILE_RESOURCE

public static final String PROFILE_RESOURCE

See Also:

• Constant Field Values

DEFAULT_SCOPE

public static final String DEFAULT_SCOPE

See Also:

• Constant Field Values

Constructor Details

OpenshiftV4IdentityProvider

public OpenshiftV4IdentityProvider(org.keycloak.models.KeycloakSession session,
 OpenshiftV4IdentityProviderConfig config)

Method Details

getDefaultScopes

protected String getDefaultScopes()

Specified by:

getDefaultScopes in class AbstractOAuth2IdentityProvider<OpenshiftV4IdentityProviderConfig>

doGetFederatedIdentity

protected org.keycloak.broker.provider.BrokeredIdentityContext doGetFederatedIdentity(String accessToken)

Overrides:

doGetFederatedIdentity in class AbstractOAuth2IdentityProvider<OpenshiftV4IdentityProviderConfig>

supportsExternalExchange

protected boolean supportsExternalExchange()

Overrides:

supportsExternalExchange in class AbstractOAuth2IdentityProvider<OpenshiftV4IdentityProviderConfig>

getProfileEndpointForValidation

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

Overrides:

getProfileEndpointForValidation in class AbstractOAuth2IdentityProvider<OpenshiftV4IdentityProviderConfig>

extractIdentityFromProfile

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

Overrides:

extractIdentityFromProfile in class AbstractOAuth2IdentityProvider<OpenshiftV4IdentityProviderConfig>