public class ScriptBasedOIDCProtocolMapper extends AbstractOIDCProtocolMapper implements OIDCAccessTokenMapper, OIDCIDTokenMapper, UserInfoTokenMapper, OIDCAccessTokenResponseMapper, EnvironmentDependentProviderFactory
ProtocolMapper that uses a provided JavaScript fragment to compute the token claim value.| Modifier and Type | Field and Description |
|---|---|
static String |
PROVIDER_ID |
static String |
SCRIPT |
TOKEN_MAPPER_CATEGORY| Constructor and Description |
|---|
ScriptBasedOIDCProtocolMapper() |
| Modifier and Type | Method and Description |
|---|---|
static ProtocolMapperModel |
create(String name,
String userAttribute,
String tokenClaimName,
String claimType,
boolean accessToken,
boolean idToken,
String script,
boolean multiValued) |
List<ProviderConfigProperty> |
getConfigProperties() |
String |
getDisplayCategory() |
String |
getDisplayType() |
String |
getHelpText() |
String |
getId() |
int |
getPriority()
Priority of this protocolMapper implementation.
|
protected String |
getScriptCode(ProtocolMapperModel mapperModel) |
boolean |
isSupported() |
protected void |
setClaim(AccessTokenResponse accessTokenResponse,
ProtocolMapperModel mappingModel,
UserSessionModel userSession,
KeycloakSession keycloakSession,
ClientSessionContext clientSessionCtx)
Intended to be overridden in
ProtocolMapper implementations to add claims to an token. |
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. |
void |
validateConfig(KeycloakSession session,
RealmModel realm,
ProtocolMapperContainerModel client,
ProtocolMapperModel mapperModel)
Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint
|
close, create, getProtocol, init, postInit, setClaim, transformAccessToken, transformAccessTokenResponse, transformIDToken, transformUserInfoTokenclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waittransformAccessTokentransformIDTokentransformUserInfoTokentransformAccessTokenResponseorderpublic static final String PROVIDER_ID
public static final String SCRIPT
public List<ProviderConfigProperty> getConfigProperties()
getConfigProperties in interface ConfiguredProviderpublic String getId()
getId in interface ProviderFactory<ProtocolMapper>public String getDisplayType()
getDisplayType in interface ProtocolMapperpublic String getDisplayCategory()
getDisplayCategory in interface ProtocolMapperpublic String getHelpText()
getHelpText in interface ConfiguredProviderpublic boolean isSupported()
isSupported in interface EnvironmentDependentProviderFactorytrue if the provider is supported and should be available, false otherwisepublic int getPriority()
ProtocolMappergetPriority in interface ProtocolMapperprotected void setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
AbstractOIDCProtocolMapperProtocolMapper implementations to add claims to an token.setClaim in class AbstractOIDCProtocolMapperprotected void setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
AbstractOIDCProtocolMapperProtocolMapper implementations to add claims to an token.setClaim in class AbstractOIDCProtocolMapperpublic void validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel) throws ProtocolMapperConfigException
ProtocolMappervalidateConfig in interface ProtocolMapperclient - client or clientTemplateProtocolMapperConfigException - if configuration provided in mapperModel is not validprotected String getScriptCode(ProtocolMapperModel mapperModel)
Copyright © 2021 JBoss by Red Hat. All rights reserved.