Uses of Interface
org.keycloak.models.KeycloakSession

Packages that use KeycloakSession

Package	Description
org.keycloak.authentication
org.keycloak.authorization	Fine-grained Authorization SPI.
org.keycloak.broker.provider
org.keycloak.component
org.keycloak.credential
org.keycloak.events
org.keycloak.hash
org.keycloak.mappers
org.keycloak.migration
org.keycloak.migration.migrators
org.keycloak.models
org.keycloak.models.dblock
org.keycloak.models.session
org.keycloak.models.utils
org.keycloak.policy
org.keycloak.protocol
org.keycloak.provider
org.keycloak.services.managers
org.keycloak.storage
org.keycloak.storage.adapter
org.keycloak.storage.user
org.keycloak.timer
org.keycloak.transaction

Uses of KeycloakSession in org.keycloak.authentication

Methods in org.keycloak.authentication that return KeycloakSession

Modifier and Type	Method and Description
KeycloakSession	AbstractAuthenticationFlowContext.getSession() Current session
KeycloakSession	RequiredActionContext.getSession()
KeycloakSession	FormContext.getSession() Current session

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

Modifier and Type	Method and Description
boolean	FormAction.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) Is this FormAction configured for the current user?
boolean	Authenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) Is this authenticator configured for this user.
void	FormAction.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticator
void	Authenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticator

Uses of KeycloakSession in org.keycloak.authorization

Methods in org.keycloak.authorization that return KeycloakSession

Modifier and Type	Method and Description
KeycloakSession	AuthorizationProvider.getKeycloakSession()

Methods in org.keycloak.authorization with parameters of type KeycloakSession

Modifier and Type	Method and Description
AuthorizationProvider	AuthorizationProviderFactory.create(KeycloakSession session, RealmModel realm)

Constructors in org.keycloak.authorization with parameters of type KeycloakSession

Constructor and Description
AuthorizationProvider(KeycloakSession session, RealmModel realm, StoreFactory storeFactory)
AuthorizationProvider(KeycloakSession session, RealmModel realm, StoreFactory storeFactory, Executor scheduller)

Uses of KeycloakSession in org.keycloak.broker.provider

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

Modifier and Type	Method and Description
KeycloakSession	AuthenticationRequest.getSession()

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

Modifier and Type	Method and Description
void	AbstractIdentityProvider.backchannelLogout(KeycloakSession session, UserSessionModel userSession, javax.ws.rs.core.UriInfo uriInfo, RealmModel realm)
void	IdentityProvider.backchannelLogout(KeycloakSession session, UserSessionModel userSession, javax.ws.rs.core.UriInfo uriInfo, RealmModel realm)
T	AbstractIdentityProviderFactory.create(KeycloakSession session)
IdentityProviderMapper	AbstractIdentityProviderMapper.create(KeycloakSession session)
void	AbstractIdentityProvider.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void	IdentityProvider.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void	IdentityProviderMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) Called after UserModel is created for first time for this user.
void	AbstractIdentityProviderMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
javax.ws.rs.core.Response	AbstractIdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, javax.ws.rs.core.UriInfo uriInfo, RealmModel realm)
javax.ws.rs.core.Response	IdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, javax.ws.rs.core.UriInfo uriInfo, RealmModel realm) Called when a Keycloak application initiates a logout through the browser.
Map<String,String>	IdentityProviderFactory.parseConfig(KeycloakSession session, InputStream inputStream) Creates an IdentityProvider based on the configuration from inputStream.
Map<String,String>	AbstractIdentityProviderFactory.parseConfig(KeycloakSession session, InputStream inputStream)
void	AbstractIdentityProvider.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context)
void	IdentityProvider.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context)
void	IdentityProviderMapper.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) Called to determine what keycloak username and email to use to process the login request from the external IDP.
void	AbstractIdentityProviderMapper.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
javax.ws.rs.core.Response	IdentityProvider.retrieveToken(KeycloakSession session, FederatedIdentityModel identity) Returns a Response containing the token previously stored during the authentication process for a specific user.
void	AbstractIdentityProvider.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void	IdentityProvider.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void	IdentityProviderMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) Called when this user has logged in before and has already been imported.

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

Constructor and Description
AuthenticationRequest(KeycloakSession session, RealmModel realm, ClientSessionModel clientSession, org.jboss.resteasy.spi.HttpRequest httpRequest, javax.ws.rs.core.UriInfo uriInfo, String state, String redirectUri)

Uses of KeycloakSession in org.keycloak.component

Methods in org.keycloak.component with parameters of type KeycloakSession

