Uses of Interface
org.keycloak.models.RealmModel
Packages that use RealmModel
Package
Description
Fine-grained Authorization SPI.
Provides the domain model and any other type related with it
Provides classes and a SPI to plug different metadata storage implementations.
-
Uses of RealmModel in org.keycloak.authentication
Fields in org.keycloak.authentication declared as RealmModelModifier and TypeFieldDescriptionprotected RealmModel
AuthenticationProcessor.realm
protected RealmModel
RequiredActionContextResult.realm
Methods in org.keycloak.authentication that return RealmModelModifier and TypeMethodDescriptionAbstractAuthenticationFlowContext.getRealm()
Current realmAuthenticationProcessor.getRealm()
AuthenticationProcessor.Result.getRealm()
FormContext.getRealm()
Current realmRequiredActionContext.getRealm()
RequiredActionContextResult.getRealm()
Methods in org.keycloak.authentication with parameters of type RealmModelModifier and TypeMethodDescriptiondefault boolean
Authenticator.areRequiredActionsEnabled
(KeycloakSession session, RealmModel realm) Checks if all required actions are configured in the realm and are enabledstatic ClientSessionContext
AuthenticationProcessor.attachSession
(AuthenticationSessionModel authSession, UserSessionModel userSession, KeycloakSession session, RealmModel realm, ClientConnection connection, EventBuilder event) boolean
Authenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) Is this authenticator configured for this user.boolean
FormAction.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) Is this FormAction configured for the current user?default List<CredentialModel>
CredentialValidator.getCredentials
(KeycloakSession session, RealmModel realm, UserModel user) static List<AuthenticationExecutionModel>
AuthenticatorUtil.getExecutionsByType
(RealmModel realm, String flowId, String providerId) AuthenticationProcessor.setRealm
(RealmModel realm) void
Authenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticatorvoid
FormAction.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticatorConstructors in org.keycloak.authentication with parameters of type RealmModelModifierConstructorDescriptionRequiredActionContextResult
(AuthenticationSessionModel authSession, RealmModel realm, EventBuilder eventBuilder, KeycloakSession session, HttpRequest httpRequest, UserModel user, RequiredActionFactory factory) -
Uses of RealmModel in org.keycloak.authentication.actiontoken
Methods in org.keycloak.authentication.actiontoken that return RealmModelMethods in org.keycloak.authentication.actiontoken with parameters of type RealmModelModifier and TypeMethodDescriptionDefaultActionToken.serialize
(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uri) Updates the following fields and serializes this token into a signed JWT.Constructors in org.keycloak.authentication.actiontoken with parameters of type RealmModelModifierConstructorDescriptionActionTokenContext
(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection clientConnection, HttpRequest request, EventBuilder event, ActionTokenHandler<T> handler, String executionId, ActionTokenContext.ProcessAuthenticateFlow processFlow, ActionTokenContext.ProcessBrokerFlow processBrokerFlow) -
Uses of RealmModel in org.keycloak.authentication.authenticators
Methods in org.keycloak.authentication.authenticators with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
AttemptedAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
AttemptedAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.authenticators.access
Methods in org.keycloak.authentication.authenticators.access with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
AllowAccessAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
DenyAccessAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
AllowAccessAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
DenyAccessAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.authenticators.broker
Methods in org.keycloak.authentication.authenticators.broker with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
IdpAutoLinkAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdpConfirmLinkAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdpCreateUserIfUniqueAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdpDetectExistingBrokerUserAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdpEmailVerificationAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdpReviewProfileAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) static UserModel
AbstractIdpAuthenticator.getExistingUser
(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession) void
AbstractIdpAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.authenticators.browser
Methods in org.keycloak.authentication.authenticators.browser with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
CookieAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdentityProviderAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
OTPFormAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
PasswordForm.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
RecoveryAuthnCodesFormAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ScriptBasedAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
SpnegoAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
UsernamePasswordForm.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
WebAuthnAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
ConditionalOtpFormAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
CookieAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
IdentityProviderAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
OTPFormAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
RecoveryAuthnCodesFormAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ScriptBasedAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
SpnegoAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
UsernamePasswordForm.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
WebAuthnAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
WebAuthnPasswordlessAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.authenticators.client
Methods in org.keycloak.authentication.authenticators.client that return RealmModel -
Uses of RealmModel in org.keycloak.authentication.authenticators.conditional
Methods in org.keycloak.authentication.authenticators.conditional with parameters of type RealmModelModifier and TypeMethodDescriptiondefault boolean
ConditionalAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
ConditionalLoaAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ConditionalRoleAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ConditionalUserAttributeValue.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ConditionalUserConfiguredAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.authenticators.directgrant
Methods in org.keycloak.authentication.authenticators.directgrant with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
ValidateOTP.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ValidatePassword.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ValidateUsername.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
ValidateOTP.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ValidatePassword.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ValidateUsername.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.authenticators.resetcred
Methods in org.keycloak.authentication.authenticators.resetcred with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
AbstractSetRequiredActionAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ResetCredentialChooseUser.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ResetCredentialEmail.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ResetOTP.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) static Long
ResetCredentialEmail.getLastChangedTimestamp
(KeycloakSession session, RealmModel realm, UserModel user) void
AbstractSetRequiredActionAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ResetCredentialChooseUser.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ResetCredentialEmail.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.authenticators.sessionlimits
Methods in org.keycloak.authentication.authenticators.sessionlimits with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
UserSessionLimitsAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
UserSessionLimitsAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.authenticators.util
Methods in org.keycloak.authentication.authenticators.util with parameters of type RealmModelModifier and TypeMethodDescriptionstatic String
AuthenticatorUtils.getDisabledByBruteForceEventError
(BruteForceProtector protector, KeycloakSession session, RealmModel realm, UserModel user) LoAUtil.getLoAConfiguredInRealmBrowserFlow
(RealmModel realm) LoAUtil.getLoaMaxAgesConfiguredInRealmBrowserFlow
(RealmModel realm) -
Uses of RealmModel in org.keycloak.authentication.authenticators.x509
Methods in org.keycloak.authentication.authenticators.x509 with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
AbstractX509ClientCertificateAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
AbstractX509ClientCertificateAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.forms
Methods in org.keycloak.authentication.forms with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
RegistrationPassword.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
RegistrationRecaptcha.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
RegistrationTermsAndConditions.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
RegistrationUserCreation.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
RegistrationPassword.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
RegistrationRecaptcha.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
RegistrationTermsAndConditions.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
RegistrationUserCreation.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.requiredactions.util
Constructors in org.keycloak.authentication.requiredactions.util with parameters of type RealmModel -
Uses of RealmModel in org.keycloak.authorization
Methods in org.keycloak.authorization that return RealmModelMethods in org.keycloak.authorization with parameters of type RealmModelModifier and TypeMethodDescriptionAuthorizationProviderFactory.create
(KeycloakSession session, RealmModel realm) DefaultAuthorizationProviderFactory.create
(KeycloakSession session, RealmModel realm) Constructors in org.keycloak.authorization with parameters of type RealmModelModifierConstructorDescriptionAuthorizationProvider
(KeycloakSession session, RealmModel realm, PolicyEvaluator policyEvaluator) -
Uses of RealmModel in org.keycloak.authorization.common
Fields in org.keycloak.authorization.common declared as RealmModelModifier and TypeFieldDescriptionprotected RealmModel
ClientModelIdentity.realm
protected final RealmModel
KeycloakIdentity.realm
protected RealmModel
UserModelIdentity.realm
Constructors in org.keycloak.authorization.common with parameters of type RealmModelModifierConstructorDescriptionKeycloakIdentity
(IDToken token, KeycloakSession keycloakSession, RealmModel realm) UserModelIdentity
(RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authorization.jpa.store
Fields in org.keycloak.authorization.jpa.store declared as RealmModelModifier and TypeFieldDescriptionstatic final RealmModel
JPAAuthorizationStoreFactory.NULL_REALM
Legacy store doesn't store realm id for any entity and no method there is using new introduced RealmModel parameter.Methods in org.keycloak.authorization.jpa.store that return RealmModelMethods in org.keycloak.authorization.jpa.store with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
JPAPermissionTicketStore.delete
(RealmModel realm, String id) void
JPAPolicyStore.delete
(RealmModel realm, String id) void
JPAResourceStore.delete
(RealmModel realm, String id) void
JPAScopeStore.delete
(RealmModel realm, String id) JPAPermissionTicketStore.find
(RealmModel realm, ResourceServer resourceServer, Map<PermissionTicket.FilterOption, String> attributes, Integer firstResult, Integer maxResult) JPAPolicyStore.find
(RealmModel realm, ResourceServer resourceServer, Map<Policy.FilterOption, String[]> attributes, Integer firstResult, Integer maxResults) JPAResourceStore.find
(RealmModel realm, ResourceServer resourceServer, Map<Resource.FilterOption, String[]> attributes, Integer firstResult, Integer maxResults) JPAPermissionTicketStore.findById
(RealmModel realm, ResourceServer resourceServer, String id) JPAPolicyStore.findById
(RealmModel realm, ResourceServer resourceServer, String id) JPAResourceServerStore.findById
(RealmModel realm, String id) JPAResourceStore.findById
(RealmModel realm, ResourceServer resourceServer, String id) JPAScopeStore.findById
(RealmModel realm, ResourceServer resourceServer, String id) void
JPAResourceStore.findByOwner
(RealmModel realm, ResourceServer resourceServer, String ownerId, Consumer<Resource> consumer) JPAPermissionTicketStore.findGrantedOwnerResources
(RealmModel realm, String owner, Integer firstResult, Integer maxResults) JPAPermissionTicketStore.findGrantedResources
(RealmModel realm, String requester, String name, Integer first, Integer max) Constructors in org.keycloak.authorization.jpa.store with parameters of type RealmModelModifierConstructorDescriptionResourceServerAdapter
(RealmModel realm, ResourceServerEntity entity, jakarta.persistence.EntityManager em, StoreFactory storeFactory) -
Uses of RealmModel in org.keycloak.authorization.model
Methods in org.keycloak.authorization.model that return RealmModelModifier and TypeMethodDescriptionResourceServer.getRealm()
Returns reference of a realm that thisResourceServer
belongs to. -
Uses of RealmModel in org.keycloak.authorization.policy.provider.js
Methods in org.keycloak.authorization.policy.provider.js with parameters of type RealmModelModifier and TypeMethodDescriptionprotected ScriptModel
DeployedScriptPolicyFactory.getScriptModel
(Policy policy, RealmModel realm, ScriptingProvider scripting) protected ScriptModel
JSPolicyProviderFactory.getScriptModel
(Policy policy, RealmModel realm, ScriptingProvider scripting) -
Uses of RealmModel in org.keycloak.authorization.store
Methods in org.keycloak.authorization.store with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
PermissionTicketStore.delete
(RealmModel realm, String id) Deletes a permission from the underlying persistence mechanism.void
PolicyStore.delete
(RealmModel realm, String id) Deletes a policy from the underlying persistence mechanism.void
ResourceStore.delete
(RealmModel realm, String id) Removes aResource
instance, with the givenid
from the persistent storage.void
ScopeStore.delete
(RealmModel realm, String id) Deletes a scope from the underlying persistence mechanism.PermissionTicketStore.find
(RealmModel realm, ResourceServer resourceServer, Map<PermissionTicket.FilterOption, String> attributes, Integer firstResult, Integer maxResults) Returns a list ofPermissionTicket
, filtered by the given attributes.PolicyStore.find
(RealmModel realm, ResourceServer resourceServer, Map<Policy.FilterOption, String[]> attributes, Integer firstResult, Integer maxResults) ResourceStore.find
(RealmModel realm, ResourceServer resourceServer, Map<Resource.FilterOption, String[]> attributes, Integer firstResult, Integer maxResults) Finds allResource
instances associated with a given resource server.PermissionTicketStore.findById
(RealmModel realm, ResourceServer resourceServer, String id) Returns aPermissionTicket
with the givenid
PolicyStore.findById
(RealmModel realm, ResourceServer resourceServer, String id) Returns aPolicy
with the givenid
ResourceServerStore.findById
(RealmModel realm, String id) Returns aResourceServer
instance based on its identifier.ResourceStore.findById
(RealmModel realm, ResourceServer resourceServer, String id) Returns aResource
instance based on its identifier.ScopeStore.findById
(RealmModel realm, ResourceServer resourceServer, String id) Returns aScope
with the givenid
ResourceStore.findByOwner
(RealmModel realm, ResourceServer resourceServer, String ownerId) Finds allResource
instances with the givenownerId
.void
ResourceStore.findByOwner
(RealmModel realm, ResourceServer resourceServer, String ownerId, Consumer<Resource> consumer) PermissionTicketStore.findGrantedOwnerResources
(RealmModel realm, String owner, Integer firstResult, Integer maxResults) Returns a list ofResource
granted by the owner to other usersPermissionTicketStore.findGrantedResources
(RealmModel realm, String requester, String name, Integer firstResult, Integer maxResults) Returns a list ofResource
granted to the givenrequester
-
Uses of RealmModel in org.keycloak.broker.oidc
Fields in org.keycloak.broker.oidc declared as RealmModelModifier and TypeFieldDescriptionprotected final RealmModel
AbstractOAuth2IdentityProvider.Endpoint.realm
Methods in org.keycloak.broker.oidc with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
OIDCIdentityProvider.backchannelLogout
(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) AbstractOAuth2IdentityProvider.callback
(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event) KeycloakOIDCIdentityProvider.callback
(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event) OIDCIdentityProvider.callback
(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event) jakarta.ws.rs.core.Response
OIDCIdentityProvider.keycloakInitiatedBrowserLogout
(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) void
OIDCIdentityProvider.preprocessFederatedIdentity
(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context) void
OAuth2IdentityProviderConfig.validate
(RealmModel realm) void
OIDCIdentityProviderConfig.validate
(RealmModel realm) Constructors in org.keycloak.broker.oidc with parameters of type RealmModelModifierConstructorDescriptionEndpoint
(IdentityProvider.AuthenticationCallback callback, RealmModel realm, EventBuilder event, AbstractOAuth2IdentityProvider provider) KeycloakEndpoint
(IdentityProvider.AuthenticationCallback callback, RealmModel realm, EventBuilder event, KeycloakOIDCIdentityProvider provider) OIDCEndpoint
(IdentityProvider.AuthenticationCallback callback, RealmModel realm, EventBuilder event, OIDCIdentityProvider provider) -
Uses of RealmModel in org.keycloak.broker.oidc.mappers
Methods in org.keycloak.broker.oidc.mappers with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
AbstractClaimToGroupMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractClaimToRoleMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
ClaimToUserSessionNoteMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractJsonUserAttributeMapper.preprocessFederatedIdentity
(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UserAttributeMapper.preprocessFederatedIdentity
(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UsernameTemplateMapper.preprocessFederatedIdentity
(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractClaimToGroupMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractClaimToRoleMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractJsonUserAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
ClaimToUserSessionNoteMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UserAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UsernameTemplateMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractClaimToRoleMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractJsonUserAttributeMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
ExternalKeycloakRoleToRoleMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UsernameTemplateMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) -
Uses of RealmModel in org.keycloak.broker.provider
Methods in org.keycloak.broker.provider that return RealmModelMethods in org.keycloak.broker.provider with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
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) AbstractIdentityProvider.callback
(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event) IdentityProvider.callback
(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event) JAXRS callback endpoint for when the remote IDP wants to callback to keycloak.static void
IdentityProviderMapperSyncModeDelegate.delegateUpdateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context, IdentityProviderMapper mapper) jakarta.ws.rs.core.Response
AbstractIdentityProvider.export
(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format) jakarta.ws.rs.core.Response
IdentityProvider.export
(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format) Export a representation of the IdentityProvider in a specific format.void
AbstractIdentityProvider.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) void
AbstractIdentityProviderMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedRoleMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedUserSessionAttributeMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, 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.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.void
AbstractIdentityProvider.preprocessFederatedIdentity
(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context) void
AbstractIdentityProviderMapper.preprocessFederatedIdentity
(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedAttributeMapper.preprocessFederatedIdentity
(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedUserSessionAttributeMapper.preprocessFederatedIdentity
(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, 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
AbstractIdentityProvider.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) void
AbstractIdentityProviderMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedRoleMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedUserSessionAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, 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.void
AbstractIdentityProviderMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedRoleMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
IdentityProviderMapper.updateBrokeredUserLegacy
(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 RealmModelModifierConstructorDescriptionAuthenticationRequest
(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession, HttpRequest httpRequest, jakarta.ws.rs.core.UriInfo uriInfo, IdentityBrokerState state, String redirectUri) -
Uses of RealmModel in org.keycloak.broker.provider.mappersync
Methods in org.keycloak.broker.provider.mappersync that return RealmModelModifier and TypeMethodDescriptionConfigSynchronizer.extractRealm
(T event) GroupConfigPropertyByPathSynchronizer.extractRealm
(GroupModel.GroupPathChangeEvent event) RoleConfigPropertyByClientIdSynchronizer.extractRealm
(ClientModel.ClientIdChangeEvent event) RoleConfigPropertyByRoleNameSynchronizer.extractRealm
(RoleModel.RoleNameChangeEvent event) -
Uses of RealmModel in org.keycloak.broker.provider.util
Methods in org.keycloak.broker.provider.util with parameters of type RealmModelModifier and TypeMethodDescriptionstatic IdentityBrokerState
IdentityBrokerState.encoded
(String encodedState, RealmModel realmModel) -
Uses of RealmModel in org.keycloak.broker.saml
Fields in org.keycloak.broker.saml declared as RealmModelMethods in org.keycloak.broker.saml with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
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) SAMLIdentityProvider.callback
(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event) jakarta.ws.rs.core.Response
SAMLIdentityProvider.export
(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format) jakarta.ws.rs.core.Response
SAMLIdentityProvider.keycloakInitiatedBrowserLogout
(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) void
SAMLIdentityProviderConfig.validate
(RealmModel realm) -
Uses of RealmModel in org.keycloak.broker.saml.mappers
Methods in org.keycloak.broker.saml.mappers with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
AbstractAttributeToGroupMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractAttributeToRoleMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UserAttributeMapper.preprocessFederatedIdentity
(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UsernameTemplateMapper.preprocessFederatedIdentity
(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
XPathAttributeMapper.preprocessFederatedIdentity
(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractAttributeToGroupMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractAttributeToRoleMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UserAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UsernameTemplateMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
XPathAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UsernameTemplateMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) -
Uses of RealmModel in org.keycloak.component
Methods in org.keycloak.component with parameters of type RealmModelModifier and TypeMethodDescriptiondefault List<ProviderConfigProperty>
SubComponentFactory.getConfigProperties
(RealmModel realm, ComponentModel parent) SubComponentFactory.getTypeMetadata
(RealmModel realm, ComponentModel parent) This is metadata about this component type.default void
ComponentFactory.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) Called after a component is createddefault void
AmphibianProviderFactory.onUpdate
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) default void
ComponentFactory.onUpdate
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) Called after the component is updated.default void
AmphibianProviderFactory.preRemove
(KeycloakSession session, RealmModel realm, ComponentModel model) default void
ComponentFactory.preRemove
(KeycloakSession session, RealmModel realm, ComponentModel model) Called before the component is removed.default void
ComponentFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel model) Called before a component is created or updated. -
Uses of RealmModel in org.keycloak.credential
Methods in org.keycloak.credential with parameters of type RealmModelModifier and TypeMethodDescriptionCredentialAuthentication.authenticate
(RealmModel realm, CredentialInput input) CredentialProvider.createCredential
(RealmModel realm, UserModel user, T credentialModel) OTPCredentialProvider.createCredential
(RealmModel realm, UserModel user, OTPCredentialModel credentialModel) boolean
PasswordCredentialProvider.createCredential
(RealmModel realm, UserModel user, String password) PasswordCredentialProvider.createCredential
(RealmModel realm, UserModel user, PasswordCredentialModel credentialModel) RecoveryAuthnCodesCredentialProvider.createCredential
(RealmModel realm, UserModel user, RecoveryAuthnCodesCredentialModel credentialModel) UserCredentialStore.createCredential
(RealmModel realm, UserModel user, CredentialModel cred) WebAuthnCredentialProvider.createCredential
(RealmModel realm, UserModel user, WebAuthnCredentialModel credentialModel) boolean
CredentialProvider.deleteCredential
(RealmModel realm, UserModel user, String credentialId) boolean
OTPCredentialProvider.deleteCredential
(RealmModel realm, UserModel user, String credentialId) boolean
PasswordCredentialProvider.deleteCredential
(RealmModel realm, UserModel user, String credentialId) boolean
RecoveryAuthnCodesCredentialProvider.deleteCredential
(RealmModel realm, UserModel user, String credentialId) boolean
WebAuthnCredentialProvider.deleteCredential
(RealmModel realm, UserModel user, String credentialId) void
CredentialInputUpdater.disableCredentialType
(RealmModel realm, UserModel user, String credentialType) void
PasswordCredentialProvider.disableCredentialType
(RealmModel realm, UserModel user, String credentialType) default T
CredentialProvider.getDefaultCredential
(KeycloakSession session, RealmModel realm, UserModel user) CredentialInputUpdater.getDisableableCredentialTypesStream
(RealmModel realm, UserModel user) Obtains the set of credential types that can be disabled viadisableCredentialType
.PasswordCredentialProvider.getDisableableCredentialTypesStream
(RealmModel realm, UserModel user) PasswordCredentialProvider.getPassword
(RealmModel realm, UserModel user) UserCredentialStore.getStoredCredentialById
(RealmModel realm, UserModel user, String id) UserCredentialStore.getStoredCredentialByNameAndType
(RealmModel realm, UserModel user, String name, String type) UserCredentialStore.getStoredCredentialsByTypeStream
(RealmModel realm, UserModel user, String type) Obtains the stored credentials associated with the specified user that match the specified type.UserCredentialStore.getStoredCredentialsStream
(RealmModel realm, UserModel user) Obtains the stored credentials associated with the specified user.boolean
CredentialInputValidator.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
OTPCredentialProvider.isConfiguredFor
(RealmModel realm, UserModel user) boolean
OTPCredentialProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
PasswordCredentialProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
RecoveryAuthnCodesCredentialProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
WebAuthnCredentialProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
CredentialInputValidator.isValid
(RealmModel realm, UserModel user, CredentialInput credentialInput) Tests whether a credential is validboolean
OTPCredentialProvider.isValid
(RealmModel realm, UserModel user, CredentialInput credentialInput) boolean
PasswordCredentialProvider.isValid
(RealmModel realm, UserModel user, CredentialInput input) boolean
RecoveryAuthnCodesCredentialProvider.isValid
(RealmModel realm, UserModel user, CredentialInput credentialInput) boolean
WebAuthnCredentialProvider.isValid
(RealmModel realm, UserModel user, CredentialInput input) boolean
UserCredentialStore.moveCredentialTo
(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) boolean
UserCredentialStore.removeStoredCredential
(RealmModel realm, UserModel user, String id) Removes credential with theid
for theuser
.boolean
CredentialInputUpdater.updateCredential
(RealmModel realm, UserModel user, CredentialInput input) boolean
PasswordCredentialProvider.updateCredential
(RealmModel realm, UserModel user, CredentialInput input) void
UserCredentialStore.updateCredential
(RealmModel realm, UserModel user, CredentialModel cred) Constructors in org.keycloak.credential with parameters of type RealmModelModifierConstructorDescriptionLegacyUserCredentialManager
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.deployment
Methods in org.keycloak.deployment with parameters of type RealmModelModifier and TypeMethodDescriptionDeployedConfigurationsManager.getAuthenticatorConfig
(RealmModel realm, String configId) DeployedConfigurationsManager.getAuthenticatorConfigByAlias
(RealmModel realm, String alias) -
Uses of RealmModel in org.keycloak.email
Methods in org.keycloak.email with parameters of type RealmModel -
Uses of RealmModel in org.keycloak.email.freemarker
Fields in org.keycloak.email.freemarker declared as RealmModelMethods in org.keycloak.email.freemarker with parameters of type RealmModel -
Uses of RealmModel in org.keycloak.events
Methods in org.keycloak.events with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
EventStoreProvider.clear
(RealmModel realm) Removes all auth events for the realm from this store provider.void
EventStoreProvider.clear
(RealmModel realm, long olderThan) Removes all auth events for the realm that are older thanolderThan
from this store provider.void
EventStoreProvider.clearAdmin
(RealmModel realm) Removes all auth events for the realm from this store provider.void
EventStoreProvider.clearAdmin
(RealmModel realm, long olderThan) Removes all auth events for the realm that are older thanolderThan
from this store provider.EventBuilder.realm
(RealmModel realm) Constructors in org.keycloak.events with parameters of type RealmModelModifierConstructorDescriptionEventBuilder
(RealmModel realm, KeycloakSession session) EventBuilder
(RealmModel realm, KeycloakSession session, ClientConnection clientConnection) -
Uses of RealmModel in org.keycloak.events.jpa
Methods in org.keycloak.events.jpa with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
JpaEventStoreProvider.clear
(RealmModel realm) void
JpaEventStoreProvider.clear
(RealmModel realm, long olderThan) void
JpaEventStoreProvider.clearAdmin
(RealmModel realm) void
JpaEventStoreProvider.clearAdmin
(RealmModel realm, long olderThan) -
Uses of RealmModel in org.keycloak.exportimport.dir
Methods in org.keycloak.exportimport.dir with parameters of type RealmModelModifier and TypeMethodDescriptionprotected void
DirExportProvider.writeFederatedUsers
(String fileName, KeycloakSession session, RealmModel realm, List<String> users) protected void
DirExportProvider.writeUsers
(String fileName, KeycloakSession session, RealmModel realm, List<UserModel> users) -
Uses of RealmModel in org.keycloak.exportimport.util
Methods in org.keycloak.exportimport.util with parameters of type RealmModelModifier and TypeMethodDescriptionExportUtils.exportComponents
(RealmModel realm, String parentId) static UserRepresentation
ExportUtils.exportFederatedUser
(KeycloakSession session, RealmModel realm, String id, ExportOptions options) Full export of user data stored in federated storage (including role mappings and credentials)static void
ExportUtils.exportFederatedUsersToStream
(KeycloakSession session, RealmModel realm, List<String> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os) static void
ExportUtils.exportFederatedUsersToStream
(KeycloakSession session, RealmModel realm, List<String> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os, ExportOptions options) static RealmRepresentation
ExportUtils.exportRealm
(KeycloakSession session, RealmModel realm, boolean includeUsers, boolean internal) static RealmRepresentation
ExportUtils.exportRealm
(KeycloakSession session, RealmModel realm, ExportOptions options, boolean internal) static UserRepresentation
ExportUtils.exportUser
(KeycloakSession session, RealmModel realm, UserModel user, ExportOptions options, boolean internal) Full export of user (including role mappings and credentials)static void
ExportUtils.exportUsersToStream
(KeycloakSession session, RealmModel realm, List<UserModel> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os) static void
ExportUtils.exportUsersToStream
(KeycloakSession session, RealmModel realm, List<UserModel> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os, ExportOptions options) protected abstract void
MultipleStepsExportProvider.writeFederatedUsers
(String fileName, KeycloakSession session, RealmModel realm, List<String> users) protected abstract void
MultipleStepsExportProvider.writeUsers
(String fileName, KeycloakSession session, RealmModel realm, List<UserModel> users) -
Uses of RealmModel in org.keycloak.federation.kerberos
Methods in org.keycloak.federation.kerberos with parameters of type RealmModelModifier and TypeMethodDescriptionKerberosFederationProvider.authenticate
(RealmModel realm, CredentialInput input) void
KerberosFederationProvider.disableCredentialType
(RealmModel realm, UserModel user, String credentialType) protected UserModel
KerberosFederationProvider.findOrCreateAuthenticatedUser
(RealmModel realm, KerberosPrincipal kerberosPrincipal) Called after successful authenticationKerberosFederationProvider.getDisableableCredentialTypesStream
(RealmModel realm, UserModel user) KerberosFederationProvider.getUserByEmail
(RealmModel realm, String email) KerberosFederationProvider.getUserById
(RealmModel realm, String id) KerberosFederationProvider.getUserByUsername
(RealmModel realm, String username) protected UserModel
KerberosFederationProvider.importUserToKeycloak
(RealmModel realm, KerberosPrincipal kerberosPrincipal) boolean
KerberosFederationProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
KerberosFederationProvider.isValid
(RealmModel realm, UserModel user, CredentialInput input) void
KerberosFederationProviderFactory.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) void
KerberosFederationProviderFactory.onUpdate
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) void
KerberosFederationProvider.preRemove
(RealmModel realm) void
KerberosFederationProvider.preRemove
(RealmModel realm, GroupModel group) void
KerberosFederationProvider.preRemove
(RealmModel realm, RoleModel role) void
KerberosFederationProviderFactory.preRemove
(KeycloakSession session, RealmModel realm, ComponentModel model) boolean
KerberosFederationProvider.updateCredential
(RealmModel realm, UserModel user, CredentialInput input) KerberosFederationProvider.validate
(RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.federation.sssd
Methods in org.keycloak.federation.sssd with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
SSSDFederationProvider.disableCredentialType
(RealmModel realm, UserModel user, String credentialType) protected UserModel
SSSDFederationProvider.findOrCreateAuthenticatedUser
(RealmModel realm, String username) Called after successful authenticationSSSDFederationProvider.getDisableableCredentialTypesStream
(RealmModel realm, UserModel user) SSSDFederationProvider.getUserByEmail
(RealmModel realm, String email) SSSDFederationProvider.getUserById
(RealmModel realm, String id) SSSDFederationProvider.getUserByUsername
(RealmModel realm, String username) protected UserModel
SSSDFederationProvider.importUserToKeycloak
(RealmModel realm, String username) boolean
SSSDFederationProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
SSSDFederationProvider.isValid
(RealmModel realm, UserModel local) boolean
SSSDFederationProvider.isValid
(RealmModel realm, UserModel user, CredentialInput input) void
SSSDFederationProvider.preRemove
(RealmModel realm) void
SSSDFederationProvider.preRemove
(RealmModel realm, GroupModel group) void
SSSDFederationProvider.preRemove
(RealmModel realm, RoleModel role) boolean
SSSDFederationProvider.updateCredential
(RealmModel realm, UserModel user, CredentialInput input) SSSDFederationProvider.validate
(RealmModel realm, UserModel user) SSSDFederationProvider.validateAndProxy
(RealmModel realm, UserModel local) -
Uses of RealmModel in org.keycloak.forms.login.freemarker
Fields in org.keycloak.forms.login.freemarker declared as RealmModelMethods in org.keycloak.forms.login.freemarker with parameters of type RealmModelModifier and TypeMethodDescriptionstatic void
AuthenticationStateCookie.expireCookie
(RealmModel realm, KeycloakSession session) static void
AuthenticationStateCookie.generateAndSetCookie
(KeycloakSession session, RealmModel realm, RootAuthenticationSessionModel rootAuthSession, int cookieMaxAge) Constructors in org.keycloak.forms.login.freemarker with parameters of type RealmModelModifierConstructorDescriptionAuthenticatorConfiguredMethod
(RealmModel realm, UserModel user, KeycloakSession session) DetachedInfoStateChecker
(KeycloakSession session, RealmModel realm) -
Uses of RealmModel in org.keycloak.forms.login.freemarker.model
Constructors in org.keycloak.forms.login.freemarker.model with parameters of type RealmModelModifierConstructorDescriptionIdentityProviderBean
(RealmModel realm, KeycloakSession session, List<IdentityProviderModel> identityProviders, URI baseURI) RealmBean
(RealmModel realmModel) RecoveryAuthnCodeInputLoginBean
(KeycloakSession session, RealmModel realm, UserModel user) RequiredActionUrlFormatterMethod
(RealmModel realm, URI baseUri) TotpBean
(KeycloakSession session, RealmModel realm, UserModel user, jakarta.ws.rs.core.UriBuilder uriBuilder) TotpLoginBean
(KeycloakSession session, RealmModel realm, UserModel user, String selectedCredentialId) UrlBean
(RealmModel realm, Theme theme, URI baseURI, URI actionUri) WebAuthnAuthenticatorsBean
(KeycloakSession session, RealmModel realm, UserModel user, String credentialType) -
Uses of RealmModel in org.keycloak.keys
Methods in org.keycloak.keys with parameters of type RealmModelModifier and TypeMethodDescriptionDefaultKeyManager.getActiveAesKey
(RealmModel realm) Deprecated.DefaultKeyManager.getActiveHmacKey
(RealmModel realm) Deprecated.DefaultKeyManager.getActiveKey
(RealmModel realm, KeyUse use, String algorithm) DefaultKeyManager.getActiveRsaKey
(RealmModel realm) Deprecated.DefaultKeyManager.getAesKeys
(RealmModel realm) DefaultKeyManager.getAesSecretKey
(RealmModel realm, String kid) Deprecated.DefaultKeyManager.getHmacKeys
(RealmModel realm) DefaultKeyManager.getHmacSecretKey
(RealmModel realm, String kid) Deprecated.DefaultKeyManager.getKey
(RealmModel realm, String kid, KeyUse use, String algorithm) DefaultKeyManager.getKeysStream
(RealmModel realm) DefaultKeyManager.getKeysStream
(RealmModel realm, KeyUse use, String algorithm) DefaultKeyManager.getRsaCertificate
(RealmModel realm, String kid) Deprecated.DefaultKeyManager.getRsaKeys
(RealmModel realm) Deprecated.DefaultKeyManager.getRsaPublicKey
(RealmModel realm, String kid) Deprecated.protected abstract KeyWrapper
AbstractEcdsaKeyProvider.loadKey
(RealmModel realm, ComponentModel model) protected abstract KeyWrapper
AbstractRsaKeyProvider.loadKey
(RealmModel realm, ComponentModel model) protected KeyWrapper
GeneratedEcdsaKeyProvider.loadKey
(RealmModel realm, ComponentModel model) ImportedRsaKeyProvider.loadKey
(RealmModel realm, ComponentModel model) protected KeyWrapper
JavaKeystoreKeyProvider.loadKey
(RealmModel realm, ComponentModel model) void
AbstractEcdsaKeyProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel model) void
AbstractGeneratedRsaKeyProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel model) void
AbstractGeneratedSecretKeyProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel model) void
AbstractImportedRsaKeyProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel model) void
AbstractRsaKeyProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel model) void
GeneratedEcdsaKeyProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel model) void
JavaKeystoreKeyProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel model) Constructors in org.keycloak.keys with parameters of type RealmModelModifierConstructorDescriptionAbstractEcdsaKeyProvider
(RealmModel realm, ComponentModel model) AbstractRsaKeyProvider
(RealmModel realm, ComponentModel model) GeneratedEcdsaKeyProvider
(RealmModel realm, ComponentModel model) ImportedRsaKeyProvider
(RealmModel realm, ComponentModel model) JavaKeystoreKeyProvider
(RealmModel realm, ComponentModel model) -
Uses of RealmModel in org.keycloak.keys.loader
Methods in org.keycloak.keys.loader with parameters of type RealmModelModifier and TypeMethodDescriptionstatic KeyWrapper
PublicKeyStorageManager.getIdentityProviderKeyWrapper
(KeycloakSession session, RealmModel realm, OIDCIdentityProviderConfig idpConfig, JWSInput input) -
Uses of RealmModel in org.keycloak.locale
Methods in org.keycloak.locale with parameters of type RealmModelModifier and TypeMethodDescriptionDefaultLocaleSelectorProvider.resolveLocale
(RealmModel realm, UserModel user) LocaleSelectorProvider.resolveLocale
(RealmModel realm, UserModel user) Resolve the locale which should be used for the request -
Uses of RealmModel in org.keycloak.migration
Methods in org.keycloak.migration with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
MigrationProvider.addOIDCAcrClientScope
(RealmModel realm) Add 'acr' client scope or return it if already existsMigrationProvider.addOIDCMicroprofileJWTClientScope
(RealmModel realm) Adds themicroprofile-jwt
optional client scope to the realm and returns the created scope.MigrationProvider.addOIDCRolesClientScope
(RealmModel realm) Add 'roles' client scope or return it if already existsMigrationProvider.addOIDCWebOriginsClientScope
(RealmModel realm) Add 'web-origins' client scope or return it if already existsstatic void
MigrationModelManager.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrationProvider.setupAdminCli
(RealmModel realm) -
Uses of RealmModel in org.keycloak.migration.migrators
Methods in org.keycloak.migration.migrators with parameters of type RealmModelModifier and TypeMethodDescriptionprotected void
MigrateTo9_0_0.addAccountConsoleClient
(RealmModel realm) static void
MigrationUtils.addAdminRole
(RealmModel realm, String roleName) protected void
MigrateTo9_0_4.checkAuthConfigNullAlias
(RealmModel realm) static ComponentModel
MigrateTo1_8_0.getMapperByName
(RealmModel realm, ComponentModel providerModel, String name) protected void
MigrateTo8_0_2.migrateAuthenticationFlowsWithAlternativeRequirements
(RealmModel realm) void
MigrateTo1_2_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo1_3_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo1_4_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo1_5_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo1_6_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo1_7_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo1_8_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo1_9_2.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo18_0_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo2_0_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo2_1_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo2_2_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo2_3_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo2_5_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo20_0_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo21_0_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo22_0_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo23_0_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo3_0_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo3_1_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo3_2_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo3_4_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo3_4_1.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo3_4_2.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo4_0_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo4_2_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo4_6_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo6_0_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo8_0_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo8_0_2.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo9_0_0.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
MigrateTo9_0_4.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) default void
Migration.migrateImport
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) Called after full import of representation.static void
MigrationUtils.migrateOldOfflineToken
(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user) static void
MigrateTo8_0_0.migrateOptionalAuthenticationExecution
(RealmModel realm, AuthenticationFlowModel parentFlow, AuthenticationExecutionModel optionalExecution, boolean updateOptionalExecution) protected void
MigrateTo1_4_0.migrateRealm
(KeycloakSession session, RealmModel realm) protected void
MigrateTo1_5_0.migrateRealm
(KeycloakSession session, RealmModel realm) protected void
MigrateTo1_6_0.migrateRealm
(KeycloakSession session, ProtocolMapperModel localeMapper, RealmModel realm) protected void
MigrateTo1_7_0.migrateRealm
(KeycloakSession session, RealmModel realm) protected void
MigrateTo1_8_0.migrateRealm
(RealmModel realm) protected void
MigrateTo1_9_2.migrateRealm
(RealmModel realm) protected void
MigrateTo18_0_0.migrateRealm
(KeycloakSession session, RealmModel realm) protected void
MigrateTo2_3_0.migrateRealm
(RealmModel realm) protected void
MigrateTo3_0_0.migrateRealm
(RealmModel realm) protected void
MigrateTo3_1_0.migrateRealm
(RealmModel realm) protected void
MigrateTo3_2_0.migrateRealm
(KeycloakSession session, RealmModel realm) protected void
MigrateTo3_4_0.migrateRealm
(RealmModel r) protected void
MigrateTo3_4_1.migrateRealm
(RealmModel r) protected void
MigrateTo3_4_2.migrateRealm
(RealmModel realm) protected void
MigrateTo4_0_0.migrateRealm
(KeycloakSession session, RealmModel realm, boolean json) protected void
MigrateTo4_2_0.migrateRealm
(RealmModel realm) protected void
MigrateTo4_6_0.migrateRealm
(KeycloakSession session, RealmModel realm, boolean json) protected void
MigrateTo6_0_0.migrateRealm
(KeycloakSession session, RealmModel realm, boolean jsn) protected void
MigrateTo8_0_0.migrateRealmCommon
(RealmModel realm) protected void
MigrateTo9_0_0.migrateRealmCommon
(RealmModel realm) protected void
MigrateTo8_0_0.migrateRealmMFA
(RealmModel realm) void
MigrateTo1_2_0.setupBrokerService
(RealmModel realm) -
Uses of RealmModel in org.keycloak.models
Subinterfaces of RealmModel in org.keycloak.modelsFields in org.keycloak.models with type parameters of type RealmModelModifier and TypeFieldDescriptionstatic final Comparator<RealmModel>
RealmModel.COMPARE_BY_NAME
protected Supplier<RealmModel>
AbstractConfig.realm
protected Supplier<RealmModel>
AbstractConfig.realmForWrite
Methods in org.keycloak.models that return RealmModelModifier and TypeMethodDescriptionRealmProvider.createRealm
(String name) Creates new realm with the given name.RealmProvider.createRealm
(String id, String name) Created new realm with given ID and name.RealmModel.RealmCreationEvent.getCreatedRealm()
RealmModel.RealmPostCreateEvent.getCreatedRealm()
ClientModel.getRealm()
ClientScopeModel.getRealm()
GroupModel.GroupPathChangeEvent.getRealm()
GroupModel.GroupRemovedEvent.getRealm()
KeycloakContext.getRealm()
RealmModel.IdentityProviderRemovedEvent.getRealm()
RealmModel.IdentityProviderUpdatedEvent.getRealm()
RealmModel.RealmRemovedEvent.getRealm()
Exact search for a realm by its internal ID.RoleModel.RoleNameChangeEvent.getRealm()
UserModel.UserRemovedEvent.getRealm()
UserSessionModel.getRealm()
RealmProvider.getRealmByName
(String name) Exact search for a realm by its name.Methods in org.keycloak.models that return types with arguments of type RealmModelModifier and TypeMethodDescriptionRealmProvider.getRealmsStream()
Returns realms as a stream.RealmProvider.getRealmsWithProviderTypeStream
(Class<?> type) Returns stream of realms which has component with the given provider type.Methods in org.keycloak.models with parameters of type RealmModelModifier and TypeMethodDescriptiondefault ClientModel
ClientProvider.addClient
(RealmModel realm, String clientId) Adds a client with givenclientId
to the given realm.ClientProvider.addClient
(RealmModel realm, String id, String clientId) Adds a client with given internal ID andclientId
to the given realm.default ClientScopeModel
ClientScopeProvider.addClientScope
(RealmModel realm, String name) Creates new client scope with givenname
to the given realm.ClientScopeProvider.addClientScope
(RealmModel realm, String id, String name) Creates new client scope with given internal ID andname
to the given realm.void
ClientProvider.addClientScopes
(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) Assign clientScopes to the client.void
UserProvider.addConsent
(RealmModel realm, String userId, UserConsentModel consent) Add user consent for the user.void
UserProvider.addFederatedIdentity
(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) Adds a federated identity link for the user within the realmdefault RoleModel
RoleProvider.addRealmRole
(RealmModel realm, String name) Adds a realm role with givenname
to the given realm.RoleProvider.addRealmRole
(RealmModel realm, String id, String name) Adds a realm role with given internal ID andname
to the given realm.void
GroupProvider.addTopLevelGroup
(RealmModel realm, GroupModel subGroup) Removes parent group for the given group in the given realm.UserProvider.addUser
(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) Adds a new user into the storage.UserLoginFailureProvider.addUserLoginFailure
(RealmModel realm, String userId) Adds aUserLoginFailureModel
for the given realm and user id.static OAuth2DeviceCodeModel
OAuth2DeviceCodeModel.create
(RealmModel realm, ClientModel client, String deviceCode, String scope, String nonce, int expiresIn, int pollingInterval, String clientNotificationToken, String authReqId, Map<String, String> additionalParams, String codeChallenge, String codeChallengeMethod) default ClientInitialAccessModel
RealmProvider.createClientInitialAccessModel
(RealmModel realm, int expiration, int count) UserSessionProvider.createClientSession
(RealmModel realm, ClientModel client, UserSessionModel userSession) default GroupModel
GroupProvider.createGroup
(RealmModel realm, String name) Creates a new group with the given name in the given realm.default GroupModel
GroupProvider.createGroup
(RealmModel realm, String id, String name) Creates a new group with the given id and name in the given realm.GroupProvider.createGroup
(RealmModel realm, String id, String name, GroupModel toParent) Creates a new group with the given name, id, name and parent to the given realm.default GroupModel
GroupProvider.createGroup
(RealmModel realm, String name, GroupModel toParent) Creates a new group with the given name and parent to the given realm.static String
OAuth2DeviceUserCodeModel.createKey
(RealmModel realm, String userCode) 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.default void
RealmProvider.decreaseRemainingCount
(RealmModel realm, ClientInitialAccessModel clientInitialAccess) boolean
RealmProvider.deleteLocalizationText
(RealmModel realm, String locale, String key) boolean
RealmProvider.deleteLocalizationTextsByLocale
(RealmModel realm, String locale) static OAuth2DeviceCodeModel
static OAuth2DeviceUserCodeModel
KeyManager.getActiveAesKey
(RealmModel realm) Deprecated.UserSessionProvider.getActiveClientSessionStats
(RealmModel realm, boolean offline) Returns a summary of client sessions key is client.getId()KeyManager.getActiveHmacKey
(RealmModel realm) Deprecated.KeyManager.getActiveKey
(RealmModel realm, KeyUse use, String algorithm) KeyManager.getActiveRsaKey
(RealmModel realm) Deprecated.long
UserSessionProvider.getActiveUserSessions
(RealmModel realm, ClientModel client) KeyManager.getAesKeys
(RealmModel realm) Deprecated.KeyManager.getAesSecretKey
(RealmModel realm, String kid) Deprecated.ClientProvider.getAllRedirectUrisOfEnabledClients
(RealmModel realm) Deprecated.Do not use, this is only to support a deprecated logout endpoint and will vanish with it's removalClientProvider.getAlwaysDisplayInConsoleClientsStream
(RealmModel realm) Returns a stream of clients that are expected to always show up in account console.default ClientInitialAccessModel
RealmProvider.getClientInitialAccessModel
(RealmModel realm, String id) ClientScopeProvider.getClientScopesStream
(RealmModel realm) Returns all the client scopes of the given realm as a stream.long
ClientProvider.getClientsCount
(RealmModel realm) Returns number of clients in the given realmdefault Stream<ClientModel>
ClientProvider.getClientsStream
(RealmModel realm) Returns all the clients of the given realm as a stream.ClientProvider.getClientsStream
(RealmModel realm, Integer firstResult, Integer maxResults) Returns the clients of the given realm as a stream.UserProvider.getConsentByClient
(RealmModel realm, String userId, String clientInternalId) Returns UserConsentModel given by a user with the userId for the client with clientInternalIdUserProvider.getConsentsStream
(RealmModel realm, String userId) Obtains the consents associated with the user identified by the specifieduserId
.UserProvider.getFederatedIdentitiesStream
(RealmModel realm, UserModel user) Obtains the federated identities of the specified user.UserProvider.getFederatedIdentity
(RealmModel realm, UserModel user, String socialProvider) Returns details of the association between the user and the socialProvider.GroupProvider.getGroupsByRoleStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) Returns groups with the given role in the given realm.GroupProvider.getGroupsCount
(RealmModel realm, Boolean onlyTopGroups) Returns a number of groups/top level groups (i.e.default Long
GroupProvider.getGroupsCount
(RealmModel realm, Stream<String> ids, String search) Returns a number of groups that contains the search string in the nameGroupProvider.getGroupsCountByNameContaining
(RealmModel realm, String search) Returns the number of top level groups containing groups with the given string in name for the given realm.GroupProvider.getGroupsStream
(RealmModel realm) Returns groups for the given realm.default Stream<GroupModel>
GroupProvider.getGroupsStream
(RealmModel realm, Stream<String> ids) Returns a stream of groups with given ids.default Stream<GroupModel>
GroupProvider.getGroupsStream
(RealmModel realm, Stream<String> ids, Integer first, Integer max) Returns a paginated stream of groups with given ids.GroupProvider.getGroupsStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) Returns a paginated stream of groups with given ids and given search value in group names.KeyManager.getHmacKeys
(RealmModel realm) Deprecated.KeyManager.getHmacSecretKey
(RealmModel realm, String kid) Deprecated.KeyManager.getKey
(RealmModel realm, String kid, KeyUse use, String algorithm) KeyManager.getKeysStream
(RealmModel realm) Returns allKeyWrapper
for the given realm.KeyManager.getKeysStream
(RealmModel realm, KeyUse use, String algorithm) Returns allKeyWrapper
for the given realm that match given criteria.OTPPolicy.getKeyURI
(RealmModel realm, UserModel user, String secret) Constructs theotpauth://
URI based on the Key-Uri-Format.RealmProvider.getLocalizationTextsById
(RealmModel realm, String locale, String key) int
UserProvider.getNotBeforeOfUser
(RealmModel realm, UserModel user) Gets the notBefore value for the given userlong
UserSessionProvider.getOfflineSessionsCount
(RealmModel realm, ClientModel client) UserSessionProvider.getOfflineUserSession
(RealmModel realm, String userSessionId) UserSessionProvider.getOfflineUserSessionByBrokerSessionId
(RealmModel realm, String brokerSessionId) UserSessionProvider.getOfflineUserSessionByBrokerUserIdStream
(RealmModel realm, String brokerUserId) Obtains the offline user sessions associated with the user that matches the specifiedbrokerUserId
.UserSessionProvider.getOfflineUserSessionsStream
(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults) Obtains the offline user sessions associated with the specified client, starting from thefirstResult
and containing at mostmaxResults
.UserSessionProvider.getOfflineUserSessionsStream
(RealmModel realm, UserModel user) Obtains the offline user sessions associated with the specified user.RoleProvider.getRealmRolesStream
(RealmModel realm) Returns all the realm roles of the given realm as a stream.RoleProvider.getRealmRolesStream
(RealmModel realm, Integer first, Integer max) Returns the realm roles of the given realm as a stream.RoleProvider.getRolesStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) Returns a paginated stream of roles with given ids and given search value in role names.KeyManager.getRsaCertificate
(RealmModel realm, String kid) Deprecated.KeyManager.getRsaKeys
(RealmModel realm) Deprecated.KeyManager.getRsaPublicKey
(RealmModel realm, String kid) Deprecated.int
UserSessionProvider.getStartupTime
(RealmModel realm) default Stream<GroupModel>
GroupProvider.getTopLevelGroupsStream
(RealmModel realm) Returns all top level groups (i.e.default Stream<GroupModel>
GroupProvider.getTopLevelGroupsStream
(RealmModel realm, Integer firstResult, Integer maxResults) Returns top level groups (i.e.GroupProvider.getTopLevelGroupsStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) Returns top level groups (i.e.UserProvider.getUserByFederatedIdentity
(RealmModel realm, FederatedIdentityModel socialLink) Returns a userModel that corresponds to the given socialLink.UserLoginFailureProvider.getUserLoginFailure
(RealmModel realm, String userId) Returns theUserLoginFailureModel
for the given realm and user id.UserSessionProvider.getUserSession
(RealmModel realm, String id) UserSessionProvider.getUserSessionByBrokerSessionId
(RealmModel realm, String brokerSessionId) UserSessionProvider.getUserSessionByBrokerUserIdStream
(RealmModel realm, String brokerUserId) Obtains the online user sessions associated with the user that matches the specifiedbrokerUserId
.UserSessionProvider.getUserSessionsStream
(RealmModel realm, ClientModel client) Obtains the online user sessions associated with the specified client.UserSessionProvider.getUserSessionsStream
(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults) Obtains the online user sessions associated with the specified client, starting from thefirstResult
and containing at mostmaxResults
.UserSessionProvider.getUserSessionsStream
(RealmModel realm, UserModel user) Obtains the online user sessions associated with the specified user.UserSessionProvider.getUserSessionWithPredicate
(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate) Return userSession of specified ID as long as the predicate passes.default Stream<ClientInitialAccessModel>
RealmProvider.listClientInitialAccessStream
(RealmModel realm) Returns client's initial access as a stream.void
GroupProvider.moveGroup
(RealmModel realm, GroupModel group, GroupModel toParent) This method is used for moving groups in group structure, for example: making an existing child group child group of some other group, setting a top level group (i.e.void
UserSessionProvider.onClientRemoved
(RealmModel realm, ClientModel client) void
UserSessionProvider.onRealmRemoved
(RealmModel realm) void
UserProvider.preRemove
(RealmModel realm) Called when a realm is removed.void
UserProvider.preRemove
(RealmModel realm, ComponentModel component) Called when a component is removed.void
UserProvider.preRemove
(RealmModel realm, ClientModel client) Called when a client is removed.void
UserProvider.preRemove
(RealmModel realm, GroupModel group) Called when a group is removed.void
UserProvider.preRemove
(RealmModel realm, IdentityProviderModel provider) Called when an identity provider is removed.void
UserProvider.preRemove
(RealmModel realm, RoleModel role) Called when a role is removed.void
UserLoginFailureProvider.removeAllUserLoginFailures
(RealmModel realm) Removes all theUserLoginFailureModel
for the given realm.boolean
ClientProvider.removeClient
(RealmModel realm, String id) Removes given client from the given realm.default void
RealmProvider.removeClientInitialAccessModel
(RealmModel realm, String id) void
ClientProvider.removeClients
(RealmModel realm) Removes all clients from the given realm.void
ClientProvider.removeClientScope
(RealmModel realm, ClientModel client, ClientScopeModel clientScope) Unassign clientScope from the client.boolean
ClientScopeProvider.removeClientScope
(RealmModel realm, String id) Removes client scope from the given realm.void
ClientScopeProvider.removeClientScopes
(RealmModel realm) Removes all client scopes from the given realm.void
UserSessionProvider.removeExpired
(RealmModel realm) Removes expired user sessions owned by this realm from this provider.boolean
UserProvider.removeFederatedIdentity
(RealmModel realm, UserModel user, String socialProvider) Removes federation link between the user and the identity provider given by its idboolean
GroupProvider.removeGroup
(RealmModel realm, GroupModel group) Removes the given group for the given realm.void
UserProvider.removeImportedUsers
(RealmModel realm, String storageProviderId) Removes any imported users from a specific User Storage Provider.void
UserSessionProvider.removeOfflineUserSession
(RealmModel realm, UserSessionModel userSession) Removes the attached clientSessions as wellvoid
RoleProvider.removeRoles
(RealmModel realm) Removes all roles from the given realm.boolean
UserManager.removeUser
(RealmModel realm, UserModel user) boolean
UserManager.removeUser
(RealmModel realm, UserModel user, UserProvider userProvider) void
UserLoginFailureProvider.removeUserLoginFailure
(RealmModel realm, String userId) Removes aUserLoginFailureModel
for the given realm and user id.void
UserSessionProvider.removeUserSession
(RealmModel realm, UserSessionModel session) This will remove attached ClientLoginSessionModels toovoid
UserSessionProvider.removeUserSessions
(RealmModel realm) void
UserSessionProvider.removeUserSessions
(RealmModel realm, UserModel user) void
UserSessionModel.restartSession
(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) boolean
UserProvider.revokeConsentForClient
(RealmModel realm, String userId, String clientInternalId) Remove a user consent given by the user id and client idvoid
RealmProvider.saveLocalizationText
(RealmModel realm, String locale, String key, String text) void
RealmProvider.saveLocalizationTexts
(RealmModel realm, String locale, Map<String, String> localizationTexts) void
UserProvider.setNotBeforeForUser
(RealmModel realm, UserModel user, int notBefore) Sets the notBefore value for the given uservoid
OAuth2DeviceConfig.setOAuth2DeviceCodeLifespan
(RealmModel realm, Integer seconds) void
OAuth2DeviceConfig.setOAuth2DevicePollingInterval
(RealmModel realm, Integer seconds) void
KeycloakContext.setRealm
(RealmModel realm) static void
ImpersonationConstants.setupImpersonationService
(KeycloakSession session, RealmModel realm) static void
ImpersonationConstants.setupMasterRealmRole
(RealmProvider model, RealmModel realm) static void
ImpersonationConstants.setupRealmRole
(RealmModel realm) void
UserProvider.unlinkUsers
(RealmModel realm, String storageProviderId) Set federation link tonull
to imported users of a specific User Storage Providervoid
UserProvider.updateConsent
(RealmModel realm, String userId, UserConsentModel consent) Update client scopes in the stored user consentvoid
UserProvider.updateFederatedIdentity
(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) Update details of association between the federatedUser and the idp given by the federatedIdentityModelboolean
RealmProvider.updateLocalizationText
(RealmModel realm, String locale, String key, String text) void
IdentityProviderModel.validate
(RealmModel realm) Validates this configuration.Constructors in org.keycloak.models with parameters of type RealmModelModifierConstructorDescriptionCibaConfig
(RealmModel realm) OAuth2DeviceConfig
(RealmModel realm) OAuth2DeviceUserCodeModel
(RealmModel realm, String deviceCode, String userCode) ParConfig
(RealmModel realm) -
Uses of RealmModel in org.keycloak.models.cache
Subinterfaces of RealmModel in org.keycloak.models.cacheModifier and TypeInterfaceDescriptioninterface
Cached realms will implement this interfaceMethods in org.keycloak.models.cache that return RealmModelModifier and TypeMethodDescriptionCachedRealmModel.getDelegateForUpdate()
Invalidates the cache for this model and returns a delegate that represents the actual data providerMethods in org.keycloak.models.cache with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
UserCache.evict
(RealmModel realm) Evict users of a specific realmvoid
UserCache.evict
(RealmModel realm, UserModel user) Evict user from cache.void
OnUserCache.onCache
(RealmModel realm, CachedUserModel user, UserModel delegate) -
Uses of RealmModel in org.keycloak.models.cache.infinispan
Classes in org.keycloak.models.cache.infinispan that implement RealmModelFields in org.keycloak.models.cache.infinispan declared as RealmModelModifier and TypeFieldDescriptionprotected RealmModel
ClientAdapter.cachedRealm
protected RealmModel
ClientScopeAdapter.cachedRealm
protected final RealmModel
GroupAdapter.realm
protected RealmModel
RoleAdapter.realm
protected final RealmModel
UserAdapter.realm
protected RealmModel
RealmAdapter.updated
Methods in org.keycloak.models.cache.infinispan that return RealmModelModifier and TypeMethodDescriptionRealmCacheSession.createRealm
(String name) RealmCacheSession.createRealm
(String id, String name) RealmAdapter.getDelegateForUpdate()
ClientAdapter.getRealm()
ClientScopeAdapter.getRealm()
RealmCacheSession.getRealmByName
(String name) Methods in org.keycloak.models.cache.infinispan that return types with arguments of type RealmModelModifier and TypeMethodDescriptionRealmCacheSession.getRealmsStream()
RealmCacheSession.getRealmsWithProviderTypeStream
(Class<?> type) Methods in org.keycloak.models.cache.infinispan with parameters of type RealmModelModifier and TypeMethodDescriptionRealmCacheSession.addClient
(RealmModel realm, String clientId) RealmCacheSession.addClient
(RealmModel realm, String id, String clientId) RealmCacheSession.addClientScope
(RealmModel realm, String name) RealmCacheSession.addClientScope
(RealmModel realm, String id, String name) void
RealmCacheSession.addClientScopes
(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) void
UserCacheSession.addConsent
(RealmModel realm, String userId, UserConsentModel consent) void
UserCacheSession.addFederatedIdentity
(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) RealmCacheSession.addRealmRole
(RealmModel realm, String name) RealmCacheSession.addRealmRole
(RealmModel realm, String id, String name) void
RealmCacheSession.addTopLevelGroup
(RealmModel realm, GroupModel subGroup) UserCacheSession.addUser
(RealmModel realm, String username) UserCacheSession.addUser
(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) protected ClientModel
RealmCacheSession.cacheClient
(RealmModel realm, ClientModel delegate, Long revision) protected UserModel
UserCacheSession.cacheUser
(RealmModel realm, UserModel delegate, Long revision) RealmCacheSession.createClientInitialAccessModel
(RealmModel realm, int expiration, int count) RealmCacheSession.createGroup
(RealmModel realm, String id, String name, GroupModel toParent) boolean
RealmCacheSession.deleteLocalizationText
(RealmModel realm, String locale, String key) boolean
RealmCacheSession.deleteLocalizationTextsByLocale
(RealmModel realm, String locale) void
UserCacheSession.evict
(RealmModel realm) void
UserCacheSession.evict
(RealmModel realm, UserModel user) void
RealmCacheSession.evictRealmOnRemoval
(RealmModel realm) protected void
UserCacheSession.fullyInvalidateUser
(RealmModel realm, UserModel user) RealmCacheSession.getAllRedirectUrisOfEnabledClients
(RealmModel realm) RealmCacheSession.getAlwaysDisplayInConsoleClientsStream
(RealmModel realm) RealmCacheSession.getClientByClientId
(RealmModel realm, String clientId) RealmCacheSession.getClientById
(RealmModel realm, String id) RealmCacheSession.getClientInitialAccessModel
(RealmModel realm, String id) RealmCacheSession.getClientScopeById
(RealmModel realm, String id) RealmCacheSession.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScopes) RealmCacheSession.getClientScopesStream
(RealmModel realm) long
RealmCacheSession.getClientsCount
(RealmModel realm) RealmCacheSession.getClientsStream
(RealmModel realm) RealmCacheSession.getClientsStream
(RealmModel realm, Integer firstResult, Integer maxResults) UserCacheSession.getConsentByClient
(RealmModel realm, String userId, String clientId) UserCacheSession.getConsentsStream
(RealmModel realm, String userId) UserCacheSession.getFederatedIdentitiesStream
(RealmModel realm, UserModel user) UserCacheSession.getFederatedIdentity
(RealmModel realm, UserModel user, String socialProvider) RealmCacheSession.getGroupById
(RealmModel realm, String id) RealmCacheSession.getGroupByName
(RealmModel realm, GroupModel parent, String name) UserCacheSession.getGroupMembersStream
(RealmModel realm, GroupModel group) UserCacheSession.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) RealmCacheSession.getGroupsByRoleStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) RealmCacheSession.getGroupsCount
(RealmModel realm, Boolean onlyTopGroups) RealmCacheSession.getGroupsCount
(RealmModel realm, Stream<String> ids, String search) RealmCacheSession.getGroupsCountByNameContaining
(RealmModel realm, String search) RealmCacheSession.getGroupsStream
(RealmModel realm) RealmCacheSession.getGroupsStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) RealmCacheSession.getLocalizationTextsById
(RealmModel realm, String locale, String key) int
UserCacheSession.getNotBeforeOfUser
(RealmModel realm, UserModel user) RealmCacheSession.getRealmRole
(RealmModel realm, String name) RealmCacheSession.getRealmRolesStream
(RealmModel realm) RealmCacheSession.getRealmRolesStream
(RealmModel realm, Integer first, Integer max) RealmCacheSession.getRoleById
(RealmModel realm, String id) UserCacheSession.getRoleMembersStream
(RealmModel realm, RoleModel role) UserCacheSession.getRoleMembersStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) RealmCacheSession.getRolesStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) RealmCacheSession.getTopLevelGroupsStream
(RealmModel realm, String search, Boolean exact, Integer first, Integer max) protected UserModel
UserCacheSession.getUserAdapter
(RealmModel realm, String userId, Long loaded, UserModel delegate) UserCacheSession.getUserByCredential
(RealmModel realm, CredentialInput input) UserCacheSession.getUserByEmail
(RealmModel realm, String email) UserCacheSession.getUserByFederatedIdentity
(RealmModel realm, FederatedIdentityModel socialLink) UserCacheSession.getUserById
(RealmModel realm, String id) UserCacheSession.getUserByUsername
(RealmModel realm, String username) int
UserCacheSession.getUsersCount
(RealmModel realm, boolean includeServiceAccount) int
UserCacheSession.getUsersCount
(RealmModel realm, String search) int
UserCacheSession.getUsersCount
(RealmModel realm, String search, Set<String> groupIds) int
UserCacheSession.getUsersCount
(RealmModel realm, Map<String, String> params) int
UserCacheSession.getUsersCount
(RealmModel realm, Map<String, String> params, Set<String> groupIds) int
UserCacheSession.getUsersCount
(RealmModel realm, Set<String> groupIds) void
UserCacheSession.grantToAllUsers
(RealmModel realm, RoleModel role) RealmCacheSession.listClientInitialAccessStream
(RealmModel realm) void
RealmCacheSession.moveGroup
(RealmModel realm, GroupModel group, GroupModel toParent) void
UserCacheSession.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) void
UserCacheSession.onUpdate
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) void
UserCacheSession.preRemove
(RealmModel realm) void
UserCacheSession.preRemove
(RealmModel realm, ComponentModel component) void
UserCacheSession.preRemove
(RealmModel realm, ClientModel client) void
UserCacheSession.preRemove
(RealmModel realm, GroupModel group) void
UserCacheSession.preRemove
(RealmModel realm, IdentityProviderModel provider) void
UserCacheSession.preRemove
(RealmModel realm, RoleModel role) void
UserCacheSession.registerUserInvalidation
(RealmModel realm, CachedUser user) boolean
RealmCacheSession.removeClient
(RealmModel realm, String id) void
RealmCacheSession.removeClientInitialAccessModel
(RealmModel realm, String id) void
RealmCacheSession.removeClients
(RealmModel realm) boolean
RealmCacheSession.removeClientScope
(RealmModel realm, String id) void
RealmCacheSession.removeClientScope
(RealmModel realm, ClientModel client, ClientScopeModel clientScope) void
RealmCacheSession.removeClientScopes
(RealmModel realm) boolean
UserCacheSession.removeFederatedIdentity
(RealmModel realm, UserModel user, String socialProvider) boolean
RealmCacheSession.removeGroup
(RealmModel realm, GroupModel group) void
UserCacheSession.removeImportedUsers
(RealmModel realm, String storageProviderId) void
RealmCacheSession.removeRoles
(RealmModel realm) boolean
UserCacheSession.removeUser
(RealmModel realm, UserModel user) boolean
UserCacheSession.revokeConsentForClient
(RealmModel realm, String userId, String clientInternalId) void
RealmCacheSession.saveLocalizationText
(RealmModel realm, String locale, String key, String text) void
RealmCacheSession.saveLocalizationTexts
(RealmModel realm, String locale, Map<String, String> localizationTexts) RealmCacheSession.searchClientsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) RealmCacheSession.searchClientsByAuthenticationFlowBindingOverrides
(RealmModel realm, Map<String, String> overrides, Integer firstResult, Integer maxResults) RealmCacheSession.searchClientsByClientIdStream
(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) RealmCacheSession.searchForClientRolesStream
(RealmModel realm, String search, Stream<String> excludedIds, Integer first, Integer max) RealmCacheSession.searchForClientRolesStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) RealmCacheSession.searchForGroupByNameStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) RealmCacheSession.searchForGroupByNameStream
(RealmModel realm, String search, Integer first, Integer max) RealmCacheSession.searchForRolesStream
(RealmModel realm, String search, Integer first, Integer max) UserCacheSession.searchForUserByUserAttributeStream
(RealmModel realm, String attrName, String attrValue) UserCacheSession.searchForUserStream
(RealmModel realm, String search) UserCacheSession.searchForUserStream
(RealmModel realm, String search, Integer firstResult, Integer maxResults) UserCacheSession.searchForUserStream
(RealmModel realm, Map<String, String> attributes) UserCacheSession.searchForUserStream
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) RealmCacheSession.searchGroupsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) void
UserCacheSession.setNotBeforeForUser
(RealmModel realm, UserModel user, int notBefore) void
UserCacheSession.unlinkUsers
(RealmModel realm, String storageProviderId) void
UserCacheSession.updateConsent
(RealmModel realm, String userId, UserConsentModel consent) void
UserCacheSession.updateFederatedIdentity
(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) boolean
RealmCacheSession.updateLocalizationText
(RealmModel realm, String locale, String key, String text) protected ClientModel
RealmCacheSession.validateCache
(RealmModel realm, CachedClient cached) protected UserModel
UserCacheSession.validateCache
(RealmModel realm, CachedUser cached) Constructors in org.keycloak.models.cache.infinispan with parameters of type RealmModelModifierConstructorDescriptionClientAdapter
(RealmModel cachedRealm, CachedClient cached, RealmCacheSession cacheSession) ClientScopeAdapter
(RealmModel cachedRealm, CachedClientScope cached, RealmCacheSession cacheSession) GroupAdapter
(CachedGroup cached, RealmCacheSession cacheSession, KeycloakSession keycloakSession, RealmModel realm) RoleAdapter
(CachedRole cached, RealmCacheSession session, RealmModel realm) SubjectCredentialManagerCacheAdapter
(KeycloakSession session, RealmModel realm, UserModel user) UserAdapter
(CachedUser cached, UserCacheSession userProvider, KeycloakSession keycloakSession, RealmModel realm) -
Uses of RealmModel in org.keycloak.models.cache.infinispan.authorization
Fields in org.keycloak.models.cache.infinispan.authorization declared as RealmModelModifier and TypeFieldDescriptionstatic final RealmModel
InfinispanCacheStoreFactoryProviderFactory.NULL_REALM
Legacy store doesn't store realm id for any entity and no method there is using new introduced RealmModel parameter.Methods in org.keycloak.models.cache.infinispan.authorization that return RealmModelMethods in org.keycloak.models.cache.infinispan.authorization with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
StoreFactoryCacheSession.PermissionTicketCache.delete
(RealmModel realm, String id) void
StoreFactoryCacheSession.PolicyCache.delete
(RealmModel realm, String id) void
StoreFactoryCacheSession.ResourceCache.delete
(RealmModel realm, String id) void
StoreFactoryCacheSession.ScopeCache.delete
(RealmModel realm, String id) StoreFactoryCacheSession.PermissionTicketCache.find
(RealmModel realm, ResourceServer resourceServer, Map<PermissionTicket.FilterOption, String> attributes, Integer firstResult, Integer maxResult) StoreFactoryCacheSession.PolicyCache.find
(RealmModel realm, ResourceServer resourceServer, Map<Policy.FilterOption, String[]> attributes, Integer firstResult, Integer maxResults) StoreFactoryCacheSession.ResourceCache.find
(RealmModel realm, ResourceServer resourceServer, Map<Resource.FilterOption, String[]> attributes, Integer firstResult, Integer maxResults) StoreFactoryCacheSession.PermissionTicketCache.findById
(RealmModel realm, ResourceServer resourceServer, String id) StoreFactoryCacheSession.PolicyCache.findById
(RealmModel realm, ResourceServer resourceServer, String id) StoreFactoryCacheSession.ResourceCache.findById
(RealmModel realm, ResourceServer resourceServer, String id) StoreFactoryCacheSession.ResourceServerCache.findById
(RealmModel realm, String id) StoreFactoryCacheSession.ScopeCache.findById
(RealmModel realm, ResourceServer resourceServer, String id) StoreFactoryCacheSession.ResourceCache.findByOwner
(RealmModel realm, ResourceServer resourceServer, String ownerId) void
StoreFactoryCacheSession.ResourceCache.findByOwner
(RealmModel realm, ResourceServer resourceServer, String ownerId, Consumer<Resource> consumer) StoreFactoryCacheSession.PermissionTicketCache.findGrantedOwnerResources
(RealmModel realm, String owner, Integer firstResult, Integer maxResults) StoreFactoryCacheSession.PermissionTicketCache.findGrantedResources
(RealmModel realm, String requester, String name, Integer first, Integer max) Constructors in org.keycloak.models.cache.infinispan.authorization with parameters of type RealmModelModifierConstructorDescriptionResourceServerAdapter
(RealmModel realm, CachedResourceServer cached, StoreFactoryCacheSession cacheSession) -
Uses of RealmModel in org.keycloak.models.cache.infinispan.entities
Fields in org.keycloak.models.cache.infinispan.entities with type parameters of type RealmModelModifier and TypeFieldDescriptionprotected LazyLoader<RealmModel,
CibaConfig> CachedRealm.cibaConfig
protected LazyLoader<RealmModel,
OAuth2DeviceConfig> CachedRealm.deviceConfig
protected LazyLoader<RealmModel,
ParConfig> CachedRealm.parConfig
Methods in org.keycloak.models.cache.infinispan.entities with parameters of type RealmModelMethod parameters in org.keycloak.models.cache.infinispan.entities with type arguments of type RealmModelModifier and TypeMethodDescriptionCachedRealm.getCibaConfig
(Supplier<RealmModel> modelSupplier) CachedRealm.getOAuth2DeviceConfig
(Supplier<RealmModel> modelSupplier) CachedRealm.getParConfig
(Supplier<RealmModel> modelSupplier) Constructors in org.keycloak.models.cache.infinispan.entities with parameters of type RealmModelModifierConstructorDescriptionCachedClient
(Long revision, RealmModel realm, ClientModel model) CachedClientRole
(Long revision, String clientId, RoleModel model, RealmModel realm) CachedClientScope
(Long revision, RealmModel realm, ClientScopeModel model) CachedFederatedIdentityLinks
(Long revision, String id, RealmModel realm, Set<FederatedIdentityModel> federatedIdentities) CachedGroup
(Long revision, RealmModel realm, GroupModel group) CachedRealm
(Long revision, RealmModel model) CachedRealmRole
(Long revision, RoleModel model, RealmModel realm) CachedRole
(Long revision, RoleModel model, RealmModel realm) CachedUser
(Long revision, RealmModel realm, UserModel user, int notBefore) CachedUserConsents
(Long revision, String id, RealmModel realm, List<CachedUserConsent> consents) CachedUserConsents
(Long revision, String id, RealmModel realm, List<CachedUserConsent> consents, boolean allConsents) ClientListQuery
(Long revisioned, String id, RealmModel realm, String client) ClientListQuery
(Long revisioned, String id, RealmModel realm, Set<String> clients) ClientScopeListQuery
(Long revisioned, String id, RealmModel realm, String clientUuid, Set<String> clientScopes) ClientScopeListQuery
(Long revisioned, String id, RealmModel realm, Set<String> clientScopes) GroupListQuery
(Long revisioned, String id, RealmModel realm, Set<String> groups) GroupNameQuery
(Long revisioned, String id, String groupId, RealmModel realm) RoleListQuery
(Long revisioned, String id, RealmModel realm, String role) RoleListQuery
(Long revision, String id, RealmModel realm, String role, String client) RoleListQuery
(Long revisioned, String id, RealmModel realm, Set<String> roles) RoleListQuery
(Long revision, String id, RealmModel realm, Set<String> roles, String client) UserListQuery
(Long revisioned, String id, RealmModel realm, String user) UserListQuery
(Long revisioned, String id, RealmModel realm, Set<String> users) -
Uses of RealmModel in org.keycloak.models.credential
Methods in org.keycloak.models.credential with parameters of type RealmModelModifier and TypeMethodDescriptionstatic OTPCredentialModel
OTPCredentialModel.createFromPolicy
(RealmModel realm, String secretValue) static OTPCredentialModel
OTPCredentialModel.createFromPolicy
(RealmModel realm, String secretValue, String userLabel) -
Uses of RealmModel in org.keycloak.models.delegate
Methods in org.keycloak.models.delegate that return RealmModelConstructors in org.keycloak.models.delegate with parameters of type RealmModel -
Uses of RealmModel in org.keycloak.models.jpa
Classes in org.keycloak.models.jpa that implement RealmModelFields in org.keycloak.models.jpa declared as RealmModelModifier and TypeFieldDescriptionprotected RealmModel
ClientAdapter.realm
protected RealmModel
ClientScopeAdapter.realm
protected RealmModel
GroupAdapter.realm
protected RealmModel
RoleAdapter.realm
protected RealmModel
UserAdapter.realm
Methods in org.keycloak.models.jpa that return RealmModelModifier and TypeMethodDescriptionJpaRealmProvider.createRealm
(String name) JpaRealmProvider.createRealm
(String id, String name) ClientAdapter.getRealm()
ClientScopeAdapter.getRealm()
JpaRealmProvider.getRealmByName
(String name) Methods in org.keycloak.models.jpa that return types with arguments of type RealmModelModifier and TypeMethodDescriptionJpaRealmProvider.getRealmsStream()
JpaRealmProvider.getRealmsWithProviderTypeStream
(Class<?> providerType) Methods in org.keycloak.models.jpa with parameters of type RealmModelModifier and TypeMethodDescriptionJpaRealmProvider.addClient
(RealmModel realm, String clientId) JpaRealmProvider.addClient
(RealmModel realm, String id, String clientId) JpaRealmProvider.addClientScope
(RealmModel realm, String id, String name) void
JpaRealmProvider.addClientScopes
(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) void
JpaUserProvider.addConsent
(RealmModel realm, String userId, UserConsentModel consent) void
JpaUserProvider.addFederatedIdentity
(RealmModel realm, UserModel user, FederatedIdentityModel identity) JpaRealmProvider.addRealmRole
(RealmModel realm, String name) JpaRealmProvider.addRealmRole
(RealmModel realm, String id, String name) void
JpaRealmProvider.addTopLevelGroup
(RealmModel realm, GroupModel subGroup) JpaUserProvider.addUser
(RealmModel realm, String username) JpaUserProvider.addUser
(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) JpaUserCredentialStore.createCredential
(RealmModel realm, UserModel user, CredentialModel cred) JpaUserProvider.createCredential
(RealmModel realm, UserModel user, CredentialModel cred) JpaRealmProvider.createGroup
(RealmModel realm, String id, String name, GroupModel toParent) boolean
JpaRealmProvider.deleteLocalizationText
(RealmModel realm, String locale, String key) boolean
JpaRealmProvider.deleteLocalizationTextsByLocale
(RealmModel realm, String locale) protected void
JpaUserProvider.ensureEmailConstraint
(List<UserEntity> users, RealmModel realm) JpaRealmProvider.getAllRedirectUrisOfEnabledClients
(RealmModel realm) JpaRealmProvider.getAlwaysDisplayInConsoleClientsStream
(RealmModel realm) JpaRealmProvider.getClientByClientId
(RealmModel realm, String clientId) JpaRealmProvider.getClientById
(RealmModel realm, String id) JpaRealmProvider.getClientScopeById
(RealmModel realm, String id) JpaRealmProvider.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScope) JpaRealmProvider.getClientScopesStream
(RealmModel realm) long
JpaRealmProvider.getClientsCount
(RealmModel realm) JpaRealmProvider.getClientsStream
(RealmModel realm) JpaRealmProvider.getClientsStream
(RealmModel realm, Integer firstResult, Integer maxResults) JpaUserProvider.getConsentByClient
(RealmModel realm, String userId, String clientId) JpaUserProvider.getConsentsStream
(RealmModel realm, String userId) JpaUserProvider.getFederatedIdentitiesStream
(RealmModel realm, UserModel user) JpaUserProvider.getFederatedIdentity
(RealmModel realm, UserModel user, String identityProvider) JpaRealmProvider.getGroupById
(RealmModel realm, String id) JpaRealmProvider.getGroupByName
(RealmModel realm, GroupModel parent, String name) JpaUserProvider.getGroupMembersStream
(RealmModel realm, GroupModel group) JpaUserProvider.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) JpaRealmProvider.getGroupsByRoleStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) JpaRealmProvider.getGroupsCount
(RealmModel realm, Boolean onlyTopGroups) JpaRealmProvider.getGroupsCount
(RealmModel realm, Stream<String> ids, String search) JpaRealmProvider.getGroupsCountByNameContaining
(RealmModel realm, String search) JpaRealmProvider.getGroupsStream
(RealmModel realm) JpaRealmProvider.getGroupsStream
(RealmModel realm, Stream<String> ids) JpaRealmProvider.getGroupsStream
(RealmModel realm, Stream<String> ids, Integer first, Integer max) JpaRealmProvider.getGroupsStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) JpaRealmProvider.getLocalizationTextsById
(RealmModel realm, String locale, String key) int
JpaUserProvider.getNotBeforeOfUser
(RealmModel realm, UserModel user) JpaRealmProvider.getRealmRole
(RealmModel realm, String name) JpaRealmProvider.getRealmRolesStream
(RealmModel realm) JpaRealmProvider.getRealmRolesStream
(RealmModel realm, Integer first, Integer max) JpaRealmProvider.getRoleById
(RealmModel realm, String id) JpaUserProvider.getRoleMembersStream
(RealmModel realm, RoleModel role) JpaUserProvider.getRoleMembersStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) JpaRealmProvider.getRolesStream
(jakarta.persistence.TypedQuery<RoleEntity> query, RealmModel realm, Integer first, Integer max) JpaRealmProvider.getRolesStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) JpaUserCredentialStore.getStoredCredentialById
(RealmModel realm, UserModel user, String id) JpaUserProvider.getStoredCredentialById
(RealmModel realm, UserModel user, String id) JpaUserCredentialStore.getStoredCredentialByNameAndType
(RealmModel realm, UserModel user, String name, String type) JpaUserProvider.getStoredCredentialByNameAndType
(RealmModel realm, UserModel user, String name, String type) JpaUserCredentialStore.getStoredCredentialsByTypeStream
(RealmModel realm, UserModel user, String type) JpaUserProvider.getStoredCredentialsByTypeStream
(RealmModel realm, UserModel user, String type) JpaUserCredentialStore.getStoredCredentialsStream
(RealmModel realm, UserModel user) JpaUserProvider.getStoredCredentialsStream
(RealmModel realm, UserModel user) JpaRealmProvider.getTopLevelGroupsStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) JpaUserProvider.getUserByEmail
(RealmModel realm, String email) JpaUserProvider.getUserByFederatedIdentity
(RealmModel realm, FederatedIdentityModel identity) JpaUserProvider.getUserById
(RealmModel realm, String id) JpaUserProvider.getUserByUsername
(RealmModel realm, String username) int
JpaUserProvider.getUsersCount
(RealmModel realm, boolean includeServiceAccount) int
JpaUserProvider.getUsersCount
(RealmModel realm, String search) int
JpaUserProvider.getUsersCount
(RealmModel realm, String search, Set<String> groupIds) int
JpaUserProvider.getUsersCount
(RealmModel realm, Map<String, String> params) int
JpaUserProvider.getUsersCount
(RealmModel realm, Map<String, String> params, Set<String> groupIds) int
JpaUserProvider.getUsersCount
(RealmModel realm, Set<String> groupIds) void
JpaUserProvider.grantToAllUsers
(RealmModel realm, RoleModel role) boolean
JpaUserCredentialStore.moveCredentialTo
(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) boolean
JpaUserProvider.moveCredentialTo
(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) void
JpaRealmProvider.moveGroup
(RealmModel realm, GroupModel group, GroupModel toParent) void
JpaRealmProvider.preRemove
(RealmModel realm, RoleModel role) void
JpaUserProvider.preRemove
(RealmModel realm) void
JpaUserProvider.preRemove
(RealmModel realm, ComponentModel component) void
JpaUserProvider.preRemove
(RealmModel realm, ClientModel client) void
JpaUserProvider.preRemove
(RealmModel realm, GroupModel group) void
JpaUserProvider.preRemove
(RealmModel realm, IdentityProviderModel provider) void
JpaUserProvider.preRemove
(RealmModel realm, RoleModel role) boolean
JpaRealmProvider.removeClient
(RealmModel realm, String id) void
JpaRealmProvider.removeClients
(RealmModel realm) boolean
JpaRealmProvider.removeClientScope
(RealmModel realm, String id) void
JpaRealmProvider.removeClientScope
(RealmModel realm, ClientModel client, ClientScopeModel clientScope) void
JpaRealmProvider.removeClientScopes
(RealmModel realm) protected void
JpaUserProvider.removeConsentByClientStorageProvider
(RealmModel realm, String providerId) boolean
JpaUserProvider.removeFederatedIdentity
(RealmModel realm, UserModel user, String identityProvider) boolean
JpaRealmProvider.removeGroup
(RealmModel realm, GroupModel group) void
JpaUserProvider.removeImportedUsers
(RealmModel realm, String storageProviderId) void
JpaRealmProvider.removeRoles
(RealmModel realm) boolean
JpaUserCredentialStore.removeStoredCredential
(RealmModel realm, UserModel user, String id) boolean
JpaUserProvider.removeStoredCredential
(RealmModel realm, UserModel user, String id) boolean
JpaUserProvider.removeUser
(RealmModel realm, UserModel user) boolean
JpaUserProvider.revokeConsentForClient
(RealmModel realm, String userId, String clientId) void
JpaRealmProvider.saveLocalizationText
(RealmModel realm, String locale, String key, String text) void
JpaRealmProvider.saveLocalizationTexts
(RealmModel realm, String locale, Map<String, String> localizationTexts) JpaRealmProvider.searchClientsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) JpaRealmProvider.searchClientsByAuthenticationFlowBindingOverrides
(RealmModel realm, Map<String, String> overrides, Integer firstResult, Integer maxResults) JpaRealmProvider.searchClientsByClientIdStream
(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) JpaRealmProvider.searchForClientRolesStream
(RealmModel realm, String search, Stream<String> excludedIds, Integer first, Integer max) JpaRealmProvider.searchForClientRolesStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) JpaRealmProvider.searchForGroupByNameStream
(RealmModel realm, String search, Boolean exact, Integer first, Integer max) JpaRealmProvider.searchForRoles
(jakarta.persistence.TypedQuery<RoleEntity> query, RealmModel realm, String search, Integer first, Integer max) JpaRealmProvider.searchForRolesStream
(RealmModel realm, String search, Integer first, Integer max) JpaUserProvider.searchForUserByUserAttributeStream
(RealmModel realm, String attrName, String attrValue) JpaUserProvider.searchForUserStream
(RealmModel realm, String search, Integer firstResult, Integer maxResults) JpaUserProvider.searchForUserStream
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) JpaRealmProvider.searchGroupsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) void
JpaUserProvider.setNotBeforeForUser
(RealmModel realm, UserModel user, int notBefore) void
JpaUserProvider.unlinkUsers
(RealmModel realm, String storageProviderId) void
JpaUserProvider.updateConsent
(RealmModel realm, String userId, UserConsentModel consent) void
JpaUserCredentialStore.updateCredential
(RealmModel realm, UserModel user, CredentialModel cred) void
JpaUserProvider.updateCredential
(RealmModel realm, UserModel user, CredentialModel cred) void
JpaUserProvider.updateFederatedIdentity
(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) boolean
JpaRealmProvider.updateLocalizationText
(RealmModel realm, String locale, String key, String text) Constructors in org.keycloak.models.jpa with parameters of type RealmModelModifierConstructorDescriptionClientAdapter
(RealmModel realm, jakarta.persistence.EntityManager em, KeycloakSession session, ClientEntity entity) ClientScopeAdapter
(RealmModel realm, jakarta.persistence.EntityManager em, KeycloakSession session, ClientScopeEntity entity) GroupAdapter
(RealmModel realm, jakarta.persistence.EntityManager em, GroupEntity group) RoleAdapter
(KeycloakSession session, RealmModel realm, jakarta.persistence.EntityManager em, RoleEntity role) UserAdapter
(KeycloakSession session, RealmModel realm, jakarta.persistence.EntityManager em, UserEntity user) -
Uses of RealmModel in org.keycloak.models.jpa.session
Methods in org.keycloak.models.jpa.session with parameters of type RealmModelModifier and TypeMethodDescriptionint
JpaUserSessionPersisterProvider.getUserSessionsCount
(RealmModel realm, ClientModel clientModel, boolean offline) JpaUserSessionPersisterProvider.getUserSessionsCountsByClients
(RealmModel realm, boolean offline) JpaUserSessionPersisterProvider.loadClientSession
(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline) JpaUserSessionPersisterProvider.loadUserSession
(RealmModel realm, String userSessionId, boolean offline) JpaUserSessionPersisterProvider.loadUserSessionsStream
(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults) JpaUserSessionPersisterProvider.loadUserSessionsStream
(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults) void
JpaUserSessionPersisterProvider.onClientRemoved
(RealmModel realm, ClientModel client) void
JpaUserSessionPersisterProvider.onRealmRemoved
(RealmModel realm) void
JpaUserSessionPersisterProvider.onUserRemoved
(RealmModel realm, UserModel user) void
JpaUserSessionPersisterProvider.removeExpired
(RealmModel realm) void
JpaUserSessionPersisterProvider.updateLastSessionRefreshes
(RealmModel realm, int lastSessionRefresh, Collection<String> userSessionIds, boolean offline) -
Uses of RealmModel in org.keycloak.models.light
Methods in org.keycloak.models.light with parameters of type RealmModelModifier and TypeMethodDescriptionstatic LightweightUserAdapter
LightweightUserAdapter.fromString
(KeycloakSession session, RealmModel realm, String serializedForm) -
Uses of RealmModel in org.keycloak.models.session
Methods in org.keycloak.models.session that return RealmModelModifier and TypeMethodDescriptionPersistentAuthenticatedClientSessionAdapter.getRealm()
PersistentUserSessionAdapter.getRealm()
Methods in org.keycloak.models.session with parameters of type RealmModelModifier and TypeMethodDescriptionint
DisabledUserSessionPersisterProvider.getUserSessionsCount
(RealmModel realm, ClientModel clientModel, boolean offline) int
UserSessionPersisterProvider.getUserSessionsCount
(RealmModel realm, ClientModel clientModel, boolean offline) Retrieves the count of user client-sessions for the given clientDisabledUserSessionPersisterProvider.getUserSessionsCountsByClients
(RealmModel realm, boolean offline) UserSessionPersisterProvider.getUserSessionsCountsByClients
(RealmModel realm, boolean offline) Returns aMap
containing the number of user-sessions aggregated by client id for the given realm.DisabledUserSessionPersisterProvider.loadClientSession
(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline) UserSessionPersisterProvider.loadClientSession
(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline) Loads client session from the db by provided user session and client.DisabledUserSessionPersisterProvider.loadUserSession
(RealmModel realm, String userSessionId, boolean offline) UserSessionPersisterProvider.loadUserSession
(RealmModel realm, String userSessionId, boolean offline) Loads the user session with the given userSessionId.DisabledUserSessionPersisterProvider.loadUserSessionsStream
(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults) DisabledUserSessionPersisterProvider.loadUserSessionsStream
(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults) UserSessionPersisterProvider.loadUserSessionsStream
(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults) Loads the user sessions for the givenClientModel
in the givenRealmModel
if present.UserSessionPersisterProvider.loadUserSessionsStream
(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults) Loads the user sessions for the givenUserModel
in the givenRealmModel
if present.void
DisabledUserSessionPersisterProvider.onClientRemoved
(RealmModel realm, ClientModel client) void
UserSessionPersisterProvider.onClientRemoved
(RealmModel realm, ClientModel client) void
DisabledUserSessionPersisterProvider.onRealmRemoved
(RealmModel realm) void
UserSessionPersisterProvider.onRealmRemoved
(RealmModel realm) void
DisabledUserSessionPersisterProvider.onUserRemoved
(RealmModel realm, UserModel user) void
UserSessionPersisterProvider.onUserRemoved
(RealmModel realm, UserModel user) void
DisabledUserSessionPersisterProvider.removeExpired
(RealmModel realm) void
UserSessionPersisterProvider.removeExpired
(RealmModel realm) void
PersistentUserSessionAdapter.restartSession
(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) void
DisabledUserSessionPersisterProvider.updateLastSessionRefreshes
(RealmModel realm, int lastSessionRefresh, Collection<String> userSessionIds, boolean offline) void
UserSessionPersisterProvider.updateLastSessionRefreshes
(RealmModel realm, int lastSessionRefresh, Collection<String> userSessionIds, boolean offline) Constructors in org.keycloak.models.session with parameters of type RealmModelModifierConstructorDescriptionPersistentAuthenticatedClientSessionAdapter
(KeycloakSession session, PersistentClientSessionModel model, RealmModel realm, ClientModel client, UserSessionModel userSession) PersistentUserSessionAdapter
(KeycloakSession session, PersistentUserSessionModel model, RealmModel realm, String userId, Map<String, AuthenticatedClientSessionModel> clientSessions) -
Uses of RealmModel in org.keycloak.models.sessions.infinispan
Methods in org.keycloak.models.sessions.infinispan that return RealmModelModifier and TypeMethodDescriptionAuthenticatedClientSessionAdapter.getRealm()
AuthenticationSessionAdapter.getRealm()
RootAuthenticationSessionAdapter.getRealm()
UserSessionAdapter.getRealm()
Methods in org.keycloak.models.sessions.infinispan with parameters of type RealmModelModifier and TypeMethodDescriptionInfinispanUserLoginFailureProvider.addUserLoginFailure
(RealmModel realm, String userId) SessionFunction.apply
(RealmModel realm, ClientModel client, V entity) InfinispanUserSessionProvider.createClientSession
(RealmModel realm, ClientModel client, UserSessionModel userSession) InfinispanAuthenticationSessionProvider.createRootAuthenticationSession
(RealmModel realm) InfinispanAuthenticationSessionProvider.createRootAuthenticationSession
(RealmModel realm, String id) InfinispanUserSessionProvider.createUserSession
(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState) InfinispanUserSessionProvider.getActiveClientSessionStats
(RealmModel realm, boolean offline) long
InfinispanUserSessionProvider.getActiveUserSessions
(RealmModel realm, ClientModel client) long
InfinispanUserSessionProvider.getOfflineSessionsCount
(RealmModel realm, ClientModel client) InfinispanUserSessionProvider.getOfflineUserSession
(RealmModel realm, String userSessionId) InfinispanUserSessionProvider.getOfflineUserSessionByBrokerSessionId
(RealmModel realm, String brokerSessionId) InfinispanUserSessionProvider.getOfflineUserSessionByBrokerUserIdStream
(RealmModel realm, String brokerUserId) InfinispanUserSessionProvider.getOfflineUserSessionsStream
(RealmModel realm, ClientModel client, Integer first, Integer max) InfinispanUserSessionProvider.getOfflineUserSessionsStream
(RealmModel realm, UserModel user) InfinispanAuthenticationSessionProvider.getRootAuthenticationSession
(RealmModel realm, String authenticationSessionId) int
InfinispanUserSessionProvider.getStartupTime
(RealmModel realm) InfinispanUserLoginFailureProvider.getUserLoginFailure
(RealmModel realm, String userId) InfinispanUserSessionProvider.getUserSession
(RealmModel realm, String id) protected UserSessionAdapter
InfinispanUserSessionProvider.getUserSession
(RealmModel realm, String id, boolean offline) InfinispanUserSessionProvider.getUserSessionByBrokerSessionId
(RealmModel realm, String brokerSessionId) InfinispanUserSessionProvider.getUserSessionByBrokerUserIdStream
(RealmModel realm, String brokerUserId) protected long
InfinispanUserSessionProvider.getUserSessionsCount
(RealmModel realm, ClientModel client, boolean offline) InfinispanUserSessionProvider.getUserSessionsStream
(RealmModel realm, ClientModel client) 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) InfinispanUserSessionProvider.getUserSessionsStream
(RealmModel realm, UserModel user) InfinispanUserSessionProvider.getUserSessionWithPredicate
(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate) void
InfinispanAuthenticationSessionProvider.onClientRemoved
(RealmModel realm, ClientModel client) void
InfinispanUserSessionProvider.onClientRemoved
(RealmModel realm, ClientModel client) void
InfinispanAuthenticationSessionProvider.onRealmRemoved
(RealmModel realm) void
InfinispanUserSessionProvider.onRealmRemoved
(RealmModel realm) protected void
InfinispanUserSessionProvider.onUserRemoved
(RealmModel realm, UserModel user) void
InfinispanUserLoginFailureProvider.removeAllUserLoginFailures
(RealmModel realm) void
InfinispanAuthenticationSessionProvider.removeExpired
(RealmModel realm) void
InfinispanUserSessionProvider.removeExpired
(RealmModel realm) void
InfinispanUserSessionProvider.removeOfflineUserSession
(RealmModel realm, UserSessionModel userSession) void
InfinispanAuthenticationSessionProvider.removeRootAuthenticationSession
(RealmModel realm, RootAuthenticationSessionModel authenticationSession) void
InfinispanUserLoginFailureProvider.removeUserLoginFailure
(RealmModel realm, String userId) void
InfinispanUserSessionProvider.removeUserSession
(RealmModel realm, UserSessionModel session) void
InfinispanUserSessionProvider.removeUserSessions
(RealmModel realm) void
InfinispanUserSessionProvider.removeUserSessions
(RealmModel realm, UserModel user) protected void
InfinispanUserSessionProvider.removeUserSessions
(RealmModel realm, UserModel user, boolean offline) void
RootAuthenticationSessionAdapter.restartSession
(RealmModel realm) void
UserSessionAdapter.restartSession
(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) Consumers.userSessionModels
(InfinispanUserSessionProvider provider, RealmModel realm, boolean offline) Constructors in org.keycloak.models.sessions.infinispan with parameters of type RealmModelModifierConstructorDescriptionRootAuthenticationSessionAdapter
(KeycloakSession session, InfinispanAuthenticationSessionProvider provider, org.infinispan.Cache<String, RootAuthenticationSessionEntity> cache, RealmModel realm, RootAuthenticationSessionEntity entity, int authSessionsLimt) UserSessionAdapter
(KeycloakSession session, UserModel user, InfinispanUserSessionProvider provider, InfinispanChangelogBasedTransaction<String, UserSessionEntity> userSessionUpdateTx, InfinispanChangelogBasedTransaction<UUID, AuthenticatedClientSessionEntity> clientSessionUpdateTx, RealmModel realm, UserSessionEntity entity, boolean offline) -
Uses of RealmModel in org.keycloak.models.sessions.infinispan.changes
Methods in org.keycloak.models.sessions.infinispan.changes with parameters of type RealmModelModifier and TypeMethodDescriptionSessionEntityWrapper.getClientIfNeeded
(RealmModel realm) void
InfinispanChangelogBasedTransaction.reloadEntityInCurrentTransaction
(RealmModel realm, K key, SessionEntityWrapper<V> entity) -
Uses of RealmModel in org.keycloak.models.sessions.infinispan.changes.sessions
Methods in org.keycloak.models.sessions.infinispan.changes.sessions with parameters of type RealmModelModifier and TypeMethodDescriptionCrossDCLastSessionRefreshChecker.shouldSaveClientSessionToRemoteCache
(KeycloakSession kcSession, RealmModel realm, SessionEntityWrapper<AuthenticatedClientSessionEntity> sessionWrapper, UserSessionModel userSession, boolean offline, int newTimestamp) CrossDCLastSessionRefreshChecker.shouldSaveUserSessionToRemoteCache
(KeycloakSession kcSession, RealmModel realm, SessionEntityWrapper<UserSessionEntity> sessionWrapper, boolean offline, int newLastSessionRefresh) -
Uses of RealmModel in org.keycloak.models.sessions.infinispan.remotestore
Methods in org.keycloak.models.sessions.infinispan.remotestore with parameters of type RealmModelModifier and TypeMethodDescriptionlong
RemoteCacheInvoker.MaxIdleTimeLoader.getMaxIdleTimeMs
(RealmModel realm) <K,
V extends SessionEntity>
voidRemoteCacheInvoker.runTask
(KeycloakSession kcSession, RealmModel realm, String cacheName, K key, MergedUpdate<V> task, SessionEntityWrapper<V> sessionWrapper) -
Uses of RealmModel in org.keycloak.models.sessions.infinispan.util
Methods in org.keycloak.models.sessions.infinispan.util with parameters of type RealmModelModifier and TypeMethodDescriptionstatic long
SessionTimeouts.getClientSessionLifespanMs
(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity clientSessionEntity) Get the maximum lifespan, which this clientSession can remain in the infinispan cache.static long
SessionTimeouts.getClientSessionMaxIdleMs
(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity clientSessionEntity) Get the maxIdle, which this clientSession will use.static long
SessionTimeouts.getLoginFailuresLifespanMs
(RealmModel realm, ClientModel client, LoginFailureEntity loginFailureEntity) Not using lifespan for detached login failure (backwards compatibility with the background cleaner threads, which were used for cleanup of detached login failures)static long
SessionTimeouts.getLoginFailuresMaxIdleMs
(RealmModel realm, ClientModel client, LoginFailureEntity loginFailureEntity) Not using maxIdle for detached login failure (backwards compatibility with the background cleaner threads, which were used for cleanup of detached login failures)static long
SessionTimeouts.getOfflineClientSessionLifespanMs
(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity authenticatedClientSessionEntity) Get the maximum lifespan, which this offline clientSession can remain in the infinispan cache.static long
SessionTimeouts.getOfflineClientSessionMaxIdleMs
(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity authenticatedClientSessionEntity) Get the maxIdle, which this offline clientSession will use.static long
SessionTimeouts.getOfflineSessionLifespanMs
(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum lifespan, which this offline userSession can remain in the infinispan cache.static long
SessionTimeouts.getOfflineSessionMaxIdleMs
(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum idle time for this offline userSession.static long
SessionTimeouts.getUserSessionLifespanMs
(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum lifespan, which this userSession can remain in the infinispan cache.static long
SessionTimeouts.getUserSessionMaxIdleMs
(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum idle time for this userSession. -
Uses of RealmModel in org.keycloak.models.utils
Methods in org.keycloak.models.utils with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
DefaultRequiredActions.Action.addAction
(RealmModel realm) static void
DefaultRequiredActions.addAction
(RealmModel realm, DefaultRequiredActions.Action action) Add default required action to the realmstatic void
DefaultRequiredActions.addActions
(RealmModel realm) Add default required actions to the realmstatic void
DefaultRequiredActions.addConfigureTotpAction
(RealmModel realm) static void
DefaultRequiredActions.addDeleteAccountAction
(RealmModel realm) static void
DefaultAuthenticationFlows.addFlows
(RealmModel realm) static void
DefaultAuthenticationFlows.addIdentityProviderAuthenticator
(RealmModel realm, String defaultProvider) static void
DefaultRequiredActions.addRecoveryAuthnCodesAction
(RealmModel realm) static void
DefaultRequiredActions.addTermsAndConditionsAction
(RealmModel realm) static void
DefaultRequiredActions.addUpdateEmailAction
(RealmModel realm) static void
DefaultRequiredActions.addUpdateLocaleAction
(RealmModel realm) static void
DefaultRequiredActions.addUpdatePasswordAction
(RealmModel realm) static void
DefaultRequiredActions.addUpdateProfileAction
(RealmModel realm) static void
DefaultRequiredActions.addVerifyEmailAction
(RealmModel realm) static void
DefaultRequiredActions.addWebAuthnPasswordlessRegisterAction
(RealmModel realm) static void
DefaultRequiredActions.addWebAuthnRegisterAction
(RealmModel realm) static void
DefaultAuthenticationFlows.browserFlow
(RealmModel realm) static void
DefaultAuthenticationFlows.browserFlow
(RealmModel realm, boolean migrate) static long
SessionExpirationUtils.calculateClientSessionIdleTimestamp
(boolean offline, boolean isRememberMe, long lastRefreshed, RealmModel realm, ClientModel client) Calculates the time in which the user session is expired via the idle configuration in the realm and client.static long
SessionExpirationUtils.calculateClientSessionMaxLifespanTimestamp
(boolean offline, boolean isRememberMe, long clientSessionCreated, long userSessionCreated, RealmModel realm, ClientModel client) Calculates the time in which the client session is expired via lifespan configuration in the realm and client.static long
SessionExpirationUtils.calculateUserSessionIdleTimestamp
(boolean offline, boolean isRememberMe, long lastRefreshed, RealmModel realm) Calculates the time in which the user session is expired via the idle configuration.static long
SessionExpirationUtils.calculateUserSessionMaxLifespanTimestamp
(boolean offline, boolean isRememberMe, long created, RealmModel realm) Calculates the time in which the session is expired via max lifetime configuration.static void
DefaultAuthenticationFlows.clientAuthFlow
(RealmModel realm) static void
DefaultKeyProviders.createAesProvider
(RealmModel realm) static ClientModel
RepresentationToModel.createClient
(KeycloakSession session, RealmModel realm, ClientRepresentation resourceRep) Does not create scope or role mappings!static ClientModel
RepresentationToModel.createClient
(KeycloakSession session, RealmModel realm, ClientRepresentation resourceRep, Map<String, String> mappedFlows) static ClientScopeModel
RepresentationToModel.createClientScope
(KeycloakSession session, RealmModel realm, ClientScopeRepresentation resourceRep) static void
RepresentationToModel.createCredentials
(UserRepresentation userRep, KeycloakSession session, RealmModel realm, UserModel user, boolean adminRequest) static void
DefaultClientScopes.createDefaultClientScopes
(KeycloakSession session, RealmModel realm, boolean addScopesToExistingClients) static void
RepresentationToModel.createFederatedIdentities
(UserRepresentation userRep, KeycloakSession session, RealmModel realm, UserModel user) static void
RepresentationToModel.createGroups
(KeycloakSession session, UserRepresentation userRep, RealmModel newRealm, UserModel user) static ClientModel
KeycloakModelUtils.createManagementClient
(RealmModel realm, String name) static void
DefaultClientScopes.createOfflineAccessClientScope
(RealmModel newRealm, RoleModel offlineRole) static void
DefaultKeyProviders.createProviders
(RealmModel realm) static void
DefaultKeyProviders.createProviders
(RealmModel realm, String privateKeyPem, String certificatePem) static ClientModel
KeycloakModelUtils.createPublicClient
(RealmModel realm, String name) static RoleModel
RepresentationToModel.createRole
(RealmModel newRealm, RoleRepresentation roleRep) static void
RepresentationToModel.createRoleMappings
(UserRepresentation userRep, UserModel user, RealmModel realm) static void
DefaultKeyProviders.createSecretProvider
(RealmModel realm) static UserModel
RepresentationToModel.createUser
(KeycloakSession session, RealmModel newRealm, UserRepresentation userRep) static void
KeycloakModelUtils.deepDeleteAuthenticationFlow
(RealmModel realm, AuthenticationFlowModel authFlow, Runnable flowUnavailableHandler, Runnable builtinFlowHandler) Recursively remove authentication flow (including all subflows and executions) from the model storagestatic void
KeycloakModelUtils.deepFindAuthenticationExecutions
(RealmModel realm, AuthenticationFlowModel flow, List<AuthenticationExecutionModel> result) Recursively find all AuthenticationExecutionModel from specified flow or all it's subflowsstatic void
DefaultAuthenticationFlows.directGrantFlow
(RealmModel realm, boolean migrate) static void
DefaultAuthenticationFlows.dockerAuthenticationFlow
(RealmModel realm) static void
ModelToRepresentation.exportAuthenticationFlows
(KeycloakSession session, RealmModel realm, RealmRepresentation rep) static void
ModelToRepresentation.exportGroups
(KeycloakSession session, RealmModel realm, RealmRepresentation rep) static void
ModelToRepresentation.exportRequiredActions
(RealmModel realm, RealmRepresentation rep) static ClientScopeModel
KeycloakModelUtils.findClientScopeById
(RealmModel realm, ClientModel client, String clientScopeId) Lookup clientScope OR client by id.static GroupModel
KeycloakModelUtils.findGroupByPath
(KeycloakSession session, RealmModel realm, String path) Finds group by path.static GroupModel
KeycloakModelUtils.findGroupByPath
(KeycloakSession session, RealmModel realm, String[] path) Finds group by path.static UserModel
KeycloakModelUtils.findUserByNameOrEmail
(KeycloakSession session, RealmModel realm, String username) Try to find user by username or email for authenticationstatic void
DefaultAuthenticationFlows.firstBrokerLoginFlow
(RealmModel realm, boolean migrate) static long
SessionExpiration.getAuthSessionExpiration
(RealmModel realm, int timestamp) static int
SessionExpiration.getAuthSessionLifespan
(RealmModel realm) static ClientScopeModel
KeycloakModelUtils.getClientScopeByName
(RealmModel realm, String clientScopeName) static RoleModel
KeycloakModelUtils.getRoleFromString
(RealmModel realm, String roleName) static ClientModel
SystemClientUtil.getSystemClient
(RealmModel realm) protected static boolean
DefaultKeyProviders.hasProvider
(RealmModel realm, String providerId) static void
RepresentationToModel.importGroup
(RealmModel realm, GroupModel parent, GroupRepresentation group) static void
RepresentationToModel.importRealm
(KeycloakSession session, RealmRepresentation rep, RealmModel newRealm, boolean skipUserDependent) static void
RepresentationToModel.importRoles
(RolesRepresentation realmRoles, RealmModel realm) static boolean
KeycloakModelUtils.isFlowUsed
(RealmModel realm, AuthenticationFlowModel model) Check to see if a flow is currently in usestatic boolean
RoleUtils.isRealmRole
(RoleModel r, RealmModel realm) static boolean
KeycloakModelUtils.isUsernameCaseSensitive
(RealmModel realm) Returnstrue
if given realm has attributeConstants.REALM_ATTR_USERNAME_CASE_SENSITIVE
set and its value istrue
.static void
DefaultAuthenticationFlows.migrateFlows
(RealmModel realm) static void
ComponentUtil.notifyCreated
(KeycloakSession session, RealmModel realm, ComponentModel model) static void
ComponentUtil.notifyPreRemove
(KeycloakSession session, RealmModel realm, ComponentModel model) static void
ComponentUtil.notifyUpdated
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) static void
DefaultAuthenticationFlows.registrationFlow
(RealmModel realm, boolean migrate) static void
DefaultAuthenticationFlows.resetCredentialsFlow
(RealmModel realm) static void
DefaultAuthenticationFlows.samlEcpProfile
(RealmModel realm) static Stream<GroupModel>
ModelToRepresentation.searchGroupModelsByAttributes
(KeycloakSession session, RealmModel realm, Map<String, String> attributes, Integer first, Integer max) static void
KeycloakModelUtils.setDefaultGroups
(KeycloakSession session, RealmModel realm, Stream<String> groups) Sets the default groups on the realmstatic void
KeycloakModelUtils.setupAuthorizationServices
(RealmModel realm) static void
KeycloakModelUtils.setupDefaultRole
(RealmModel realm, String defaultRoleName) Creates default role for particular realm with the given name.static RoleModel
KeycloakModelUtils.setupOfflineRole
(RealmModel realm) static RealmRepresentation
ModelToRepresentation.toBriefRepresentation
(RealmModel realm) ModelToRepresentation.toBriefRepresentation
(RealmModel realm, IdentityProviderModel identityProviderModel) ModelToRepresentation.toEventsConfigReprensetation
(RealmModel realm) static Stream<GroupRepresentation>
ModelToRepresentation.toGroupHierarchy
(KeycloakSession session, RealmModel realm, boolean full) Deprecated.static AuthenticationExecutionModel
RepresentationToModel.toModel
(KeycloakSession session, RealmModel realm, AuthenticationExecutionRepresentation rep) static IdentityProviderModel
RepresentationToModel.toModel
(RealmModel realm, IdentityProviderRepresentation representation, KeycloakSession session) static UserConsentModel
RepresentationToModel.toModel
(RealmModel newRealm, UserConsentRepresentation consentRep) static RealmRepresentation
ModelToRepresentation.toRepresentation
(KeycloakSession session, RealmModel realm, boolean internal) ModelToRepresentation.toRepresentation
(KeycloakSession session, RealmModel realm, AuthenticationExecutionModel model) ModelToRepresentation.toRepresentation
(KeycloakSession session, RealmModel realm, AuthenticationFlowModel model) static UserRepresentation
ModelToRepresentation.toRepresentation
(KeycloakSession session, RealmModel realm, UserModel user) ModelToRepresentation.toRepresentation
(RealmModel realm, IdentityProviderModel identityProviderModel) static void
RepresentationToModel.updateRealm
(RealmRepresentation rep, RealmModel realm, KeycloakSession session) -
Uses of RealmModel in org.keycloak.partialimport
Methods in org.keycloak.partialimport with parameters of type RealmModelModifier and TypeMethodDescriptionabstract void
AbstractPartialImport.create
(RealmModel realm, KeycloakSession session, T resourceRep) void
ClientsPartialImport.create
(RealmModel realm, KeycloakSession session, ClientRepresentation clientRep) void
GroupsPartialImport.create
(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep) void
IdentityProviderMappersPartialImport.create
(RealmModel realm, KeycloakSession session, IdentityProviderMapperRepresentation idpMapperRep) void
IdentityProvidersPartialImport.create
(RealmModel realm, KeycloakSession session, IdentityProviderRepresentation idpRep) void
RealmRolesPartialImport.create
(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep) void
UsersPartialImport.create
(RealmModel realm, KeycloakSession session, UserRepresentation user) void
ClientRolesPartialImport.deleteRole
(RealmModel realm, String clientId, RoleRepresentation roleRep) AbstractPartialImport.doImport
(PartialImportRepresentation partialImportRep, RealmModel realm, KeycloakSession session) PartialImport.doImport
(PartialImportRepresentation rep, RealmModel realm, KeycloakSession session) Create (or re-create) all the imported resources.RolesPartialImport.doImport
(PartialImportRepresentation rep, RealmModel realm, KeycloakSession session) abstract boolean
AbstractPartialImport.exists
(RealmModel realm, KeycloakSession session, T resourceRep) boolean
ClientRolesPartialImport.exists
(RealmModel realm, KeycloakSession session, String clientId, RoleRepresentation roleRep) boolean
ClientsPartialImport.exists
(RealmModel realm, KeycloakSession session, ClientRepresentation clientRep) boolean
GroupsPartialImport.exists
(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep) boolean
IdentityProviderMappersPartialImport.exists
(RealmModel realm, KeycloakSession session, IdentityProviderMapperRepresentation idpMapperRep) boolean
IdentityProvidersPartialImport.exists
(RealmModel realm, KeycloakSession session, IdentityProviderRepresentation idpRep) boolean
RealmRolesPartialImport.exists
(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep) boolean
UsersPartialImport.exists
(RealmModel realm, KeycloakSession session, UserRepresentation user) abstract String
AbstractPartialImport.existsMessage
(RealmModel realm, T resourceRep) ClientsPartialImport.existsMessage
(RealmModel realm, ClientRepresentation clientRep) GroupsPartialImport.existsMessage
(RealmModel realm, GroupRepresentation groupRep) IdentityProviderMappersPartialImport.existsMessage
(RealmModel realm, IdentityProviderMapperRepresentation idpMapperRep) IdentityProvidersPartialImport.existsMessage
(RealmModel realm, IdentityProviderRepresentation idpRep) RealmRolesPartialImport.existsMessage
(RealmModel realm, RoleRepresentation roleRep) UsersPartialImport.existsMessage
(RealmModel realm, UserRepresentation user) abstract String
AbstractPartialImport.getModelId
(RealmModel realm, KeycloakSession session, T resourceRep) ClientRolesPartialImport.getModelId
(RealmModel realm, String clientId) ClientsPartialImport.getModelId
(RealmModel realm, KeycloakSession session, ClientRepresentation clientRep) GroupsPartialImport.getModelId
(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep) IdentityProviderMappersPartialImport.getModelId
(RealmModel realm, KeycloakSession session, IdentityProviderMapperRepresentation idpMapperRep) IdentityProvidersPartialImport.getModelId
(RealmModel realm, KeycloakSession session, IdentityProviderRepresentation idpRep) RealmRolesPartialImport.getModelId
(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep) UsersPartialImport.getModelId
(RealmModel realm, KeycloakSession session, UserRepresentation user) void
AbstractPartialImport.prepare
(PartialImportRepresentation partialImportRep, RealmModel realm, KeycloakSession session) void
ClientRolesPartialImport.prepare
(PartialImportRepresentation partialImportRep, RealmModel realm, KeycloakSession session) void
PartialImport.prepare
(PartialImportRepresentation rep, RealmModel realm, KeycloakSession session) Find which resources will need to be skipped or overwritten.void
RolesPartialImport.prepare
(PartialImportRepresentation rep, RealmModel realm, KeycloakSession session) abstract void
AbstractPartialImport.remove
(RealmModel realm, KeycloakSession session, T resourceRep) void
ClientsPartialImport.remove
(RealmModel realm, KeycloakSession session, ClientRepresentation clientRep) void
GroupsPartialImport.remove
(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep) void
IdentityProviderMappersPartialImport.remove
(RealmModel realm, KeycloakSession session, IdentityProviderMapperRepresentation idpMapperRep) void
IdentityProvidersPartialImport.remove
(RealmModel realm, KeycloakSession session, IdentityProviderRepresentation idpRep) void
RealmRolesPartialImport.remove
(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep) void
UsersPartialImport.remove
(RealmModel realm, KeycloakSession session, UserRepresentation user) void
AbstractPartialImport.removeOverwrites
(RealmModel realm, KeycloakSession session) void
PartialImport.removeOverwrites
(RealmModel realm, KeycloakSession session) Delete resources that will be overwritten.void
RolesPartialImport.removeOverwrites
(RealmModel realm, KeycloakSession session) Constructors in org.keycloak.partialimport with parameters of type RealmModelModifierConstructorDescriptionPartialImportManager
(PartialImportRepresentation rep, KeycloakSession session, RealmModel realm) RoleHelper
(RealmModel realm) -
Uses of RealmModel in org.keycloak.policy
Methods in org.keycloak.policy with parameters of type RealmModelModifier and TypeMethodDescriptionBlacklistPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) DefaultPasswordPolicyManagerProvider.validate
(RealmModel realm, UserModel user, String password) DigitsPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) ForceExpiredPasswordPolicyProviderFactory.validate
(RealmModel realm, UserModel user, String password) HashAlgorithmPasswordPolicyProviderFactory.validate
(RealmModel realm, UserModel user, String password) HashIterationsPasswordPolicyProviderFactory.validate
(RealmModel realm, UserModel user, String password) HistoryPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) LengthPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) LowerCasePasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) MaxAuthAgePasswordPolicyProviderFactory.validate
(RealmModel realm, UserModel user, String password) MaximumLengthPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) NotEmailPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) NotUsernamePasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) PasswordPolicyManagerProvider.validate
(RealmModel realm, UserModel user, String password) PasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) RecoveryCodesWarningThresholdPasswordPolicyProviderFactory.validate
(RealmModel realm, UserModel user, String password) RegexPatternsPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) SpecialCharsPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) UpperCasePasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) -
Uses of RealmModel in org.keycloak.protocol
Fields in org.keycloak.protocol declared as RealmModelMethods in org.keycloak.protocol with parameters of type RealmModelModifier and TypeMethodDescriptionprotected void
AbstractLoginProtocolFactory.addDefaultClientScopes
(RealmModel realm, Stream<ClientModel> newClients) protected void
AbstractLoginProtocolFactory.addDefaultClientScopes
(RealmModel realm, ClientModel newClient) void
AbstractLoginProtocolFactory.createDefaultClientScopes
(RealmModel newRealm, boolean addScopesToExistingClients) void
LoginProtocolFactory.createDefaultClientScopes
(RealmModel newRealm, boolean addScopesToExistingClients) Called when new realm is createdprotected abstract void
AbstractLoginProtocolFactory.createDefaultClientScopesImpl
(RealmModel newRealm) Impl should create default client scopes.static void
RestartLoginCookie.expireRestartCookie
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, KeycloakSession session) jakarta.ws.rs.core.Response
ClientInstallationProvider.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) default ProtocolMapperModel
ProtocolMapper.getEffectiveModel
(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel) Get effective configuration of protocol mapper.static AuthenticationSessionModel
RestartLoginCookie.restartSession
(KeycloakSession session, RealmModel realm, RootAuthenticationSessionModel rootSession, String expectedClientId, jakarta.ws.rs.core.Cookie cook) default boolean
LoginProtocol.sendPushRevocationPolicyRequest
(RealmModel realm, ClientModel resource, int notBefore, String managementUrl) Send not-before revocation policy to the given client.LoginProtocol.setRealm
(RealmModel realm) static void
RestartLoginCookie.setRestartCookie
(KeycloakSession session, RealmModel realm, ClientConnection connection, jakarta.ws.rs.core.UriInfo uriInfo, AuthenticationSessionModel authSession) 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 RealmModel in org.keycloak.protocol.docker
Methods in org.keycloak.protocol.docker with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
DockerAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) protected void
DockerAuthV2ProtocolFactory.createDefaultClientScopesImpl
(RealmModel newRealm) protected void
DockerAuthenticator.notValidCredentialsAction
(AuthenticationFlowContext context, RealmModel realm, UserModel user) protected void
DockerAuthenticator.nullUserAction
(AuthenticationFlowContext context, RealmModel realm, String userId) DockerAuthV2Protocol.setRealm
(RealmModel realm) protected void
DockerAuthenticator.userDisabledAction
(AuthenticationFlowContext context, RealmModel realm, UserModel user, String eventError) Constructors in org.keycloak.protocol.docker with parameters of type RealmModelModifierConstructorDescriptionDockerAuthV2Protocol
(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.HttpHeaders headers, EventBuilder event) -
Uses of RealmModel in org.keycloak.protocol.docker.installation
Methods in org.keycloak.protocol.docker.installation with parameters of type RealmModelModifier and TypeMethodDescriptionjakarta.ws.rs.core.Response
DockerComposeYamlInstallationProvider.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) jakarta.ws.rs.core.Response
DockerRegistryConfigFileInstallationProvider.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) jakarta.ws.rs.core.Response
DockerVariableOverrideInstallationProvider.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) -
Uses of RealmModel in org.keycloak.protocol.oidc
Fields in org.keycloak.protocol.oidc declared as RealmModelMethods in org.keycloak.protocol.oidc that return RealmModelMethods in org.keycloak.protocol.oidc with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
OIDCLoginProtocolFactory.addAcrClientScope
(RealmModel newRealm) OIDCLoginProtocolFactory.addMicroprofileJWTClientScope
(RealmModel newRealm) Adds themicroprofile-jwt
optional client scope to the specified realm.OIDCLoginProtocolFactory.addRolesClientScope
(RealmModel newRealm) OIDCLoginProtocolFactory.addWebOriginsClientScope
(RealmModel newRealm) boolean
TokenManager.checkTokenValidForIntrospection
(KeycloakSession session, RealmModel realm, AccessToken token, boolean updateTimestamps) Checks if the token is valid.TokenManager.createClientAccessToken
(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx) protected void
OIDCLoginProtocolFactory.createDefaultClientScopesImpl
(RealmModel newRealm) static TokenManager.NotBeforeCheck
TokenManager.NotBeforeCheck.forModel
(KeycloakSession session, RealmModel realmModel, UserModel userModel) static TokenManager.NotBeforeCheck
TokenManager.NotBeforeCheck.forModel
(RealmModel realmModel) TokenManager.getValidOIDCIdentityProvidersForBackchannelLogout
(RealmModel realm, KeycloakSession session, String encodedLogoutToken, LogoutToken logoutToken) protected AccessToken
TokenManager.initToken
(RealmModel realm, ClientModel client, UserModel user, UserSessionModel session, ClientSessionContext clientSessionCtx, jakarta.ws.rs.core.UriInfo uriInfo) static UserModel
TokenManager.lookupUserFromStatelessToken
(KeycloakSession session, RealmModel realm, AccessToken token) Lookup user from the "stateless" token.TokenManager.refreshAccessToken
(KeycloakSession session, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection, RealmModel realm, ClientModel authorizedClient, String encodedRefreshToken, EventBuilder event, jakarta.ws.rs.core.HttpHeaders headers, HttpRequest request) TokenManager.responseBuilder
(RealmModel realm, ClientModel client, EventBuilder event, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx) boolean
OIDCLoginProtocol.sendPushRevocationPolicyRequest
(RealmModel realm, ClientModel resource, int notBefore, String managementUrl) OIDCLoginProtocol.setRealm
(RealmModel realm) TokenManager.validateToken
(KeycloakSession session, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection, RealmModel realm, RefreshToken oldToken, jakarta.ws.rs.core.HttpHeaders headers) TokenManager.verifyIDToken
(KeycloakSession session, RealmModel realm, String encodedIDToken) TokenManager.verifyLogoutToken
(KeycloakSession session, RealmModel realm, String encodedLogoutToken) TokenManager.verifyRefreshToken
(KeycloakSession session, RealmModel realm, ClientModel client, HttpRequest request, String encodedRefreshToken, boolean checkExpiration) Constructors in org.keycloak.protocol.oidc with parameters of type RealmModelModifierConstructorDescriptionAccessTokenResponseBuilder
(RealmModel realm, ClientModel client, EventBuilder event, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx) OIDCLoginProtocol
(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.HttpHeaders headers, EventBuilder event) TokenExchangeContext
(KeycloakSession session, jakarta.ws.rs.core.MultivaluedMap<String, String> formParams, Object cors, RealmModel realm, EventBuilder event, ClientModel client, ClientConnection clientConnection, jakarta.ws.rs.core.HttpHeaders headers, Object tokenManager, Map<String, String> clientAuthAttributes) -
Uses of RealmModel in org.keycloak.protocol.oidc.endpoints
Methods in org.keycloak.protocol.oidc.endpoints with parameters of type RealmModel -
Uses of RealmModel in org.keycloak.protocol.oidc.grants.ciba
Constructors in org.keycloak.protocol.oidc.grants.ciba with parameters of type RealmModelModifierConstructorDescriptionCibaGrantType
(jakarta.ws.rs.core.MultivaluedMap<String, String> formParams, ClientModel client, KeycloakSession session, TokenEndpoint tokenEndpoint, RealmModel realm, EventBuilder event, Cors cors) -
Uses of RealmModel in org.keycloak.protocol.oidc.grants.ciba.channel
Fields in org.keycloak.protocol.oidc.grants.ciba.channel declared as RealmModel -
Uses of RealmModel in org.keycloak.protocol.oidc.grants.ciba.endpoints
Fields in org.keycloak.protocol.oidc.grants.ciba.endpoints declared as RealmModel -
Uses of RealmModel in org.keycloak.protocol.oidc.grants.device
Methods in org.keycloak.protocol.oidc.grants.device with parameters of type RealmModelModifier and TypeMethodDescriptionstatic boolean
DeviceGrantType.approveUserCode
(KeycloakSession session, RealmModel realm, String userCode, String userSessionId, Map<String, String> additionalParams) static boolean
DeviceGrantType.denyUserCode
(KeycloakSession session, RealmModel realm, String userCode) static OAuth2DeviceCodeModel
DeviceGrantType.getDeviceByDeviceCode
(KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, String deviceCode) static void
DeviceGrantType.removeDeviceByUserCode
(KeycloakSession session, RealmModel realm, String userCode) Constructors in org.keycloak.protocol.oidc.grants.device with parameters of type RealmModelModifierConstructorDescriptionDeviceGrantType
(jakarta.ws.rs.core.MultivaluedMap<String, String> formParams, ClientModel client, KeycloakSession session, TokenEndpoint tokenEndpoint, RealmModel realm, EventBuilder event, Cors cors) -
Uses of RealmModel in org.keycloak.protocol.oidc.grants.device.endpoints
Methods in org.keycloak.protocol.oidc.grants.device.endpoints with parameters of type RealmModelModifier and TypeMethodDescriptionstatic OAuth2DeviceCodeModel
DeviceEndpoint.getDeviceByUserCode
(KeycloakSession session, RealmModel realm, String userCode) -
Uses of RealmModel in org.keycloak.protocol.oidc.installation
Methods in org.keycloak.protocol.oidc.installation with parameters of type RealmModelModifier and TypeMethodDescriptionjakarta.ws.rs.core.Response
KeycloakOIDCClientInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.Response
KeycloakOIDCJbossSubsystemClientCliInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.Response
KeycloakOIDCJbossSubsystemClientInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) -
Uses of RealmModel in org.keycloak.protocol.oidc.mappers
Methods in org.keycloak.protocol.oidc.mappers with parameters of type RealmModelModifier and TypeMethodDescriptionAbstractOIDCProtocolMapper.getEffectiveModel
(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel) AllowedWebOriginsProtocolMapper.getEffectiveModel
(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel) AudienceResolveProtocolMapper.getEffectiveModel
(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel) void
AbstractPairwiseSubMapper.validateAdditionalConfig
(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, ProtocolMapperModel mapperModel) Override to add additional configuration validation.void
SHA256PairwiseSubMapper.validateAdditionalConfig
(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, ProtocolMapperModel mapperModel) final void
AbstractPairwiseSubMapper.validateConfig
(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, ProtocolMapperModel mapperModel) void
ScriptBasedOIDCProtocolMapper.validateConfig
(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel) -
Uses of RealmModel in org.keycloak.protocol.oidc.par.endpoints
Fields in org.keycloak.protocol.oidc.par.endpoints declared as RealmModel -
Uses of RealmModel in org.keycloak.protocol.oidc.utils
Methods in org.keycloak.protocol.oidc.utils with parameters of type RealmModelModifier and TypeMethodDescriptionAcrUtils.getAcrLoaMap
(RealmModel realm) static OAuth2CodeParser.ParseResult
OAuth2CodeParser.parseCode
(KeycloakSession session, String code, RealmModel realm, EventBuilder event) Will parse the code and retrieve the corresponding OAuth2Code and AuthenticatedClientSessionModel. -
Uses of RealmModel in org.keycloak.protocol.saml
Fields in org.keycloak.protocol.saml declared as RealmModelMethods in org.keycloak.protocol.saml with parameters of type RealmModelModifier and TypeMethodDescriptionprotected void
SamlProtocolFactory.createDefaultClientScopesImpl
(RealmModel newRealm) SamlSessionUtils.getClientSession
(KeycloakSession session, RealmModel realm, String sessionIndex) static String
SamlService.getIDPMetadataDescriptor
(jakarta.ws.rs.core.UriInfo uriInfo, KeycloakSession session, RealmModel realm) SamlService.getOrCreateLoginSessionForIdpInitiatedSso
(KeycloakSession session, RealmModel realm, ClientModel client, String relayState) Creates a client session object for SAML IdP-initiated SSO session.protected String
SamlProtocol.getResponseIssuer
(RealmModel realm) SamlProtocol.setRealm
(RealmModel realm) Constructors in org.keycloak.protocol.saml with parameters of type RealmModelModifierConstructorDescriptionSAMLDecryptionKeysLocator
(KeycloakSession session, RealmModel realm, String requestedAlgorithm) -
Uses of RealmModel in org.keycloak.protocol.saml.installation
Methods in org.keycloak.protocol.saml.installation with parameters of type RealmModelModifier and TypeMethodDescriptionstatic void
KeycloakSamlClientInstallation.baseXml
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri, SamlClient samlClient, StringBuilder buffer) jakarta.ws.rs.core.Response
KeycloakSamlClientInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.Response
KeycloakSamlSubsystemCliInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.Response
KeycloakSamlSubsystemInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.Response
ModAuthMellonClientInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) jakarta.ws.rs.core.Response
SamlSPDescriptorClientInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) -
Uses of RealmModel in org.keycloak.protocol.saml.mappers
Methods in org.keycloak.protocol.saml.mappers with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
ScriptBasedMapper.validateConfig
(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel) -
Uses of RealmModel in org.keycloak.protocol.saml.profile.ecp.authenticator
Methods in org.keycloak.protocol.saml.profile.ecp.authenticator with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
HttpBasicAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) protected void
HttpBasicAuthenticator.notValidCredentialsAction
(AuthenticationFlowContext context, RealmModel realm, UserModel user) protected void
HttpBasicAuthenticator.nullUserAction
(AuthenticationFlowContext context, RealmModel realm, String user) void
HttpBasicAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) protected void
HttpBasicAuthenticator.userDisabledAction
(AuthenticationFlowContext context, RealmModel realm, UserModel user, String eventError) -
Uses of RealmModel in org.keycloak.services
Methods in org.keycloak.services that return RealmModelMethods in org.keycloak.services with parameters of type RealmModel -
Uses of RealmModel in org.keycloak.services.clientpolicy
Methods in org.keycloak.services.clientpolicy with parameters of type RealmModelModifier and TypeMethodDescriptionClientPolicyManager.getClientPolicies
(RealmModel realm) when getting client policies via Admin REST API, returns the existing client policies set on the realm.DefaultClientPolicyManager.getClientPolicies
(RealmModel realm) ClientPolicyManager.getClientProfiles
(RealmModel realm, boolean includeGlobalProfiles) when getting client profiles via Admin REST API, returns the existing client profiles set on the realm.DefaultClientPolicyManager.getClientProfiles
(RealmModel realm, boolean includeGlobalProfiles) void
ClientPolicyManager.setupClientPoliciesOnCreatedRealm
(RealmModel realm) when creating a realm, adds the default client policies, which should be available on the realm and put them onto the realm as its attribute.void
DefaultClientPolicyManager.setupClientPoliciesOnCreatedRealm
(RealmModel realm) void
ClientPolicyManager.updateClientPolicies
(RealmModel realm, ClientPoliciesRepresentation clientPolicies) when updating client policies via Admin REST API, reads the json representation of the client policies and overrides the existing client policies set on the realm with them.void
DefaultClientPolicyManager.updateClientPolicies
(RealmModel realm, ClientPoliciesRepresentation clientPolicies) void
ClientPolicyManager.updateClientProfiles
(RealmModel realm, ClientProfilesRepresentation clientProfiles) when updating client profiles via Admin REST API, reads the json representation of the client profiles and overrides the existing client profiles set on the realm with them.void
DefaultClientPolicyManager.updateClientProfiles
(RealmModel realm, ClientProfilesRepresentation clientProfiles) void
ClientPolicyManager.updateRealmModelFromRepresentation
(RealmModel realm, RealmRepresentation rep) when importing a realm, or updating a realm, update model from the representation objectvoid
DefaultClientPolicyManager.updateRealmModelFromRepresentation
(RealmModel realm, RealmRepresentation rep) void
ClientPolicyManager.updateRealmRepresentationFromModel
(RealmModel realm, RealmRepresentation rep) when exporting realm, or retrieve the realm for admin REST API, prepares the exported representation of the client profiles and policies.void
DefaultClientPolicyManager.updateRealmRepresentationFromModel
(RealmModel realm, RealmRepresentation rep) -
Uses of RealmModel in org.keycloak.services.clientpolicy.context
Constructors in org.keycloak.services.clientpolicy.context with parameters of type RealmModelModifierConstructorDescriptionDynamicClientRegisterContext
(ClientRegistrationContext context, JsonWebToken token, RealmModel realm) DynamicClientRegisteredContext
(ClientRegistrationContext context, ClientModel registeredClient, JsonWebToken token, RealmModel realm) DynamicClientUnregisterContext
(KeycloakSession session, ClientModel targetClient, JsonWebToken token, RealmModel realm) DynamicClientUpdateContext
(ClientRegistrationContext context, ClientModel proposedClientRepresentation, JsonWebToken token, RealmModel realm) DynamicClientUpdatedContext
(KeycloakSession session, ClientModel updatedClient, JsonWebToken token, RealmModel realm) DynamicClientViewContext
(KeycloakSession session, ClientModel targetClient, JsonWebToken token, RealmModel realm) -
Uses of RealmModel in org.keycloak.services.clientregistration
Methods in org.keycloak.services.clientregistration with parameters of type RealmModelModifier and TypeMethodDescriptionstatic String
ClientRegistrationTokenUtils.createInitialAccessToken
(KeycloakSession session, RealmModel realm, ClientInitialAccessModel model) static String
ClientRegistrationTokenUtils.updateRegistrationAccessToken
(KeycloakSession session, RealmModel realm, ClientModel client, RegistrationAuth registrationAuth) ClientRegistrationTokenUtils.verifyToken
(KeycloakSession session, RealmModel realm, String token) -
Uses of RealmModel in org.keycloak.services.clientregistration.policy
Methods in org.keycloak.services.clientregistration.policy with parameters of type RealmModelModifier and TypeMethodDescriptionstatic void
DefaultClientRegistrationPolicies.addDefaultPolicies
(RealmModel realm) void
AbstractClientRegistrationPolicyFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) -
Uses of RealmModel in org.keycloak.services.clientregistration.policy.impl
Methods in org.keycloak.services.clientregistration.policy.impl with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
MaxClientsClientRegistrationPolicyFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) void
TrustedHostClientRegistrationPolicyFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) -
Uses of RealmModel in org.keycloak.services.managers
Methods in org.keycloak.services.managers that return RealmModelModifier and TypeMethodDescriptionRealmManager.createRealm
(String name) RealmManager.createRealm
(String id, String name) RealmManager.getKeycloakAdminstrationRealm()
Auth.getRealm()
RealmManager.getRealmByName
(String name) protected RealmModel
DefaultBruteForceProtector.getRealmModel
(KeycloakSession session, DefaultBruteForceProtector.LoginEvent event) RealmManager.importRealm
(RealmRepresentation rep) RealmManager.importRealm
(RealmRepresentation rep, boolean skipUserDependent) if "skipUserDependent" is true, then import of any models, which needs users already imported in DB, will be skipped.Methods in org.keycloak.services.managers with parameters of type RealmModelModifier and TypeMethodDescriptionstatic void
UserConsentManager.addConsent
(KeycloakSession session, RealmModel realm, UserModel user, UserConsentModel consent) Add user consent for the user.AppAuthManager.authenticateIdentityCookie
(KeycloakSession session, RealmModel realm) AuthenticationManager.authenticateIdentityCookie
(KeycloakSession session, RealmModel realm) AuthenticationManager.authenticateIdentityCookie
(KeycloakSession session, RealmModel realm, boolean checkActive) 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.backchannelLogoutUserFromClient
(KeycloakSession session, RealmModel realm, UserModel user, ClientModel client, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.HttpHeaders headers) Logout all clientSessions of this user and clientstatic 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 LDAPConfig
LDAPServerCapabilitiesManager.buildLDAPConfig
(TestLdapConnectionRepresentation config, RealmModel realm) void
BruteForceProtector.cleanUpPermanentLockout
(KeycloakSession session, RealmModel realm, UserModel user) Clears any remaining traces of the permanent lockout.void
DefaultBruteForceProtector.cleanUpPermanentLockout
(KeycloakSession session, RealmModel realm, UserModel user) AuthenticationSessionManager.createAuthenticationSession
(RealmModel realm, boolean browserCookie) Creates a fresh authentication session for the given realm .static ClientModel
ClientManager.createClient
(KeycloakSession session, RealmModel realm, ClientRepresentation rep) Should not be called from an import.protected void
RealmManager.createDefaultClientScopes
(RealmModel realm) 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) UserSessionManager.createUserSession
(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState) UserSessionManager.createUserSession
(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) static void
AuthenticationManager.evaluateRequiredActionTriggers
(KeycloakSession session, AuthenticationSessionModel authSession, HttpRequest request, EventBuilder event, RealmModel realm, UserModel user) protected static jakarta.ws.rs.core.Response
AuthenticationManager.executionActions
(KeycloakSession session, AuthenticationSessionModel authSession, HttpRequest request, EventBuilder event, RealmModel realm, UserModel user, Stream<String> requiredActions) static void
AuthenticationManager.expireAuthSessionCookie
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, KeycloakSession session) static void
AuthenticationManager.expireCookie
(RealmModel realm, String cookieName, String path, boolean httpOnly, ClientConnection connection, ServerCookie.SameSiteAttributeValue sameSite, KeycloakSession session) static void
AuthenticationManager.expireIdentityCookie
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, KeycloakSession session) static void
AuthenticationManager.expireOldAuthSessionCookie
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, KeycloakSession session) static void
AuthenticationManager.expireOldIdentityCookie
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, KeycloakSession session) static void
AuthenticationManager.expireRememberMeCookie
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, KeycloakSession session) static boolean
AuthenticationManager.expireUserSessionCookie
(KeycloakSession session, UserSessionModel userSession, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.HttpHeaders headers, ClientConnection connection) void
BruteForceProtector.failedLogin
(RealmModel realm, UserModel user, ClientConnection clientConnection) void
DefaultBruteForceProtector.failedLogin
(RealmModel realm, UserModel user, ClientConnection clientConnection) UserSessionManager.findClientsWithOfflineToken
(RealmModel realm, UserModel user) UserSessionManager.findOfflineSessions
(RealmModel realm, UserModel user) Deprecated.UserSessionManager.findOfflineSessionsStream
(RealmModel realm, UserModel user) UserSessionManager.findOfflineUserSession
(RealmModel realm, String userSessionId) 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 void
AuthenticationManager.finishUnconfirmedUserSession
(KeycloakSession session, RealmModel realm, UserSessionModel userSessionModel) static String
AuthenticationManager.getAccountCookiePath
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo) AuthenticationSessionManager.getAuthenticationSessionByIdAndClient
(RealmModel realm, String authSessionId, ClientModel client, String tabId) static <CLIENT_SESSION extends CommonClientSessionModel>
CLIENT_SESSIONClientSessionCode.getClientSession
(String code, String tabId, KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, Class<CLIENT_SESSION> sessionClass) static UserConsentModel
UserConsentManager.getConsentByClient
(KeycloakSession session, RealmModel realm, UserModel user, String clientInternalId) Returns UserConsentModel given by a user for the client with clientInternalIdstatic Stream<UserConsentModel>
UserConsentManager.getConsentsStream
(KeycloakSession session, RealmModel realm, UserModel user) Obtains the consents associated with the userAuthenticationSessionManager.getCurrentAuthenticationSession
(RealmModel realm, ClientModel client, String tabId) Returns current authentication session if it exists, otherwise returnsnull
.AuthenticationSessionManager.getCurrentRootAuthenticationSession
(RealmModel realm) protected static String
AuthenticationManager.getIdentityCookiePath
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo) static String
AuthenticationManager.getOldCookiePath
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo) RealmManager.getRealmAdminClientId
(RealmModel realm) static String
AuthenticationManager.getRealmCookiePath
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo) static String
AuthenticationManager.getRememberMeUsername
(RealmModel realm, jakarta.ws.rs.core.HttpHeaders headers) AuthenticationSessionManager.getUserSessionFromAuthCookie
(RealmModel realm) UserSessionCrossDCManager.getUserSessionIfExistsRemotely
(AuthenticationSessionManager asm, RealmModel realm) UserSessionCrossDCManager.getUserSessionWithClient
(RealmModel realm, String id, boolean offline, String clientUUID) UserSessionCrossDCManager.getUserSessionWithClient
(RealmModel realm, String id, String clientUUID) static boolean
RealmManager.isAdministrationRealm
(RealmModel realm) static boolean
AuthenticationManager.isOfflineSessionValid
(RealmModel realm, UserSessionModel userSession) boolean
BruteForceProtector.isPermanentlyLockedOut
(KeycloakSession session, RealmModel realm, UserModel user) boolean
DefaultBruteForceProtector.isPermanentlyLockedOut
(KeycloakSession session, RealmModel realm, UserModel user) static boolean
AuthenticationManager.isSessionValid
(RealmModel realm, UserSessionModel userSession) boolean
BruteForceProtector.isTemporarilyDisabled
(KeycloakSession session, RealmModel realm, UserModel user) boolean
DefaultBruteForceProtector.isTemporarilyDisabled
(KeycloakSession session, RealmModel realm, UserModel user) ResourceAdminManager.logoutAll
(RealmModel realm) ResourceAdminManager.logoutClient
(RealmModel realm, ClientModel resource) protected GlobalRequestResult
ResourceAdminManager.logoutClient
(RealmModel realm, ClientModel resource, int notBefore) jakarta.ws.rs.core.Response
ResourceAdminManager.logoutClientSession
(RealmModel realm, ClientModel resource, AuthenticatedClientSessionModel clientSession) protected jakarta.ws.rs.core.Response
ResourceAdminManager.logoutClientSessions
(RealmModel realm, ClientModel resource, List<AuthenticatedClientSessionModel> clientSessions) static UserModel
AuthenticationManager.lookupUserForBruteForceLog
(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authenticationSession) static <CLIENT_SESSION extends CommonClientSessionModel>
ClientSessionCode.ParseResult<CLIENT_SESSION>ClientSessionCode.parseResult
(String code, String tabId, KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, CLIENT_SESSION clientSession) static <CLIENT_SESSION extends CommonClientSessionModel>
ClientSessionCode.ParseResult<CLIENT_SESSION>ClientSessionCode.parseResult
(String code, String tabId, KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, Class<CLIENT_SESSION> sessionClass) ResourceAdminManager.pushClientRevocationPolicy
(RealmModel realm, ClientModel client) ResourceAdminManager.pushRealmRevocationPolicy
(RealmModel realm) protected GlobalRequestResult
ResourceAdminManager.pushRevocationPolicy
(RealmModel realm, ClientModel resource, int notBefore) static Set<LDAPCapabilityRepresentation>
LDAPServerCapabilitiesManager.queryServerCapabilities
(TestLdapConnectionRepresentation config, KeycloakSession session, RealmModel realm) static jakarta.ws.rs.core.Response
AuthenticationManager.redirectAfterSuccessfulFlow
(KeycloakSession session, RealmModel realm, UserSessionModel userSession, ClientSessionContext clientSessionCtx, HttpRequest request, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection clientConnection, EventBuilder event, AuthenticationSessionModel authSession) static jakarta.ws.rs.core.Response
AuthenticationManager.redirectAfterSuccessfulFlow
(KeycloakSession session, RealmModel realm, UserSessionModel userSession, ClientSessionContext clientSessionCtx, HttpRequest request, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection clientConnection, EventBuilder event, AuthenticationSessionModel authSession, LoginProtocol protocol) static jakarta.ws.rs.core.Response
AuthenticationManager.redirectToRequiredActions
(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession, jakarta.ws.rs.core.UriInfo uriInfo, String requiredAction) void
AuthenticationSessionManager.removeAuthenticationSession
(RealmModel realm, AuthenticationSessionModel authSession, boolean expireRestartCookie) boolean
ClientManager.removeClient
(RealmModel realm, ClientModel client) boolean
RealmManager.removeRealm
(RealmModel realm) boolean
AuthenticationSessionManager.removeTabIdInAuthenticationSession
(RealmModel realm, AuthenticationSessionModel authSession) Remove authentication session from root session.static boolean
UserConsentManager.revokeConsentForClient
(KeycloakSession session, RealmModel realm, UserModel user, String clientInternalId) Remove a user consent given by the user and client idprotected jakarta.ws.rs.core.Response
ResourceAdminManager.sendLogoutRequest
(RealmModel realm, ClientModel resource, List<String> adapterSessionIds, List<String> userSessions, int notBefore, String managementUrl) protected boolean
ResourceAdminManager.sendPushRevocationPolicyRequest
(RealmModel realm, ClientModel resource, int notBefore, String managementUrl) protected boolean
ResourceAdminManager.sendTestNodeAvailabilityRequest
(RealmModel realm, ClientModel client, String managementUrl) void
AuthenticationSessionManager.setAuthSessionCookie
(String authSessionId, RealmModel realm) void
RealmManager.setDefaultsForNewRealm
(RealmModel realm) AppAuthManager.BearerTokenAuthenticator.setRealm
(RealmModel realm) void
RealmManager.setupAdminCli
(RealmModel realm) protected void
RealmManager.setupAdminConsole
(RealmModel realm) protected void
RealmManager.setupAdminConsoleLocaleMapper
(RealmModel realm) protected void
RealmManager.setupAuthenticationFlows
(RealmModel realm) void
RealmManager.setupBrokerService
(RealmModel realm) void
RealmManager.setupImpersonationService
(RealmModel realm) void
RealmManager.setupMasterAdminManagement
(RealmModel realm) protected void
RealmManager.setupRealmDefaults
(RealmModel realm) protected void
RealmManager.setupRequiredActions
(RealmModel realm) void
BruteForceProtector.successfulLogin
(RealmModel realm, UserModel user, ClientConnection clientConnection) void
DefaultBruteForceProtector.successfulLogin
(RealmModel realm, UserModel user, ClientConnection clientConnection) static void
LDAPServerCapabilitiesManager.testLDAP
(TestLdapConnectionRepresentation config, KeycloakSession session, RealmModel realm) ResourceAdminManager.testNodesAvailability
(RealmModel realm, ClientModel client) ClientManager.toInstallationRepresentation
(RealmModel realmModel, ClientModel clientModel, URI baseUri) ClientManager.toJBossSubsystemConfig
(RealmModel realmModel, ClientModel clientModel, URI baseUri) void
AuthenticationSessionManager.updateAuthenticationSessionAfterSuccessfulAuthentication
(RealmModel realm, AuthenticationSessionModel authSession) This happens when one browser tab successfully finished authentication (including required actions and consent screen if applicable) Just authenticationSession of the current browser tab is removed from "root authentication session" and other tabs are kept, so authentication can be automatically finished in other browser tabs (typically with authChecker.js javascript)static void
UserConsentManager.updateConsent
(KeycloakSession session, RealmModel realm, UserModel user, UserConsentModel consent) Update client scopes in the stored user consentvoid
RealmManager.updateRealmEventsConfig
(RealmEventsConfigRepresentation rep, RealmModel realm) AuthenticationManager.verifyIdentityToken
(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection, boolean checkActive, boolean checkTokenType, String checkAudience, boolean isCookie, String tokenString, jakarta.ws.rs.core.HttpHeaders headers, TokenVerifier.Predicate<? super AccessToken>... additionalChecks) Constructors in org.keycloak.services.managers with parameters of type RealmModelModifierConstructorDescriptionAuth
(RealmModel realm, AccessToken token, UserModel user, ClientModel client, UserSessionModel session, boolean cookie) ClientSessionCode
(KeycloakSession session, RealmModel realm, CLIENT_SESSION commonLoginSession) -
Uses of RealmModel in org.keycloak.services.migration
Methods in org.keycloak.services.migration with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
DefaultMigrationProvider.addOIDCAcrClientScope
(RealmModel realm) DefaultMigrationProvider.addOIDCMicroprofileJWTClientScope
(RealmModel realm) DefaultMigrationProvider.addOIDCRolesClientScope
(RealmModel realm) DefaultMigrationProvider.addOIDCWebOriginsClientScope
(RealmModel realm) void
DefaultMigrationProvider.setupAdminCli
(RealmModel realm) -
Uses of RealmModel in org.keycloak.services.resources
Fields in org.keycloak.services.resources declared as RealmModelModifier and TypeFieldDescriptionprotected final RealmModel
AbstractSecuredLocalService.realm
protected final RealmModel
PublicRealmResource.realm
Methods in org.keycloak.services.resources with parameters of type RealmModelModifier and TypeMethodDescriptionstatic void
LoginActionsServiceChecks.checkIsUserValid
(KeycloakSession session, RealmModel realm, String userId, Consumer<UserModel> userSetter) Verifies whether the user given by ID both exists in the current realm.static IdentityProvider<?>
IdentityBrokerService.getIdentityProvider
(KeycloakSession session, RealmModel realm, String alias) static PublishedRealmRepresentation
PublicRealmResource.realmRep
(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo) static jakarta.ws.rs.core.Response
LoginActionsService.redirectToAfterBrokerLoginEndpoint
(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, AuthenticationSessionModel authSession, boolean firstBrokerLogin) jakarta.ws.rs.core.Response
IdentityBrokerService.validateUser
(AuthenticationSessionModel authSession, UserModel user, RealmModel realm) Constructors in org.keycloak.services.resources with parameters of type RealmModelModifierConstructorDescriptionLogoutSessionCodeChecks
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, HttpRequest request, ClientConnection clientConnection, KeycloakSession session, EventBuilder event, String code, String clientId, String tabId) SessionCodeChecks
(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, HttpRequest request, ClientConnection clientConnection, KeycloakSession session, EventBuilder event, String authSessionId, String code, String execution, String clientId, String tabId, String flowPath) -
Uses of RealmModel in org.keycloak.services.resources.account
Methods in org.keycloak.services.resources.account with parameters of type RealmModelModifier and TypeMethodDescriptionLinkedAccountsResource.getLinkedAccounts
(KeycloakSession session, RealmModel realm, UserModel user) boolean
PasswordUtil.isConfigured
(KeycloakSession session, RealmModel realm, UserModel user) Deprecated.Instead, usePasswordUtil.isConfigured()
-
Uses of RealmModel in org.keycloak.services.resources.admin
Fields in org.keycloak.services.resources.admin declared as RealmModelModifier and TypeFieldDescriptionprotected final RealmModel
AdminConsole.realm
protected final RealmModel
AttackDetectionResource.realm
protected final RealmModel
ClearKeysCacheResource.realm
protected final RealmModel
ClearRealmCacheResource.realm
protected final RealmModel
ClearUserCacheResource.realm
protected final RealmModel
ClientAttributeCertificateResource.realm
protected final RealmModel
ClientPoliciesResource.realm
protected final RealmModel
ClientProfilesResource.realm
protected RealmModel
ClientResource.realm
protected RealmModel
ClientRoleMappingsResource.realm
protected RealmModel
ClientScopeResource.realm
protected final RealmModel
ClientScopesResource.realm
protected final RealmModel
ClientsResource.realm
protected final RealmModel
ClientStorageProviderResource.realm
protected final RealmModel
ComponentResource.realm
protected final RealmModel
LdapServerCapabilitiesResource.realm
protected final RealmModel
ProtocolMappersResource.realm
protected final RealmModel
RealmAdminResource.realm
protected final RealmModel
RoleMapperResource.realm
protected RealmModel
RoleResource.realm
protected RealmModel
ScopeMappedClientResource.realm
protected RealmModel
ScopeMappedResource.realm
protected final RealmModel
TestLdapConnectionResource.realm
protected final RealmModel
UserProfileResource.realm
protected final RealmModel
UserResource.realm
protected final RealmModel
UsersResource.realm
protected final RealmModel
UserStorageProviderResource.realm
Methods in org.keycloak.services.resources.admin that return RealmModelModifier and TypeMethodDescriptionprotected RealmModel
AdminConsole.getAdminstrationRealm
(RealmManager realmManager) AdminAuth.getRealm()
Methods in org.keycloak.services.resources.admin with parameters of type RealmModelModifier and TypeMethodDescriptionAdminEventBuilder.authRealm
(RealmModel realm) static void
AuthenticationManagementResource.copy
(KeycloakSession session, RealmModel realm, String newName, AuthenticationFlowModel from, AuthenticationFlowModel to) static AuthenticationFlowModel
AuthenticationManagementResource.copyFlow
(KeycloakSession session, RealmModel realm, AuthenticationFlowModel flow, String newName) static Properties
AdminRoot.getMessages
(KeycloakSession session, RealmModel realm, String lang) static Properties
AdminRoot.getMessages
(KeycloakSession session, RealmModel realm, String lang, String... bundles) ClearKeysCacheRealmAdminProvider.getResource
(KeycloakSession session, RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) ClearRealmCacheRealmAdminProvider.getResource
(KeycloakSession session, RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) ClearUserCacheRealmAdminProvider.getResource
(KeycloakSession session, RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) LdapServerCapabilitiesRealmAdminProvider.getResource
(KeycloakSession session, RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) TestLdapConnectionRealmAdminProvider.getResource
(KeycloakSession session, RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) UserStorageProviderRealmAdminProvider.getResource
(KeycloakSession session, RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) static Theme
AdminRoot.getTheme
(KeycloakSession session, RealmModel realm) AdminEventBuilder.realm
(RealmModel realm) protected RealmRepresentation
RealmsAdminResource.toRealmRep
(RealmModel realm, boolean briefRep) static void
GroupResource.updateGroup
(GroupRepresentation rep, GroupModel model, RealmModel realm, KeycloakSession session) protected void
RoleResource.updateRole
(RoleRepresentation rep, RoleModel role, RealmModel realm, KeycloakSession session) Constructors in org.keycloak.services.resources.admin with parameters of type RealmModelModifierConstructorDescriptionAdminAuth
(RealmModel realm, AccessToken token, UserModel user, ClientModel client) AdminEventBuilder
(RealmModel realm, AdminAuth auth, KeycloakSession session, ClientConnection clientConnection) ClientResource
(RealmModel realm, AdminPermissionEvaluator auth, ClientModel clientModel, KeycloakSession session, AdminEventBuilder adminEvent) ClientRoleMappingsResource
(jakarta.ws.rs.core.UriInfo uriInfo, KeycloakSession session, RealmModel realm, AdminPermissionEvaluator auth, RoleMapperModel user, ClientModel client, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck manageCheck, AdminPermissionEvaluator.RequirePermissionCheck viewCheck) ClientScopeEvaluateResource
(KeycloakSession session, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, AdminPermissionEvaluator auth, ClientModel client, ClientConnection clientConnection) ClientScopeResource
(RealmModel realm, AdminPermissionEvaluator auth, ClientScopeModel clientScope, KeycloakSession session, AdminEventBuilder adminEvent) GroupResource
(RealmModel realm, GroupModel group, KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) GroupsResource
(RealmModel realm, KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) IdentityProviderResource
(AdminPermissionEvaluator auth, RealmModel realm, KeycloakSession session, IdentityProviderModel identityProviderModel, AdminEventBuilder adminEvent) IdentityProvidersResource
(RealmModel realm, KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) KeyResource
(RealmModel realm, KeycloakSession session, AdminPermissionEvaluator auth) RoleContainerResource
(KeycloakSession session, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, AdminPermissionEvaluator auth, RoleContainerModel roleContainer, AdminEventBuilder adminEvent) RoleResource
(RealmModel realm) ScopeMappedClientResource
(RealmModel realm, AdminPermissionEvaluator auth, ScopeContainerModel scopeContainer, KeycloakSession session, ClientModel scopedClient, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck managePermission, AdminPermissionEvaluator.RequirePermissionCheck viewPermission) ScopeMappedResource
(RealmModel realm, AdminPermissionEvaluator auth, ScopeContainerModel scopeContainer, KeycloakSession session, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck managePermission, AdminPermissionEvaluator.RequirePermissionCheck viewPermission) -
Uses of RealmModel in org.keycloak.services.resources.admin.ext
Methods in org.keycloak.services.resources.admin.ext with parameters of type RealmModelModifier and TypeMethodDescriptionAdminRealmResourceProvider.getResource
(KeycloakSession session, RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) Returns a JAX-RS resource instance. -
Uses of RealmModel in org.keycloak.services.resources.admin.permissions
Methods in org.keycloak.services.resources.admin.permissions with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
RealmsPermissionEvaluator.canView
(RealmModel realm) static AdminPermissionEvaluator
AdminPermissions.evaluator
(KeycloakSession session, RealmModel realm, RealmModel adminsRealm, UserModel admin) static AdminPermissionEvaluator
AdminPermissions.evaluator
(KeycloakSession session, RealmModel realm, AdminAuth auth) boolean
RealmsPermissionEvaluator.isAdmin
(RealmModel realm) static AdminPermissionManagement
AdminPermissions.management
(KeycloakSession session, RealmModel realm) static RealmsPermissionEvaluator
AdminPermissions.realms
(KeycloakSession session, RealmModel adminsRealm, UserModel admin) -
Uses of RealmModel in org.keycloak.services.util
Methods in org.keycloak.services.util with parameters of type RealmModelModifier and TypeMethodDescriptionstatic Properties
LocaleUtil.enhancePropertiesWithRealmLocalizationTexts
(RealmModel realm, Locale locale, Map<Locale, Properties> themeMessages) Enhance the properties from a theme with realm localization texts.static UserSessionModel
UserSessionUtil.findValidSession
(KeycloakSession session, RealmModel realm, AccessToken token, EventBuilder event, ClientModel client) static Map<Locale,
Properties> LocaleUtil.getRealmLocalizationTexts
(RealmModel realm, Locale locale) static void
LocaleUtil.processLocaleParam
(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession) Constructors in org.keycloak.services.util with parameters of type RealmModelModifierConstructorDescriptionAuthenticationFlowURLHelper
(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo) -
Uses of RealmModel in org.keycloak.sessions
Methods in org.keycloak.sessions that return RealmModelModifier and TypeMethodDescriptionCommonClientSessionModel.getRealm()
RootAuthenticationSessionModel.getRealm()
Returns realm associated to the root authentication session.Methods in org.keycloak.sessions with parameters of type RealmModelModifier and TypeMethodDescriptionAuthenticationSessionProvider.createRootAuthenticationSession
(RealmModel realm) Creates and registers a new authentication session with random ID.AuthenticationSessionProvider.createRootAuthenticationSession
(RealmModel realm, String id) Creates a new root authentication session specified by the provided realm and id.AuthenticationSessionProvider.getRootAuthenticationSession
(RealmModel realm, String authenticationSessionId) Returns the root authentication session specified by the provided realm and id.void
AuthenticationSessionProvider.onClientRemoved
(RealmModel realm, ClientModel client) Removes all associated root authentication sessions to the given realm and client which was removed.void
AuthenticationSessionProvider.onRealmRemoved
(RealmModel realm) Removes all associated root authentication sessions to the given realm which was removed.void
AuthenticationSessionProvider.removeExpired
(RealmModel realm) Deprecated.manual removal of expired entities should not be used anymore.void
AuthenticationSessionProvider.removeRootAuthenticationSession
(RealmModel realm, RootAuthenticationSessionModel authenticationSession) Removes provided root authentication session.void
RootAuthenticationSessionModel.restartSession
(RealmModel realm) Will completely restart whole state of authentication session. -
Uses of RealmModel in org.keycloak.social.twitter
Fields in org.keycloak.social.twitter declared as RealmModelModifier and TypeFieldDescriptionprotected final RealmModel
TwitterIdentityProvider.Endpoint.realm
Methods in org.keycloak.social.twitter with parameters of type RealmModelModifier and TypeMethodDescriptionTwitterIdentityProvider.callback
(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event) -
Uses of RealmModel in org.keycloak.storage
Methods in org.keycloak.storage that return RealmModelModifier and TypeMethodDescriptionstatic RealmModel
ImportRealmFromRepresentationEvent.fire
(KeycloakSession session, RealmRepresentation rep) Deprecated.LegacyStoreMigrateRepresentationEvent.getRealm()
LegacyStoreSyncEvent.getRealm()
PartialImportRealmFromRepresentationEvent.getRealm()
Deprecated.ImportRealmFromRepresentationEvent.getRealmModel()
Deprecated.SetDefaultsForNewRealm.getRealmModel()
ExportImportManager.importRealm
(InputStream requestBody) Methods in org.keycloak.storage with parameters of type RealmModelModifier and TypeMethodDescriptionClientStorageManager.addClient
(RealmModel realm, String clientId) ClientStorageManager.addClient
(RealmModel realm, String id, String clientId) ClientScopeStorageManager.addClientScope
(RealmModel realm, String id, String name) void
ClientStorageManager.addClientScopes
(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) void
UserStorageManager.addConsent
(RealmModel realm, String userId, UserConsentModel consent) void
UserStorageManager.addFederatedIdentity
(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) RoleStorageManager.addRealmRole
(RealmModel realm, String name) RoleStorageManager.addRealmRole
(RealmModel realm, String id, String name) void
GroupStorageManager.addTopLevelGroup
(RealmModel realm, GroupModel subGroup) UserStorageManager.addUser
(RealmModel realm, String username) UserRegistrationProvider
methods implementations start hereUserStorageManager.addUser
(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) UserStorageProvider
methods implementation end hereUserProvider
methods implementations start here -> no StorageProviders involvedprotected <T> void
AbstractStorageManager.consumeEnabledStorageProvidersWithTimeout
(RealmModel realm, Class<T> capabilityInterface, Consumer<T> consumer) Gets all enabled StorageProviders that implements the capabilityInterface and call applyFunction on each !! Each StorageProvider has a limited time for consuming !!GroupStorageManager.createGroup
(RealmModel realm, String id, String name, GroupModel toParent) ExportImportManager.createUser
(RealmModel realm, UserRepresentation userRep) protected void
UserStorageManager.deleteInvalidUser
(RealmModel realm, UserModel user) void
ExportImportManager.exportRealm
(RealmModel realm, ExportOptions options, ExportAdapter callback) static void
LegacyStoreMigrateRepresentationEvent.fire
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) static void
LegacyStoreSyncEvent.fire
(KeycloakSession session, RealmModel realm, boolean removed) static PartialImportResults
PartialImportRealmFromRepresentationEvent.fire
(KeycloakSession session, PartialImportRepresentation rep, RealmModel realm) Deprecated.static void
SetDefaultsForNewRealm.fire
(KeycloakSession session, RealmModel realm) protected <R,
T> Stream<R> AbstractStorageManager.flatMapEnabledStorageProvidersWithTimeout
(RealmModel realm, Class<T> capabilityInterface, Function<T, ? extends Stream<R>> applyFunction) Gets all enabled StorageProviders that implements the capabilityInterface, applies applyFunction on each of them and then join the results together.ClientStorageManager.getAllRedirectUrisOfEnabledClients
(RealmModel realm) ClientStorageManager.getAlwaysDisplayInConsoleClientsStream
(RealmModel realm) ClientStorageManager.getClientByClientId
(RealmModel realm, String clientId) ClientStorageManager.getClientById
(RealmModel realm, String id) ClientScopeStorageManager.getClientScopeById
(RealmModel realm, String id) ClientStorageManager.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScopes) ClientScopeStorageManager.getClientScopesStream
(RealmModel realm) long
ClientStorageManager.getClientsCount
(RealmModel realm) ClientStorageManager.getClientsStream
(RealmModel realm) ClientStorageManager.getClientsStream
(RealmModel realm, Integer firstResult, Integer maxResults) UserStorageManager.getConsentByClient
(RealmModel realm, String userId, String clientInternalId) UserStorageManager.getConsentsStream
(RealmModel realm, String userId) protected <T> Stream<T>
AbstractStorageManager.getEnabledStorageProviders
(RealmModel realm, Class<T> capabilityInterface) Returns stream of all storageProviders within the realm that implements the capabilityInterface.static <T> Stream<T>
ClientStorageManager.getEnabledStorageProviders
(KeycloakSession session, RealmModel realm, Class<T> type) static <T> Stream<T>
RoleStorageManager.getEnabledStorageProviders
(KeycloakSession session, RealmModel realm, Class<T> type) UserStorageManager.getFederatedIdentitiesStream
(RealmModel realm, UserModel user) UserStorageManager.getFederatedIdentity
(RealmModel realm, UserModel user, String socialProvider) GroupStorageManager.getGroupById
(RealmModel realm, String id) GroupStorageManager.getGroupByName
(RealmModel realm, GroupModel parent, String name) UserStorageManager.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) UserLookupProvider
methods implementations end hereUserQueryProvider
methods implementation start hereGroupStorageManager.getGroupsByRoleStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) GroupStorageManager.getGroupsCount
(RealmModel realm, Boolean onlyTopGroups) GroupStorageManager.getGroupsCountByNameContaining
(RealmModel realm, String search) GroupStorageManager.getGroupsStream
(RealmModel realm) GroupStorageManager.getGroupsStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) int
UserStorageManager.getNotBeforeOfUser
(RealmModel realm, UserModel user) RoleStorageManager.getRealmRole
(RealmModel realm, String name) RoleStorageManager.getRealmRolesStream
(RealmModel realm, Integer first, Integer max) RoleStorageManager.getRoleById
(RealmModel realm, String id) UserStorageManager.getRoleMembersStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) RoleStorageManager.getRolesStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) static ClientStorageProvider
ClientStorageManager.getStorageProvider
(KeycloakSession session, RealmModel realm, String componentId) static RoleStorageProvider
RoleStorageManager.getStorageProvider
(KeycloakSession session, RealmModel realm, String componentId) protected <T> T
AbstractStorageManager.getStorageProviderInstance
(RealmModel realm, String providerId, Class<T> capabilityInterface) protected <T> T
AbstractStorageManager.getStorageProviderInstance
(RealmModel realm, String providerId, Class<T> capabilityInterface, boolean includeDisabled) Returns an instance of provider with the providerId within the realm or null if storage provider with providerId doesn't implement capabilityInterface.protected StorageProviderModelType
AbstractStorageManager.getStorageProviderModel
(RealmModel realm, String providerId) Returns an instance of StorageProvider model corresponding realm and providerIdstatic ClientStorageProviderModel
ClientStorageManager.getStorageProviderModel
(RealmModel realm, String componentId) static RoleStorageProviderModel
RoleStorageManager.getStorageProviderModel
(RealmModel realm, String componentId) static Stream<ComponentModel>
AbstractStorageManager.getStorageProviderModels
(RealmModel realm, Class<? extends Provider> storageType) Stream of ComponentModels of storageType.static <T> Stream<T>
ClientStorageManager.getStorageProviders
(KeycloakSession session, RealmModel realm, Class<T> type) static <T> Stream<T>
RoleStorageManager.getStorageProviders
(KeycloakSession session, RealmModel realm, Class<T> type) static <T> Stream<RoleStorageProviderModel>
RoleStorageManager.getStorageProviders
(RealmModel realm, KeycloakSession session, Class<T> type) GroupStorageManager.getTopLevelGroupsStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) UserStorageManager.getUserByCredential
(RealmModel realm, CredentialInput input) UserStorageManager.getUserByEmail
(RealmModel realm, String email) UserStorageManager.getUserByFederatedIdentity
(RealmModel realm, FederatedIdentityModel socialLink) UserStorageManager.getUserById
(RealmModel realm, String id) UserRegistrationProvider
methods implementations end hereUserLookupProvider
methods implementations start hereUserStorageManager.getUserByUsername
(RealmModel realm, String username) int
UserStorageManager.getUsersCount
(RealmModel realm) int
UserStorageManager.getUsersCount
(RealmModel realm, boolean includeServiceAccount) int
UserStorageManager.getUsersCount
(RealmModel realm, String search) int
UserStorageManager.getUsersCount
(RealmModel realm, String search, Set<String> groupIds) int
UserStorageManager.getUsersCount
(RealmModel realm, Map<String, String> params) int
UserStorageManager.getUsersCount
(RealmModel realm, Map<String, String> params, Set<String> groupIds) int
UserStorageManager.getUsersCount
(RealmModel realm, Set<String> groupIds) void
UserStorageManager.grantToAllUsers
(RealmModel realm, RoleModel role) UserQueryProvider
methods implementation end hereUserBulkUpdateProvider
methods implementation start herestatic boolean
ClientStorageManager.hasEnabledStorageProviders
(KeycloakSession session, RealmModel realm, Class<?> type) void
ExportImportManager.importRealm
(RealmRepresentation rep, RealmModel newRealm, boolean skipUserDependent) UserStorageManager.importValidation
(RealmModel realm, Stream<UserModel> users) protected UserModel
UserStorageManager.importValidation
(RealmModel realm, UserModel user) Allows a UserStorageProvider to proxy and/or synchronize an imported user.static boolean
ClientStorageManager.isStorageProviderEnabled
(RealmModel realm, String providerId) static boolean
RoleStorageManager.isStorageProviderEnabled
(RealmModel realm, String providerId) protected <R,
T> Stream<R> AbstractStorageManager.mapEnabledStorageProvidersWithTimeout
(RealmModel realm, Class<T> capabilityInterface, Function<T, R> applyFunction) Gets all enabled StorageProviders that implements the capabilityInterface, applies applyFunction on each of them and returns the stream.void
MigrationManager.migrate
(RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) void
GroupStorageManager.moveGroup
(RealmModel realm, GroupModel group, GroupModel toParent) void
UserStorageManager.onCache
(RealmModel realm, CachedUserModel user, UserModel delegate) void
OnCreateComponent.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) void
UserStorageManager.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) default void
UserStorageProviderFactory.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) Called when UserStorageProviderModel is created.void
OnUpdateComponent.onUpdate
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) void
UserStorageManager.onUpdate
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) ExportImportManager.partialImportRealm
(RealmModel realm, InputStream requestBody) void
UserStorageManager.preRemove
(RealmModel realm) UserBulkUpdateProvider
methods implementation end hereUserStorageProvider
methods implementations start here -> no StorageProviders involvedvoid
UserStorageManager.preRemove
(RealmModel realm, ComponentModel component) void
UserStorageManager.preRemove
(RealmModel realm, ClientModel client) void
UserStorageManager.preRemove
(RealmModel realm, GroupModel group) void
UserStorageManager.preRemove
(RealmModel realm, IdentityProviderModel provider) void
UserStorageManager.preRemove
(RealmModel realm, RoleModel role) default void
UserStorageProvider.preRemove
(RealmModel realm) Callback when a realm is removed.default void
UserStorageProvider.preRemove
(RealmModel realm, GroupModel group) Callback when a group is removed.default void
UserStorageProvider.preRemove
(RealmModel realm, RoleModel role) Callback when a role is removed.protected Stream<ClientModel>
ClientStorageManager.query
(org.keycloak.storage.ClientStorageManager.PaginatedQuery paginatedQuery, RealmModel realm, Integer firstResult, Integer maxResults) UserStorageManager.query
(org.keycloak.storage.UserStorageManager.PaginatedQuery pagedQuery, RealmModel realm, Integer firstResult, Integer maxResults) UserStorageManager.query
(org.keycloak.storage.UserStorageManager.PaginatedQuery pagedQuery, org.keycloak.storage.UserStorageManager.CountQuery countQuery, RealmModel realm, Integer firstResult, Integer maxResults) boolean
ClientStorageManager.removeClient
(RealmModel realm, String id) void
ClientStorageManager.removeClients
(RealmModel realm) boolean
ClientScopeStorageManager.removeClientScope
(RealmModel realm, String id) void
ClientStorageManager.removeClientScope
(RealmModel realm, ClientModel client, ClientScopeModel clientScope) void
ClientScopeStorageManager.removeClientScopes
(RealmModel realm) boolean
UserStorageManager.removeFederatedIdentity
(RealmModel realm, UserModel user, String socialProvider) boolean
GroupStorageManager.removeGroup
(RealmModel realm, GroupModel group) void
UserStorageManager.removeImportedUsers
(RealmModel realm, String storageProviderId) void
RoleStorageManager.removeRoles
(RealmModel realm) boolean
UserStorageManager.removeUser
(RealmModel realm, UserModel user) boolean
UserStorageManager.revokeConsentForClient
(RealmModel realm, String userId, String clientInternalId) ClientStorageManager.searchClientsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) ClientStorageManager.searchClientsByAuthenticationFlowBindingOverrides
(RealmModel realm, Map<String, String> overrides, Integer firstResult, Integer maxResults) ClientStorageManager.searchClientsByClientIdStream
(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) RoleStorageManager.searchForClientRolesStream
(RealmModel realm, String search, Stream<String> excludedIds, Integer first, Integer max) RoleStorageManager.searchForClientRolesStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) GroupStorageManager.searchForGroupByNameStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) Obtaining groups from an external client storage is time-bounded.RoleStorageManager.searchForRolesStream
(RealmModel realm, String search, Integer first, Integer max) Obtaining roles from an external role storage is time-bounded.UserStorageManager.searchForUserByUserAttributeStream
(RealmModel realm, String attrName, String attrValue) UserStorageManager.searchForUserStream
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) GroupStorageManager.searchGroupsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) void
UserStorageManager.setNotBeforeForUser
(RealmModel realm, UserModel user, int notBefore) void
ImportRealmFromRepresentationEvent.setRealmModel
(RealmModel realmModel) Deprecated.void
UserStorageManager.unlinkUsers
(RealmModel realm, String storageProviderId) void
UserStorageManager.updateConsent
(RealmModel realm, String userId, UserConsentModel consent) void
UserStorageManager.updateFederatedIdentity
(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) void
ExportImportManager.updateRealm
(RealmRepresentation rep, RealmModel realm) default void
UserStorageProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) Constructors in org.keycloak.storage with parameters of type RealmModelModifierConstructorDescriptionLegacyStoreMigrateRepresentationEvent
(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) LegacyStoreSyncEvent
(KeycloakSession session, RealmModel realm, boolean removed) PartialImportRealmFromRepresentationEvent
(KeycloakSession session, PartialImportRepresentation rep, RealmModel realm) Deprecated.SetDefaultsForNewRealm
(KeycloakSession session, RealmModel realmModel) -
Uses of RealmModel in org.keycloak.storage.adapter
Fields in org.keycloak.storage.adapter declared as RealmModelModifier and TypeFieldDescriptionprotected RealmModel
AbstractInMemoryUserAdapter.realm
protected RealmModel
AbstractUserAdapter.realm
protected RealmModel
AbstractUserAdapterFederatedStorage.realm
Constructors in org.keycloak.storage.adapter with parameters of type RealmModelModifierConstructorDescriptionprotected
AbstractInMemoryUserAdapter
(KeycloakSession session, RealmModel realm, String id) AbstractUserAdapter
(KeycloakSession session, RealmModel realm, ComponentModel storageProviderModel) AbstractUserAdapterFederatedStorage
(KeycloakSession session, RealmModel realm, ComponentModel storageProviderModel) InMemoryUserAdapter
(KeycloakSession session, RealmModel realm, String id) Streams
(KeycloakSession session, RealmModel realm, ComponentModel storageProviderModel) Streams
(KeycloakSession session, RealmModel realm, ComponentModel storageProviderModel) Deprecated. -
Uses of RealmModel in org.keycloak.storage.client
Fields in org.keycloak.storage.client declared as RealmModelMethods in org.keycloak.storage.client that return RealmModelMethods in org.keycloak.storage.client with parameters of type RealmModelModifier and TypeMethodDescriptionClientLookupProvider.getClientByClientId
(RealmModel realm, String clientId) Exact search for a client by its public client identifier.ClientLookupProvider.getClientById
(RealmModel realm, String id) Exact search for a client by its internal ID.ClientLookupProvider.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScopes) Return all default scopes (ifdefaultScope
istrue
) or all optional scopes (ifdefaultScope
isfalse
) linked with the clientdefault void
ClientStorageProviderFactory.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) Called when ClientStorageProviderModel is created.default void
ClientStorageProvider.preRemove
(RealmModel realm) Callback when a realm is removed.default void
ClientStorageProvider.preRemove
(RealmModel realm, GroupModel group) Callback when a group is removed.default void
ClientStorageProvider.preRemove
(RealmModel realm, RoleModel role) Callback when a role is removed.ClientLookupProvider.searchClientsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) default Stream<ClientModel>
ClientLookupProvider.searchClientsByAuthenticationFlowBindingOverrides
(RealmModel realm, Map<String, String> overrides, Integer firstResult, Integer maxResults) ClientLookupProvider.searchClientsByClientIdStream
(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) Case-insensitive search for clients that contain the given string in their public client identifier.default void
ClientStorageProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) Constructors in org.keycloak.storage.client with parameters of type RealmModelModifierConstructorDescriptionAbstractClientStorageAdapter
(KeycloakSession session, RealmModel realm, ClientStorageProviderModel component) AbstractReadOnlyClientStorageAdapter
(KeycloakSession session, RealmModel realm, ClientStorageProviderModel component) -
Uses of RealmModel in org.keycloak.storage.clientscope
Methods in org.keycloak.storage.clientscope with parameters of type RealmModelModifier and TypeMethodDescriptionClientScopeLookupProvider.getClientScopeById
(RealmModel realm, String id) Exact search for a client scope by its internal ID..default void
ClientScopeStorageProviderFactory.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) Called when ClientScopeStorageProviderFactory is created.default void
ClientScopeStorageProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) -
Uses of RealmModel in org.keycloak.storage.datastore
Methods in org.keycloak.storage.datastore that return RealmModelMethods in org.keycloak.storage.datastore with parameters of type RealmModelModifier and TypeMethodDescriptionstatic ComponentModel
LegacyExportImportManager.convertFedMapperToComponent
(RealmModel realm, ComponentModel parent, UserFederationMapperRepresentation rep, String newMapperType) static void
LegacyExportImportManager.createClientScopeMappings
(RealmModel realm, ClientModel clientModel, List<ScopeMappingRepresentation> mappings) LegacyExportImportManager.createUser
(RealmModel newRealm, UserRepresentation userRep) void
LegacyExportImportManager.exportRealm
(RealmModel realm, ExportOptions options, ExportAdapter callback) LegacyExportImportManager.importAuthenticationFlows
(KeycloakSession session, RealmModel newRealm, RealmRepresentation rep) protected static void
LegacyExportImportManager.importComponents
(RealmModel newRealm, MultivaluedHashMap<String, ComponentExportRepresentation> components, String parentId) static void
LegacyExportImportManager.importFederatedUser
(KeycloakSession session, RealmModel newRealm, UserRepresentation userRep) static void
LegacyExportImportManager.importGroups
(RealmModel realm, RealmRepresentation rep) void
LegacyExportImportManager.importRealm
(RealmRepresentation rep, RealmModel newRealm, boolean skipUserDependent) static void
LegacyExportImportManager.importRealmAuthorizationSettings
(RealmRepresentation rep, RealmModel newRealm, KeycloakSession session) static void
LegacyExportImportManager.importUserFederationProvidersAndMappers
(KeycloakSession session, RealmRepresentation rep, RealmModel newRealm) void
LegacyMigrationManager.migrate
(RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) LegacyExportImportManager.partialImportRealm
(RealmModel realm, InputStream requestBody) static void
LegacyExportImportManager.renameRealm
(RealmModel realm, String name) void
LegacyExportImportManager.updateRealm
(RealmRepresentation rep, RealmModel realm) -
Uses of RealmModel in org.keycloak.storage.federated
Methods in org.keycloak.storage.federated with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
UserConsentFederatedStorage.addConsent
(RealmModel realm, String userId, UserConsentModel consent) void
UserBrokerLinkFederatedStorage.addFederatedIdentity
(RealmModel realm, String userId, FederatedIdentityModel socialLink) void
UserRequiredActionsFederatedStorage.addRequiredAction
(RealmModel realm, String userId, String action) UserFederatedUserCredentialStore.createCredential
(RealmModel realm, String userId, CredentialModel cred) void
UserRoleMappingsFederatedStorage.deleteRoleMapping
(RealmModel realm, String userId, RoleModel role) UserAttributeFederatedStorage.getAttributes
(RealmModel realm, String userId) UserConsentFederatedStorage.getConsentByClient
(RealmModel realm, String userId, String clientInternalId) UserConsentFederatedStorage.getConsentsStream
(RealmModel realm, String userId) Obtains the consents associated with the federated user identified byuserId
.UserBrokerLinkFederatedStorage.getFederatedIdentitiesStream
(String userId, RealmModel realm) Obtains the identities of the federated user identified byuserId
.UserBrokerLinkFederatedStorage.getFederatedIdentity
(String userId, String socialProvider, RealmModel realm) UserGroupMembershipFederatedStorage.getGroupsStream
(RealmModel realm, String userId) Obtains the groups associated with the federated user.UserGroupMembershipFederatedStorage.getMembershipStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer max) Obtains the federated users that are members of the givengroup
in the specifiedrealm
.int
UserNotBeforeFederatedStorage.getNotBeforeOfUser
(RealmModel realm, String userId) UserRequiredActionsFederatedStorage.getRequiredActionsStream
(RealmModel realm, String userId) Obtains the names of required actions associated with the federated user identified byuserId
.UserRoleMappingsFederatedStorage.getRoleMappingsStream
(RealmModel realm, String userId) Obtains the roles associated with the federated user identified byuserId
.UserRoleMappingsFederatedStorage.getRoleMembersStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer max) Obtains the federated users that are members of the givenrole
in the specifiedrealm
.UserFederatedUserCredentialStore.getStoredCredentialById
(RealmModel realm, String userId, String id) UserFederatedUserCredentialStore.getStoredCredentialByNameAndType
(RealmModel realm, String userId, String name, String type) UserFederatedUserCredentialStore.getStoredCredentialsByTypeStream
(RealmModel realm, String userId, String type) Obtains the credentials of typetype
that are associated with the federated user identified byuserId
.UserFederatedUserCredentialStore.getStoredCredentialsStream
(RealmModel realm, String userId) Obtains the credentials associated with the federated user identified byuserId
.int
UserFederatedStorageProvider.getStoredUsersCount
(RealmModel realm) UserFederatedStorageProvider.getStoredUsersStream
(RealmModel realm, Integer first, Integer max) Obtains the ids of all federated users in the realm.UserBrokerLinkFederatedStorage.getUserByFederatedIdentity
(FederatedIdentityModel socialLink, RealmModel realm) UserAttributeFederatedStorage.getUsersByUserAttributeStream
(RealmModel realm, String name, String value) Searches for federated users that have an attribute with the specifiedname
andvalue
.void
UserRoleMappingsFederatedStorage.grantRole
(RealmModel realm, String userId, RoleModel role) void
UserGroupMembershipFederatedStorage.joinGroup
(RealmModel realm, String userId, GroupModel group) void
UserGroupMembershipFederatedStorage.leaveGroup
(RealmModel realm, String userId, GroupModel group) void
UserBrokerLinkFederatedStorage.preRemove
(RealmModel realm, IdentityProviderModel provider) void
UserFederatedStorageProvider.preRemove
(RealmModel realm) void
UserFederatedStorageProvider.preRemove
(RealmModel realm, ComponentModel model) void
UserFederatedStorageProvider.preRemove
(RealmModel realm, ClientModel client) void
UserFederatedStorageProvider.preRemove
(RealmModel realm, GroupModel group) void
UserFederatedStorageProvider.preRemove
(RealmModel realm, RoleModel role) void
UserFederatedStorageProvider.preRemove
(RealmModel realm, UserModel user) void
UserAttributeFederatedStorage.removeAttribute
(RealmModel realm, String userId, String name) boolean
UserBrokerLinkFederatedStorage.removeFederatedIdentity
(RealmModel realm, String userId, String socialProvider) void
UserRequiredActionsFederatedStorage.removeRequiredAction
(RealmModel realm, String userId, String action) boolean
UserFederatedUserCredentialStore.removeStoredCredential
(RealmModel realm, String userId, String id) boolean
UserConsentFederatedStorage.revokeConsentForClient
(RealmModel realm, String userId, String clientInternalId) void
UserAttributeFederatedStorage.setAttribute
(RealmModel realm, String userId, String name, List<String> values) void
UserNotBeforeFederatedStorage.setNotBeforeForUser
(RealmModel realm, String userId, int notBefore) void
UserAttributeFederatedStorage.setSingleAttribute
(RealmModel realm, String userId, String name, String value) void
UserConsentFederatedStorage.updateConsent
(RealmModel realm, String userId, UserConsentModel consent) void
UserFederatedUserCredentialStore.updateCredential
(RealmModel realm, String userId, CredentialModel cred) void
UserBrokerLinkFederatedStorage.updateFederatedIdentity
(RealmModel realm, String userId, FederatedIdentityModel federatedIdentityModel) -
Uses of RealmModel in org.keycloak.storage.group
Methods in org.keycloak.storage.group with parameters of type RealmModelModifier and TypeMethodDescriptionGroupLookupProvider.getGroupById
(RealmModel realm, String id) Returns a group from the given realm with the corresponding iddefault GroupModel
GroupLookupProvider.getGroupByName
(RealmModel realm, GroupModel parent, String name) Returns a group from the given realm with the corresponding name and parentdefault void
GroupStorageProviderFactory.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) Called when GroupStorageProviderModel is created.GroupLookupProvider.searchForGroupByNameStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) Returns the group hierarchy with the given string in name for the given realm.default Stream<GroupModel>
GroupLookupProvider.searchForGroupByNameStream
(RealmModel realm, String search, Integer firstResult, Integer maxResults) Deprecated.GroupLookupProvider.searchGroupsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) Returns the groups filtered by attribute names and attribute values for the given realm.default void
GroupStorageProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) -
Uses of RealmModel in org.keycloak.storage.jpa
Methods in org.keycloak.storage.jpa with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
JpaUserFederatedStorageProvider.addConsent
(RealmModel realm, String userId, UserConsentModel consent) void
JpaUserFederatedStorageProvider.addFederatedIdentity
(RealmModel realm, String userId, FederatedIdentityModel link) void
JpaUserFederatedStorageProvider.addRequiredAction
(RealmModel realm, String userId, String action) JpaUserFederatedStorageProvider.createCredential
(RealmModel realm, String userId, CredentialModel cred) JpaUserFederatedStorageProvider.createCredential
(RealmModel realm, UserModel user, CredentialModel cred) protected void
JpaUserFederatedStorageProvider.createIndex
(RealmModel realm, String userId) We create an entry so that its easy to iterate over all things in the database.void
JpaUserFederatedStorageProvider.deleteRoleMapping
(RealmModel realm, String userId, RoleModel role) JpaUserFederatedStorageProvider.getAttributes
(RealmModel realm, String userId) JpaUserFederatedStorageProvider.getConsentByClient
(RealmModel realm, String userId, String clientInternalId) JpaUserFederatedStorageProvider.getConsentsStream
(RealmModel realm, String userId) JpaUserFederatedStorageProvider.getFederatedIdentitiesStream
(String userId, RealmModel realm) JpaUserFederatedStorageProvider.getFederatedIdentity
(String userId, String socialProvider, RealmModel realm) JpaUserFederatedStorageProvider.getGroupsStream
(RealmModel realm, String userId) JpaUserFederatedStorageProvider.getMembershipStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer max) int
JpaUserFederatedStorageProvider.getNotBeforeOfUser
(RealmModel realm, String userId) JpaUserFederatedStorageProvider.getRequiredActionsStream
(RealmModel realm, String userId) JpaUserFederatedStorageProvider.getRoleMappingsStream
(RealmModel realm, String userId) JpaUserFederatedStorageProvider.getRoleMembersStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer max) JpaUserFederatedStorageProvider.getStoredCredentialById
(RealmModel realm, String userId, String id) JpaUserFederatedStorageProvider.getStoredCredentialById
(RealmModel realm, UserModel user, String id) JpaUserFederatedStorageProvider.getStoredCredentialByNameAndType
(RealmModel realm, String userId, String name, String type) JpaUserFederatedStorageProvider.getStoredCredentialByNameAndType
(RealmModel realm, UserModel user, String name, String type) JpaUserFederatedStorageProvider.getStoredCredentialsByTypeStream
(RealmModel realm, String userId, String type) JpaUserFederatedStorageProvider.getStoredCredentialsByTypeStream
(RealmModel realm, UserModel user, String type) JpaUserFederatedStorageProvider.getStoredCredentialsStream
(RealmModel realm, String userId) JpaUserFederatedStorageProvider.getStoredCredentialsStream
(RealmModel realm, UserModel user) int
JpaUserFederatedStorageProvider.getStoredUsersCount
(RealmModel realm) JpaUserFederatedStorageProvider.getStoredUsersStream
(RealmModel realm, Integer first, Integer max) JpaUserFederatedStorageProvider.getUserByFederatedIdentity
(FederatedIdentityModel link, RealmModel realm) JpaUserFederatedStorageProvider.getUsersByUserAttributeStream
(RealmModel realm, String name, String value) void
JpaUserFederatedStorageProvider.grantRole
(RealmModel realm, String userId, RoleModel role) void
JpaUserFederatedStorageProvider.joinGroup
(RealmModel realm, String userId, GroupModel group) void
JpaUserFederatedStorageProvider.leaveGroup
(RealmModel realm, String userId, GroupModel group) boolean
JpaUserFederatedStorageProvider.moveCredentialTo
(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) void
JpaUserFederatedStorageProvider.preRemove
(RealmModel realm) void
JpaUserFederatedStorageProvider.preRemove
(RealmModel realm, ComponentModel model) void
JpaUserFederatedStorageProvider.preRemove
(RealmModel realm, ClientModel client) void
JpaUserFederatedStorageProvider.preRemove
(RealmModel realm, GroupModel group) void
JpaUserFederatedStorageProvider.preRemove
(RealmModel realm, IdentityProviderModel provider) void
JpaUserFederatedStorageProvider.preRemove
(RealmModel realm, RoleModel role) void
JpaUserFederatedStorageProvider.preRemove
(RealmModel realm, UserModel user) void
JpaUserFederatedStorageProvider.removeAttribute
(RealmModel realm, String userId, String name) boolean
JpaUserFederatedStorageProvider.removeFederatedIdentity
(RealmModel realm, String userId, String socialProvider) void
JpaUserFederatedStorageProvider.removeRequiredAction
(RealmModel realm, String userId, String action) boolean
JpaUserFederatedStorageProvider.removeStoredCredential
(RealmModel realm, String userId, String id) boolean
JpaUserFederatedStorageProvider.removeStoredCredential
(RealmModel realm, UserModel user, String id) boolean
JpaUserFederatedStorageProvider.revokeConsentForClient
(RealmModel realm, String userId, String clientInternalId) void
JpaUserFederatedStorageProvider.setAttribute
(RealmModel realm, String userId, String name, List<String> values) void
JpaUserFederatedStorageProvider.setNotBeforeForUser
(RealmModel realm, String userId, int notBefore) void
JpaUserFederatedStorageProvider.setSingleAttribute
(RealmModel realm, String userId, String name, String value) void
JpaUserFederatedStorageProvider.updateConsent
(RealmModel realm, String userId, UserConsentModel consent) void
JpaUserFederatedStorageProvider.updateCredential
(RealmModel realm, String userId, CredentialModel cred) void
JpaUserFederatedStorageProvider.updateCredential
(RealmModel realm, UserModel user, CredentialModel cred) void
JpaUserFederatedStorageProvider.updateFederatedIdentity
(RealmModel realm, String userId, FederatedIdentityModel model) -
Uses of RealmModel in org.keycloak.storage.ldap
Methods in org.keycloak.storage.ldap with parameters of type RealmModelModifier and TypeMethodDescriptionLDAPStorageProvider.addUser
(RealmModel realm, String username) static LDAPObject
LDAPUtils.addUserToLDAP
(LDAPStorageProvider ldapProvider, RealmModel realm, UserModel user) Method to crate a user in the LDAP.static LDAPObject
LDAPUtils.addUserToLDAP
(LDAPStorageProvider ldapProvider, RealmModel realm, UserModel user, Consumer<LDAPObject> consumerOnCreated) Method that creates a user in the LDAP when all the attributes marked as mandatory by the mappers are set.LDAPStorageProvider.authenticate
(RealmModel realm, CredentialInput cred) static LDAPQuery
LDAPUtils.createQueryForUserSearch
(LDAPStorageProvider ldapProvider, RealmModel realm) void
LDAPStorageProvider.disableCredentialType
(RealmModel realm, UserModel user, String credentialType) protected UserModel
LDAPStorageProvider.findOrCreateAuthenticatedUser
(RealmModel realm, KerberosPrincipal kerberosPrincipal) Called after successful kerberos authenticationLDAPStorageProvider.getDisableableCredentialTypesStream
(RealmModel realm, UserModel user) LDAPStorageProvider.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) LDAPStorageProvider.getRoleMembersStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) LDAPStorageProvider.getUserByEmail
(RealmModel realm, String email) LDAPStorageProvider.getUserById
(RealmModel realm, String id) LDAPStorageProvider.getUserByUsername
(RealmModel realm, String username) protected UserModel
LDAPStorageProvider.importUserFromLDAP
(KeycloakSession session, RealmModel realm, LDAPObject ldapUser) boolean
LDAPStorageProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
LDAPStorageProvider.isValid
(RealmModel realm, UserModel user, CredentialInput input) protected LDAPObject
LDAPStorageProvider.loadAndValidateUser
(RealmModel realm, UserModel local) LDAPStorageProvider.loadLDAPUserByUsername
(RealmModel realm, String username) LDAPStorageProvider.loadLDAPUserByUuid
(RealmModel realm, String uuid) LDAPStorageProvider.loadUsersByUsernames
(List<String> usernames, RealmModel realm) void
LDAPStorageProviderFactory.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) void
LDAPStorageProviderFactory.onUpdate
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) void
LDAPStorageProvider.preRemove
(RealmModel realm) void
LDAPStorageProvider.preRemove
(RealmModel realm, GroupModel group) void
LDAPStorageProvider.preRemove
(RealmModel realm, RoleModel role) void
LDAPStorageProviderFactory.preRemove
(KeycloakSession session, RealmModel realm, ComponentModel model) protected UserModel
LDAPStorageProvider.proxy
(RealmModel realm, UserModel local, LDAPObject ldapObject, boolean newUser) protected LDAPObject
LDAPStorageProvider.queryByEmail
(RealmModel realm, String email) boolean
LDAPStorageProvider.removeUser
(RealmModel realm, UserModel user) LDAPStorageProvider.searchForUserByUserAttributeStream
(RealmModel realm, String attrName, String attrValue) LDAPStorageProvider.searchForUserStream
(RealmModel realm, Map<String, String> params, Integer firstResult, Integer maxResults) It supportsUserModel.FIRST_NAME
UserModel.LAST_NAME
UserModel.EMAIL
UserModel.USERNAME
Other fields are not supported.boolean
LDAPStorageProvider.updateCredential
(RealmModel realm, UserModel user, CredentialInput input) LDAPStorageProvider.validate
(RealmModel realm, UserModel local) void
LDAPStorageProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) boolean
LDAPStorageProvider.validPassword
(RealmModel realm, UserModel user, String password) -
Uses of RealmModel in org.keycloak.storage.ldap.mappers
Methods in org.keycloak.storage.ldap.mappers with parameters of type RealmModelModifier and TypeMethodDescriptionprotected void
UserAttributeLDAPStorageMapper.checkDuplicateEmail
(String userModelAttrName, String email, RealmModel realm, KeycloakSession session, UserModel user) protected void
UserAttributeLDAPStorageMapper.checkDuplicateUsername
(String userModelAttrName, String username, RealmModel realm, KeycloakSession session, UserModel user) protected String
HardcodedLDAPAttributeMapper.computeAttributeValue
(String ldapAttrName, String ldapAttrValue, LDAPObject ldapUser, UserModel localUser, RealmModel realm) CertificateLDAPStorageMapperFactory.getConfigProperties
(RealmModel realm, ComponentModel parent) FullNameLDAPStorageMapperFactory.getConfigProperties
(RealmModel realm, ComponentModel parent) UserAttributeLDAPStorageMapperFactory.getConfigProperties
(RealmModel realm, ComponentModel parent) AbstractLDAPStorageMapper.getGroupMembers
(RealmModel realm, GroupModel group, int firstResult, int maxResults) LDAPStorageMapper.getGroupMembers
(RealmModel realm, GroupModel group, int firstResult, int maxResults) Return empty list if doesn't support storing of groupsAbstractLDAPStorageMapper.getRoleMembers
(RealmModel realm, RoleModel role, int firstResult, int maxResults) LDAPStorageMapper.getRoleMembers
(RealmModel realm, RoleModel role, int firstResult, int maxResults) Return empty list if doesn't support storing of rolesboolean
AbstractLDAPStorageMapper.onAuthenticationFailure
(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) boolean
LDAPStorageMapper.onAuthenticationFailure
(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) Called when LDAP authentication of specified user fails.default void
LDAPStorageMapperFactory.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) Called when UserStorageProviderModel is created.void
FullNameLDAPStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
HardcodedAttributeMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
HardcodedLDAPAttributeMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
HardcodedLDAPGroupStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
HardcodedLDAPRoleStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
LDAPStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) Called when importing user from LDAP to local keycloak DB.void
UserAttributeLDAPStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) default void
LDAPStorageMapperFactory.onParentUpdate
(RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel) void
FullNameLDAPStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
HardcodedAttributeMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
HardcodedLDAPAttributeMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
HardcodedLDAPGroupStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
HardcodedLDAPRoleStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
LDAPStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) Called when register new user to LDAP - just after user was created in Keycloak DBvoid
UserAttributeLDAPStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) FullNameLDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedAttributeMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedLDAPAttributeMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedLDAPGroupStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedLDAPRoleStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) LDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Called when invoke proxy on LDAP federation providerUserAttributeLDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) AbstractLDAPStorageMapper.syncDataFromFederationProviderToKeycloak
(RealmModel realm) LDAPStorageMapper.syncDataFromFederationProviderToKeycloak
(RealmModel realm) Sync data from federated storage to Keycloak.AbstractLDAPStorageMapper.syncDataFromKeycloakToFederationProvider
(RealmModel realm) LDAPStorageMapper.syncDataFromKeycloakToFederationProvider
(RealmModel realm) Sync data from Keycloak back to federated storagevoid
CertificateLDAPStorageMapperFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) void
FullNameLDAPStorageMapperFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) void
HardcodedAttributeMapperFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) void
HardcodedLDAPAttributeMapperFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) void
HardcodedLDAPGroupStorageMapperFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) void
HardcodedLDAPRoleStorageMapperFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) default void
LDAPStorageMapperFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) void
UserAttributeLDAPStorageMapperFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) -
Uses of RealmModel in org.keycloak.storage.ldap.mappers.membership
Methods in org.keycloak.storage.ldap.mappers.membership with parameters of type RealmModelModifier and TypeMethodDescriptionMembershipType.getGroupMembers
(RealmModel realm, CommonLDAPGroupMapper groupMapper, LDAPObject ldapGroup, int firstResult, int maxResults) -
Uses of RealmModel in org.keycloak.storage.ldap.mappers.membership.group
Methods in org.keycloak.storage.ldap.mappers.membership.group with parameters of type RealmModelModifier and TypeMethodDescriptionvoid
GroupLDAPStorageMapper.addGroupMappingInLDAP
(RealmModel realm, GroupModel kcGroup, LDAPObject ldapUser) protected GroupModel
GroupLDAPStorageMapper.createKcGroup
(RealmModel realm, String ldapGroupName, GroupModel parentGroup) Creates a new KC group from given LDAP group name in given KC parent group or the groups path.protected GroupModel
GroupLDAPStorageMapper.findKcGroupByLDAPGroup
(RealmModel realm, GroupModel parent, LDAPObject ldapGroup) protected GroupModel
GroupLDAPStorageMapper.findKcGroupOrSyncFromLDAP
(RealmModel realm, GroupModel parent, LDAPObject ldapGroup, UserModel user) protected Stream<GroupModel>
GroupLDAPStorageMapper.getAllKcGroups
(RealmModel realm, GroupModel topParentGroup) Provides a stream of all KC groups (with their sub groups) from groups path configured by the "Groups Path" configuration property.GroupLDAPStorageMapperFactory.getConfigProperties
(RealmModel realm, ComponentModel parent) GroupLDAPStorageMapper.getGroupMembers
(RealmModel realm, GroupModel kcGroup, int firstResult, int maxResults) protected GroupModel
GroupLDAPStorageMapper.getKcGroupsPathGroup
(RealmModel realm) Provides KC group defined as groups path or null (top-level group) if corresponding group is not available.protected Stream<GroupModel>
GroupLDAPStorageMapper.getKcSubGroups
(RealmModel realm, GroupModel parentGroup) Provides a list of all KC sub groups from given parent group or from groups path.void
GroupLDAPStorageMapperFactory.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) void
GroupLDAPStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
GroupLDAPStorageMapperFactory.onParentUpdate
(RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel) void
GroupLDAPStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
GroupLDAPStorageMapperFactory.onUpdate
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) GroupLDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) GroupLDAPStorageMapper.syncDataFromFederationProviderToKeycloak
(RealmModel realm) GroupLDAPStorageMapper.syncDataFromKeycloakToFederationProvider
(RealmModel realm) void
GroupLDAPStorageMapperFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) Constructors in org.keycloak.storage.ldap.mappers.membership.group with parameters of type RealmModelModifierConstructorDescriptionLDAPGroupMappingsUserDelegate
(RealmModel realm, UserModel user, LDAPObject ldapUser) -
Uses of RealmModel in org.keycloak.storage.ldap.mappers.membership.role
Methods in org.keycloak.storage.ldap.mappers.membership.role with parameters of type RealmModelModifier and TypeMethodDescriptionRoleLDAPStorageMapperFactory.getConfigProperties
(RealmModel realm, ComponentModel parent) RoleLDAPStorageMapper.getRoleMembers
(RealmModel realm, RoleModel role, int firstResult, int maxResults) protected RoleContainerModel
RoleLDAPStorageMapper.getTargetRoleContainer
(RealmModel realm) void
RoleLDAPStorageMapperFactory.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) void
RoleLDAPStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
RoleLDAPStorageMapperFactory.onParentUpdate
(RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel) void
RoleLDAPStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
RoleLDAPStorageMapperFactory.onUpdate
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) RoleLDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) RoleLDAPStorageMapper.syncDataFromFederationProviderToKeycloak
(RealmModel realm) RoleLDAPStorageMapper.syncDataFromKeycloakToFederationProvider
(RealmModel realm) void
RoleLDAPStorageMapperFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) Constructors in org.keycloak.storage.ldap.mappers.membership.role with parameters of type RealmModelModifierConstructorDescriptionLDAPRoleMappingsUserDelegate
(RealmModel realm, UserModel user, LDAPObject ldapUser, RoleContainerModel targetRoleContainer) -
Uses of RealmModel in org.keycloak.storage.ldap.mappers.msad
Methods in org.keycloak.storage.ldap.mappers.msad with parameters of type RealmModelModifier and TypeMethodDescriptionMSADUserAccountControlStorageMapperFactory.getConfigProperties
(RealmModel realm, ComponentModel parent) boolean
MSADUserAccountControlStorageMapper.onAuthenticationFailure
(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) void
MSADUserAccountControlStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
MSADUserAccountControlStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) MSADUserAccountControlStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) -
Uses of RealmModel in org.keycloak.storage.ldap.mappers.msadlds
Methods in org.keycloak.storage.ldap.mappers.msadlds with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
MSADLDSUserAccountControlStorageMapper.onAuthenticationFailure
(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) void
MSADLDSUserAccountControlStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
MSADLDSUserAccountControlStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) MSADLDSUserAccountControlStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) -
Uses of RealmModel in org.keycloak.storage.managers
Methods in org.keycloak.storage.managers with parameters of type RealmModelModifier and TypeMethodDescriptionstatic void
UserStorageSyncManager.notifyToRefreshPeriodicSync
(KeycloakSession session, RealmModel realm, UserStorageProviderModel provider, boolean removed) static void
UserStorageSyncManager.notifyToRefreshPeriodicSyncAll
(KeycloakSession session, RealmModel realm, boolean removed) static void
UserStorageSyncManager.notifyToRefreshPeriodicSyncSingle
(KeycloakSession session, RealmModel realm, ComponentModel component, boolean removed) -
Uses of RealmModel in org.keycloak.storage.role
Methods in org.keycloak.storage.role with parameters of type RealmModelModifier and TypeMethodDescriptionRoleLookupProvider.getRealmRole
(RealmModel realm, String name) Exact search for a role by given name.RoleLookupProvider.getRoleById
(RealmModel realm, String id) Exact search for a role by its internal ID..default void
RoleStorageProviderFactory.onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) Called when RoleStorageProviderModel is created.RoleLookupProvider.searchForClientRolesStream
(RealmModel realm, String search, Stream<String> excludedIds, Integer first, Integer max) Case-insensitive search for client roles that contain the given string in their name or their client's public identifier (clientId - (client_id
in OIDC orentityID
in SAML)).RoleLookupProvider.searchForClientRolesStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) Case-insensitive search for client roles that contain the given string in its name or their client's public identifier (clientId - (client_id
in OIDC orentityID
in SAML)).RoleLookupProvider.searchForRolesStream
(RealmModel realm, String search, Integer first, Integer max) Case-insensitive search for roles that contain the given string in their name or description.default void
RoleStorageProviderFactory.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) -
Uses of RealmModel in org.keycloak.storage.user
Methods in org.keycloak.storage.user with parameters of type RealmModelModifier and TypeMethodDescriptionUserRegistrationProvider.addUser
(RealmModel realm, String username) All storage providers that implement this interface will be looped through.UserQueryMethodsProvider.getGroupMembersStream
(RealmModel realm, GroupModel group) Obtains users that belong to a specific group.UserQueryMethodsProvider.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) Obtains users that belong to a specific group.UserQueryMethodsProvider.getRoleMembersStream
(RealmModel realm, RoleModel role) Obtains users that have the specified role.UserQueryMethodsProvider.getRoleMembersStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) Searches for users that have the specified role.default CredentialValidationOutput
UserLookupProvider.getUserByCredential
(RealmModel realm, CredentialInput input) UserLookupProvider.getUserByEmail
(RealmModel realm, String email) Returns a user with the given email belonging to the realmUserLookupProvider.getUserById
(RealmModel realm, String id) Returns a user with the given id belonging to the realmUserLookupProvider.getUserByUsername
(RealmModel realm, String username) Exact search for a user by its username.default int
UserCountMethodsProvider.getUsersCount
(RealmModel realm) Returns the number of users, without consider any service account.default int
UserCountMethodsProvider.getUsersCount
(RealmModel realm, boolean includeServiceAccount) Returns the number of users.default int
UserCountMethodsProvider.getUsersCount
(RealmModel realm, String search) Deprecated.UseUserCountMethodsProvider.getUsersCount(RealmModel, Map)
with anparams
map containingUserModel.SEARCH
instead.default int
UserCountMethodsProvider.getUsersCount
(RealmModel realm, String search, Set<String> groupIds) Deprecated.UseUserCountMethodsProvider.getUsersCount(RealmModel, Map, Set)
with anparams
map containingUserModel.SEARCH
instead.default int
UserCountMethodsProvider.getUsersCount
(RealmModel realm, Map<String, String> params) Returns the number of users that match the given filter parameters.default int
UserCountMethodsProvider.getUsersCount
(RealmModel realm, Map<String, String> params, Set<String> groupIds) Returns the number of users that match the given filter parameters and is in at least one of the given groups.default int
UserCountMethodsProvider.getUsersCount
(RealmModel realm, Set<String> groupIds) Returns the number of users that are in at least one of the groups given.void
UserBulkUpdateProvider.grantToAllUsers
(RealmModel realm, RoleModel role) Grants the given role to all users from particular realm.boolean
UserRegistrationProvider.removeUser
(RealmModel realm, UserModel user) Called if user originated from this provider.UserQueryMethodsProvider.searchForUserByUserAttributeStream
(RealmModel realm, String attrName, String attrValue) Searches for users that have a specific attribute with a specific value.UserQueryMethodsProvider.searchForUserStream
(RealmModel realm, String search) Deprecated.UseUserQueryMethodsProvider.searchForUserStream(RealmModel, Map)
with anparams
map containingUserModel.SEARCH
instead.UserQueryMethodsProvider.searchForUserStream
(RealmModel realm, String search, Integer firstResult, Integer maxResults) Deprecated.UseUserQueryMethodsProvider.searchForUserStream(RealmModel, Map, Integer, Integer)
with anparams
map containingUserModel.SEARCH
instead.UserQueryMethodsProvider.searchForUserStream
(RealmModel realm, Map<String, String> params) Searches for user by parameter.UserQueryMethodsProvider.searchForUserStream
(RealmModel realm, Map<String, String> params, Integer firstResult, Integer maxResults) Searches for user by parameter.ImportedUserValidation.validate
(RealmModel realm, UserModel user) If this method returns null, then the user in local storage will be removed -
Uses of RealmModel in org.keycloak.theme
Methods in org.keycloak.theme with parameters of type RealmModelModifier and TypeMethodDescriptionClassLoaderTheme.getEnhancedMessages
(RealmModel realm, Locale locale) FolderTheme.getEnhancedMessages
(RealmModel realm, Locale locale) Theme.getEnhancedMessages
(RealmModel realm, Locale locale) Retrieve localized messages from a message bundle named "messages" and enhance those messages with messages from realm localization. -
Uses of RealmModel in org.keycloak.theme.beans
Constructors in org.keycloak.theme.beans with parameters of type RealmModelModifierConstructorDescriptionLocaleBean
(RealmModel realm, Locale current, jakarta.ws.rs.core.UriBuilder uriBuilder, Properties messages) -
Uses of RealmModel in org.keycloak.userprofile
Methods in org.keycloak.userprofile with parameters of type RealmModelModifier and TypeMethodDescriptionboolean
DeclarativeUserProfileProvider.isEnabled
(RealmModel realm) boolean
UserProfileProvider.isEnabled
(RealmModel realm) Deprecated.should be removed onceDeclarativeUserProfileProvider
becomes the default.void
DeclarativeUserProfileProvider.validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel model) -
Uses of RealmModel in org.keycloak.utils
Methods in org.keycloak.utils with parameters of type RealmModelModifier and TypeMethodDescriptionstatic boolean
CredentialHelper.createOTPCredential
(KeycloakSession session, RealmModel realm, UserModel user, String totpCode, OTPCredentialModel credentialModel) Create OTP credential either in userStorage or local storage (Keycloak DB)static void
CredentialHelper.deleteOTPCredential
(KeycloakSession session, RealmModel realm, UserModel user, String credentialId) static Stream<GroupRepresentation>
GroupUtils.populateGroupHierarchyFromSubGroups
(KeycloakSession session, RealmModel realm, Stream<GroupModel> groups, boolean full, GroupPermissionEvaluator groupEvaluator) This method takes the provided groups and attempts to load their parents all the way to the root group while maintaining the hierarchy data for each GroupRepresentation object.static String
TotpUtils.qrCode
(String totpSecret, RealmModel realm, UserModel user) OAuth2Error.realm
(RealmModel realm) static void
CredentialHelper.setAlternativeCredential
(KeycloakSession session, String type, RealmModel realm) static void
CredentialHelper.setOrReplaceAuthenticationRequirement
(KeycloakSession session, RealmModel realm, String type, AuthenticationExecutionModel.Requirement requirement, AuthenticationExecutionModel.Requirement currentRequirement) static void
CredentialHelper.setRequiredCredential
(KeycloakSession session, String type, RealmModel realm)
UserSessionProvider.createUserSession(String, RealmModel, UserModel, String, String, String, boolean, String, String, UserSessionModel.SessionPersistenceState)
instead.