Package org.keycloak.protocol.saml.mappers

Class SAMLAudienceProtocolMapper

java.lang.Object

org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper

org.keycloak.protocol.saml.mappers.SAMLAudienceProtocolMapper

All Implemented Interfaces:

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

public class SAMLAudienceProtocolMapper
extends AbstractSAMLProtocolMapper
implements SAMLLoginResponseMapper

SAML mapper to add a audience restriction into the assertion, to another client (clientId) or to a custom URI. Only one URI is added, clientId has preference over the custom value (the class maps OIDC behavior).

Author:

rmartinc

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUDIENCE_CATEGORY
static final String	INCLUDED_CLIENT_AUDIENCE
static final String	INCLUDED_CUSTOM_AUDIENCE
protected static final org.jboss.logging.Logger	logger
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
SAMLAudienceProtocolMapper()

Method Summary

Modifier and Type	Method	Description
List<org.keycloak.provider.ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
String	getHelpText()
String	getId()
protected static org.keycloak.dom.saml.v2.assertion.AudienceRestrictionType	locateAudienceRestriction(org.keycloak.dom.saml.v2.protocol.ResponseType response)
org.keycloak.dom.saml.v2.protocol.ResponseType	transformLoginResponse(org.keycloak.dom.saml.v2.protocol.ResponseType response, 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.saml.mappers.AbstractSAMLProtocolMapper

close, create, getProtocol, init, postInit

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.ProtocolMapper

getEffectiveModel, getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

logger

protected static final org.jboss.logging.Logger logger

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

AUDIENCE_CATEGORY

public static final String AUDIENCE_CATEGORY

See Also:

• Constant Field Values

INCLUDED_CLIENT_AUDIENCE

public static final String INCLUDED_CLIENT_AUDIENCE

See Also:

• Constant Field Values

INCLUDED_CUSTOM_AUDIENCE

public static final String INCLUDED_CUSTOM_AUDIENCE

See Also:

• Constant Field Values

Constructor Details

SAMLAudienceProtocolMapper

public SAMLAudienceProtocolMapper()

Method Details

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

locateAudienceRestriction

protected static org.keycloak.dom.saml.v2.assertion.AudienceRestrictionType locateAudienceRestriction(org.keycloak.dom.saml.v2.protocol.ResponseType response)

transformLoginResponse

public org.keycloak.dom.saml.v2.protocol.ResponseType transformLoginResponse(org.keycloak.dom.saml.v2.protocol.ResponseType response,
 org.keycloak.models.ProtocolMapperModel mappingModel,
 org.keycloak.models.KeycloakSession session,
 org.keycloak.models.UserSessionModel userSession,
 org.keycloak.models.ClientSessionContext clientSessionCtx)

Specified by:

transformLoginResponse in interface SAMLLoginResponseMapper