Uses of Interface
org.keycloak.models.UserSessionModel

Packages that use UserSessionModel

Package	Description
org.keycloak.authentication
org.keycloak.authentication.authenticators.util
org.keycloak.broker.oidc
org.keycloak.broker.provider
org.keycloak.broker.saml
org.keycloak.device
org.keycloak.events
org.keycloak.models
org.keycloak.models.jpa.session
org.keycloak.models.session
org.keycloak.models.sessions.infinispan
org.keycloak.models.sessions.infinispan.changes
org.keycloak.models.sessions.infinispan.changes.remote.updater.client
org.keycloak.models.sessions.infinispan.changes.remote.updater.user
org.keycloak.models.sessions.infinispan.changes.sessions
org.keycloak.models.sessions.infinispan.entities
org.keycloak.models.sessions.infinispan.remote
org.keycloak.models.sessions.infinispan.stream
org.keycloak.models.utils
org.keycloak.organization.protocol.mappers.oidc
org.keycloak.organization.protocol.mappers.saml
org.keycloak.protocol
org.keycloak.protocol.docker
org.keycloak.protocol.docker.mapper
org.keycloak.protocol.oid4vc.issuance.mappers
org.keycloak.protocol.oidc
org.keycloak.protocol.oidc.grants
org.keycloak.protocol.oidc.mappers
org.keycloak.protocol.saml
org.keycloak.protocol.saml.mappers
org.keycloak.protocol.saml.preprocessor
org.keycloak.services.managers
org.keycloak.services.util
org.keycloak.social.twitter

Uses of UserSessionModel in org.keycloak.authentication

Fields in org.keycloak.authentication declared as UserSessionModel

Modifier and Type	Field	Description
protected UserSessionModel	AuthenticationProcessor.userSession

Methods in org.keycloak.authentication that return UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	AuthenticationProcessor.getUserSession()

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

Modifier and Type	Method	Description
static ClientSessionContext	AuthenticationProcessor.attachSession(AuthenticationSessionModel authSession, UserSessionModel userSession, KeycloakSession session, RealmModel realm, ClientConnection connection, EventBuilder event)
void	AuthenticationFlowContext.attachUserSession(UserSessionModel userSession)
void	AuthenticationProcessor.Result.attachUserSession(UserSessionModel userSession)

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

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

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

Uses of UserSessionModel in org.keycloak.broker.oidc

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

Modifier and Type	Method	Description
void	OIDCIdentityProvider.backchannelLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm)
protected void	OIDCIdentityProvider.backchannelLogout(UserSessionModel userSession, String idToken)
void	AbstractOAuth2IdentityProvider.exchangeExternalComplete(UserSessionModel userSession, BrokeredIdentityContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> params)
jakarta.ws.rs.core.Response	AbstractOAuth2IdentityProvider.exchangeFromToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, jakarta.ws.rs.core.MultivaluedMap<String,String> params)
protected jakarta.ws.rs.core.Response	AbstractOAuth2IdentityProvider.exchangeSessionToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
protected jakarta.ws.rs.core.Response	OIDCIdentityProvider.exchangeSessionToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
protected jakarta.ws.rs.core.Response	AbstractOAuth2IdentityProvider.exchangeStoredToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
protected jakarta.ws.rs.core.Response	OIDCIdentityProvider.exchangeStoredToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
protected jakarta.ws.rs.core.Response	AbstractOAuth2IdentityProvider.hasExternalExchangeToken(EventBuilder event, UserSessionModel tokenUserSession, jakarta.ws.rs.core.MultivaluedMap<String,String> params)	check to see if we have a token exchange in session in other words check to see if this session was created by an external exchange
jakarta.ws.rs.core.Response	OIDCIdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm)
String	OIDCIdentityProvider.refreshTokenForLogout(KeycloakSession session, UserSessionModel userSession)	Returns access token response as a string from a refresh token invocation on the remote OIDC broker

Uses of UserSessionModel in org.keycloak.broker.provider

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

Modifier and Type	Method	Description
void	BrokeredIdentityContext.addSessionNotesToUserSession(UserSessionModel userSession)
void	AbstractIdentityProvider.backchannelLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm)
void	IdentityProvider.backchannelLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm)
protected jakarta.ws.rs.core.Response	AbstractIdentityProvider.exchangeErrorResponse(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, String errorCode, String reason)
void	ExchangeExternalToken.exchangeExternalComplete(UserSessionModel userSession, BrokeredIdentityContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> params)
jakarta.ws.rs.core.Response	ExchangeTokenToIdentityProviderToken.exchangeFromToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, jakarta.ws.rs.core.MultivaluedMap<String,String> params)
jakarta.ws.rs.core.Response	AbstractIdentityProvider.exchangeNotLinked(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
jakarta.ws.rs.core.Response	AbstractIdentityProvider.exchangeNotLinkedNoStore(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
jakarta.ws.rs.core.Response	AbstractIdentityProvider.exchangeTokenExpired(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
protected String	AbstractIdentityProvider.getLinkingUrl(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession)
jakarta.ws.rs.core.Response	AbstractIdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm)
jakarta.ws.rs.core.Response	IdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm)	Called when a Keycloak application initiates a logout through the browser.

Uses of UserSessionModel in org.keycloak.broker.saml

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

Modifier and Type	Method	Description
void	SAMLIdentityProvider.backchannelLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm)
protected LogoutRequestType	SAMLIdentityProvider.buildLogoutRequest(UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String singleLogoutServiceUrl, SamlProtocolExtensionsAwareBuilder.NodeGenerator... extensions)
jakarta.ws.rs.core.Response	SAMLIdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm)

Uses of UserSessionModel in org.keycloak.device

Methods in org.keycloak.device with parameters of type UserSessionModel

