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, ProtocolMapper, ConfiguredProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<ProtocolMapper>

Direct Known Subclasses:

ParameterizedScopeUserPropertyMapper

public class ParameterizedScopeMapper
extends AbstractOIDCProtocolMapper
implements OIDCAccessTokenMapper, OIDCIDTokenMapper, TokenIntrospectionTokenMapper, 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 ProtocolMapperModel	create(String name, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
String	getHelpText()
String	getId()
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
protected Optional<ClientScopeModel>	resolveClientScope(ProtocolMapperModel mappingModel, ClientSessionContext clientSessionCtx)
protected List<String>	resolveParameterValues(ClientScopeModel clientScope, ClientSessionContext clientSessionCtx)
protected void	setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, List<String> parameterValues)
protected void	setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientScopeModel clientScope, List<String> parameterValues)	Maps resolved parameter values to a token claim.
protected void	setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, 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 ProviderFactory<ProtocolMapper>

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface ProtocolMapper

getDisplayCategory

public String getDisplayCategory()

Specified by:

getDisplayCategory in interface ProtocolMapper

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

setClaim

protected void setClaim(IDToken token,
 ProtocolMapperModel mappingModel,
 UserSessionModel userSession,
 KeycloakSession keycloakSession,
 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(IDToken token,
 ProtocolMapperModel mappingModel,
 UserSessionModel userSession,
 KeycloakSession keycloakSession,
 ClientScopeModel clientScope,
 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.

setClaim

protected void setClaim(IDToken token,
 ProtocolMapperModel mappingModel,
 UserSessionModel userSession,
 KeycloakSession keycloakSession,
 List<String> parameterValues)

resolveClientScope

protected Optional<ClientScopeModel> resolveClientScope(ProtocolMapperModel mappingModel,
 ClientSessionContext clientSessionCtx)

resolveParameterValues

protected List<String> resolveParameterValues(ClientScopeModel clientScope,
 ClientSessionContext clientSessionCtx)

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

create

public static ProtocolMapperModel create(String name,
 String tokenClaimName,
 String claimType,
 boolean accessToken,
 boolean idToken,
 boolean introspectionEndpoint)