Package org.keycloak.protocol.oidc.mappers

Class ParameterizedScopeUserPropertyMapper

java.lang.Object

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

org.keycloak.protocol.oidc.mappers.ParameterizedScopeMapper

org.keycloak.protocol.oidc.mappers.ParameterizedScopeUserPropertyMapper

All Implemented Interfaces:

OIDCAccessTokenMapper, OIDCIDTokenMapper, TokenIntrospectionTokenMapper, ProtocolMapper, ConfiguredProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<ProtocolMapper>

public class ParameterizedScopeUserPropertyMapper
extends ParameterizedScopeMapper

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

Method Summary

Modifier and Type	Method	Description
static ProtocolMapperModel	create(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
static ProtocolMapperModel	create(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint, boolean multivalued)
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayType()
String	getHelpText()
String	getId()
protected void	setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientScopeModel clientScope, List<String> parameterValues)	Maps resolved parameter values to a token claim.

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

create, getDisplayCategory, isSupported, resolveClientScope, resolveParameterValues, setClaim, setClaim

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

ParameterizedScopeUserPropertyMapper

public ParameterizedScopeUserPropertyMapper()

Method Details

getId

public String getId()

Specified by:

getId in interface ProviderFactory<ProtocolMapper>

Overrides:

getId in class ParameterizedScopeMapper

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface ProtocolMapper

Overrides:

getDisplayType in class ParameterizedScopeMapper

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

Overrides:

getHelpText in class ParameterizedScopeMapper

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

Overrides:

getConfigProperties in class ParameterizedScopeMapper

setClaim

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

Description copied from class: ParameterizedScopeMapper

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.

Overrides:

setClaim in class ParameterizedScopeMapper

create

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

create

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