Modifier and Type	Method	Description
static void	DeviceActivityManager.attachDevice(UserSessionModel userSession, KeycloakSession session)	Attaches a device to the given userSession where the device information is obtained from the HttpHeaders.USER_AGENT in the current request, if available.
static DeviceRepresentation	DeviceActivityManager.getCurrentDevice(UserSessionModel userSession)	Returns the device information associated with the given userSession.

Uses of UserSessionModel in org.keycloak.events

Methods in org.keycloak.events with parameters of type UserSessionModel

Modifier and Type	Method	Description
EventBuilder	EventBuilder.session(UserSessionModel session)

Uses of UserSessionModel in org.keycloak.models

Subinterfaces of UserSessionModel in org.keycloak.models

Modifier and Type	Interface	Description
interface	OfflineUserSessionModel	Hacked extension to UserSessionModel so that user id can be obtain directly so

Methods in org.keycloak.models that return UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	UserSessionProvider.createOfflineUserSession(UserSessionModel userSession)	Newly created userSession won't contain attached AuthenticatedClientSessions
UserSessionModel	UserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)	Creates a new user session with the given parameters.
default UserSessionModel	UserSessionProvider.createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)	Deprecated. Use UserSessionProvider.createUserSession(String, RealmModel, UserModel, String, String, String, boolean, String, String, UserSessionModel.SessionPersistenceState) instead.
UserSessionModel	UserSessionProvider.getOfflineUserSession(RealmModel realm, String userSessionId)
UserSessionModel	AuthenticatedClientSessionModel.getUserSession()
UserSessionModel	UserSessionProvider.getUserSession(RealmModel realm, String id)
UserSessionModel	UserSessionProvider.getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
default UserSessionModel	UserSessionProvider.getUserSessionIfClientExists(RealmModel realm, String userSessionId, boolean offline, String clientUUID)	Returns the UserSessionModel if the user session with ID userSessionId exist, and it has an AuthenticatedClientSessionModel from a ClientModel with ID clientUUID.
UserSessionModel	UserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)	Return userSession of specified ID as long as the predicate passes.

Methods in org.keycloak.models that return types with arguments of type UserSessionModel

Modifier and Type	Method	Description
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)	Obtains the offline user sessions associated with the user that matches the specified brokerUserId.
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)	Obtains the offline user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user)	Obtains the offline user sessions associated with the specified user.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)	Obtains the online user sessions associated with the user that matches the specified brokerUserId.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client)	Obtains the online user sessions associated with the specified client.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)	Obtains the online user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user)	Obtains the online user sessions associated with the specified user.

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

Modifier and Type	Method	Description
AuthenticatedClientSessionModel	UserSessionProvider.createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
AuthenticatedClientSessionModel	UserSessionProvider.createOfflineClientSession(AuthenticatedClientSessionModel clientSession, UserSessionModel offlineUserSession)	Will automatically attach newly created offline client session to the offlineUserSession
UserSessionModel	UserSessionProvider.createOfflineUserSession(UserSessionModel userSession)	Newly created userSession won't contain attached AuthenticatedClientSessions
AuthenticatedClientSessionModel	UserSessionProvider.getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline)
default AuthenticatedClientSessionModel	UserSessionProvider.getClientSession(UserSessionModel userSession, ClientModel client, UUID clientSessionId, boolean offline)	Deprecated. Use UserSessionProvider.getClientSession(UserSessionModel, ClientModel, String, boolean) instead.
void	UserSessionProvider.removeOfflineUserSession(RealmModel realm, UserSessionModel userSession)	Removes the attached clientSessions as well
void	UserSessionProvider.removeUserSession(RealmModel realm, UserSessionModel session)	This will remove attached ClientLoginSessionModels too

Method parameters in org.keycloak.models with type arguments of type UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	UserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)	Return userSession of specified ID as long as the predicate passes.
default void	UserSessionProvider.importUserSessions(Collection<UserSessionModel> persistentUserSessions, boolean offline)	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated as offline session preloading was removed in KC25.

Uses of UserSessionModel in org.keycloak.models.jpa.session

Methods in org.keycloak.models.jpa.session that return UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	JpaUserSessionPersisterProvider.loadUserSession(RealmModel realm, String userSessionId, boolean offline)
UserSessionModel	JpaUserSessionPersisterProvider.loadUserSessionsStreamByBrokerSessionId(RealmModel realm, String brokerSessionId, boolean offline)

Methods in org.keycloak.models.jpa.session that return types with arguments of type UserSessionModel

Modifier and Type	Method	Description
Stream<UserSessionModel>	JpaUserSessionPersisterProvider.loadUserSessionsStream(Integer firstResult, Integer maxResults, boolean offline, String lastUserSessionId)
Stream<UserSessionModel>	JpaUserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults)
Stream<UserSessionModel>	JpaUserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults)

Methods in org.keycloak.models.jpa.session with parameters of type UserSessionModel

Modifier and Type	Method	Description
void	JpaUserSessionPersisterProvider.createUserSession(UserSessionModel userSession, boolean offline)
AuthenticatedClientSessionModel	JpaUserSessionPersisterProvider.loadClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline)

Uses of UserSessionModel in org.keycloak.models.session

Classes in org.keycloak.models.session that implement UserSessionModel

Modifier and Type	Class	Description
class	PersistentUserSessionAdapter

Methods in org.keycloak.models.session that return UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	PersistentAuthenticatedClientSessionAdapter.getUserSession()
UserSessionModel	DisabledUserSessionPersisterProvider.loadUserSession(RealmModel realm, String userSessionId, boolean offline)
UserSessionModel	UserSessionPersisterProvider.loadUserSession(RealmModel realm, String userSessionId, boolean offline)	Loads the user session with the given userSessionId.
default UserSessionModel	UserSessionPersisterProvider.loadUserSessionsStreamByBrokerSessionId(RealmModel realm, String brokerSessionId, boolean offline)