Modifier and Type	Method and Description
default ProviderType	ComponentFactory.create(KeycloakSession session)
CreatedType	ComponentFactory.create(KeycloakSession session, ComponentModel model)
void	ComponentFactory.validateConfiguration(KeycloakSession session, ComponentModel config)

Uses of KeycloakSession in org.keycloak.credential

Methods in org.keycloak.credential with parameters of type KeycloakSession

Modifier and Type	Method and Description
T	CredentialProviderFactory.create(KeycloakSession session, ComponentModel model) called per Keycloak transaction.
default void	CredentialProviderFactory.validateConfiguration(KeycloakSession session, ComponentModel config)

Uses of KeycloakSession in org.keycloak.events

Constructors in org.keycloak.events with parameters of type KeycloakSession

Constructor and Description
EventBuilder(RealmModel realm, KeycloakSession session, org.keycloak.common.ClientConnection clientConnection)

Uses of KeycloakSession in org.keycloak.hash

Methods in org.keycloak.hash with parameters of type KeycloakSession

Modifier and Type	Method and Description
PasswordHashProvider	Pbkdf2PasswordHashProvider.create(KeycloakSession session)
static UserCredentialValueModel	PasswordHashManager.encode(KeycloakSession session, PasswordPolicy passwordPolicy, String rawPassword)
static UserCredentialValueModel	PasswordHashManager.encode(KeycloakSession session, RealmModel realm, String rawPassword)
static boolean	PasswordHashManager.verify(KeycloakSession session, PasswordPolicy passwordPolicy, String password, UserCredentialValueModel credential)
static boolean	PasswordHashManager.verify(KeycloakSession session, RealmModel realm, String password, UserCredentialValueModel credential)

Uses of KeycloakSession in org.keycloak.mappers

Methods in org.keycloak.mappers with parameters of type KeycloakSession

Modifier and Type	Method and Description
UserFederationSyncResult	UserFederationMapper.syncDataFromFederationProviderToKeycloak(UserFederationMapperModel mapperModel, UserFederationProvider federationProvider, KeycloakSession session, RealmModel realm) Sync data from federated storage to Keycloak.
UserFederationSyncResult	UserFederationMapper.syncDataFromKeycloakToFederationProvider(UserFederationMapperModel mapperModel, UserFederationProvider federationProvider, KeycloakSession session, RealmModel realm) Sync data from Keycloak back to federated storage

Uses of KeycloakSession in org.keycloak.migration

Methods in org.keycloak.migration with parameters of type KeycloakSession

Modifier and Type	Method and Description
static void	MigrationModelManager.migrate(KeycloakSession session)

Uses of KeycloakSession in org.keycloak.migration.migrators

Methods in org.keycloak.migration.migrators with parameters of type KeycloakSession

Modifier and Type	Method and Description
void	MigrateTo1_7_0.migrate(KeycloakSession session)
void	MigrateTo1_2_0.migrate(KeycloakSession session)
void	MigrateTo1_5_0.migrate(KeycloakSession session)
void	MigrateTo1_8_0.migrate(KeycloakSession session)
void	Migration.migrate(KeycloakSession session)
void	MigrateTo1_9_2.migrate(KeycloakSession session)
void	MigrateTo1_3_0.migrate(KeycloakSession session)
void	MigrateTo2_2_0.migrate(KeycloakSession session)
void	MigrateTo1_4_0.migrate(KeycloakSession session)
void	MigrateTo2_1_0.migrate(KeycloakSession session)
void	MigrateTo2_0_0.migrate(KeycloakSession session)
void	MigrateTo1_6_0.migrate(KeycloakSession session)
void	MigrateTo1_9_0.migrate(KeycloakSession session)

Uses of KeycloakSession in org.keycloak.models

Fields in org.keycloak.models declared as KeycloakSession

Modifier and Type	Field and Description
protected KeycloakSession	UserFederationManager.session

Methods in org.keycloak.models that return KeycloakSession

Modifier and Type	Method and Description
KeycloakSession	KeycloakSessionFactory.create()
KeycloakSession	RoleContainerModel.RoleRemovedEvent.getKeycloakSession()
KeycloakSession	UserModel.UserRemovedEvent.getKeycloakSession()
KeycloakSession	RealmModel.RealmPostCreateEvent.getKeycloakSession()
KeycloakSession	RealmModel.RealmRemovedEvent.getKeycloakSession()
KeycloakSession	RealmModel.ClientUpdatedEvent.getKeycloakSession()
KeycloakSession	RealmModel.ClientRemovedEvent.getKeycloakSession()

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

