Uses of Interface
org.keycloak.sessions.AuthenticationSessionModel

Packages that use AuthenticationSessionModel

Package	Description
org.keycloak.authentication
org.keycloak.authentication.actiontoken
org.keycloak.authentication.authenticators.broker
org.keycloak.authentication.authenticators.broker.util
org.keycloak.authentication.authenticators.util
org.keycloak.authentication.requiredactions
org.keycloak.broker.oidc
org.keycloak.broker.provider
org.keycloak.broker.saml
org.keycloak.email
org.keycloak.email.freemarker
org.keycloak.forms.login
org.keycloak.forms.login.freemarker
org.keycloak.forms.login.freemarker.model
org.keycloak.models
org.keycloak.models.sessions.infinispan
org.keycloak.models.utils
org.keycloak.protocol
org.keycloak.protocol.docker
org.keycloak.protocol.oidc
org.keycloak.protocol.oidc.endpoints
org.keycloak.protocol.oidc.grants.device
org.keycloak.protocol.oidc.grants.device.endpoints
org.keycloak.protocol.oidc.utils
org.keycloak.protocol.saml
org.keycloak.protocol.saml.preprocessor
org.keycloak.protocol.saml.profile.ecp
org.keycloak.services
org.keycloak.services.clientpolicy.context
org.keycloak.services.managers
org.keycloak.services.resources
org.keycloak.services.util
org.keycloak.sessions
org.keycloak.social.twitter

Uses of AuthenticationSessionModel in org.keycloak.authentication

Fields in org.keycloak.authentication declared as AuthenticationSessionModel

Modifier and Type	Field	Description
protected AuthenticationSessionModel	AuthenticationProcessor.authenticationSession
protected AuthenticationSessionModel	RequiredActionContextResult.authenticationSession

Methods in org.keycloak.authentication that return AuthenticationSessionModel

Modifier and Type	Method	Description
static AuthenticationSessionModel	AuthenticationProcessor.clone(KeycloakSession session, AuthenticationSessionModel authSession)
AuthenticationSessionModel	AuthenticationFlowContext.getAuthenticationSession()	AuthenticationSessionModel attached to this flow
AuthenticationSessionModel	AuthenticationProcessor.getAuthenticationSession()
AuthenticationSessionModel	AuthenticationProcessor.Result.getAuthenticationSession()
AuthenticationSessionModel	FormContext.getAuthenticationSession()	AuthenticationSessionModel attached to this flow
AuthenticationSessionModel	RequiredActionContext.getAuthenticationSession()
AuthenticationSessionModel	RequiredActionContextResult.getAuthenticationSession()
static AuthenticationSessionModel	AuthenticationProcessor.recreate(KeycloakSession session, AuthenticationSessionModel authSession)

Methods in org.keycloak.authentication with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
static ClientSessionContext	AuthenticationProcessor.attachSession(AuthenticationSessionModel authSession, UserSessionModel userSession, KeycloakSession session, RealmModel realm, ClientConnection connection, EventBuilder event)
static AuthenticationSessionModel	AuthenticationProcessor.clone(KeycloakSession session, AuthenticationSessionModel authSession)
static Set<String>	AuthenticatorUtil.getAuthCallbacksFactoryIds(AuthenticationSessionModel authSession)	Get set of Authentication factories IDs defined in authentication session as CALLBACKS_FACTORY_IDS_NOTE
static String	AuthenticationProcessor.getClientData(KeycloakSession session, AuthenticationSessionModel authSession)
String	CredentialAction.getCredentialType(KeycloakSession session, AuthenticationSessionModel authenticationSession)
default void	RequiredActionProvider.initiatedActionCanceled(KeycloakSession session, AuthenticationSessionModel authSession)	Callback to let the action know that an application-initiated action was canceled.
static boolean	AuthenticatorUtil.isForcedReauthentication(AuthenticationSessionModel authSession)
static boolean	AuthenticatorUtil.isForkedFlow(AuthenticationSessionModel authSession)
static boolean	AuthenticatorUtil.isPasswordValidated(AuthenticationSessionModel authSession)
static boolean	AuthenticatorUtil.isSSOAuthentication(AuthenticationSessionModel authSession)
static AuthenticationSessionModel	AuthenticationProcessor.recreate(KeycloakSession session, AuthenticationSessionModel authSession)
static void	AuthenticationProcessor.resetFlow(AuthenticationSessionModel authSession, String flowPath)
static void	AuthenticatorUtil.setAuthCallbacksFactoryIds(AuthenticationSessionModel authSession, String authFactoryId)	Set authentication session note for callbacks defined for {@link AuthenticationFlowCallbackFactory) factories
AuthenticationProcessor	AuthenticationProcessor.setAuthenticationSession(AuthenticationSessionModel authenticationSession)