Methods in org.keycloak.models.session that return types with arguments of type UserSessionModel

Modifier and Type	Method	Description
Stream<UserSessionModel>	DisabledUserSessionPersisterProvider.loadUserSessionsStream(Integer firstResult, Integer maxResults, boolean offline, String lastUserSessionId)
Stream<UserSessionModel>	DisabledUserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults)
Stream<UserSessionModel>	DisabledUserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults)
Stream<UserSessionModel>	UserSessionPersisterProvider.loadUserSessionsStream(Integer firstResult, Integer maxResults, boolean offline, String lastUserSessionId)	Called during startup.
Stream<UserSessionModel>	UserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults)	Loads the user sessions for the given ClientModel in the given RealmModel if present.
Stream<UserSessionModel>	UserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults)	Loads the user sessions for the given UserModel in the given RealmModel if present.

Methods in org.keycloak.models.session with parameters of type UserSessionModel

Modifier and Type	Method	Description
void	DisabledUserSessionPersisterProvider.createUserSession(UserSessionModel userSession, boolean offline)
void	UserSessionPersisterProvider.createUserSession(UserSessionModel userSession, boolean offline)
AuthenticatedClientSessionModel	DisabledUserSessionPersisterProvider.loadClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline)
AuthenticatedClientSessionModel	UserSessionPersisterProvider.loadClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline)	Loads client session from the db by provided user session and client.
void	PersistentAuthenticatedClientSessionAdapter.setUserSession(UserSessionModel userSession)

Constructors in org.keycloak.models.session with parameters of type UserSessionModel

Modifier	Constructor	Description
	PersistentAuthenticatedClientSessionAdapter(KeycloakSession session, PersistentClientSessionModel model, RealmModel realm, ClientModel client, UserSessionModel userSession)
	PersistentUserSessionAdapter(UserSessionModel other)

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

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

Modifier and Type	Class	Description
class	UserSessionAdapter<T extends SessionRefreshStore & UserSessionProvider>

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

Modifier and Type	Method	Description
UserSessionModel	InfinispanUserSessionProvider.createOfflineUserSession(UserSessionModel userSession)
UserSessionModel	PersistentUserSessionProvider.createOfflineUserSession(UserSessionModel userSession)
UserSessionModel	InfinispanUserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)
UserSessionModel	PersistentUserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)
UserSessionModel	AuthenticatedClientSessionAdapter.getUserSession()
UserSessionModel	InfinispanUserSessionProvider.getUserSession(RealmModel realm, String id)
UserSessionModel	PersistentUserSessionProvider.getUserSession(RealmModel realm, String id)
UserSessionModel	InfinispanUserSessionProvider.getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
UserSessionModel	PersistentUserSessionProvider.getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
UserSessionModel	InfinispanUserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)
UserSessionModel	PersistentUserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)

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

Modifier and Type	Method	Description
Stream<UserSessionModel>	InfinispanUserSessionProvider.getOfflineUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)
Stream<UserSessionModel>	PersistentUserSessionProvider.getOfflineUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)
Stream<UserSessionModel>	InfinispanUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer first, Integer max)
Stream<UserSessionModel>	InfinispanUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user)
Stream<UserSessionModel>	PersistentUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer first, Integer max)
Stream<UserSessionModel>	PersistentUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user)
Stream<UserSessionModel>	InfinispanUserSessionProvider.getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)
Stream<UserSessionModel>	PersistentUserSessionProvider.getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)
Stream<UserSessionModel>	InfinispanUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client)
Stream<UserSessionModel>	InfinispanUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)
protected Stream<UserSessionModel>	InfinispanUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults, boolean offline)
protected Stream<UserSessionModel>	InfinispanUserSessionProvider.getUserSessionsStream(RealmModel realm, UserSessionPredicate predicate, boolean offline)
Stream<UserSessionModel>	InfinispanUserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user)
Stream<UserSessionModel>	PersistentUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client)
Stream<UserSessionModel>	PersistentUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)
protected Stream<UserSessionModel>	PersistentUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults, boolean offline)
protected Stream<UserSessionModel>	PersistentUserSessionProvider.getUserSessionsStream(RealmModel realm, UserSessionPredicate predicate, boolean offline)
Stream<UserSessionModel>	PersistentUserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user)

Methods in org.keycloak.models.sessions.infinispan with parameters of type UserSessionModel

Modifier and Type	Method	Description
AuthenticatedClientSessionModel	InfinispanUserSessionProvider.createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
AuthenticatedClientSessionModel	PersistentUserSessionProvider.createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
AuthenticatedClientSessionModel	InfinispanUserSessionProvider.createOfflineClientSession(AuthenticatedClientSessionModel clientSession, UserSessionModel offlineUserSession)
AuthenticatedClientSessionModel	PersistentUserSessionProvider.createOfflineClientSession(AuthenticatedClientSessionModel clientSession, UserSessionModel offlineUserSession)
UserSessionModel	InfinispanUserSessionProvider.createOfflineUserSession(UserSessionModel userSession)
UserSessionModel	PersistentUserSessionProvider.createOfflineUserSession(UserSessionModel userSession)
AuthenticatedClientSessionAdapter	InfinispanUserSessionProvider.getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline)
AuthenticatedClientSessionAdapter	PersistentUserSessionProvider.getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline)
protected UserSessionAdapter	InfinispanUserSessionProvider.importUserSession(UserSessionModel userSession, boolean offline)
SessionEntityWrapper<UserSessionEntity>	PersistentUserSessionProvider.importUserSession(UserSessionModel persistentUserSession, boolean offline)
void	InfinispanUserSessionProvider.removeOfflineUserSession(RealmModel realm, UserSessionModel userSession)
void	PersistentUserSessionProvider.removeOfflineUserSession(RealmModel realm, UserSessionModel userSession)
void	InfinispanUserSessionProvider.removeUserSession(RealmModel realm, UserSessionModel session)
void	PersistentUserSessionProvider.removeUserSession(RealmModel realm, UserSessionModel session)
SessionEntityWrapper<UserSessionEntity>	PersistentUserSessionProvider.wrapPersistentEntity(RealmModel realm, boolean offline, UserSessionModel persistentUserSession)

