org.keycloak.protocol.oidc.mappers

Class ScriptBasedOIDCProtocolMapper

java.lang.Object

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

org.keycloak.protocol.oidc.mappers.ScriptBasedOIDCProtocolMapper

All Implemented Interfaces:

OIDCAccessTokenMapper, OIDCIDTokenMapper, UserInfoTokenMapper, ProtocolMapper, ConfiguredProvider, Provider, ProviderFactory<ProtocolMapper>

public class ScriptBasedOIDCProtocolMapper
extends AbstractOIDCProtocolMapper
implements OIDCAccessTokenMapper, OIDCIDTokenMapper, UserInfoTokenMapper

OIDC ProtocolMapper that uses a provided JavaScript fragment to compute the token claim value.

Author:

Thomas Darimont

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROVIDER_ID

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

TOKEN_MAPPER_CATEGORY

Constructor Summary

Constructors

Constructor and Description
ScriptBasedOIDCProtocolMapper()

Method Summary

Modifier and Type	Method and Description
static ProtocolMapperModel	create(String name, String userAttribute, String tokenClaimName, String claimType, boolean consentRequired, String consentText, boolean accessToken, boolean idToken, String script, boolean multiValued)
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
String	getHelpText()
String	getId()
boolean	isSupported()
protected void	setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession) Intended to be overridden in ProtocolMapper implementations to add claims to an token.
void	validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel)

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

close, create, getProtocol, init, postInit, setClaim, transformAccessToken, 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.protocol.oidc.mappers.OIDCAccessTokenMapper

transformAccessToken

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

transformIDToken

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

transformUserInfoToken

Methods inherited from interface org.keycloak.provider.ProviderFactory

order

Field Detail

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

Constant Field Values

Constructor Detail

ScriptBasedOIDCProtocolMapper

public ScriptBasedOIDCProtocolMapper()

Method Detail

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

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

isSupported

public boolean isSupported()

setClaim

protected void setClaim(IDToken token,
                        ProtocolMapperModel mappingModel,
                        UserSessionModel userSession,
                        KeycloakSession keycloakSession)

Description copied from class: AbstractOIDCProtocolMapper

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

Overrides:

setClaim in class AbstractOIDCProtocolMapper

validateConfig

public void validateConfig(KeycloakSession session,
                           RealmModel realm,
                           ProtocolMapperContainerModel client,
                           ProtocolMapperModel mapperModel)
                    throws ProtocolMapperConfigException

Specified by:

validateConfig in interface ProtocolMapper

Throws:

ProtocolMapperConfigException

create

public static ProtocolMapperModel create(String name,
                                         String userAttribute,
                                         String tokenClaimName,
                                         String claimType,
                                         boolean consentRequired,
                                         String consentText,
                                         boolean accessToken,
                                         boolean idToken,
                                         String script,
                                         boolean multiValued)