Constructors in org.keycloak.authentication with parameters of type AuthenticationSessionModel

Modifier	Constructor	Description
	RequiredActionContextResult(AuthenticationSessionModel authSession, RealmModel realm, EventBuilder eventBuilder, KeycloakSession session, HttpRequest httpRequest, UserModel user, RequiredActionFactory factory)

Uses of AuthenticationSessionModel in org.keycloak.authentication.actiontoken

Methods in org.keycloak.authentication.actiontoken that return AuthenticationSessionModel

Modifier and Type	Method	Description
AuthenticationSessionModel	ActionTokenContext.createAuthenticationSessionForClient(String clientId)
AuthenticationSessionModel	ActionTokenContext.getAuthenticationSession()
AuthenticationSessionModel	AbstractActionTokenHandler.startFreshAuthenticationSession(T token, ActionTokenContext<T> tokenContext)
AuthenticationSessionModel	ActionTokenHandler.startFreshAuthenticationSession(T token, ActionTokenContext<T> tokenContext)	Creates a fresh authentication session according to the information from the token.

Methods in org.keycloak.authentication.actiontoken with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
String	AbstractActionTokenHandler.getAuthenticationSessionIdFromToken(T token, ActionTokenContext<T> tokenContext, AuthenticationSessionModel currentAuthSession)
String	ActionTokenHandler.getAuthenticationSessionIdFromToken(T token, ActionTokenContext<T> tokenContext, AuthenticationSessionModel currentAuthSession)	Returns a compound authentication session ID requested from within the given token that the handler should attempt to join.
jakarta.ws.rs.core.Response	ActionTokenContext.ProcessAuthenticateFlow.processFlow(boolean action, String execution, AuthenticationSessionModel authSession, String flowPath, AuthenticationFlowModel flow, String errorMessage, AuthenticationProcessor processor)
void	ActionTokenContext.setAuthenticationSession(AuthenticationSessionModel authenticationSession, boolean isFresh)

Uses of AuthenticationSessionModel in org.keycloak.authentication.authenticators.broker

Methods in org.keycloak.authentication.authenticators.broker with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
static UserModel	AbstractIdpAuthenticator.getExistingUser(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession)

Uses of AuthenticationSessionModel in org.keycloak.authentication.authenticators.broker.util

Methods in org.keycloak.authentication.authenticators.broker.util with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
BrokeredIdentityContext	SerializedBrokeredIdentityContext.deserialize(KeycloakSession session, AuthenticationSessionModel authSession)
static SerializedBrokeredIdentityContext	SerializedBrokeredIdentityContext.readFromAuthenticationSession(AuthenticationSessionModel authSession, String noteKey)
void	SerializedBrokeredIdentityContext.saveToAuthenticationSession(AuthenticationSessionModel authSession, String noteKey)

Uses of AuthenticationSessionModel in org.keycloak.authentication.authenticators.util

Methods in org.keycloak.authentication.authenticators.util with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
static void	AuthenticatorUtils.updateCompletedExecutions(AuthenticationSessionModel authSession, UserSessionModel userSession, String executionId)	Update the completed authenticators note on the new auth session

Constructors in org.keycloak.authentication.authenticators.util with parameters of type AuthenticationSessionModel

Modifier	Constructor	Description
	AcrStore(KeycloakSession session, AuthenticationSessionModel authSession)

Uses of AuthenticationSessionModel in org.keycloak.authentication.requiredactions

Methods in org.keycloak.authentication.requiredactions with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
String	DeleteCredentialAction.getCredentialType(KeycloakSession session, AuthenticationSessionModel authenticationSession)
String	RecoveryAuthnCodesAction.getCredentialType(KeycloakSession session, AuthenticationSessionModel authenticationSession)
String	UpdateTotp.getCredentialType(KeycloakSession session, AuthenticationSessionModel authenticationSession)
String	WebAuthnRegister.getCredentialType(KeycloakSession session, AuthenticationSessionModel authenticationSession)

Uses of AuthenticationSessionModel in org.keycloak.broker.oidc