Method parameters in org.keycloak.models.sessions.infinispan with type arguments of type UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	InfinispanUserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)
UserSessionModel	PersistentUserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)
void	InfinispanUserSessionProvider.importUserSessions(Collection<UserSessionModel> persistentUserSessions, boolean offline)
void	PersistentUserSessionProvider.importUserSessions(Collection<UserSessionModel> persistentUserSessions, boolean offline)

Constructors in org.keycloak.models.sessions.infinispan with parameters of type UserSessionModel

Modifier	Constructor	Description
	AuthenticatedClientSessionAdapter(KeycloakSession kcSession, SessionRefreshStore provider, AuthenticatedClientSessionEntity entity, ClientModel client, UserSessionModel userSession, SessionsChangelogBasedTransaction<UUID,AuthenticatedClientSessionEntity> clientSessionUpdateTx, boolean offline)

Uses of UserSessionModel in org.keycloak.models.sessions.infinispan.changes

Methods in org.keycloak.models.sessions.infinispan.changes with parameters of type UserSessionModel

Modifier and Type	Method	Description
SessionEntityWrapper<AuthenticatedClientSessionEntity>	ClientSessionPersistentChangelogBasedTransaction.get(RealmModel realm, ClientModel client, UserSessionModel userSession, UUID key, boolean offline)
SessionEntityWrapper<UserSessionEntity>	UserSessionPersistentChangelogBasedTransaction.get(RealmModel realm, String key, UserSessionModel userSession, boolean offline)

Uses of UserSessionModel in org.keycloak.models.sessions.infinispan.changes.remote.updater.client

Methods in org.keycloak.models.sessions.infinispan.changes.remote.updater.client that return UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	AuthenticatedClientSessionUpdater.getUserSession()

Methods in org.keycloak.models.sessions.infinispan.changes.remote.updater.client with parameters of type UserSessionModel

Modifier and Type	Method	Description
void	AuthenticatedClientSessionUpdater.initialize(UserSessionModel userSession, ClientModel client, ClientSessionChangeLogTransaction clientTransaction)	Initializes this class with references to other models classes.

Uses of UserSessionModel in org.keycloak.models.sessions.infinispan.changes.remote.updater.user

Classes in org.keycloak.models.sessions.infinispan.changes.remote.updater.user that implement UserSessionModel

Modifier and Type	Class	Description
class	UserSessionUpdater	The Updater implementation to keep track of modifications for UserSessionModel.

Uses of UserSessionModel in org.keycloak.models.sessions.infinispan.changes.sessions

Methods in org.keycloak.models.sessions.infinispan.changes.sessions with parameters of type UserSessionModel

Modifier and Type	Method	Description
SessionUpdateTask.CrossDCMessageStatus	CrossDCLastSessionRefreshChecker.shouldSaveClientSessionToRemoteCache(KeycloakSession kcSession, RealmModel realm, SessionEntityWrapper<AuthenticatedClientSessionEntity> sessionWrapper, UserSessionModel userSession, boolean offline, int newTimestamp)

Uses of UserSessionModel in org.keycloak.models.sessions.infinispan.entities

Methods in org.keycloak.models.sessions.infinispan.entities with parameters of type UserSessionModel

Modifier and Type	Method	Description
static AuthenticatedClientSessionEntity	AuthenticatedClientSessionEntity.create(UUID clientSessionId, RealmModel realm, ClientModel client, UserSessionModel userSession)
static RemoteAuthenticatedClientSessionEntity	RemoteAuthenticatedClientSessionEntity.create(ClientSessionKey id, String realmId, UserSessionModel userSession)
static RemoteUserSessionEntity	RemoteUserSessionEntity.createFromModel(UserSessionModel model)
static UserSessionEntity	UserSessionEntity.createFromModel(UserSessionModel userSession)

Uses of UserSessionModel in org.keycloak.models.sessions.infinispan.remote

Methods in org.keycloak.models.sessions.infinispan.remote that return UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	RemoteUserSessionProvider.createOfflineUserSession(UserSessionModel userSession)
UserSessionModel	RemoteUserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)
UserSessionModel	RemoteUserSessionProvider.getOfflineUserSession(RealmModel realm, String userSessionId)
UserSessionModel	RemoteUserSessionProvider.getUserSession(RealmModel realm, String id)
UserSessionModel	RemoteUserSessionProvider.getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
UserSessionModel	RemoteUserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)

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

Modifier and Type	Method	Description
Stream<UserSessionModel>	RemoteUserSessionProvider.getOfflineUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)
Stream<UserSessionModel>	RemoteUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)
Stream<UserSessionModel>	RemoteUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user)
Stream<UserSessionModel>	RemoteUserSessionProvider.getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)
Stream<UserSessionModel>	RemoteUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client)
Stream<UserSessionModel>	RemoteUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)
Stream<UserSessionModel>	RemoteUserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user)

Methods in org.keycloak.models.sessions.infinispan.remote with parameters of type UserSessionModel

