Package org.keycloak.protocol.saml.preprocessor

Interface SamlAuthenticationPreprocessor

All Superinterfaces:
org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<SamlAuthenticationPreprocessor>
public interface SamlAuthenticationPreprocessor extends org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<SamlAuthenticationPreprocessor>
Provider interface for SAML authentication preprocessing.
Author:
Gideon Caranzo

  • Method Summary

    Modifier and Type
    Method
    Description
    default org.keycloak.dom.saml.v2.protocol.AuthnRequestType
    beforeProcessingLoginRequest(org.keycloak.dom.saml.v2.protocol.AuthnRequestType authnRequest, org.keycloak.sessions.AuthenticationSessionModel authSession)
    Called before a login request is processed.
    default org.keycloak.dom.saml.v2.protocol.StatusResponseType
    beforeProcessingLoginResponse(org.keycloak.dom.saml.v2.protocol.StatusResponseType statusResponse, org.keycloak.sessions.AuthenticationSessionModel authSession)
    Called before a login response is processed.
    default org.keycloak.dom.saml.v2.protocol.LogoutRequestType
    beforeProcessingLogoutRequest(org.keycloak.dom.saml.v2.protocol.LogoutRequestType logoutRequest, org.keycloak.models.UserSessionModel authSession, org.keycloak.models.AuthenticatedClientSessionModel clientSession)
    Called before a logout request is processed.
    default org.keycloak.dom.saml.v2.protocol.AuthnRequestType
    beforeSendingLoginRequest(org.keycloak.dom.saml.v2.protocol.AuthnRequestType authnRequest, org.keycloak.sessions.AuthenticationSessionModel clientSession)
    Called before a login request is sent.
    default org.keycloak.dom.saml.v2.protocol.LogoutRequestType
    beforeSendingLogoutRequest(org.keycloak.dom.saml.v2.protocol.LogoutRequestType logoutRequest, org.keycloak.models.UserSessionModel authSession, org.keycloak.models.AuthenticatedClientSessionModel clientSession)
    Called before a logout request is sent.
    default org.keycloak.dom.saml.v2.protocol.StatusResponseType
    beforeSendingResponse(org.keycloak.dom.saml.v2.protocol.StatusResponseType statusResponse, org.keycloak.models.AuthenticatedClientSessionModel clientSession)
    Called before a response is sent back to the client.

    Methods inherited from interface org.keycloak.provider.Provider

    close

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    close, create, dependsOn, getConfigMetadata, getId, init, order, postInit

  • Method Details

    • beforeProcessingLoginRequest

      default org.keycloak.dom.saml.v2.protocol.AuthnRequestType beforeProcessingLoginRequest(org.keycloak.dom.saml.v2.protocol.AuthnRequestType authnRequest, org.keycloak.sessions.AuthenticationSessionModel authSession)
      Called before a login request is processed.

    • beforeProcessingLogoutRequest

      default org.keycloak.dom.saml.v2.protocol.LogoutRequestType beforeProcessingLogoutRequest(org.keycloak.dom.saml.v2.protocol.LogoutRequestType logoutRequest, org.keycloak.models.UserSessionModel authSession, org.keycloak.models.AuthenticatedClientSessionModel clientSession)
      Called before a logout request is processed.
      Parameters:
      clientSession - can be null if client is not applicable (e.g. when used within identity broker)

    • beforeSendingLoginRequest

      default org.keycloak.dom.saml.v2.protocol.AuthnRequestType beforeSendingLoginRequest(org.keycloak.dom.saml.v2.protocol.AuthnRequestType authnRequest, org.keycloak.sessions.AuthenticationSessionModel clientSession)
      Called before a login request is sent.

    • beforeSendingLogoutRequest

      default org.keycloak.dom.saml.v2.protocol.LogoutRequestType beforeSendingLogoutRequest(org.keycloak.dom.saml.v2.protocol.LogoutRequestType logoutRequest, org.keycloak.models.UserSessionModel authSession, org.keycloak.models.AuthenticatedClientSessionModel clientSession)
      Called before a logout request is sent.
      Parameters:
      clientSession - can be null if client is not applicable (e.g. when used within identity broker)

    • beforeProcessingLoginResponse

      default org.keycloak.dom.saml.v2.protocol.StatusResponseType beforeProcessingLoginResponse(org.keycloak.dom.saml.v2.protocol.StatusResponseType statusResponse, org.keycloak.sessions.AuthenticationSessionModel authSession)
      Called before a login response is processed.

    • beforeSendingResponse

      default org.keycloak.dom.saml.v2.protocol.StatusResponseType beforeSendingResponse(org.keycloak.dom.saml.v2.protocol.StatusResponseType statusResponse, org.keycloak.models.AuthenticatedClientSessionModel clientSession)
      Called before a response is sent back to the client.