Modifier and Type	Method and Description
UserFederationProvider	UserFederationProviderFactory.create(KeycloakSession session) This method is never called and is only an artifact of ProviderFactory.
UserFederationProvider	UserFederationProviderFactory.getInstance(KeycloakSession session, UserFederationProviderModel model) called per Keycloak transaction.
static PasswordPolicy	PasswordPolicy.parse(KeycloakSession session, String policyString)
void	KeycloakSessionTask.run(KeycloakSession session)
static void	ImpersonationConstants.setupImpersonationService(KeycloakSession session, RealmModel realm)
CredentialValidationOutput	UserFederationManager.validCredentials(KeycloakSession session, RealmModel realm, UserCredentialModel... input)
CredentialValidationOutput	UserProvider.validCredentials(KeycloakSession session, RealmModel realm, UserCredentialModel... input)
boolean	UserFederationManager.validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> input)
boolean	UserFederationManager.validCredentials(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel... input)
boolean	UserProvider.validCredentials(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel... input)

Constructors in org.keycloak.models with parameters of type KeycloakSession

Constructor and Description
UserFederationManager(KeycloakSession session)

Uses of KeycloakSession in org.keycloak.models.dblock

Constructors in org.keycloak.models.dblock with parameters of type KeycloakSession

Constructor and Description
DBLockManager(KeycloakSession session)

Uses of KeycloakSession in org.keycloak.models.session

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

Modifier and Type	Method and Description
UserSessionPersisterProvider	DisabledUserSessionPersisterProvider.create(KeycloakSession session)

Uses of KeycloakSession in org.keycloak.models.utils

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

Modifier and Type	Method and Description
static ClientModel	RepresentationToModel.createClient(KeycloakSession session, RealmModel realm, ClientRepresentation resourceRep, boolean addDefaultRoles) Does not create scope or role mappings!
static ClientTemplateModel	RepresentationToModel.createClientTemplate(KeycloakSession session, RealmModel realm, ClientTemplateRepresentation resourceRep)
static UserModel	RepresentationToModel.createUser(KeycloakSession session, RealmModel newRealm, UserRepresentation userRep)
static UserModel	KeycloakModelUtils.findUserByNameOrEmail(KeycloakSession session, RealmModel realm, String username) Try to find user by username or email
static UserFederationProviderFactory	KeycloakModelUtils.getFederationProviderFactory(KeycloakSession session, UserFederationProviderModel model)
static UserFederationProvider	KeycloakModelUtils.getFederationProviderInstance(KeycloakSession session, UserFederationProviderModel model)
static void	RepresentationToModel.importAuthorizationSettings(ClientRepresentation clientRepresentation, ClientModel client, KeycloakSession session)
static void	RepresentationToModel.importRealm(KeycloakSession session, RealmRepresentation rep, RealmModel newRealm)
static void	FederatedCredentials.updateCredential(KeycloakSession session, UserFederatedStorageProvider provider, RealmModel realm, UserModel user, UserCredentialModel cred)
static void	FederatedCredentials.updateOtpCredential(KeycloakSession session, UserFederatedStorageProvider provider, RealmModel realm, UserModel user, UserCredentialModel cred)
static void	FederatedCredentials.updatePasswordCredential(KeycloakSession session, UserFederatedStorageProvider provider, RealmModel realm, UserModel user, UserCredentialModel cred)
static void	RepresentationToModel.updateRealm(RealmRepresentation rep, RealmModel realm, KeycloakSession session)
static boolean	FederatedCredentialValidation.validateHashedCredential(KeycloakSession session, RealmModel realm, UserModel user, String unhashedCredValue, UserCredentialValueModel credential)
static boolean	CredentialValidation.validateHashedCredential(KeycloakSession session, RealmModel realm, UserModel user, String unhashedCredValue, UserCredentialValueModel credential)
static boolean	CredentialValidation.validCredential(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel credential)
static boolean	FederatedCredentialValidation.validCredential(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel credential, List<UserCredentialValueModel> fedCreds)
static boolean	CredentialValidation.validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> credentials) Must validate all credentials.
static boolean	CredentialValidation.validCredentials(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel... credentials) Must validate all credentials.
static boolean	FederatedCredentialValidation.validHOTP(KeycloakSession session, RealmModel realm, UserModel user, String otp, List<UserCredentialValueModel> fedCreds)
static boolean	CredentialValidation.validPassword(KeycloakSession session, RealmModel realm, UserModel user, String password) Will update password if hash iteration policy has changed
static boolean	FederatedCredentialValidation.validPassword(KeycloakSession session, RealmModel realm, UserModel user, String password, UserCredentialValueModel fedCred) Will update password if hash iteration policy has changed

Uses of KeycloakSession in org.keycloak.policy

Methods in org.keycloak.policy with parameters of type KeycloakSession