Modifier and Type	Method	Description
AuthenticatedClientSessionModel	RemoteUserSessionProvider.createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
AuthenticatedClientSessionModel	RemoteUserSessionProvider.createOfflineClientSession(AuthenticatedClientSessionModel clientSession, UserSessionModel offlineUserSession)
UserSessionModel	RemoteUserSessionProvider.createOfflineUserSession(UserSessionModel userSession)
AuthenticatedClientSessionModel	RemoteUserSessionProvider.getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline)
void	RemoteUserSessionProvider.removeOfflineUserSession(RealmModel realm, UserSessionModel userSession)
void	RemoteUserSessionProvider.removeUserSession(RealmModel realm, UserSessionModel userSession)

Method parameters in org.keycloak.models.sessions.infinispan.remote with type arguments of type UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	RemoteUserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)

Uses of UserSessionModel in org.keycloak.models.sessions.infinispan.stream

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

Modifier and Type	Method	Description
Predicate<? super UserSessionModel>	UserSessionPredicate.toModelPredicate()

Uses of UserSessionModel in org.keycloak.models.utils

Classes in org.keycloak.models.utils that implement UserSessionModel

Modifier and Type	Class	Description
class	UserSessionModelDelegate

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

Modifier and Type	Method	Description
static UserSessionRepresentation	ModelToRepresentation.toRepresentation(UserSessionModel session)

Constructors in org.keycloak.models.utils with parameters of type UserSessionModel

Modifier	Constructor	Description
	UserSessionModelDelegate(UserSessionModel delegate)

Uses of UserSessionModel in org.keycloak.organization.protocol.mappers.oidc

Methods in org.keycloak.organization.protocol.mappers.oidc with parameters of type UserSessionModel

Modifier and Type	Method	Description
protected void	OrganizationMembershipMapper.setClaim(IDToken token, ProtocolMapperModel model, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)

Uses of UserSessionModel in org.keycloak.organization.protocol.mappers.saml

Methods in org.keycloak.organization.protocol.mappers.saml with parameters of type UserSessionModel

Modifier and Type	Method	Description
void	OrganizationMembershipMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

