Package org.keycloak.models

Interface Summary

Interface	Description
ActionTokenKeyModel
ActionTokenValueModel	This model represents contents of an action token shareable among Keycloak instances in the cluster.
AuthenticatedClientSessionModel
AuthenticationFlowBindings	Defines constants for authentication flow bindings.
ClientModel
ClientModel.ClientCreationEvent
ClientModel.ClientProtocolUpdatedEvent
ClientModel.ClientRemovedEvent
ClientModel.ClientUpdatedEvent
ClientProvider	Provider of the client records.
ClientScopeModel
ClientScopeModel.ClientScopeRemovedEvent
ClientScopeProvider	Provider of the client scopes records.
ClientSessionContext	Request-scoped context object
GroupModel
GroupModel.GroupRemovedEvent
GroupModel.Streams	The GroupModel.Streams interface makes all collection-based methods in GroupModel default by providing implementations that delegate to the Stream-based variants instead of the other way around.
GroupProvider	Provider of group records
KeycloakContext
KeycloakSession
KeycloakSessionFactory
KeycloakSessionTask	Task to be executed inside transaction
KeycloakTransaction
KeycloakTransactionManager
KeyManager
OrderedModel
OTPPolicy.OtpApp
ProtocolMapperContainerModel
RealmModel
RealmModel.IdentityProviderRemovedEvent
RealmModel.IdentityProviderUpdatedEvent
RealmModel.RealmCreationEvent
RealmModel.RealmPostCreateEvent
RealmModel.RealmRemovedEvent
RealmProvider
RoleContainerModel
RoleContainerModel.RoleRemovedEvent
RoleMapperModel
RoleMapperModel.Streams	The RoleMapperModel.Streams interface makes all collection-based methods in RoleMapperModel default by providing implementations that delegate to the Stream-based variants instead of the other way around.
RoleModel
RoleProvider	Provider of the role records.
ScopeContainerModel
ScriptModel	A representation of a Script with some additional meta-data.
ThemeManager
TokenManager
UserCredentialManager
UserCredentialManager.Streams	The UserCredentialManager.Streams interface makes all collection-based methods in UserCredentialManager default by providing implementations that delegate to the Stream-based variants instead of the other way around.
UserLoginFailureModel
UserLoginFailureProvider
UserModel
UserModel.Streams	The UserModel.Streams interface makes all collection-based methods in UserModel default by providing implementations that delegate to the Stream-based variants instead of the other way around.
UserModel.UserRemovedEvent
UserProvider
UserProvider.Streams	The UserProvider.Streams interface makes all collection-based methods in UserProvider default by providing implementations that delegate to the Stream-based variants instead of the other way around.
UserSessionModel
UserSessionProvider

Class Summary

Class	Description
AbstractConfig
AbstractKeycloakTransaction	Handles some common transaction logic related to start, rollback-only etc.
AuthenticatedClientSessionModel.SearchableFields
AuthenticationExecutionModel
AuthenticationExecutionModel.ExecutionComparator
AuthenticationFlowModel
AuthenticationFlowModel.AuthenticationFlowComparator
AuthenticatorConfigModel
AuthenticatorConfigModel.AuthenticationConfigComparator
CibaConfig
ClaimTypeModel
ClientInitialAccessModel
ClientModel.SearchableFields
ClientScopeModel.SearchableFields
CredentialValidationOutput	Output of credential validation
FederatedIdentityModel
GroupModel.SearchableFields
IdentityProviderMapperModel	Specifies a mapping from broker login to user data.
IdentityProviderModel	A model type representing the configuration for identity providers.
KeycloakUriInfo
KeyManager.ActiveAesKey
KeyManager.ActiveHmacKey
KeyManager.ActiveRsaKey
OAuth2DeviceConfig
OrderedModel.OrderedModelComparator<OM extends OrderedModel>
OTPPolicy
OTPPolicy.FreeOTP
OTPPolicy.GoogleAuthenticator
ParConfig
PasswordPolicy
PasswordPolicy.Builder
ProtocolMapperModel	Specifies a mapping from user data to a protocol claim assertion.
RealmModel.SearchableFields
RequiredActionProviderModel
RequiredActionProviderModel.RequiredActionComparator
RequiredCredentialModel
RoleModel.SearchableFields
SamlArtifactSessionMappingModel
UserConsentModel
UserCredentialModel
UserLoginFailureModel.SearchableFields
UserManager
UserModel.SearchableFields
UserModelDefaultMethods
UserModelDefaultMethods.Streams	The UserModelDefaultMethods.Streams class extends the UserModelDefaultMethods abstract class and implements the UserModel.Streams interface, allowing subclasses to focus on the implementation of the Stream-based query methods and providing default implementations for the collections-based variants that delegate to their Stream counterparts.
UserSessionModel.SearchableFields
WebAuthnPolicy

Enum Summary

Enum	Description
AbstractKeycloakTransaction.TransactionState
AuthenticationExecutionModel.Requirement
ClaimTypeModel.ValueType
CredentialValidationOutput.Status
IdentityProviderMapperSyncMode
IdentityProviderSyncMode
KeycloakTransactionManager.JTAPolicy
UserModel.RequiredAction
UserSessionModel.SessionPersistenceState	Flag used when creating user session
UserSessionModel.State

Exception Summary

Exception	Description
ModelDuplicateException
ModelException
ModelIllegalStateException	Thrown when data can't be retrieved for the model.