Package org.keycloak.protocol.oidc.mappers

Class AllowedWebOriginsProtocolMapper

java.lang.Object

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

org.keycloak.protocol.oidc.mappers.AllowedWebOriginsProtocolMapper

All Implemented Interfaces:

OIDCAccessTokenMapper, TokenIntrospectionTokenMapper, org.keycloak.protocol.ProtocolMapper, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>

public class AllowedWebOriginsProtocolMapper
extends AbstractOIDCProtocolMapper
implements OIDCAccessTokenMapper, TokenIntrospectionTokenMapper

Protocol mapper to add allowed web origins to the access token to the 'allowed-origins' claim

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Fields inherited from class org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

TOKEN_MAPPER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
AllowedWebOriginsProtocolMapper()

Method Summary

Modifier and Type	Method	Description
static org.keycloak.models.ProtocolMapperModel	createClaimMapper(String name, boolean accessToken, boolean introspectionEndpoint)
List<org.keycloak.provider.ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
org.keycloak.models.ProtocolMapperModel	getEffectiveModel(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.ProtocolMapperModel protocolMapperModel)
String	getHelpText()
String	getId()
org.keycloak.representations.AccessToken	transformAccessToken(org.keycloak.representations.AccessToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)
org.keycloak.representations.AccessToken	transformIntrospectionToken(org.keycloak.representations.AccessToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)

Methods inherited from class org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

close, create, getProtocol, getShouldUseLightweightToken, init, postInit, setClaim, setClaim, setClaim, transformAccessTokenResponse, transformIDToken, transformUserInfoToken

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.protocol.ProtocolMapper

getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

Constructor Details

AllowedWebOriginsProtocolMapper

public AllowedWebOriginsProtocolMapper()

Method Details

getConfigProperties

public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface org.keycloak.provider.ConfiguredProvider

getId

public String getId()

Specified by:

getId in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface org.keycloak.protocol.ProtocolMapper

getDisplayCategory

public String getDisplayCategory()

Specified by:

getDisplayCategory in interface org.keycloak.protocol.ProtocolMapper

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface org.keycloak.provider.ConfiguredProvider

transformAccessToken

public org.keycloak.representations.AccessToken transformAccessToken(org.keycloak.representations.AccessToken token,
 org.keycloak.models.ProtocolMapperModel mappingModel,
 org.keycloak.models.KeycloakSession session,
 org.keycloak.models.UserSessionModel userSession,
 org.keycloak.models.ClientSessionContext clientSessionCtx)

Specified by:

transformAccessToken in interface OIDCAccessTokenMapper

Overrides:

transformAccessToken in class AbstractOIDCProtocolMapper

transformIntrospectionToken

public org.keycloak.representations.AccessToken transformIntrospectionToken(org.keycloak.representations.AccessToken token,
 org.keycloak.models.ProtocolMapperModel mappingModel,
 org.keycloak.models.KeycloakSession session,
 org.keycloak.models.UserSessionModel userSession,
 org.keycloak.models.ClientSessionContext clientSessionCtx)

Specified by:

transformIntrospectionToken in interface TokenIntrospectionTokenMapper

Overrides:

transformIntrospectionToken in class AbstractOIDCProtocolMapper

getEffectiveModel

public org.keycloak.models.ProtocolMapperModel getEffectiveModel(org.keycloak.models.KeycloakSession session,
 org.keycloak.models.RealmModel realm,
 org.keycloak.models.ProtocolMapperModel protocolMapperModel)

Specified by:

getEffectiveModel in interface org.keycloak.protocol.ProtocolMapper

Overrides:

getEffectiveModel in class AbstractOIDCProtocolMapper

createClaimMapper

public static org.keycloak.models.ProtocolMapperModel createClaimMapper(String name,
 boolean accessToken,
 boolean introspectionEndpoint)