Methods in org.keycloak.broker.oidc with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
void	AbstractOAuth2IdentityProvider.authenticationFinished(AuthenticationSessionModel authSession, BrokeredIdentityContext context)
void	OIDCIdentityProvider.authenticationFinished(AuthenticationSessionModel authSession, BrokeredIdentityContext context)
protected boolean	OIDCIdentityProvider.isAuthTimeExpired(JsonWebToken idToken, AuthenticationSessionModel authSession)

Uses of AuthenticationSessionModel in org.keycloak.broker.provider

Methods in org.keycloak.broker.provider that return AuthenticationSessionModel

Modifier and Type	Method	Description
AuthenticationSessionModel	IdentityProvider.AuthenticationCallback.getAndVerifyAuthenticationSession(String encodedCode)	Common method to return current authenticationSession and verify if it is not expired
AuthenticationSessionModel	AuthenticationRequest.getAuthenticationSession()
AuthenticationSessionModel	BrokeredIdentityContext.getAuthenticationSession()

Methods in org.keycloak.broker.provider with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
void	AbstractIdentityProvider.authenticationFinished(AuthenticationSessionModel authSession, BrokeredIdentityContext context)
void	IdentityProvider.authenticationFinished(AuthenticationSessionModel authSession, BrokeredIdentityContext context)
jakarta.ws.rs.core.Response	IdentityProvider.AuthenticationCallback.retryLogin(IdentityProvider<?> identityProvider, AuthenticationSessionModel authSession)	Indicates that login with the particular IDP should be retried
void	BrokeredIdentityContext.setAuthenticationSession(AuthenticationSessionModel authenticationSession)

Constructors in org.keycloak.broker.provider with parameters of type AuthenticationSessionModel

Modifier	Constructor	Description
	AuthenticationRequest(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession, HttpRequest httpRequest, jakarta.ws.rs.core.UriInfo uriInfo, IdentityBrokerState state, String redirectUri)

Uses of AuthenticationSessionModel in org.keycloak.broker.saml

Methods in org.keycloak.broker.saml with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
void	SAMLIdentityProvider.authenticationFinished(AuthenticationSessionModel authSession, BrokeredIdentityContext context)

Uses of AuthenticationSessionModel in org.keycloak.email

Methods in org.keycloak.email with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
EmailTemplateProvider	EmailTemplateProvider.setAuthenticationSession(AuthenticationSessionModel authenticationSession)

Uses of AuthenticationSessionModel in org.keycloak.email.freemarker

Fields in org.keycloak.email.freemarker declared as AuthenticationSessionModel

Modifier and Type	Field	Description
protected AuthenticationSessionModel	FreeMarkerEmailTemplateProvider.authenticationSession	authenticationSession can be null for some email sendings, it is filled only for email sendings performed as part of the authentication session (email verification, password reset, broker link etc.)!

Methods in org.keycloak.email.freemarker with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
EmailTemplateProvider	FreeMarkerEmailTemplateProvider.setAuthenticationSession(AuthenticationSessionModel authenticationSession)

Uses of AuthenticationSessionModel in org.keycloak.forms.login

Methods in org.keycloak.forms.login with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
LoginFormsProvider	LoginFormsProvider.setAuthenticationSession(AuthenticationSessionModel authenticationSession)

Uses of AuthenticationSessionModel in org.keycloak.forms.login.freemarker

Fields in org.keycloak.forms.login.freemarker declared as AuthenticationSessionModel

Modifier and Type	Field	Description
protected AuthenticationSessionModel	FreeMarkerLoginFormsProvider.authenticationSession	authenticationSession can be null for some renderings, mainly error pages

Methods in org.keycloak.forms.login.freemarker with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
LoginFormsProvider	FreeMarkerLoginFormsProvider.setAuthenticationSession(AuthenticationSessionModel authenticationSession)

Uses of AuthenticationSessionModel in org.keycloak.forms.login.freemarker.model

Constructors in org.keycloak.forms.login.freemarker.model with parameters of type AuthenticationSessionModel

Modifier	Constructor	Description
	LogoutConfirmBean(String code, AuthenticationSessionModel logoutSession)

Uses of AuthenticationSessionModel in org.keycloak.models

Methods in org.keycloak.models that return AuthenticationSessionModel

Modifier and Type	Method	Description
AuthenticationSessionModel	KeycloakContext.getAuthenticationSession()	Get current AuthenticationSessionModel, can be null out of the AuthenticationSession context.

Methods in org.keycloak.models with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
void	KeycloakContext.setAuthenticationSession(AuthenticationSessionModel authenticationSession)