Modifier and Type	Method and Description
PasswordPolicyProvider	RegexPatternsPasswordPolicyProviderFactory.create(KeycloakSession session)
PasswordPolicyProvider	DigitsPasswordPolicyProviderFactory.create(KeycloakSession session)
PasswordPolicyProvider	LowerCasePasswordPolicyProviderFactory.create(KeycloakSession session)
PasswordPolicyProvider	HashAlgorithmPasswordPolicyProviderFactory.create(KeycloakSession session)
PasswordPolicyProvider	ForceExpiredPasswordPolicyProviderFactory.create(KeycloakSession session)
PasswordPolicyProvider	NotUsernamePasswordPolicyProviderFactory.create(KeycloakSession session)
PasswordPolicyProvider	UpperCasePasswordPolicyProviderFactory.create(KeycloakSession session)
PasswordPolicyProvider	HistoryPasswordPolicyProviderFactory.create(KeycloakSession session)
PasswordPolicyProvider	HashIterationsPasswordPolicyProviderFactory.create(KeycloakSession session)
PasswordPolicyProvider	SpecialCharsPasswordPolicyProviderFactory.create(KeycloakSession session)
PasswordPolicyProvider	LengthPasswordPolicyProviderFactory.create(KeycloakSession session)
PasswordPolicyManagerProvider	DefaultPasswordPolicyManagerProviderFactory.create(KeycloakSession session)

Constructors in org.keycloak.policy with parameters of type KeycloakSession

Constructor and Description
DefaultPasswordPolicyManagerProvider(KeycloakSession session)
HistoryPasswordPolicyProvider(KeycloakSession session)

Uses of KeycloakSession in org.keycloak.protocol

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

Modifier and Type	Method and Description
javax.ws.rs.core.Response	ClientInstallationProvider.generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri)
LoginProtocol	LoginProtocol.setSession(KeycloakSession session)
default void	ProtocolMapper.validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel) Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint

Uses of KeycloakSession in org.keycloak.provider

Methods in org.keycloak.provider with parameters of type KeycloakSession

Modifier and Type	Method and Description
T	ProviderFactory.create(KeycloakSession session)

Uses of KeycloakSession in org.keycloak.services.managers

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

Modifier and Type	Method and Description
boolean	BruteForceProtector.isTemporarilyDisabled(KeycloakSession session, RealmModel realm, UserModel user)
static ClientSessionCode	ClientSessionCode.parse(String code, KeycloakSession session)
static ClientSessionCode	ClientSessionCode.parse(String code, KeycloakSession session, RealmModel realm)
static ClientSessionCode.ParseResult	ClientSessionCode.parseResult(String code, KeycloakSession session, RealmModel realm)

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

Constructor and Description
UserManager(KeycloakSession session)

Uses of KeycloakSession in org.keycloak.storage

Methods in org.keycloak.storage with parameters of type KeycloakSession

Modifier and Type	Method and Description
T	UserStorageProviderFactory.create(KeycloakSession session, ComponentModel model) called per Keycloak transaction.
default void	UserStorageProviderFactory.validateConfiguration(KeycloakSession session, ComponentModel config)

Uses of KeycloakSession in org.keycloak.storage.adapter

Fields in org.keycloak.storage.adapter declared as KeycloakSession

Modifier and Type	Field and Description
protected KeycloakSession	AbstractUserAdapterFederatedStorage.session
protected KeycloakSession	AbstractUserAdapter.session

Constructors in org.keycloak.storage.adapter with parameters of type KeycloakSession

Constructor and Description
AbstractUserAdapter(KeycloakSession session, RealmModel realm, ComponentModel storageProviderModel)
AbstractUserAdapterFederatedStorage(KeycloakSession session, RealmModel realm, ComponentModel storageProviderModel)

Uses of KeycloakSession in org.keycloak.storage.user

Methods in org.keycloak.storage.user with parameters of type KeycloakSession

Modifier and Type	Method and Description
CredentialValidationOutput	UserCredentialAuthenticationProvider.validCredential(KeycloakSession session, RealmModel realm, UserCredentialModel input)
boolean	UserCredentialValidatorProvider.validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> input)

Uses of KeycloakSession in org.keycloak.timer

Methods in org.keycloak.timer with parameters of type KeycloakSession

Modifier and Type	Method and Description
void	ScheduledTask.run(KeycloakSession session)

Uses of KeycloakSession in org.keycloak.transaction

Methods in org.keycloak.transaction with parameters of type KeycloakSession

Modifier and Type	Method and Description
default JtaTransactionManagerLookup	JtaTransactionManagerLookup.create(KeycloakSession session)