Package org.keycloak.protocol.oidc.mappers

Class ParameterizedScopeMapper

java.lang.Object

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

org.keycloak.protocol.oidc.mappers.ParameterizedScopeMapper

All Implemented Interfaces:

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

Direct Known Subclasses:

ParameterizedScopeUserPropertyMapper

public class ParameterizedScopeMapper
extends AbstractOIDCProtocolMapper
implements OIDCAccessTokenMapper, OIDCIDTokenMapper, TokenIntrospectionTokenMapper, org.keycloak.provider.EnvironmentDependentProviderFactory

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
ParameterizedScopeMapper()

Method Summary

Modifier and Type	Method	Description
static org.keycloak.models.ProtocolMapperModel	create(String name, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
List<org.keycloak.provider.ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
String	getHelpText()
String	getId()
boolean	isSupported(org.keycloak.Config.Scope config)
protected Optional<org.keycloak.models.ClientScopeModel>	resolveClientScope(org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.ClientSessionContext clientSessionCtx)
protected List<String>	resolveParameterValues(org.keycloak.models.ClientScopeModel clientScope, org.keycloak.models.ClientSessionContext clientSessionCtx)
protected void	setClaim(org.keycloak.representations.IDToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.KeycloakSession keycloakSession, List<String> parameterValues)	Maps resolved parameter values to a token claim.
protected void	setClaim(org.keycloak.representations.IDToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.KeycloakSession keycloakSession, org.keycloak.models.ClientSessionContext clientSessionCtx)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.

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

close, create, getEffectiveModel, getProtocol, getShouldUseLightweightToken, init, postInit, setClaim, setClaim, transformAccessToken, transformAccessTokenResponse, transformIDToken, transformIntrospectionToken, 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.oidc.mappers.OIDCAccessTokenMapper

transformAccessToken

Methods inherited from interface org.keycloak.protocol.oidc.mappers.OIDCIDTokenMapper

transformIDToken

Methods inherited from interface org.keycloak.protocol.ProtocolMapper

getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Methods inherited from interface org.keycloak.protocol.oidc.mappers.TokenIntrospectionTokenMapper

transformIntrospectionToken

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

Constructor Details

ParameterizedScopeMapper

public ParameterizedScopeMapper()

Method Details

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

getConfigProperties

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

Specified by:

getConfigProperties in interface org.keycloak.provider.ConfiguredProvider

setClaim

protected void setClaim(org.keycloak.representations.IDToken token,
 org.keycloak.models.ProtocolMapperModel mappingModel,
 org.keycloak.models.UserSessionModel userSession,
 org.keycloak.models.KeycloakSession keycloakSession,
 org.keycloak.models.ClientSessionContext clientSessionCtx)

Description copied from class: AbstractOIDCProtocolMapper

Intended to be overridden in ProtocolMapper implementations to add claims to an token.

Overrides:

setClaim in class AbstractOIDCProtocolMapper

setClaim

protected void setClaim(org.keycloak.representations.IDToken token,
 org.keycloak.models.ProtocolMapperModel mappingModel,
 org.keycloak.models.UserSessionModel userSession,
 org.keycloak.models.KeycloakSession keycloakSession,
 List<String> parameterValues)

Maps resolved parameter values to a token claim. The mapper's multivalued config controls whether multiple values are mapped as a JSON array or only the first value is used.

resolveClientScope

protected Optional<org.keycloak.models.ClientScopeModel> resolveClientScope(org.keycloak.models.ProtocolMapperModel mappingModel,
 org.keycloak.models.ClientSessionContext clientSessionCtx)

resolveParameterValues

protected List<String> resolveParameterValues(org.keycloak.models.ClientScopeModel clientScope,
 org.keycloak.models.ClientSessionContext clientSessionCtx)

isSupported

public boolean isSupported(org.keycloak.Config.Scope config)

Specified by:

isSupported in interface org.keycloak.provider.EnvironmentDependentProviderFactory

create

public static org.keycloak.models.ProtocolMapperModel create(String name,
 String tokenClaimName,
 String claimType,
 boolean accessToken,
 boolean idToken,
 boolean introspectionEndpoint)