Uses of AuthenticationSessionModel in org.keycloak.models.sessions.infinispan

Classes in org.keycloak.models.sessions.infinispan that implement AuthenticationSessionModel

Modifier and Type	Class	Description
class	AuthenticationSessionAdapter	NOTE: Calling setter doesn't automatically enlist for update

Methods in org.keycloak.models.sessions.infinispan that return AuthenticationSessionModel

Modifier and Type	Method	Description
AuthenticationSessionModel	RootAuthenticationSessionAdapter.createAuthenticationSession(ClientModel client)
AuthenticationSessionModel	RootAuthenticationSessionAdapter.getAuthenticationSession(ClientModel client, String tabId)

Methods in org.keycloak.models.sessions.infinispan that return types with arguments of type AuthenticationSessionModel

Modifier and Type	Method	Description
Map<String,AuthenticationSessionModel>	RootAuthenticationSessionAdapter.getAuthenticationSessions()

Uses of AuthenticationSessionModel in org.keycloak.models.utils

Methods in org.keycloak.models.utils with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
static void	SystemClientUtil.checkSkipLink(KeycloakSession session, AuthenticationSessionModel authSession)	Cleanup system client URL to avoid links to account management
static AuthenticationFlowModel	AuthenticationFlowResolver.resolveBrowserFlow(AuthenticationSessionModel authSession)
static AuthenticationFlowModel	AuthenticationFlowResolver.resolveDirectGrantFlow(AuthenticationSessionModel authSession)

Uses of AuthenticationSessionModel in org.keycloak.protocol

Methods in org.keycloak.protocol that return AuthenticationSessionModel

Modifier and Type	Method	Description
protected AuthenticationSessionModel	AuthorizationEndpointBase.createAuthenticationSession(ClientModel client, String requestState)
static AuthenticationSessionModel	RestartLoginCookie.restartSession(KeycloakSession session, RealmModel realm, RootAuthenticationSessionModel rootSession, String expectedClientId, String encodedCookie)

