Class SAMLAudienceProtocolMapper
java.lang.Object
org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper
org.keycloak.protocol.saml.mappers.SAMLAudienceProtocolMapper
- All Implemented Interfaces:
ProtocolMapper
,SAMLLoginResponseMapper
,ConfiguredProvider
,Provider
,ProviderFactory<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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetId()
protected static AudienceRestrictionType
locateAudienceRestriction
(ResponseType response) transformLoginResponse
(ResponseType response, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, 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
getConfigMetadata, order
-
Field Details
-
logger
protected static final org.jboss.logging.Logger logger -
PROVIDER_ID
- See Also:
-
AUDIENCE_CATEGORY
- See Also:
-
INCLUDED_CLIENT_AUDIENCE
- See Also:
-
INCLUDED_CUSTOM_AUDIENCE
- See Also:
-
-
Constructor Details
-
SAMLAudienceProtocolMapper
public SAMLAudienceProtocolMapper()
-
-
Method Details
-
getConfigProperties
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
getId
- Specified by:
getId
in interfaceProviderFactory<ProtocolMapper>
-
getDisplayType
- Specified by:
getDisplayType
in interfaceProtocolMapper
-
getDisplayCategory
- Specified by:
getDisplayCategory
in interfaceProtocolMapper
-
getHelpText
- Specified by:
getHelpText
in interfaceConfiguredProvider
-
locateAudienceRestriction
-
transformLoginResponse
public ResponseType transformLoginResponse(ResponseType response, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx) - Specified by:
transformLoginResponse
in interfaceSAMLLoginResponseMapper
-