Uses of UserSessionModel in org.keycloak.protocol

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

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	LoginProtocol.authenticated(AuthenticationSessionModel authSession, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
jakarta.ws.rs.core.Response	LoginProtocol.backchannelLogout(UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
jakarta.ws.rs.core.Response	LoginProtocol.finishBrowserLogout(UserSessionModel userSession, AuthenticationSessionModel logoutSession)	This method is called when browser logout is going to be finished.
jakarta.ws.rs.core.Response	LoginProtocol.frontchannelLogout(UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
boolean	LoginProtocol.requireReauthentication(UserSessionModel userSession, AuthenticationSessionModel authSession)

Uses of UserSessionModel in org.keycloak.protocol.docker

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

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	DockerAuthV2Protocol.authenticated(AuthenticationSessionModel authSession, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
jakarta.ws.rs.core.Response	DockerAuthV2Protocol.backchannelLogout(UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
jakarta.ws.rs.core.Response	DockerAuthV2Protocol.finishBrowserLogout(UserSessionModel userSession, AuthenticationSessionModel logoutSession)
jakarta.ws.rs.core.Response	DockerAuthV2Protocol.frontchannelLogout(UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
boolean	DockerAuthV2Protocol.requireReauthentication(UserSessionModel userSession, AuthenticationSessionModel clientSession)

Uses of UserSessionModel in org.keycloak.protocol.docker.mapper

Methods in org.keycloak.protocol.docker.mapper with parameters of type UserSessionModel

Modifier and Type	Method	Description
DockerResponseToken	AllowAllDockerProtocolMapper.transformDockerResponseToken(DockerResponseToken responseToken, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
DockerResponseToken	DockerAuthV2AttributeMapper.transformDockerResponseToken(DockerResponseToken responseToken, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

Uses of UserSessionModel in org.keycloak.protocol.oid4vc.issuance.mappers

Methods in org.keycloak.protocol.oid4vc.issuance.mappers with parameters of type UserSessionModel

Modifier and Type	Method	Description
void	OID4VCContextMapper.setClaimsForCredential(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)
void	OID4VCIssuedAtTimeClaimMapper.setClaimsForCredential(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)
abstract void	OID4VCMapper.setClaimsForCredential(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)	Set the claims to credential, like f.e.
void	OID4VCStaticClaimMapper.setClaimsForCredential(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)
void	OID4VCSubjectIdMapper.setClaimsForCredential(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)
void	OID4VCTargetRoleMapper.setClaimsForCredential(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)
void	OID4VCTypeMapper.setClaimsForCredential(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)
void	OID4VCUserAttributeMapper.setClaimsForCredential(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)
void	OID4VCContextMapper.setClaimsForSubject(Map<String,Object> claims, UserSessionModel userSessionModel)
void	OID4VCIssuedAtTimeClaimMapper.setClaimsForSubject(Map<String,Object> claims, UserSessionModel userSessionModel)
abstract void	OID4VCMapper.setClaimsForSubject(Map<String,Object> claims, UserSessionModel userSessionModel)	Set the claims to the credential subject.
void	OID4VCStaticClaimMapper.setClaimsForSubject(Map<String,Object> claims, UserSessionModel userSessionModel)
void	OID4VCSubjectIdMapper.setClaimsForSubject(Map<String,Object> claims, UserSessionModel userSessionModel)
void	OID4VCTargetRoleMapper.setClaimsForSubject(Map<String,Object> claims, UserSessionModel userSessionModel)
void	OID4VCTypeMapper.setClaimsForSubject(Map<String,Object> claims, UserSessionModel userSessionModel)
void	OID4VCUserAttributeMapper.setClaimsForSubject(Map<String,Object> claims, UserSessionModel userSessionModel)

Uses of UserSessionModel in org.keycloak.protocol.oidc

Fields in org.keycloak.protocol.oidc declared as UserSessionModel

Modifier and Type	Field	Description
final UserSessionModel	TokenManager.TokenValidation.userSession

Methods in org.keycloak.protocol.oidc that return UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	TokenManager.getValidUserSessionIfTokenIsValid(KeycloakSession session, RealmModel realm, AccessToken token, EventBuilder eventBuilder)	Checks if the token is valid and return a valid user session.

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

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.backchannelLogout(UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
jakarta.ws.rs.core.Response	OIDCLoginProtocol.buildRedirectUri(OIDCRedirectUriBuilder redirectUriBuilder, AuthenticationSessionModel authSession, UserSessionModel userSession, ClientSessionContext clientSessionCtx)	this method can be used in extension-implementations to the OIDCLoginProtocol to add additional parameters to the redirectUri after successful authentication and to store these e.g.
jakarta.ws.rs.core.Response	OIDCLoginProtocol.buildRedirectUri(OIDCRedirectUriBuilder redirectUriBuilder, AuthenticationSessionModel authSession, UserSessionModel userSession, ClientSessionContext clientSessionCtx, Exception ex, LoginProtocol.Error oidcError)	this method can be used in extension-implementations to the OIDCLoginProtocol to add additional parameters to the redirectUri after failed authentication
AccessToken	TokenManager.createClientAccessToken(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
protected jakarta.ws.rs.core.Response	DefaultTokenExchangeProvider.exchangeClientToClient(UserModel targetUser, UserSessionModel targetUserSession, AccessToken token, boolean disallowOnHolderOfTokenMismatch)
protected jakarta.ws.rs.core.Response	DefaultTokenExchangeProvider.exchangeClientToOIDCClient(UserModel targetUser, UserSessionModel targetUserSession, String requestedTokenType, ClientModel targetClient, String audience, String scope)
protected jakarta.ws.rs.core.Response	DefaultTokenExchangeProvider.exchangeClientToSAML2Client(UserModel targetUser, UserSessionModel targetUserSession, String requestedTokenType, ClientModel targetClient)
protected jakarta.ws.rs.core.Response	DefaultTokenExchangeProvider.exchangeToIdentityProvider(UserModel targetUser, UserSessionModel targetUserSession, String requestedIssuer)
jakarta.ws.rs.core.Response	OIDCLoginProtocol.finishBrowserLogout(UserSessionModel userSession, AuthenticationSessionModel logoutSession)
jakarta.ws.rs.core.Response	OIDCLoginProtocol.frontchannelLogout(UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
protected AccessToken	TokenManager.initToken(RealmModel realm, ClientModel client, UserModel user, UserSessionModel session, ClientSessionContext clientSessionCtx, jakarta.ws.rs.core.UriInfo uriInfo)
protected boolean	OIDCLoginProtocol.isAuthTimeExpired(UserSessionModel userSession, AuthenticationSessionModel authSession)
protected boolean	OIDCLoginProtocol.isReAuthRequiredForKcAction(UserSessionModel userSession, AuthenticationSessionModel authSession)
boolean	OIDCLoginProtocol.requireReauthentication(UserSessionModel userSession, AuthenticationSessionModel authSession)
TokenManager.AccessTokenResponseBuilder	TokenManager.responseBuilder(RealmModel realm, ClientModel client, EventBuilder event, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AccessTokenIntrospectionProvider.transformAccessToken(AccessToken token, UserSessionModel userSession)
AccessToken	TokenManager.transformAccessToken(KeycloakSession session, AccessToken token, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessTokenResponse	TokenManager.transformAccessTokenResponse(KeycloakSession session, AccessTokenResponse accessTokenResponse, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	TokenManager.transformIDToken(KeycloakSession session, IDToken token, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	TokenManager.transformIntrospectionAccessToken(KeycloakSession session, AccessToken token, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	TokenManager.transformUserInfoAccessToken(KeycloakSession session, AccessToken token, UserSessionModel userSession, ClientSessionContext clientSessionCtx)

Constructors in org.keycloak.protocol.oidc with parameters of type UserSessionModel

Modifier	Constructor	Description
	AccessTokenResponseBuilder(RealmModel realm, ClientModel client, EventBuilder event, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
	TokenValidation(UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx, AccessToken newToken)

Uses of UserSessionModel in org.keycloak.protocol.oidc.grants

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

Modifier and Type	Method	Description
protected jakarta.ws.rs.core.Response	OAuth2GrantTypeBase.createTokenResponse(UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx, String scopeParam, boolean code, Function<TokenManager.AccessTokenResponseBuilder,ClientPolicyContext> clientPolicyContextGenerator)
protected void	OAuth2GrantTypeBase.updateUserSessionFromClientAuth(UserSessionModel userSession)

Uses of UserSessionModel in org.keycloak.protocol.oidc.mappers

Methods in org.keycloak.protocol.oidc.mappers with parameters of type UserSessionModel

Modifier and Type	Method	Description
protected void	AbstractOIDCProtocolMapper.setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.
protected void	AbstractOIDCProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)	Deprecated. override AbstractOIDCProtocolMapper.setClaim(IDToken, ProtocolMapperModel, UserSessionModel, KeycloakSession, ClientSessionContext) instead.
protected void	AbstractOIDCProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.
protected void	AcrProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	AddressMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	AmrProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	AudienceProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	ClaimsParameterTokenMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	ClaimsParameterWithValueIdTokenMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	FullNameMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	GroupMembershipMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)	Adds the group membership information to the JsonWebToken.otherClaims.
protected void	HardcodedClaim.setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	HardcodedClaim.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	HardcodedRole.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	RoleNameMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	ScriptBasedOIDCProtocolMapper.setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	ScriptBasedOIDCProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	SessionStateMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	SubMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	UserAttributeMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	UserClientRoleMappingMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	UserPropertyMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	UserRealmRoleMappingMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	UserSessionNoteMapper.setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	UserSessionNoteMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
AccessToken	AbstractOIDCProtocolMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AbstractPairwiseSubMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AllowedWebOriginsProtocolMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AudienceResolveProtocolMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	HardcodedRole.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	NonceBackwardsCompatibleMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	OIDCAccessTokenMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	RoleNameMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessTokenResponse	AbstractOIDCProtocolMapper.transformAccessTokenResponse(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessTokenResponse	OIDCAccessTokenResponseMapper.transformAccessTokenResponse(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	AbstractOIDCProtocolMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	AbstractPairwiseSubMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	OIDCIDTokenMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSession)
AccessToken	AbstractOIDCProtocolMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AbstractPairwiseSubMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AllowedWebOriginsProtocolMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AudienceResolveProtocolMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	HardcodedRole.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	RoleNameMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	TokenIntrospectionTokenMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AbstractOIDCProtocolMapper.transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AbstractPairwiseSubMapper.transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	HardcodedRole.transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	RoleNameMapper.transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	UserInfoTokenMapper.transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)

Uses of UserSessionModel in org.keycloak.protocol.saml

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

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	SamlProtocol.authenticated(AuthenticationSessionModel authSession, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
jakarta.ws.rs.core.Response	SamlProtocol.backchannelLogout(UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
protected String	SamlProtocol.buildArtifactAndStoreResponse(SAML2Object statusResponseType, UserSessionModel userSession)
protected jakarta.ws.rs.core.Response	SamlProtocol.buildLogoutArtifactResponse(UserSessionModel userSession, String redirectUri, StatusResponseType statusResponseType, JaxrsSAML2BindingBuilder bindingBuilder)	This method, instead of sending the actual response with the token, sends the artifact message via post or redirect.
protected jakarta.ws.rs.core.Response	SamlProtocol.buildLogoutResponse(UserSessionModel userSession, String logoutBindingUri, SAML2LogoutResponseBuilder builder, JaxrsSAML2BindingBuilder binding)
jakarta.ws.rs.core.Response	SamlProtocol.finishBrowserLogout(UserSessionModel userSession, AuthenticationSessionModel logoutSession)
jakarta.ws.rs.core.Response	SamlProtocol.frontchannelLogout(UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
protected String	SamlProtocol.getNameId(String nameIdFormat, CommonClientSessionModel clientSession, UserSessionModel userSession)
protected String	SamlProtocol.getPersistentNameId(CommonClientSessionModel clientSession, UserSessionModel userSession)	Attempts to retrieve the persistent type NameId as follows: saml.persistent.name.id.for.$clientId user attribute saml.persistent.name.id.for.* user attribute G-$randomUuid
protected String	SamlProtocol.getSAMLNameId(List<SamlProtocol.ProtocolMapperProcessor<SAMLNameIdMapper>> samlNameIdMappers, String nameIdFormat, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
static boolean	SamlProtocol.isLogoutPostBindingForInitiator(UserSessionModel session)
AttributeStatementType	SamlProtocol.populateAttributeStatements(List<SamlProtocol.ProtocolMapperProcessor<SAMLAttributeStatementMapper>> attributeStatementMappers, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	SamlProtocol.populateRoles(SamlProtocol.ProtocolMapperProcessor<SAMLRoleListMapper> roleListMapper, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx, AttributeStatementType existingAttributeStatement)
boolean	SamlProtocol.requireReauthentication(UserSessionModel userSession, AuthenticationSessionModel authSession)
ResponseType	SamlProtocol.transformLoginResponse(List<SamlProtocol.ProtocolMapperProcessor<SAMLLoginResponseMapper>> mappers, ResponseType response, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)

Uses of UserSessionModel in org.keycloak.protocol.saml.mappers

Methods in org.keycloak.protocol.saml.mappers with parameters of type UserSessionModel

Modifier and Type	Method	Description
String	SAMLNameIdMapper.mapperNameId(String nameIdFormat, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
String	UserAttributeNameIdMapper.mapperNameId(String nameIdFormat, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	RoleListMapper.mapRoles(AttributeStatementType roleAttributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
void	SAMLRoleListMapper.mapRoles(AttributeStatementType roleAttributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
void	GroupMembershipMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	HardcodedAttributeMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	SAMLAttributeStatementMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	ScriptBasedMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)	This method attaches one or many attributes to the passed attribute statement.
void	UserAttributeStatementMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	UserPropertyAttributeStatementMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	UserSessionNoteStatementMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
ResponseType	SAMLAudienceProtocolMapper.transformLoginResponse(ResponseType response, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
ResponseType	SAMLAudienceResolveProtocolMapper.transformLoginResponse(ResponseType response, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
ResponseType	SAMLLoginResponseMapper.transformLoginResponse(ResponseType response, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)

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

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

Modifier and Type	Method	Description
default LogoutRequestType	SamlAuthenticationPreprocessor.beforeProcessingLogoutRequest(LogoutRequestType logoutRequest, UserSessionModel authSession, AuthenticatedClientSessionModel clientSession)	Called before a logout request is processed.
default LogoutRequestType	SamlAuthenticationPreprocessor.beforeSendingLogoutRequest(LogoutRequestType logoutRequest, UserSessionModel authSession, AuthenticatedClientSessionModel clientSession)	Called before a logout request is sent.

Uses of UserSessionModel in org.keycloak.services.managers

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

Modifier and Type	Method	Description
UserSessionModel	UserSessionManager.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)
UserSessionModel	UserSessionManager.createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
UserSessionModel	UserSessionManager.findOfflineUserSession(RealmModel realm, String userSessionId)
UserSessionModel	Auth.getSession()
UserSessionModel	AuthenticationManager.AuthResult.getSession()
UserSessionModel	AuthenticationSessionManager.getUserSession(AuthenticationSessionModel authSession)
UserSessionModel	AuthenticationSessionManager.getUserSessionFromAuthenticationCookie(RealmModel realm)
UserSessionModel	UserSessionCrossDCManager.getUserSessionIfExistsRemotely(AuthenticationSessionManager asm, RealmModel realm)	Deprecated, for removal: This API element is subject to removal in a future version. To be removed in Keycloak 27+.
UserSessionModel	UserSessionCrossDCManager.getUserSessionWithClient(RealmModel realm, String id, boolean offline, String clientUUID)	Deprecated, for removal: This API element is subject to removal in a future version. To be removed in Keycloak 27+.
UserSessionModel	UserSessionCrossDCManager.getUserSessionWithClient(RealmModel realm, String id, String clientUUID)	Deprecated, for removal: This API element is subject to removal in a future version. To be removed in Keycloak 27+.
UserSessionModel	UserSessionCrossDCManager.getUserSessionWithImpersonatorClient(RealmModel realm, String id, boolean offline, String clientUUID)	Deprecated, for removal: This API element is subject to removal in a future version. To be removed in Keycloak 27+.

Methods in org.keycloak.services.managers that return types with arguments of type UserSessionModel

Modifier and Type	Method	Description
List<UserSessionModel>	UserSessionManager.findOfflineSessions(RealmModel realm, UserModel user)	Deprecated.
Stream<UserSessionModel>	UserSessionManager.findOfflineSessionsStream(RealmModel realm, UserModel user)

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

Modifier and Type	Method	Description
static BackchannelLogoutResponse	AuthenticationManager.backchannelLogout(KeycloakSession session, RealmModel realm, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection, jakarta.ws.rs.core.HttpHeaders headers, boolean logoutBroker)
static BackchannelLogoutResponse	AuthenticationManager.backchannelLogout(KeycloakSession session, RealmModel realm, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection, jakarta.ws.rs.core.HttpHeaders headers, boolean logoutBroker, boolean offlineSession)
static void	AuthenticationManager.backchannelLogout(KeycloakSession session, UserSessionModel userSession, boolean logoutBroker)
static jakarta.ws.rs.core.Response	AuthenticationManager.browserLogout(KeycloakSession session, RealmModel realm, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection, jakarta.ws.rs.core.HttpHeaders headers)
static IdentityCookieToken	AuthenticationManager.createIdentityToken(KeycloakSession keycloakSession, RealmModel realm, UserModel user, UserSessionModel session, String issuer)
static void	AuthenticationManager.createLoginCookie(KeycloakSession keycloakSession, RealmModel realm, UserModel user, UserSessionModel session, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection)
static AuthenticationSessionModel	AuthenticationManager.createOrJoinLogoutSession(KeycloakSession session, RealmModel realm, AuthenticationSessionManager asm, UserSessionModel userSession, boolean browserCookie, boolean initiateLogout)
void	UserSessionManager.createOrUpdateOfflineSession(AuthenticatedClientSessionModel clientSession, UserSessionModel userSession)
static boolean	AuthenticationManager.expireUserSessionCookie(KeycloakSession session, UserSessionModel userSession, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.HttpHeaders headers, ClientConnection connection)
static jakarta.ws.rs.core.Response	AuthenticationManager.finishBrowserLogout(KeycloakSession session, RealmModel realm, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection, jakarta.ws.rs.core.HttpHeaders headers)
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 void	AuthenticationManager.finishUnconfirmedUserSession(KeycloakSession session, RealmModel realm, UserSessionModel userSessionModel)
static boolean	AuthenticationManager.isClientSessionValid(RealmModel realm, ClientModel client, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
static boolean	AuthenticationManager.isSessionValid(RealmModel realm, UserSessionModel userSession)
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)
void	UserSessionManager.revokeOfflineUserSession(UserSessionModel userSession)

Constructors in org.keycloak.services.managers with parameters of type UserSessionModel

Modifier	Constructor	Description
	Auth(RealmModel realm, AccessToken token, UserModel user, ClientModel client, UserSessionModel session, boolean cookie)
	AuthResult(UserModel user, UserSessionModel session, AccessToken token, ClientModel client)

Uses of UserSessionModel in org.keycloak.services.util

Methods in org.keycloak.services.util that return UserSessionModel

Modifier and Type	Method	Description
static UserSessionModel	UserSessionUtil.findValidSession(KeycloakSession session, RealmModel realm, AccessToken token, EventBuilder event, ClientModel client)
static UserSessionModel	UserSessionUtil.findValidSession(KeycloakSession session, RealmModel realm, AccessToken token, EventBuilder event, ClientModel client, OAuth2Error error)
static UserSessionModel	UserSessionUtil.getUserSessionWithImpersonatorClient(KeycloakSession session, RealmModel realm, String userSessionId, boolean offline, String clientUUID)

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

Modifier and Type	Method	Description
static void	UserSessionUtil.checkTokenIssuedAt(RealmModel realm, AccessToken token, UserSessionModel userSession, EventBuilder event, ClientModel client)

Uses of UserSessionModel in org.keycloak.social.twitter

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

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	TwitterIdentityProvider.exchangeFromToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder builder, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, jakarta.ws.rs.core.MultivaluedMap<String,String> params)
protected jakarta.ws.rs.core.Response	TwitterIdentityProvider.exchangeSessionToken(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
protected jakarta.ws.rs.core.Response	TwitterIdentityProvider.exchangeStoredToken(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)