Package org.keycloak.protocol.oidc.mappers

Class AudienceResolveProtocolMapper

java.lang.Object

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

org.keycloak.protocol.oidc.mappers.AudienceResolveProtocolMapper

All Implemented Interfaces:

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

public class AudienceResolveProtocolMapper
extends AbstractOIDCProtocolMapper
implements OIDCAccessTokenMapper

Protocol mapper, which adds all client_ids of "allowed" clients to the audience field of the token. Allowed client means the client for which user has at least one client role

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROVIDER_ID

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

TOKEN_MAPPER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
AudienceResolveProtocolMapper()

Method Summary

Modifier and Type	Method	Description
static org.keycloak.models.ProtocolMapperModel	createClaimMapper(String name)
List<org.keycloak.provider.ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
String	getHelpText()
String	getId()
int	getPriority()
org.keycloak.representations.AccessToken	transformAccessToken(org.keycloak.representations.AccessToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)

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

close, create, getProtocol, init, postInit, setClaim, setClaim, setClaim, transformAccessTokenResponse, 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.ProtocolMapper

validateConfig

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

AudienceResolveProtocolMapper

public AudienceResolveProtocolMapper()

Method Detail

getConfigProperties

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

Specified by:

getConfigProperties in interface org.keycloak.provider.ConfiguredProvider

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

getPriority

public int getPriority()

Specified by:

getPriority in interface org.keycloak.protocol.ProtocolMapper

transformAccessToken

public org.keycloak.representations.AccessToken transformAccessToken(org.keycloak.representations.AccessToken token,
                                                                     org.keycloak.models.ProtocolMapperModel mappingModel,
                                                                     org.keycloak.models.KeycloakSession session,
                                                                     org.keycloak.models.UserSessionModel userSession,
                                                                     org.keycloak.models.ClientSessionContext clientSessionCtx)

Specified by:

transformAccessToken in interface OIDCAccessTokenMapper

Overrides:

transformAccessToken in class AbstractOIDCProtocolMapper

createClaimMapper

public static org.keycloak.models.ProtocolMapperModel createClaimMapper(String name)