Methods in org.keycloak.protocol with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	LoginProtocol.authenticated(AuthenticationSessionModel authSession, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
protected AuthenticationProcessor	AuthorizationEndpointBase.createProcessor(AuthenticationSessionModel authSession, String flowId, String flowPath)
jakarta.ws.rs.core.Response	LoginProtocol.finishBrowserLogout(UserSessionModel userSession, AuthenticationSessionModel logoutSession)	This method is called when browser logout is going to be finished.
protected AuthenticationFlowModel	AuthorizationEndpointBase.getAuthenticationFlow(AuthenticationSessionModel authSession)
ClientData	LoginProtocol.getClientData(AuthenticationSessionModel authSession)	Returns client data, which will be wrapped in the "clientData" parameter sent within "authentication flow" requests.
protected jakarta.ws.rs.core.Response	AuthorizationEndpointBase.handleBrowserAuthenticationRequest(AuthenticationSessionModel authSession, LoginProtocol protocol, boolean isPassive, boolean redirectToAuthentication)	Common method to handle browser authentication request in protocols unified way.
boolean	LoginProtocol.requireReauthentication(UserSessionModel userSession, AuthenticationSessionModel authSession)
jakarta.ws.rs.core.Response	LoginProtocol.sendError(AuthenticationSessionModel authSession, LoginProtocol.Error error)
static void	RestartLoginCookie.setRestartCookie(KeycloakSession session, AuthenticationSessionModel authSession)

Constructors in org.keycloak.protocol with parameters of type AuthenticationSessionModel

Modifier	Constructor	Description
	RestartLoginCookie(AuthenticationSessionModel authSession)

Uses of AuthenticationSessionModel in org.keycloak.protocol.docker

Methods in org.keycloak.protocol.docker with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	DockerAuthV2Protocol.authenticated(AuthenticationSessionModel authSession, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
jakarta.ws.rs.core.Response	DockerAuthV2Protocol.finishBrowserLogout(UserSessionModel userSession, AuthenticationSessionModel logoutSession)
protected AuthenticationFlowModel	DockerEndpoint.getAuthenticationFlow(AuthenticationSessionModel authSession)
ClientData	DockerAuthV2Protocol.getClientData(AuthenticationSessionModel authSession)
boolean	DockerAuthV2Protocol.requireReauthentication(UserSessionModel userSession, AuthenticationSessionModel clientSession)
jakarta.ws.rs.core.Response	DockerAuthV2Protocol.sendError(AuthenticationSessionModel clientSession, LoginProtocol.Error error)

Uses of AuthenticationSessionModel in org.keycloak.protocol.oidc

Methods in org.keycloak.protocol.oidc with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
static ClientSessionContext	TokenManager.attachAuthenticationSession(KeycloakSession session, UserSessionModel userSession, AuthenticationSessionModel authSession)
jakarta.ws.rs.core.Response	OIDCLoginProtocol.authenticated(AuthenticationSessionModel authSession, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
jakarta.ws.rs.core.Response	OIDCLoginProtocol.finishBrowserLogout(UserSessionModel userSession, AuthenticationSessionModel logoutSession)
ClientData	OIDCLoginProtocol.getClientData(AuthenticationSessionModel authSession)
protected boolean	OIDCLoginProtocol.isAuthTimeExpired(UserSessionModel userSession, AuthenticationSessionModel authSession)
protected boolean	OIDCLoginProtocol.isPromptLogin(AuthenticationSessionModel authSession)
protected boolean	OIDCLoginProtocol.isReAuthRequiredForKcAction(UserSessionModel userSession, AuthenticationSessionModel authSession)
boolean	OIDCLoginProtocol.requireReauthentication(UserSessionModel userSession, AuthenticationSessionModel authSession)
jakarta.ws.rs.core.Response	OIDCLoginProtocol.sendError(AuthenticationSessionModel authSession, LoginProtocol.Error error)

Uses of AuthenticationSessionModel in org.keycloak.protocol.oidc.endpoints

Methods in org.keycloak.protocol.oidc.endpoints with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
void	AuthorizationEndpointChecker.AuthorizationCheckException.throwAsErrorPageException(AuthenticationSessionModel authenticationSession)

Uses of AuthenticationSessionModel in org.keycloak.protocol.oidc.grants.device

Methods in org.keycloak.protocol.oidc.grants.device with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
static jakarta.ws.rs.core.Response	DeviceGrantType.approveOAuth2DeviceAuthorization(AuthenticationSessionModel authSession, AuthenticatedClientSessionModel clientSession, KeycloakSession session)
static jakarta.ws.rs.core.Response	DeviceGrantType.denyOAuth2DeviceAuthorization(AuthenticationSessionModel authSession, LoginProtocol.Error error, KeycloakSession session)
static boolean	DeviceGrantType.isOAuth2DeviceVerificationFlow(AuthenticationSessionModel authSession)

Uses of AuthenticationSessionModel in org.keycloak.protocol.oidc.grants.device.endpoints

Methods in org.keycloak.protocol.oidc.grants.device.endpoints that return AuthenticationSessionModel

Modifier and Type	Method	Description
protected AuthenticationSessionModel	DeviceEndpoint.createAuthenticationSession(ClientModel client, String scope)

Uses of AuthenticationSessionModel in org.keycloak.protocol.oidc.utils

Methods in org.keycloak.protocol.oidc.utils with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
static URI	LogoutUtil.getRedirectUriWithAttachedState(String redirectUri, AuthenticationSessionModel logoutSession)
static jakarta.ws.rs.core.Response	LogoutUtil.sendResponseAfterLogoutFinished(KeycloakSession session, AuthenticationSessionModel logoutSession)

Uses of AuthenticationSessionModel in org.keycloak.protocol.saml

Methods in org.keycloak.protocol.saml that return AuthenticationSessionModel

Modifier and Type	Method	Description
AuthenticationSessionModel	SamlService.getOrCreateLoginSessionForIdpInitiatedSso(KeycloakSession session, RealmModel realm, ClientModel client, String relayState)	Creates a client session object for SAML IdP-initiated SSO session.

Methods in org.keycloak.protocol.saml with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	SamlProtocol.authenticated(AuthenticationSessionModel authSession, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
protected abstract jakarta.ws.rs.core.Response	SamlService.BindingProtocol.error(KeycloakSession session, AuthenticationSessionModel authenticationSession, jakarta.ws.rs.core.Response.Status status, String message, Object... parameters)
protected jakarta.ws.rs.core.Response	SamlService.PostBindingProtocol.error(KeycloakSession session, AuthenticationSessionModel authenticationSession, jakarta.ws.rs.core.Response.Status status, String message, Object... parameters)
protected jakarta.ws.rs.core.Response	SamlService.RedirectBindingProtocol.error(KeycloakSession session, AuthenticationSessionModel authenticationSession, jakarta.ws.rs.core.Response.Status status, String message, Object... parameters)
jakarta.ws.rs.core.Response	SamlProtocol.finishBrowserLogout(UserSessionModel userSession, AuthenticationSessionModel logoutSession)
ClientData	SamlProtocol.getClientData(AuthenticationSessionModel authSession)
protected String	SamlProtocol.getNameIdFormat(SamlClient samlClient, AuthenticationSessionModel authSession)
protected boolean	SamlProtocol.isPostBinding(AuthenticationSessionModel authSession)
protected jakarta.ws.rs.core.Response	SamlService.newBrowserAuthentication(AuthenticationSessionModel authSession, boolean isPassive, boolean redirectToAuthentication)
protected jakarta.ws.rs.core.Response	SamlService.newBrowserAuthentication(AuthenticationSessionModel authSession, boolean isPassive, boolean redirectToAuthentication, SamlProtocol samlProtocol)
boolean	SamlProtocol.requireReauthentication(UserSessionModel userSession, AuthenticationSessionModel authSession)
jakarta.ws.rs.core.Response	SamlProtocol.sendError(AuthenticationSessionModel authSession, LoginProtocol.Error error)

Uses of AuthenticationSessionModel in org.keycloak.protocol.saml.preprocessor

Methods in org.keycloak.protocol.saml.preprocessor with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
default AuthnRequestType	SamlAuthenticationPreprocessor.beforeProcessingLoginRequest(AuthnRequestType authnRequest, AuthenticationSessionModel authSession)	Called before a login request is processed.
default StatusResponseType	SamlAuthenticationPreprocessor.beforeProcessingLoginResponse(StatusResponseType statusResponse, AuthenticationSessionModel authSession)	Called before a login response is processed.
default AuthnRequestType	SamlAuthenticationPreprocessor.beforeSendingLoginRequest(AuthnRequestType authnRequest, AuthenticationSessionModel clientSession)	Called before a login request is sent.

Uses of AuthenticationSessionModel in org.keycloak.protocol.saml.profile.ecp

Methods in org.keycloak.protocol.saml.profile.ecp with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
protected AuthenticationFlowModel	SamlEcpProfileService.getAuthenticationFlow(AuthenticationSessionModel authSession)
protected jakarta.ws.rs.core.Response	SamlEcpProfileService.newBrowserAuthentication(AuthenticationSessionModel authSession, boolean isPassive, boolean redirectToAuthentication, SamlProtocol samlProtocol)

Uses of AuthenticationSessionModel in org.keycloak.services

Methods in org.keycloak.services that return AuthenticationSessionModel

Modifier and Type	Method	Description
AuthenticationSessionModel	DefaultKeycloakContext.getAuthenticationSession()

Methods in org.keycloak.services with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
static jakarta.ws.rs.core.Response	ErrorPage.error(KeycloakSession session, AuthenticationSessionModel authenticationSession, jakarta.ws.rs.core.Response.Status status, String message, Object... parameters)
void	DefaultKeycloakContext.setAuthenticationSession(AuthenticationSessionModel authenticationSession)

Constructors in org.keycloak.services with parameters of type AuthenticationSessionModel

Modifier	Constructor	Description
	ErrorPageException(KeycloakSession session, AuthenticationSessionModel authSession, jakarta.ws.rs.core.Response.Status status, String errorMessage, Object... parameters)

Uses of AuthenticationSessionModel in org.keycloak.services.clientpolicy.context

Methods in org.keycloak.services.clientpolicy.context that return AuthenticationSessionModel

Modifier and Type	Method	Description
AuthenticationSessionModel	ImplicitHybridTokenResponse.getAuthenticationSession()

Constructors in org.keycloak.services.clientpolicy.context with parameters of type AuthenticationSessionModel

Modifier	Constructor	Description
	ImplicitHybridTokenResponse(AuthenticationSessionModel authSession, ClientSessionContext clientSessionCtx, TokenManager.AccessTokenResponseBuilder accessTokenResponseBuilder)

Uses of AuthenticationSessionModel in org.keycloak.services.managers

Methods in org.keycloak.services.managers that return AuthenticationSessionModel

Modifier and Type	Method	Description
static AuthenticationSessionModel	AuthenticationManager.createOrJoinLogoutSession(KeycloakSession session, RealmModel realm, AuthenticationSessionManager asm, UserSessionModel userSession, boolean browserCookie)
AuthenticationSessionModel	AuthenticationSessionManager.getAuthenticationSessionByIdAndClient(RealmModel realm, String authSessionId, ClientModel client, String tabId)
AuthenticationSessionModel	AuthenticationSessionManager.getCurrentAuthenticationSession(RealmModel realm, ClientModel client, String tabId)	Returns current authentication session if it exists, otherwise returns null.

Methods in org.keycloak.services.managers with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
static jakarta.ws.rs.core.Response	AuthenticationManager.actionRequired(KeycloakSession session, AuthenticationSessionModel authSession, HttpRequest request, EventBuilder event)
static void	AuthenticationManager.evaluateRequiredActionTriggers(KeycloakSession session, AuthenticationSessionModel authSession, HttpRequest request, EventBuilder event, RealmModel realm, UserModel user)
protected static jakarta.ws.rs.core.Response	AuthenticationManager.executionActions(KeycloakSession session, AuthenticationSessionModel authSession, HttpRequest request, EventBuilder event, RealmModel realm, UserModel user, Set<String> ignoredActions)
static jakarta.ws.rs.core.Response	AuthenticationManager.finishedRequiredActions(KeycloakSession session, AuthenticationSessionModel authSession, UserSessionModel userSession, ClientConnection clientConnection, HttpRequest request, jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event)
static CommonClientSessionModel.Action	AuthenticationManager.getClientLogoutAction(AuthenticationSessionModel logoutAuthSession, String clientUuid)	Returns the logout state of the particular client as per the logoutAuthSession
UserSessionModel	AuthenticationSessionManager.getUserSession(AuthenticationSessionModel authSession)
static void	AuthenticationManager.logSuccess(KeycloakSession session, AuthenticationSessionModel authSession)
static UserModel	AuthenticationManager.lookupUserForBruteForceLog(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authenticationSession)
static jakarta.ws.rs.core.Response	AuthenticationManager.nextActionAfterAuthentication(KeycloakSession session, AuthenticationSessionModel authSession, ClientConnection clientConnection, HttpRequest request, jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event)
static String	AuthenticationManager.nextRequiredAction(KeycloakSession session, AuthenticationSessionModel authSession, HttpRequest request, EventBuilder event)
static jakarta.ws.rs.core.Response	AuthenticationManager.redirectAfterSuccessfulFlow(KeycloakSession session, RealmModel realm, UserSessionModel userSession, ClientSessionContext clientSessionCtx, HttpRequest request, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection clientConnection, EventBuilder event, AuthenticationSessionModel authSession)
static jakarta.ws.rs.core.Response	AuthenticationManager.redirectAfterSuccessfulFlow(KeycloakSession session, RealmModel realm, UserSessionModel userSession, ClientSessionContext clientSessionCtx, HttpRequest request, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection clientConnection, EventBuilder event, AuthenticationSessionModel authSession, LoginProtocol protocol)
static jakarta.ws.rs.core.Response	AuthenticationManager.redirectToRequiredActions(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession, jakarta.ws.rs.core.UriInfo uriInfo, String requiredAction)
void	AuthenticationSessionManager.removeAuthenticationSession(RealmModel realm, AuthenticationSessionModel authSession, boolean expireRestartCookie)
boolean	AuthenticationSessionManager.removeTabIdInAuthenticationSession(RealmModel realm, AuthenticationSessionModel authSession)	Remove authentication session from root session.
static void	AuthenticationManager.setClientLogoutAction(AuthenticationSessionModel logoutAuthSession, String clientUuid, CommonClientSessionModel.Action action)	Sets logout state of the particular client into the logoutAuthSession
static void	AuthenticationManager.setClientScopesInSession(AuthenticationSessionModel authSession)
static void	AuthenticationManager.setKcActionStatus(String executedProviderId, RequiredActionContext.KcActionStatus status, AuthenticationSessionModel authSession)
static void	AuthenticationManager.setKcActionToEnforced(String executedProviderId, AuthenticationSessionModel authSession)
void	AuthenticationSessionManager.updateAuthenticationSessionAfterSuccessfulAuthentication(RealmModel realm, AuthenticationSessionModel authSession)	This happens when one browser tab successfully finished authentication (including required actions and consent screen if applicable) Just authenticationSession of the current browser tab is removed from "root authentication session" and other tabs are kept, so authentication can be automatically finished in other browser tabs (typically with authChecker.js javascript)

Uses of AuthenticationSessionModel in org.keycloak.services.resources

Methods in org.keycloak.services.resources that return AuthenticationSessionModel

Modifier and Type	Method	Description
AuthenticationSessionModel	IdentityBrokerService.getAndVerifyAuthenticationSession(String encodedCode)
AuthenticationSessionModel	SessionCodeChecks.getAuthenticationSession()
AuthenticationSessionModel	SessionCodeChecks.initialVerifyAuthSession()

Methods in org.keycloak.services.resources that return types with arguments of type AuthenticationSessionModel

Modifier and Type	Method	Description
ClientSessionCode<AuthenticationSessionModel>	SessionCodeChecks.getClientCode()

Methods in org.keycloak.services.resources with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
protected jakarta.ws.rs.core.Response	IdentityBrokerService.browserAuthentication(AuthenticationSessionModel authSession, String errorMessage, Object... parameters)
static <T extends JsonWebToken> boolean	LoginActionsServiceChecks.doesAuthenticationSessionFromCookieMatchOneFromToken(ActionTokenContext<T> context, AuthenticationSessionModel authSessionFromCookie, String authSessionCompoundIdFromToken)	This check verifies that current authentication session is consistent with the one specified in token.
protected jakarta.ws.rs.core.Response	LoginActionsService.processAuthentication(boolean action, String execution, AuthenticationSessionModel authSession, String errorMessage)
protected jakarta.ws.rs.core.Response	LoginActionsService.processFlow(boolean action, String execution, AuthenticationSessionModel authSession, String flowPath, AuthenticationFlowModel flow, String errorMessage, AuthenticationProcessor processor)
protected void	LoginActionsService.processLocaleParam(AuthenticationSessionModel authSession)
protected jakarta.ws.rs.core.Response	LoginActionsService.processRegistration(boolean action, String execution, AuthenticationSessionModel authSession, String errorMessage)
protected jakarta.ws.rs.core.Response	LoginActionsService.processResetCredentials(boolean actionRequest, String execution, AuthenticationSessionModel authSession, String errorMessage)
static jakarta.ws.rs.core.Response	LoginActionsService.redirectToAfterBrokerLoginEndpoint(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, AuthenticationSessionModel authSession, boolean firstBrokerLogin)
jakarta.ws.rs.core.Response	IdentityBrokerService.retryLogin(IdentityProvider<?> identityProvider, AuthenticationSessionModel authSession)
jakarta.ws.rs.core.Response	IdentityBrokerService.validateUser(AuthenticationSessionModel authSession, UserModel user, RealmModel realm)

Uses of AuthenticationSessionModel in org.keycloak.services.util

Methods in org.keycloak.services.util with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
URI	AuthenticationFlowURLHelper.getLastExecutionUrl(AuthenticationSessionModel authSession)
abstract jakarta.ws.rs.core.Response	BrowserHistoryHelper.loadSavedResponse(KeycloakSession session, AuthenticationSessionModel authSession)
static void	LocaleUtil.processLocaleParam(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession)
abstract jakarta.ws.rs.core.Response	BrowserHistoryHelper.saveResponseAndRedirect(KeycloakSession session, AuthenticationSessionModel authSession, jakarta.ws.rs.core.Response response, boolean actionRequest, HttpRequest httpRequest)
jakarta.ws.rs.core.Response	AuthenticationFlowURLHelper.showPageExpired(AuthenticationSessionModel authSession)

Uses of AuthenticationSessionModel in org.keycloak.sessions

Methods in org.keycloak.sessions that return AuthenticationSessionModel

Modifier and Type	Method	Description
AuthenticationSessionModel	RootAuthenticationSessionModel.createAuthenticationSession(ClientModel client)	Create a new authentication session and returns it.
AuthenticationSessionModel	RootAuthenticationSessionModel.getAuthenticationSession(ClientModel client, String tabId)	Returns an authentication session for the particular client and tab or null if it doesn't yet exists.

Methods in org.keycloak.sessions that return types with arguments of type AuthenticationSessionModel

Modifier and Type	Method	Description
Map<String,AuthenticationSessionModel>	RootAuthenticationSessionModel.getAuthenticationSessions()	Returns authentication sessions for the root authentication session.

Methods in org.keycloak.sessions with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
static AuthenticationSessionCompoundId	AuthenticationSessionCompoundId.fromAuthSession(AuthenticationSessionModel authSession)

Uses of AuthenticationSessionModel in org.keycloak.social.twitter

Methods in org.keycloak.social.twitter with parameters of type AuthenticationSessionModel

Modifier and Type	Method	Description
void	TwitterIdentityProvider.authenticationFinished(AuthenticationSessionModel authSession, BrokeredIdentityContext context)