Uses of Interface
org.keycloak.models.RealmModel
Packages that use RealmModel
Package
Description
Fine-grained Authorization SPI.
Provides classes related with the representation and management of identities.
-
Uses of RealmModel in org.keycloak.authentication
Fields in org.keycloak.authentication declared as RealmModelModifier and TypeFieldDescriptionprotected RealmModelAuthenticationProcessor.realmprotected RealmModelRequiredActionContextResult.realmMethods 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 booleanAuthenticator.areRequiredActionsEnabled(KeycloakSession session, RealmModel realm) Checks if all required actions are configured in the realm and are enabledstatic ClientSessionContextAuthenticationProcessor.attachSession(AuthenticationSessionModel authSession, UserSessionModel userSession, KeycloakSession session, RealmModel realm, ClientConnection connection, EventBuilder event) booleanAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) Is this authenticator configured for this user.booleanFormAction.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) static AuthenticationFlowModelAuthenticatorUtil.getTopParentFlow(RealmModel realm, AuthenticationExecutionModel executionModel) Useful if we need to find top-level flow from executionModelAuthenticationProcessor.setRealm(RealmModel realm) voidAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticatorvoidFormAction.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticatordefault voidRequiredActionFactory.validateConfig(KeycloakSession session, RealmModel realm, RequiredActionConfigModel model) Allows users to validate the provided configuration for this required action.Constructors 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, String clientData, 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 TypeMethodDescriptionbooleanAttemptedAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidAttemptedAuthenticator.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 TypeMethodDescriptionbooleanAllowAccessAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanDenyAccessAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidAllowAccessAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidDenyAccessAuthenticator.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 TypeMethodDescriptionbooleanIdpAutoLinkAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanIdpConfirmLinkAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanIdpConfirmOverrideLinkAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanIdpCreateUserIfUniqueAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanIdpDetectExistingBrokerUserAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanIdpEmailVerificationAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanIdpReviewProfileAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) static UserModelAbstractIdpAuthenticator.getExistingUser(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession) voidAbstractIdpAuthenticator.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 TypeMethodDescriptionbooleanCookieAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanIdentityProviderAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanOTPFormAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanPasswordForm.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanRecoveryAuthnCodesFormAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanScriptBasedAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanSpnegoAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanUsernamePasswordForm.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanWebAuthnAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidConditionalOtpFormAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidCookieAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidIdentityProviderAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidOTPFormAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidRecoveryAuthnCodesFormAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidScriptBasedAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidSpnegoAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidUsernamePasswordForm.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidWebAuthnAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidWebAuthnPasswordlessAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.authenticators.client
Fields in org.keycloak.authentication.authenticators.client declared as RealmModel -
Uses of RealmModel in org.keycloak.authentication.authenticators.conditional
Methods in org.keycloak.authentication.authenticators.conditional with parameters of type RealmModelModifier and TypeMethodDescriptiondefault booleanConditionalAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidConditionalClientScopeAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidConditionalCredentialAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidConditionalLoaAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidConditionalRoleAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidConditionalSubFlowExecutedAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidConditionalUserAttributeValue.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidConditionalUserConfiguredAuthenticator.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 TypeMethodDescriptionbooleanValidateOTP.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanValidatePassword.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanValidateUsername.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidValidateOTP.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidValidatePassword.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidValidateUsername.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 TypeMethodDescriptionbooleanAbstractSetRequiredActionAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanResetCredentialChooseUser.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanResetCredentialEmail.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanResetOTP.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) static LongResetCredentialEmail.getLastChangedTimestamp(KeycloakSession session, RealmModel realm, UserModel user) voidAbstractSetRequiredActionAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidResetCredentialChooseUser.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidResetCredentialEmail.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 TypeMethodDescriptionbooleanUserSessionLimitsAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidUserSessionLimitsAuthenticator.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 TypeMethodDescriptionLoAUtil.getCredentialTypesToLoAMap(KeycloakSession session, RealmModel realm, AuthenticationFlowModel topFlow) Return map where: - keys are credential types corresponding to authenticators available in given authentication flow - values are LoA levels of those credentials in the given flow (If not step-up authentication is used, values will be always Constants.NO_LOA) For instance if we have password as level1 and OTP or WebAuthn as available level2 authenticators it can return map like: { "password" -> 1, "otp" -> 2 "webauthn" -> 2 }static StringAuthenticatorUtils.getDisabledByBruteForceEventError(BruteForceProtector protector, KeycloakSession session, RealmModel realm, UserModel user) LoAUtil.getLoAConfiguredInRealmBrowserFlow(RealmModel realm) LoAUtil.getLoaMaxAgesConfiguredInRealmBrowserFlow(RealmModel realm) LoAUtil.getLoaMaxAgesConfiguredInRealmFlow(RealmModel realm, String flowId) -
Uses of RealmModel in org.keycloak.authentication.authenticators.x509
Methods in org.keycloak.authentication.authenticators.x509 with parameters of type RealmModelModifier and TypeMethodDescriptionbooleanAbstractX509ClientCertificateAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidAbstractX509ClientCertificateAuthenticator.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 TypeMethodDescriptionbooleanAbstractRegistrationRecaptcha.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanRegistrationPassword.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanRegistrationTermsAndConditions.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanRegistrationUserCreation.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidAbstractRegistrationRecaptcha.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidRegistrationPassword.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidRegistrationTermsAndConditions.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidRegistrationUserCreation.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.authentication.requiredactions
Methods in org.keycloak.authentication.requiredactions with parameters of type RealmModelModifier and TypeMethodDescriptionstatic booleanUpdateEmail.isEnabled(RealmModel realm) static booleanUpdateEmail.isVerifyEmailEnabled(RealmModel realm) voidRecoveryAuthnCodesAction.validateConfig(KeycloakSession session, RealmModel realm, RequiredActionConfigModel model) -
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 final RealmModelClientModelIdentity.realmprotected final RealmModelKeycloakIdentity.realmConstructors in org.keycloak.authorization.common with parameters of type RealmModelModifierConstructorDescriptionKeycloakIdentity(AccessToken accessToken, KeycloakSession keycloakSession, RealmModel realm) KeycloakIdentity(IDToken token, KeycloakSession keycloakSession, RealmModel realm) -
Uses of RealmModel in org.keycloak.authorization.fgap
Methods in org.keycloak.authorization.fgap with parameters of type RealmModelModifier and TypeMethodDescriptionList<jakarta.persistence.criteria.Predicate>AdminPermissionsSchema.applyAuthorizationFilters(KeycloakSession session, ResourceType resourceType, PartialEvaluationStorageProvider evaluator, RealmModel realm, jakarta.persistence.criteria.CriteriaBuilder builder, jakarta.persistence.criteria.CriteriaQuery<?> queryBuilder, jakarta.persistence.criteria.Path<?> path) List<jakarta.persistence.criteria.Predicate>AdminPermissionsSchema.applyAuthorizationFilters(KeycloakSession session, ResourceType resourceType, RealmModel realm, jakarta.persistence.criteria.CriteriaBuilder builder, jakarta.persistence.criteria.CriteriaQuery<?> queryBuilder, jakarta.persistence.criteria.Path<?> path) voidAdminPermissionsSchema.init(KeycloakSession session, RealmModel realm) booleanAdminPermissionsSchema.isAdminPermissionClient(RealmModel realm, String id) booleanAdminPermissionsSchema.isAdminPermissionsEnabled(RealmModel realm) -
Uses of RealmModel in org.keycloak.authorization.fgap.evaluation.partial
Methods in org.keycloak.authorization.fgap.evaluation.partial with parameters of type RealmModelModifier and TypeMethodDescriptionList<jakarta.persistence.criteria.Predicate>PartialEvaluator.getPredicates(KeycloakSession session, ResourceType resourceType, PartialEvaluationStorageProvider storage, RealmModel realm, jakarta.persistence.criteria.CriteriaBuilder builder, jakarta.persistence.criteria.CriteriaQuery<?> queryBuilder, jakarta.persistence.criteria.Path<?> path) -
Uses of RealmModel in org.keycloak.authorization.identity
Fields in org.keycloak.authorization.identity declared as RealmModelConstructors in org.keycloak.authorization.identity with parameters of type RealmModel -
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 ScriptModelDeployedScriptPolicyFactory.getScriptModel(Policy policy, RealmModel realm, ScriptingProvider scripting) protected ScriptModelJSPolicyProviderFactory.getScriptModel(Policy policy, RealmModel realm, ScriptingProvider scripting) -
Uses of RealmModel in org.keycloak.broker.kubernetes
Methods in org.keycloak.broker.kubernetes with parameters of type RealmModelModifier and TypeMethodDescriptionvoidKubernetesIdentityProvider.backchannelLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) KubernetesIdentityProvider.callback(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event) jakarta.ws.rs.core.ResponseKubernetesIdentityProvider.export(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format) voidKubernetesIdentityProvider.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) jakarta.ws.rs.core.ResponseKubernetesIdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) voidKubernetesIdentityProvider.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context) voidKubernetesIdentityProvider.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) -
Uses of RealmModel in org.keycloak.broker.oidc
Fields in org.keycloak.broker.oidc declared as RealmModelModifier and TypeFieldDescriptionprotected final RealmModelAbstractOAuth2IdentityProvider.Endpoint.realmMethods in org.keycloak.broker.oidc with parameters of type RealmModelModifier and TypeMethodDescriptionvoidOIDCIdentityProvider.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.ResponseOIDCIdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) voidOIDCIdentityProvider.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context) voidOAuth2IdentityProviderConfig.validate(RealmModel realm) voidOIDCIdentityProviderConfig.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 TypeMethodDescriptionvoidAbstractClaimToGroupMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidAbstractClaimToRoleMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidClaimToUserSessionNoteMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidAbstractJsonUserAttributeMapper.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidUserAttributeMapper.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidUsernameTemplateMapper.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidAbstractClaimToGroupMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidAbstractClaimToRoleMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidAbstractJsonUserAttributeMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidClaimToUserSessionNoteMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidUserAttributeMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidUsernameTemplateMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidAbstractClaimToRoleMapper.updateBrokeredUserLegacy(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidAbstractJsonUserAttributeMapper.updateBrokeredUserLegacy(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidExternalKeycloakRoleToRoleMapper.updateBrokeredUserLegacy(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidUsernameTemplateMapper.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 TypeMethodDescriptionvoidAbstractIdentityProvider.backchannelLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) voidIdentityProvider.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 voidIdentityProviderMapperSyncModeDelegate.delegateUpdateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context, IdentityProviderMapper mapper) jakarta.ws.rs.core.ResponseAbstractIdentityProvider.export(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format) jakarta.ws.rs.core.ResponseIdentityProvider.export(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format) Export a representation of the IdentityProvider in a specific format.voidAbstractIdentityProvider.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) voidAbstractIdentityProviderMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidHardcodedRoleMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidHardcodedUserSessionAttributeMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidIdentityProvider.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) voidIdentityProviderMapper.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.ResponseAbstractIdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) jakarta.ws.rs.core.ResponseIdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) Called when a Keycloak application initiates a logout through the browser.voidAbstractIdentityProvider.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context) voidAbstractIdentityProviderMapper.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidHardcodedAttributeMapper.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidHardcodedUserSessionAttributeMapper.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidIdentityProvider.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context) voidIdentityProviderMapper.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.voidAbstractIdentityProvider.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) voidAbstractIdentityProviderMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidHardcodedAttributeMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidHardcodedRoleMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidHardcodedUserSessionAttributeMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidIdentityProvider.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) voidIdentityProviderMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) Called when this user has logged in before and has already been imported.voidAbstractIdentityProviderMapper.updateBrokeredUserLegacy(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidHardcodedRoleMapper.updateBrokeredUserLegacy(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidIdentityProviderMapper.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.util
Methods in org.keycloak.broker.provider.util with parameters of type RealmModelModifier and TypeMethodDescriptionstatic IdentityBrokerStateIdentityBrokerState.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 TypeMethodDescriptionvoidSAMLIdentityProvider.backchannelLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) protected ArtifactResolveTypeSAMLIdentityProvider.buildArtifactResolveRequest(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String artifactServiceUrl, String artifact, SamlProtocolExtensionsAwareBuilder.NodeGenerator... extensions) protected LogoutRequestTypeSAMLIdentityProvider.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.ResponseSAMLIdentityProvider.export(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format) jakarta.ws.rs.core.ResponseSAMLIdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) SAMLIdentityProvider.resolveArtifact(KeycloakSession session, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String relayState, String samlArt) voidSAMLIdentityProviderConfig.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 TypeMethodDescriptionvoidAbstractAttributeToGroupMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidAbstractAttributeToRoleMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidUserAttributeMapper.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidUsernameTemplateMapper.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidXPathAttributeMapper.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidAbstractAttributeToGroupMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidAbstractAttributeToRoleMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidUserAttributeMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidUsernameTemplateMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidXPathAttributeMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) voidUsernameTemplateMapper.updateBrokeredUserLegacy(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) -
Uses of RealmModel in org.keycloak.broker.spiffe
Methods in org.keycloak.broker.spiffe with parameters of type RealmModelModifier and TypeMethodDescriptionvoidSpiffeIdentityProvider.backchannelLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) SpiffeIdentityProvider.callback(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event) jakarta.ws.rs.core.ResponseSpiffeIdentityProvider.export(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format) voidSpiffeIdentityProvider.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) jakarta.ws.rs.core.ResponseSpiffeIdentityProvider.keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm) voidSpiffeIdentityProvider.preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context) voidSpiffeIdentityProvider.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) voidSpiffeIdentityProviderConfig.validate(RealmModel realm) -
Uses of RealmModel in org.keycloak.client.clienttype
Methods in org.keycloak.client.clienttype with parameters of type RealmModelModifier and TypeMethodDescriptionClientTypeManager.getClientType(RealmModel realm, String typeName) ClientTypeManager.getClientTypes(RealmModel realm) voidClientTypeManager.updateClientTypes(RealmModel realm, ClientTypesRepresentation clientTypes) -
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 voidComponentFactory.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) Called after a component is createddefault voidAmphibianProviderFactory.onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) default voidComponentFactory.onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) Called after the component is updated.default voidAmphibianProviderFactory.preRemove(KeycloakSession session, RealmModel realm, ComponentModel model) default voidComponentFactory.preRemove(KeycloakSession session, RealmModel realm, ComponentModel model) Called before the component is removed.default voidComponentFactory.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) booleanPasswordCredentialProvider.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) booleanCredentialProvider.deleteCredential(RealmModel realm, UserModel user, String credentialId) booleanOTPCredentialProvider.deleteCredential(RealmModel realm, UserModel user, String credentialId) booleanPasswordCredentialProvider.deleteCredential(RealmModel realm, UserModel user, String credentialId) booleanRecoveryAuthnCodesCredentialProvider.deleteCredential(RealmModel realm, UserModel user, String credentialId) booleanWebAuthnCredentialProvider.deleteCredential(RealmModel realm, UserModel user, String credentialId) voidCredentialInputUpdater.disableCredentialType(RealmModel realm, UserModel user, String credentialType) voidPasswordCredentialProvider.disableCredentialType(RealmModel realm, UserModel user, String credentialType) default Stream<CredentialModel>CredentialInputUpdater.getCredentials(RealmModel realm, UserModel user) Returns a stream ofCredentialModelinstances managed by this provider for the givenuser.default TCredentialProvider.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.booleanCredentialInputValidator.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanOTPCredentialProvider.isConfiguredFor(RealmModel realm, UserModel user) booleanOTPCredentialProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanPasswordCredentialProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanRecoveryAuthnCodesCredentialProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanWebAuthnCredentialProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanCredentialInputValidator.isValid(RealmModel realm, UserModel user, CredentialInput credentialInput) Tests whether a credential is validbooleanOTPCredentialProvider.isValid(RealmModel realm, UserModel user, CredentialInput credentialInput) booleanPasswordCredentialProvider.isValid(RealmModel realm, UserModel user, CredentialInput input) booleanRecoveryAuthnCodesCredentialProvider.isValid(RealmModel realm, UserModel user, CredentialInput credentialInput) booleanWebAuthnCredentialProvider.isValid(RealmModel realm, UserModel user, CredentialInput input) booleanUserCredentialStore.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) booleanUserCredentialStore.removeStoredCredential(RealmModel realm, UserModel user, String id) Removes credential with theidfor theuser.booleanCredentialInputUpdater.updateCredential(RealmModel realm, UserModel user, CredentialInput input) booleanPasswordCredentialProvider.updateCredential(RealmModel realm, UserModel user, CredentialInput input) voidUserCredentialStore.updateCredential(RealmModel realm, UserModel user, CredentialModel cred) Constructors in org.keycloak.credential with parameters of type RealmModelModifierConstructorDescriptionUserCredentialManager(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 TypeMethodDescriptionvoidEventStoreProvider.clear(RealmModel realm) Removes all auth events for the realm from this store provider.voidEventStoreProvider.clear(RealmModel realm, long olderThan) Removes all auth events for the realm that are older thanolderThanfrom this store provider.voidEventStoreProvider.clearAdmin(RealmModel realm) Removes all auth events for the realm from this store provider.voidEventStoreProvider.clearAdmin(RealmModel realm, long olderThan) Removes all auth events for the realm that are older thanolderThanfrom 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 TypeMethodDescriptionvoidJpaEventStoreProvider.clear(RealmModel realm) voidJpaEventStoreProvider.clear(RealmModel realm, long olderThan) voidJpaEventStoreProvider.clearAdmin(RealmModel realm) voidJpaEventStoreProvider.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 voidDirExportProvider.writeFederatedUsers(String fileName, KeycloakSession session, RealmModel realm, List<String> users) protected voidDirExportProvider.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 UserRepresentationExportUtils.exportFederatedUser(KeycloakSession session, RealmModel realm, String id, ExportOptions options) Full export of user data stored in federated storage (including role mappings and credentials)static voidExportUtils.exportFederatedUsersToStream(KeycloakSession session, RealmModel realm, List<String> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os) static voidExportUtils.exportFederatedUsersToStream(KeycloakSession session, RealmModel realm, List<String> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os, ExportOptions options) static RealmRepresentationExportUtils.exportRealm(KeycloakSession session, RealmModel realm, boolean includeUsers, boolean internal) static RealmRepresentationExportUtils.exportRealm(KeycloakSession session, RealmModel realm, ExportOptions options, boolean internal) static UserRepresentationExportUtils.exportUser(KeycloakSession session, RealmModel realm, UserModel user, ExportOptions options, boolean internal) Full export of user (including role mappings and credentials)static voidExportUtils.exportUsersToStream(KeycloakSession session, RealmModel realm, List<UserModel> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os) static voidExportUtils.exportUsersToStream(KeycloakSession session, RealmModel realm, List<UserModel> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os, ExportOptions options) protected abstract voidMultipleStepsExportProvider.writeFederatedUsers(String fileName, KeycloakSession session, RealmModel realm, List<String> users) protected abstract voidMultipleStepsExportProvider.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.addUser(RealmModel realm, String username) KerberosFederationProvider.authenticate(RealmModel realm, CredentialInput input) voidKerberosFederationProvider.disableCredentialType(RealmModel realm, UserModel user, String credentialType) protected UserModelKerberosFederationProvider.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 UserModelKerberosFederationProvider.importUserToKeycloak(RealmModel realm, KerberosPrincipal kerberosPrincipal) booleanKerberosFederationProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanKerberosFederationProvider.isValid(RealmModel realm, UserModel user, CredentialInput input) voidKerberosFederationProviderFactory.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) voidKerberosFederationProviderFactory.onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) voidKerberosFederationProvider.preRemove(RealmModel realm) voidKerberosFederationProvider.preRemove(RealmModel realm, GroupModel group) voidKerberosFederationProvider.preRemove(RealmModel realm, RoleModel role) voidKerberosFederationProviderFactory.preRemove(KeycloakSession session, RealmModel realm, ComponentModel model) booleanKerberosFederationProvider.removeUser(RealmModel realm, UserModel user) booleanKerberosFederationProvider.updateCredential(RealmModel realm, UserModel user, CredentialInput input) KerberosFederationProvider.validate(RealmModel realm, UserModel user) voidKerberosFederationProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) -
Uses of RealmModel in org.keycloak.federation.sssd
Methods in org.keycloak.federation.sssd with parameters of type RealmModelModifier and TypeMethodDescriptionvoidSSSDFederationProvider.disableCredentialType(RealmModel realm, UserModel user, String credentialType) protected UserModelSSSDFederationProvider.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 UserModelSSSDFederationProvider.importUserToKeycloak(RealmModel realm, String username) booleanSSSDFederationProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanSSSDFederationProvider.isValid(RealmModel realm, UserModel local) booleanSSSDFederationProvider.isValid(RealmModel realm, UserModel user, CredentialInput input) voidSSSDFederationProvider.preRemove(RealmModel realm) voidSSSDFederationProvider.preRemove(RealmModel realm, GroupModel group) voidSSSDFederationProvider.preRemove(RealmModel realm, RoleModel role) booleanSSSDFederationProvider.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 RealmModelConstructors 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
Fields in org.keycloak.forms.login.freemarker.model declared as RealmModelMethods in org.keycloak.forms.login.freemarker.model that return RealmModelMethods in org.keycloak.forms.login.freemarker.model with parameters of type RealmModelModifier and TypeMethodDescriptionprotected IdentityProviderBean.IdentityProviderIdentityProviderBean.createIdentityProvider(RealmModel realm, URI baseURI, IdentityProviderModel identityProvider) Creates anIdentityProviderBean.IdentityProviderinstance from the specifiedIdentityProviderModel.IdentityProviderBean.getLinkedBrokerAliases(KeycloakSession session, RealmModel realm, AuthenticationFlowContext context) Returns the list of IDPs linked with the user's federated identities, if any.Constructors in org.keycloak.forms.login.freemarker.model with parameters of type RealmModelModifierConstructorDescriptionIdentityProviderBean(KeycloakSession session, RealmModel realm, URI baseURI, AuthenticationFlowContext context) 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) TotpBean(KeycloakSession session, RealmModel realm, UserModel user, jakarta.ws.rs.core.UriBuilder uriBuilder, String secret) 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.ipatuura_user_spi
Methods in org.keycloak.ipatuura_user_spi with parameters of type RealmModelModifier and TypeMethodDescriptionIpatuuraUserStorageProvider.addUser(RealmModel realm, String username) IpatuuraUserStorageProvider.authenticate(RealmModel realm, CredentialInput input) protected UserModelIpatuuraUserStorageProvider.createUserInKeycloak(RealmModel realm, String username) IpatuuraUserStorageProvider.getGroupMembersStream(RealmModel arg0, GroupModel arg1, Integer arg2, Integer arg3) IpatuuraUserStorageProvider.getUserByEmail(RealmModel realm, String email) IpatuuraUserStorageProvider.getUserById(RealmModel realm, String id) IpatuuraUserStorageProvider.getUserByUsername(RealmModel realm, String username) intIpatuuraUserStorageProvider.getUsersCount(RealmModel realm) booleanIpatuuraUserStorageProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanIpatuuraUserStorageProvider.isValid(RealmModel realm, UserModel user, CredentialInput input) booleanIpatuuraUserStorageProvider.removeUser(RealmModel realm, UserModel user) IpatuuraUserStorageProvider.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue) IpatuuraUserStorageProvider.searchForUserStream(RealmModel realm, Map<String, String> params, Integer firstResult, Integer maxResults) IpatuuraUserStorageProvider.validate(RealmModel realm, UserModel local) voidIpatuuraUserStorageProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) -
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 KeyWrapperAbstractEcKeyProvider.loadKey(RealmModel realm, ComponentModel model) protected abstract KeyWrapperAbstractEddsaKeyProvider.loadKey(RealmModel realm, ComponentModel model) AbstractRsaKeyProvider.loadKey(RealmModel realm, ComponentModel model) protected KeyWrapperGeneratedEcdhKeyProvider.loadKey(RealmModel realm, ComponentModel model) protected KeyWrapperGeneratedEcdsaKeyProvider.loadKey(RealmModel realm, ComponentModel model) protected KeyWrapperGeneratedEddsaKeyProvider.loadKey(RealmModel realm, ComponentModel model) protected KeyWrapperJavaKeystoreKeyProvider.loadKey(RealmModel realm, ComponentModel model) voidAbstractEcKeyProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) voidAbstractEddsaKeyProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) voidAbstractGeneratedEcKeyProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) voidAbstractGeneratedRsaKeyProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) voidAbstractGeneratedSecretKeyProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) voidAbstractImportedRsaKeyProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) voidAbstractRsaKeyProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) voidGeneratedEddsaKeyProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) voidJavaKeystoreKeyProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) Constructors in org.keycloak.keys with parameters of type RealmModelModifierConstructorDescriptionAbstractEcKeyProvider(RealmModel realm, ComponentModel model) AbstractEddsaKeyProvider(RealmModel realm, ComponentModel model) AbstractRsaKeyProvider(RealmModel realm, ComponentModel model) GeneratedEcdhKeyProvider(RealmModel realm, ComponentModel model) GeneratedEcdsaKeyProvider(RealmModel realm, ComponentModel model) GeneratedEddsaKeyProvider(RealmModel realm, ComponentModel model) ImportedRsaKeyProvider(RealmModel realm, ComponentModel model) JavaKeystoreKeyProvider(RealmModel realm, ComponentModel model, VaultTranscriber vault) -
Uses of RealmModel in org.keycloak.keys.loader
Methods in org.keycloak.keys.loader with parameters of type RealmModelModifier and TypeMethodDescriptionstatic KeyWrapperPublicKeyStorageManager.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) DefaultLocaleSelectorProvider.resolveLocale(RealmModel realm, UserModel user, boolean ignoreAcceptLanguageHeader) LocaleSelectorProvider.resolveLocale(RealmModel realm, UserModel user) Resolve the locale which should be used for the requestdefault LocaleLocaleSelectorProvider.resolveLocale(RealmModel realm, UserModel user, boolean ignoreAcceptLanguageHeader) default LocaleLocaleSelectorProvider.resolveLocale(RealmModel realm, UserModel user, Theme.Type themeType) -
Uses of RealmModel in org.keycloak.logging
Methods in org.keycloak.logging with parameters of type RealmModelModifier and TypeMethodDescriptionvoidMappedDiagnosticContextProvider.update(KeycloakContext keycloakContext, RealmModel realm) Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context.voidNoopMappedDiagnosticContextProvider.update(KeycloakContext keycloakContext, RealmModel realm) -
Uses of RealmModel in org.keycloak.migration
Methods in org.keycloak.migration with parameters of type RealmModelModifier and TypeMethodDescriptionMigrationProvider.addOIDCAcrClientScope(RealmModel realm) Add 'acr' client scope or return it if already existsMigrationProvider.addOIDCBasicClientScope(RealmModel realm) Add 'basic' client scope or return it if already existsMigrationProvider.addOIDCMicroprofileJWTClientScope(RealmModel realm) Adds themicroprofile-jwtoptional client scope to the realm and returns the created scope.MigrationProvider.addOIDCRolesClientScope(RealmModel realm) Add 'roles' client scope or return it if already existsMigrationProvider.addOIDCServiceAccountClientScope(RealmModel realm) Add 'service_account' client scope or return it if already existsMigrationProvider.addOIDCWebOriginsClientScope(RealmModel realm) Add 'web-origins' client scope or return it if already existsstatic voidMigrationModelManager.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrationProvider.setupAdminCli(RealmModel realm) -
Uses of RealmModel in org.keycloak.migration.migrators
Methods in org.keycloak.migration.migrators with parameters of type RealmModelModifier and TypeMethodDescriptionprotected voidMigrateTo9_0_0.addAccountConsoleClient(RealmModel realm) static voidMigrationUtils.addAdminRole(RealmModel realm, String roleName) protected voidMigrateTo9_0_4.checkAuthConfigNullAlias(RealmModel realm) static ComponentModelMigrateTo1_8_0.getMapperByName(RealmModel realm, ComponentModel providerModel, String name) protected voidMigrateTo8_0_2.migrateAuthenticationFlowsWithAlternativeRequirements(RealmModel realm) voidMigrateTo1_2_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo1_3_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo1_4_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo1_5_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo1_6_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo1_7_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo1_8_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo1_9_2.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo18_0_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo2_0_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo2_1_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo2_2_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo2_3_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo2_5_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo20_0_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo21_0_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo22_0_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo3_0_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo3_1_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo3_2_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo3_4_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo3_4_1.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo3_4_2.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo4_0_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo4_2_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo4_6_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo6_0_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo8_0_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo8_0_2.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo9_0_0.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidMigrateTo9_0_4.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) default voidMigration.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) Called after full import of representation.voidRealmMigration.migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) static voidMigrationUtils.migrateOldOfflineToken(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user) static voidMigrateTo8_0_0.migrateOptionalAuthenticationExecution(RealmModel realm, AuthenticationFlowModel parentFlow, AuthenticationExecutionModel optionalExecution, boolean updateOptionalExecution) protected voidMigrateTo1_4_0.migrateRealm(KeycloakSession session, RealmModel realm) protected voidMigrateTo1_5_0.migrateRealm(KeycloakSession session, RealmModel realm) protected voidMigrateTo1_6_0.migrateRealm(KeycloakSession session, ProtocolMapperModel localeMapper, RealmModel realm) protected voidMigrateTo1_7_0.migrateRealm(KeycloakSession session, RealmModel realm) protected voidMigrateTo1_8_0.migrateRealm(RealmModel realm) protected voidMigrateTo1_9_2.migrateRealm(RealmModel realm) protected voidMigrateTo18_0_0.migrateRealm(KeycloakSession session, RealmModel realm) protected voidMigrateTo2_3_0.migrateRealm(RealmModel realm) voidMigrateTo22_0_0.migrateRealm(KeycloakSession session, RealmModel realm) voidMigrateTo23_0_0.migrateRealm(KeycloakSession session, RealmModel realm) voidMigrateTo24_0_0.migrateRealm(KeycloakSession session, RealmModel realm) voidMigrateTo24_0_3.migrateRealm(KeycloakSession session, RealmModel realm) voidMigrateTo25_0_0.migrateRealm(KeycloakSession session, RealmModel realm) voidMigrateTo26_0_0.migrateRealm(KeycloakSession session, RealmModel realm) voidMigrateTo26_1_0.migrateRealm(KeycloakSession session, RealmModel realm) voidMigrateTo26_2_0.migrateRealm(KeycloakSession session, RealmModel realm) voidMigrateTo26_3_0.migrateRealm(KeycloakSession session, RealmModel realm) voidMigrateTo26_4_0.migrateRealm(KeycloakSession session, RealmModel realm) protected voidMigrateTo3_0_0.migrateRealm(RealmModel realm) protected voidMigrateTo3_1_0.migrateRealm(RealmModel realm) protected voidMigrateTo3_2_0.migrateRealm(KeycloakSession session, RealmModel realm) protected voidMigrateTo3_4_0.migrateRealm(RealmModel r) protected voidMigrateTo3_4_1.migrateRealm(RealmModel r) protected voidMigrateTo3_4_2.migrateRealm(RealmModel realm) protected voidMigrateTo4_0_0.migrateRealm(KeycloakSession session, RealmModel realm, boolean json) protected voidMigrateTo4_2_0.migrateRealm(RealmModel realm) protected voidMigrateTo4_6_0.migrateRealm(KeycloakSession session, RealmModel realm, boolean json) protected voidMigrateTo6_0_0.migrateRealm(KeycloakSession session, RealmModel realm, boolean jsn) abstract voidRealmMigration.migrateRealm(KeycloakSession session, RealmModel realm) protected voidMigrateTo8_0_0.migrateRealmCommon(RealmModel realm) protected voidMigrateTo9_0_0.migrateRealmCommon(RealmModel realm) protected voidMigrateTo8_0_0.migrateRealmMFA(RealmModel realm) voidMigrateTo1_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_NAMEprotected Supplier<RealmModel>AbstractConfig.realmprotected Supplier<RealmModel>AbstractConfig.realmForWriteMethods 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()ClientScopeDecorator.getRealm()ClientScopeModel.getRealm()FederatedIdentityModel.FederatedIdentityCreatedEvent.getRealm()FederatedIdentityModel.FederatedIdentityRemovedEvent.getRealm()GroupModel.GroupEvent.getRealm()KeycloakContext.getRealm()RealmModel.IdentityProviderRemovedEvent.getRealm()RealmModel.IdentityProviderUpdatedEvent.getRealm()RealmModel.RealmAttributeUpdateEvent.getRealm()RealmModel.RealmRemovedEvent.getRealm()Exact search for a realm by its internal ID.RoleModel.RoleEvent.getRealm()RoleModel.RoleNameChangeEvent.getRealm()UserModel.UserPreRemovedEvent.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.default Stream<RealmModel>RealmProvider.getRealmsStream(String search) Returns realms as a stream filtered by search.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 ClientModelClientProvider.addClient(RealmModel realm, String clientId) Adds a client with givenclientIdto the given realm.ClientProvider.addClient(RealmModel realm, String id, String clientId) Adds a client with given internal ID andclientIdto the given realm.default ClientScopeModelClientScopeProvider.addClientScope(RealmModel realm, String name) Creates new client scope with givennameto the given realm.ClientScopeProvider.addClientScope(RealmModel realm, String id, String name) Creates new client scope with given internal ID andnameto the given realm.voidClientProvider.addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) Assign clientScopes to the client.voidClientProvider.addClientScopeToAllClients(RealmModel realm, ClientScopeModel clientScope, boolean defaultClientScope) Add specified client scope to all non bearer-only clients in the realm, which have same protocol as specified client scope.voidUserProvider.addConsent(RealmModel realm, String userId, UserConsentModel consent) Add user consent for the user.voidUserProvider.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) Adds a federated identity link for the user within the realmdefault RoleModelRoleProvider.addRealmRole(RealmModel realm, String name) Adds a realm role with givennameto the given realm.RoleProvider.addRealmRole(RealmModel realm, String id, String name) Adds a realm role with given internal ID andnameto the given realm.voidGroupProvider.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 aUserLoginFailureModelfor the given realm and user id.static OAuth2DeviceCodeModelOAuth2DeviceCodeModel.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 ClientInitialAccessModelRealmProvider.createClientInitialAccessModel(RealmModel realm, int expiration, int count) UserSessionProvider.createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession) default GroupModelGroupProvider.createGroup(RealmModel realm, String name) Creates a new group with the given name in the given realm.default GroupModelGroupProvider.createGroup(RealmModel realm, String id, String name) Creates a new group with the given id and name in the given realm.default GroupModelGroupProvider.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 GroupModelGroupProvider.createGroup(RealmModel realm, String name, GroupModel toParent) Creates a new group with the given name and parent to the given realm.GroupProvider.createGroup(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent) Creates a new group with the given name, id, name and parent to the given realm.static StringOAuth2DeviceUserCodeModel.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 UserSessionModelUserSessionProvider.createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) Deprecated, for removal: This API element is subject to removal in a future version.default voidRealmProvider.decreaseRemainingCount(RealmModel realm, ClientInitialAccessModel clientInitialAccess) booleanRealmProvider.deleteLocalizationText(RealmModel realm, String locale, String key) booleanRealmProvider.deleteLocalizationTextsByLocale(RealmModel realm, String locale) static OAuth2DeviceCodeModelstatic OAuth2DeviceUserCodeModelKeyManager.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.longUserSessionProvider.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 ClientInitialAccessModelRealmProvider.getClientInitialAccessModel(RealmModel realm, String id) ClientScopeProvider.getClientScopesByAttributes(RealmModel realm, Map<String, String> searchMap, boolean useOr) Allows us to filter for scopes by specific attributesClientScopeProvider.getClientScopesByProtocol(RealmModel realm, String protocol) Must retrieve all client scopes of the given realm that are use the given protocol.ClientScopeProvider.getClientScopesStream(RealmModel realm) Returns all the client scopes of the given realm as a stream.longClientProvider.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 LongGroupProvider.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 allKeyWrapperfor the given realm.KeyManager.getKeysStream(RealmModel realm, KeyUse use, String algorithm) Returns allKeyWrapperfor 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) intUserProvider.getNotBeforeOfUser(RealmModel realm, UserModel user) Gets the notBefore value for the given userlongUserSessionProvider.getOfflineSessionsCount(RealmModel realm, ClientModel client) UserSessionProvider.getOfflineUserSession(RealmModel realm, String userSessionId) 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 thefirstResultand 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.intUserSessionProvider.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 theUserLoginFailureModelfor 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.default UserSessionModelUserSessionProvider.getUserSessionIfClientExists(RealmModel realm, String userSessionId, boolean offline, String clientUUID) Returns theUserSessionModelif the user session with IDuserSessionIdexist, and it has anAuthenticatedClientSessionModelfrom aClientModelwith IDclientUUID.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 thefirstResultand 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.voidGroupProvider.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.voidUserSessionProvider.onClientRemoved(RealmModel realm, ClientModel client) Callback method invoked when a client is removed.voidUserSessionProvider.onRealmRemoved(RealmModel realm) Callback method invoked when a realm is removed.voidGroupProvider.preRemove(RealmModel realm) Called when a realm is removed.voidUserProvider.preRemove(RealmModel realm) Called when a realm is removed.voidUserProvider.preRemove(RealmModel realm, ComponentModel component) Called when a component is removed.voidUserProvider.preRemove(RealmModel realm, ClientModel client) Called when a client is removed.voidUserProvider.preRemove(RealmModel realm, GroupModel group) Called when a group is removed.voidUserProvider.preRemove(RealmModel realm, IdentityProviderModel provider) Called when an identity provider is removed.voidUserProvider.preRemove(RealmModel realm, RoleModel role) Called when a role is removed.voidUserLoginFailureProvider.removeAllUserLoginFailures(RealmModel realm) Removes all theUserLoginFailureModelfor the given realm.booleanClientProvider.removeClient(RealmModel realm, String id) Removes given client from the given realm.default voidRealmProvider.removeClientInitialAccessModel(RealmModel realm, String id) voidClientProvider.removeClients(RealmModel realm) Removes all clients from the given realm.voidClientProvider.removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope) Unassign clientScope from the client.booleanClientScopeProvider.removeClientScope(RealmModel realm, String id) Removes client scope from the given realm.voidClientScopeProvider.removeClientScopes(RealmModel realm) Removes all client scopes from the given realm.voidUserSessionProvider.removeExpired(RealmModel realm) Removes expired user sessions owned by this realm from this provider.booleanUserProvider.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) Removes federation link between the user and the identity provider given by its idbooleanGroupProvider.removeGroup(RealmModel realm, GroupModel group) Removes the given group for the given realm.voidUserProvider.removeImportedUsers(RealmModel realm, String storageProviderId) Removes any imported users from a specific User Storage Provider.voidUserSessionProvider.removeOfflineUserSession(RealmModel realm, UserSessionModel userSession) Removes the attached clientSessions as wellvoidRoleProvider.removeRoles(RealmModel realm) Removes all roles from the given realm.booleanUserManager.removeUser(RealmModel realm, UserModel user) booleanUserManager.removeUser(RealmModel realm, UserModel user, UserProvider userProvider) voidUserLoginFailureProvider.removeUserLoginFailure(RealmModel realm, String userId) Removes aUserLoginFailureModelfor the given realm and user id.voidUserSessionProvider.removeUserSession(RealmModel realm, UserSessionModel session) This will remove attached ClientLoginSessionModels toovoidUserSessionProvider.removeUserSessions(RealmModel realm) Removes all user sessions (regular and offline) from the specified realm.voidUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user) voidUserSessionModel.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) booleanUserProvider.revokeConsentForClient(RealmModel realm, String userId, String clientInternalId) Remove a user consent given by the user id and client idvoidRealmProvider.saveLocalizationText(RealmModel realm, String locale, String key, String text) voidRealmProvider.saveLocalizationTexts(RealmModel realm, String locale, Map<String, String> localizationTexts) voidUserProvider.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore) Sets the notBefore value for the given uservoidOAuth2DeviceConfig.setOAuth2DeviceCodeLifespan(RealmModel realm, Integer seconds) voidOAuth2DeviceConfig.setOAuth2DevicePollingInterval(RealmModel realm, Integer seconds) voidKeycloakContext.setRealm(RealmModel realm) static voidImpersonationConstants.setupImpersonationService(KeycloakSession session, RealmModel realm) static voidImpersonationConstants.setupMasterRealmRole(RealmProvider model, RealmModel realm) static voidImpersonationConstants.setupRealmRole(RealmModel realm) voidUserProvider.unlinkUsers(RealmModel realm, String storageProviderId) Set federation link tonullto imported users of a specific User Storage ProvidervoidUserProvider.updateConsent(RealmModel realm, String userId, UserConsentModel consent) Update client scopes in the stored user consentvoidUserProvider.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) Update details of association between the federatedUser and the idp given by the federatedIdentityModelbooleanRealmProvider.updateLocalizationText(RealmModel realm, String locale, String key, String text) voidIdentityProviderModel.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 TypeInterfaceDescriptioninterfaceCached 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 TypeMethodDescriptionvoidUserCache.evict(RealmModel realm) Evict users of a specific realmvoidUserCache.evict(RealmModel realm, UserModel user) Evict user from cache.voidOnUserCache.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 RealmModelClientAdapter.cachedRealmprotected RealmModelClientScopeAdapter.cachedRealmprotected final RealmModelGroupAdapter.realmprotected RealmModelRoleAdapter.realmprotected final RealmModelUserAdapter.realmprotected RealmModelRealmAdapter.updatedMethods 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.getRealmsStream(String search) 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) voidRealmCacheSession.addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) voidRealmCacheSession.addClientScopeToAllClients(RealmModel realm, ClientScopeModel clientScope, boolean defaultClientScope) voidUserCacheSession.addConsent(RealmModel realm, String userId, UserConsentModel consent) voidUserCacheSession.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) RealmCacheSession.addRealmRole(RealmModel realm, String name) RealmCacheSession.addRealmRole(RealmModel realm, String id, String name) voidRealmCacheSession.addTopLevelGroup(RealmModel realm, GroupModel subGroup) UserCacheSession.addUser(RealmModel realm, String username) UserCacheSession.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) protected ClientModelRealmCacheSession.cacheClient(RealmModel realm, ClientModel delegate, Long revision) protected UserModelUserCacheSession.cacheUser(RealmModel realm, UserModel delegate, Long revision) RealmCacheSession.createClientInitialAccessModel(RealmModel realm, int expiration, int count) RealmCacheSession.createGroup(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent) booleanRealmCacheSession.deleteLocalizationText(RealmModel realm, String locale, String key) booleanRealmCacheSession.deleteLocalizationTextsByLocale(RealmModel realm, String locale) voidUserCacheSession.evict(RealmModel realm) voidUserCacheSession.evict(RealmModel realm, UserModel user) voidRealmCacheSession.evictRealmOnRemoval(RealmModel realm) protected voidUserCacheSession.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.getClientScopesByAttributes(RealmModel realm, Map<String, String> searchMap, boolean useOr) RealmCacheSession.getClientScopesByProtocol(RealmModel realm, String protocol) RealmCacheSession.getClientScopesStream(RealmModel realm) longRealmCacheSession.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) UserCacheSession.getGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, 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) intUserCacheSession.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 UserModelUserCacheSession.getUserAdapter(RealmModel realm, String userId, Long loaded, UserModel delegate) UserCacheSession.getUserByCredential(RealmModel realm, CredentialInput input) UserCacheSession.getUserByEmail(RealmModel realm, String rawEmail) UserCacheSession.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink) UserCacheSession.getUserById(RealmModel realm, String id) UserCacheSession.getUserByUsername(RealmModel realm, String rawUsername) intUserCacheSession.getUsersCount(RealmModel realm, boolean includeServiceAccount) intUserCacheSession.getUsersCount(RealmModel realm, String search) intUserCacheSession.getUsersCount(RealmModel realm, String search, Set<String> groupIds) intUserCacheSession.getUsersCount(RealmModel realm, Map<String, String> params) intUserCacheSession.getUsersCount(RealmModel realm, Map<String, String> params, Set<String> groupIds) intUserCacheSession.getUsersCount(RealmModel realm, Set<String> groupIds) voidUserCacheSession.grantToAllUsers(RealmModel realm, RoleModel role) RealmCacheSession.listClientInitialAccessStream(RealmModel realm) voidRealmCacheSession.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent) voidUserCacheSession.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) voidUserCacheSession.onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) voidRealmCacheSession.preRemove(RealmModel realm) voidUserCacheSession.preRemove(RealmModel realm) voidUserCacheSession.preRemove(RealmModel realm, ComponentModel component) voidUserCacheSession.preRemove(RealmModel realm, ClientModel client) voidUserCacheSession.preRemove(RealmModel realm, GroupModel group) voidUserCacheSession.preRemove(RealmModel realm, IdentityProviderModel provider) voidUserCacheSession.preRemove(RealmModel realm, RoleModel role) booleanRealmCacheSession.removeClient(RealmModel realm, String id) voidRealmCacheSession.removeClientInitialAccessModel(RealmModel realm, String id) voidRealmCacheSession.removeClients(RealmModel realm) booleanRealmCacheSession.removeClientScope(RealmModel realm, String id) voidRealmCacheSession.removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope) voidRealmCacheSession.removeClientScopes(RealmModel realm) booleanUserCacheSession.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) booleanRealmCacheSession.removeGroup(RealmModel realm, GroupModel group) voidUserCacheSession.removeImportedUsers(RealmModel realm, String storageProviderId) voidRealmCacheSession.removeRoles(RealmModel realm) booleanUserCacheSession.removeUser(RealmModel realm, UserModel user) booleanUserCacheSession.revokeConsentForClient(RealmModel realm, String userId, String clientInternalId) voidRealmCacheSession.saveLocalizationText(RealmModel realm, String locale, String key, String text) voidRealmCacheSession.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) voidUserCacheSession.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore) voidUserCacheSession.unlinkUsers(RealmModel realm, String storageProviderId) voidUserCacheSession.updateConsent(RealmModel realm, String userId, UserConsentModel consent) voidUserCacheSession.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) booleanRealmCacheSession.updateLocalizationText(RealmModel realm, String locale, String key, String text) protected ClientModelRealmCacheSession.validateCache(RealmModel realm, CachedClient cached) protected UserModelUserCacheSession.validateCache(RealmModel realm, CachedUser cached, Supplier<UserModel> supplier) Constructors in org.keycloak.models.cache.infinispan with parameters of type RealmModelModifierConstructorDescriptionCachedCount(Long revision, RealmModel realm, String cacheKey, long count) ClientAdapter(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 cacheSession, 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.entities
Fields in org.keycloak.models.cache.infinispan.entities with type parameters of type RealmModelModifier and TypeFieldDescriptionprotected LazyLoader<RealmModel,CibaConfig> CachedRealm.cibaConfigprotected DefaultLazyLoader<RealmModel,List<String>> CachedRealm.defaultDefaultClientScopesprotected LazyLoader<RealmModel,OAuth2DeviceConfig> CachedRealm.deviceConfigprotected DefaultLazyLoader<RealmModel,List<String>> CachedRealm.optionalDefaultClientScopesprotected LazyLoader<RealmModel,ParConfig> CachedRealm.parConfigMethod parameters in org.keycloak.models.cache.infinispan.entities with type arguments of type RealmModelModifier and TypeMethodDescriptionCachedRealm.getCibaConfig(KeycloakSession session, Supplier<RealmModel> modelSupplier) CachedRealm.getDefaultDefaultClientScopes(KeycloakSession session, Supplier<RealmModel> modelSupplier) CachedRealm.getOAuth2DeviceConfig(KeycloakSession session, Supplier<RealmModel> modelSupplier) CachedRealm.getOptionalDefaultClientScopes(KeycloakSession session, Supplier<RealmModel> modelSupplier) CachedRealm.getParConfig(KeycloakSession session, 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, String searchKey, Set<String> result) GroupListQuery(Long revisioned, String id, RealmModel realm, String searchKey, Set<String> result, GroupListQuery previous) GroupListQuery(Long revisioned, String id, RealmModel realm, Set<String> ids) GroupNameQuery(Long revisioned, String id, String groupId, RealmModel realm) RoleByNameQuery(Long revisioned, String id, RealmModel realm, String role) RoleByNameQuery(Long revision, String id, RealmModel realm, String role, String client) 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.cache.infinispan.idp
Methods in org.keycloak.models.cache.infinispan.idp with parameters of type RealmModelModifier and TypeMethodDescriptionstatic StringInfinispanIdentityProviderStorageProvider.cacheKeyForLogin(RealmModel realm, IdentityProviderStorageProvider.FetchMode fetchMode) static StringInfinispanIdentityProviderStorageProvider.cacheKeyIsEnabled(RealmModel realm) static StringInfinispanIdentityProviderStorageProvider.cacheKeyOrgId(RealmModel realm, String orgId) Constructors in org.keycloak.models.cache.infinispan.idp with parameters of type RealmModelModifierConstructorDescriptionCachedIdentityProvider(Long revision, RealmModel realm, String cacheKey, IdentityProviderModel idp) CachedIdentityProviderMapper(Long revision, RealmModel realm, String cacheKey, IdentityProviderMapperModel mapper) IdentityProviderListQuery(Long revision, String id, RealmModel realm, String searchKey, Set<String> result) IdentityProviderListQuery(Long revision, String id, RealmModel realm, String searchKey, Set<String> result, IdentityProviderListQuery previous) -
Uses of RealmModel in org.keycloak.models.cache.infinispan.organization
Methods in org.keycloak.models.cache.infinispan.organization with parameters of type RealmModelModifier and TypeMethodDescriptionstatic StringInfinispanOrganizationProvider.cacheKeyOrgMemberCount(RealmModel realm, OrganizationModel organization) Constructors in org.keycloak.models.cache.infinispan.organization with parameters of type RealmModelModifierConstructorDescriptionCachedMembership(Long revision, String key, RealmModel realm, boolean managed, boolean isMember) CachedOrganization(Long revision, RealmModel realm, OrganizationModel organization) CachedOrganizationIds(Long revision, String id, RealmModel realm, Stream<OrganizationModel> models) CachedOrganizationIds(Long revision, String id, RealmModel realm, OrganizationModel model) -
Uses of RealmModel in org.keycloak.models.credential
Methods in org.keycloak.models.credential with parameters of type RealmModelModifier and TypeMethodDescriptionstatic OTPCredentialModelOTPCredentialModel.createFromPolicy(RealmModel realm, String secretValue) static OTPCredentialModelOTPCredentialModel.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 RealmModelClientAdapter.realmprotected RealmModelClientScopeAdapter.realmprotected RealmModelGroupAdapter.realmprotected RealmModelRoleAdapter.realmprotected RealmModelUserAdapter.realmMethods 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.getRealmsStream(String search) 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) voidJpaRealmProvider.addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) voidJpaRealmProvider.addClientScopeToAllClients(RealmModel realm, ClientScopeModel clientScope, boolean defaultClientScope) voidJpaUserProvider.addConsent(RealmModel realm, String userId, UserConsentModel consent) voidJpaUserProvider.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel identity) JpaRealmProvider.addRealmRole(RealmModel realm, String name) JpaRealmProvider.addRealmRole(RealmModel realm, String id, String name) voidJpaRealmProvider.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, GroupModel.Type type, String name, GroupModel toParent) booleanJpaRealmProvider.deleteLocalizationText(RealmModel realm, String locale, String key) booleanJpaRealmProvider.deleteLocalizationTextsByLocale(RealmModel realm, String locale) protected voidJpaUserProvider.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.getClientScopesByAttributes(RealmModel realm, Map<String, String> searchMap, boolean useOr) This method filters clientScopes by specific attributes.JpaRealmProvider.getClientScopesByProtocol(RealmModel realm, String protocol) JpaRealmProvider.getClientScopesStream(RealmModel realm) longJpaRealmProvider.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) JpaUserProvider.getGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, Integer first, Integer max) 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) intJpaUserProvider.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) intJpaUserProvider.getUsersCount(RealmModel realm, boolean includeServiceAccount) intJpaUserProvider.getUsersCount(RealmModel realm, String search) intJpaUserProvider.getUsersCount(RealmModel realm, String search, Set<String> groupIds) intJpaUserProvider.getUsersCount(RealmModel realm, Map<String, String> params) intJpaUserProvider.getUsersCount(RealmModel realm, Map<String, String> params, Set<String> groupIds) intJpaUserProvider.getUsersCount(RealmModel realm, Set<String> groupIds) voidJpaUserProvider.grantToAllUsers(RealmModel realm, RoleModel role) booleanJpaUserCredentialStore.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) booleanJpaUserProvider.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) voidJpaRealmProvider.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent) voidJpaRealmProvider.preRemove(RealmModel realm) voidJpaRealmProvider.preRemove(RealmModel realm, RoleModel role) voidJpaUserProvider.preRemove(RealmModel realm) voidJpaUserProvider.preRemove(RealmModel realm, ComponentModel component) voidJpaUserProvider.preRemove(RealmModel realm, ClientModel client) voidJpaUserProvider.preRemove(RealmModel realm, GroupModel group) voidJpaUserProvider.preRemove(RealmModel realm, IdentityProviderModel provider) voidJpaUserProvider.preRemove(RealmModel realm, RoleModel role) booleanJpaRealmProvider.removeClient(RealmModel realm, String id) voidJpaRealmProvider.removeClients(RealmModel realm) booleanJpaRealmProvider.removeClientScope(RealmModel realm, String id) voidJpaRealmProvider.removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope) voidJpaRealmProvider.removeClientScopes(RealmModel realm) protected voidJpaUserProvider.removeConsentByClientStorageProvider(RealmModel realm, String providerId) booleanJpaUserProvider.removeFederatedIdentity(RealmModel realm, UserModel user, String identityProvider) booleanJpaRealmProvider.removeGroup(RealmModel realm, GroupModel group) voidJpaUserProvider.removeImportedUsers(RealmModel realm, String storageProviderId) voidJpaRealmProvider.removeRoles(RealmModel realm) booleanJpaUserCredentialStore.removeStoredCredential(RealmModel realm, UserModel user, String id) booleanJpaUserProvider.removeStoredCredential(RealmModel realm, UserModel user, String id) booleanJpaUserProvider.removeUser(RealmModel realm, UserModel user) booleanJpaUserProvider.revokeConsentForClient(RealmModel realm, String userId, String clientId) voidJpaRealmProvider.saveLocalizationText(RealmModel realm, String locale, String key, String text) voidJpaRealmProvider.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) voidJpaUserProvider.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore) voidJpaUserProvider.unlinkUsers(RealmModel realm, String storageProviderId) voidJpaUserProvider.updateConsent(RealmModel realm, String userId, UserConsentModel consent) voidJpaUserCredentialStore.updateCredential(RealmModel realm, UserModel user, CredentialModel cred) voidJpaUserProvider.updateCredential(RealmModel realm, UserModel user, CredentialModel cred) voidJpaUserProvider.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) booleanJpaRealmProvider.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(KeycloakSession session, 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 TypeMethodDescriptionintJpaUserSessionPersisterProvider.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) JpaUserSessionPersisterProvider.loadUserSessionsStreamByBrokerSessionId(RealmModel realm, String brokerSessionId, boolean offline) voidJpaUserSessionPersisterProvider.onClientRemoved(RealmModel realm, ClientModel client) voidJpaUserSessionPersisterProvider.onRealmRemoved(RealmModel realm) voidJpaUserSessionPersisterProvider.onUserRemoved(RealmModel realm, UserModel user) voidJpaUserSessionPersisterProvider.removeExpired(RealmModel realm) voidJpaUserSessionPersisterProvider.removeUserSessions(RealmModel realm) voidJpaUserSessionPersisterProvider.removeUserSessions(RealmModel realm, boolean offline) voidJpaUserSessionPersisterProvider.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 LightweightUserAdapterLightweightUserAdapter.fromString(KeycloakSession session, RealmModel realm, String serializedForm) Constructors in org.keycloak.models.light with parameters of type RealmModelModifierConstructorDescriptionLightweightUserAdapter(KeycloakSession session, RealmModel realm, String id) -
Uses of RealmModel in org.keycloak.models.oid4vci
Methods in org.keycloak.models.oid4vci that return RealmModel -
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 TypeMethodDescriptionintDisabledUserSessionPersisterProvider.getUserSessionsCount(RealmModel realm, ClientModel clientModel, boolean offline) intUserSessionPersisterProvider.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 aMapcontaining 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 givenClientModelin the givenRealmModelif present.UserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults) Loads the user sessions for the givenUserModelin the givenRealmModelif present.default UserSessionModelUserSessionPersisterProvider.loadUserSessionsStreamByBrokerSessionId(RealmModel realm, String brokerSessionId, boolean offline) voidDisabledUserSessionPersisterProvider.onClientRemoved(RealmModel realm, ClientModel client) voidUserSessionPersisterProvider.onClientRemoved(RealmModel realm, ClientModel client) voidDisabledUserSessionPersisterProvider.onRealmRemoved(RealmModel realm) voidUserSessionPersisterProvider.onRealmRemoved(RealmModel realm) voidDisabledUserSessionPersisterProvider.onUserRemoved(RealmModel realm, UserModel user) voidUserSessionPersisterProvider.onUserRemoved(RealmModel realm, UserModel user) voidDisabledUserSessionPersisterProvider.removeExpired(RealmModel realm) voidUserSessionPersisterProvider.removeExpired(RealmModel realm) default voidUserSessionPersisterProvider.removeUserSessions(RealmModel realm) Removes all user sessions from the specified realm.default voidUserSessionPersisterProvider.removeUserSessions(RealmModel realm, boolean offline) Remove the online user sessions for this realm.voidPersistentUserSessionAdapter.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) voidPersistentUserSessionAdapter.setRealm(RealmModel realm) voidDisabledUserSessionPersisterProvider.updateLastSessionRefreshes(RealmModel realm, int lastSessionRefresh, Collection<String> userSessionIds, boolean offline) voidUserSessionPersisterProvider.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) PersistentUserSessionProvider.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) PersistentUserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState) protected LongInfinispanUserSessionProviderFactory.deriveOfflineClientSessionCacheEntryLifespanOverrideMs(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity entity) protected LongInfinispanUserSessionProviderFactory.deriveOfflineSessionCacheEntryLifespanMs(RealmModel realm, ClientModel client, UserSessionEntity entity) InfinispanUserSessionProvider.getActiveClientSessionStats(RealmModel realm, boolean offline) PersistentUserSessionProvider.getActiveClientSessionStats(RealmModel realm, boolean offline) longInfinispanUserSessionProvider.getActiveUserSessions(RealmModel realm, ClientModel client) longPersistentUserSessionProvider.getActiveUserSessions(RealmModel realm, ClientModel client) longInfinispanUserSessionProvider.getOfflineSessionsCount(RealmModel realm, ClientModel client) longPersistentUserSessionProvider.getOfflineSessionsCount(RealmModel realm, ClientModel client) InfinispanUserSessionProvider.getOfflineUserSession(RealmModel realm, String userSessionId) PersistentUserSessionProvider.getOfflineUserSession(RealmModel realm, String userSessionId) InfinispanUserSessionProvider.getOfflineUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId) PersistentUserSessionProvider.getOfflineUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId) InfinispanUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer first, Integer max) InfinispanUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user) PersistentUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer first, Integer max) PersistentUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user) InfinispanAuthenticationSessionProvider.getRootAuthenticationSession(RealmModel realm, String authenticationSessionId) intInfinispanUserSessionProvider.getStartupTime(RealmModel realm) intPersistentUserSessionProvider.getStartupTime(RealmModel realm) InfinispanUserLoginFailureProvider.getUserLoginFailure(RealmModel realm, String userId) InfinispanUserSessionProvider.getUserSession(RealmModel realm, String id) protected UserSessionAdapter<InfinispanUserSessionProvider>InfinispanUserSessionProvider.getUserSession(RealmModel realm, String id, boolean offline) PersistentUserSessionProvider.getUserSession(RealmModel realm, String id) InfinispanUserSessionProvider.getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId) PersistentUserSessionProvider.getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId) InfinispanUserSessionProvider.getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId) PersistentUserSessionProvider.getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId) protected longInfinispanUserSessionProvider.getUserSessionsCount(RealmModel realm, ClientModel client, boolean offline) protected longPersistentUserSessionProvider.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) PersistentUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client) PersistentUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults) protected Stream<UserSessionModel>PersistentUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults, boolean offline) protected Stream<UserSessionModel>PersistentUserSessionProvider.getUserSessionsStream(RealmModel realm, UserSessionPredicate predicate, boolean offline) PersistentUserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user) InfinispanUserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate) PersistentUserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate) voidInfinispanAuthenticationSessionProvider.onClientRemoved(RealmModel realm, ClientModel client) voidInfinispanUserSessionProvider.onClientRemoved(RealmModel realm, ClientModel client) voidPersistentUserSessionProvider.onClientRemoved(RealmModel realm, ClientModel client) voidInfinispanAuthenticationSessionProvider.onRealmRemoved(RealmModel realm) voidInfinispanUserSessionProvider.onRealmRemoved(RealmModel realm) voidPersistentUserSessionProvider.onRealmRemoved(RealmModel realm) protected voidInfinispanUserSessionProvider.onUserRemoved(RealmModel realm, UserModel user) protected voidPersistentUserSessionProvider.onUserRemoved(RealmModel realm, UserModel user) voidInfinispanUserLoginFailureProvider.removeAllUserLoginFailures(RealmModel realm) voidInfinispanAuthenticationSessionProvider.removeExpired(RealmModel realm) voidInfinispanUserSessionProvider.removeExpired(RealmModel realm) voidPersistentUserSessionProvider.removeExpired(RealmModel realm) voidInfinispanUserSessionProvider.removeOfflineUserSession(RealmModel realm, UserSessionModel userSession) voidPersistentUserSessionProvider.removeOfflineUserSession(RealmModel realm, UserSessionModel userSession) voidInfinispanAuthenticationSessionProvider.removeRootAuthenticationSession(RealmModel realm, RootAuthenticationSessionModel authenticationSession) voidInfinispanUserLoginFailureProvider.removeUserLoginFailure(RealmModel realm, String userId) voidInfinispanUserSessionProvider.removeUserSession(RealmModel realm, UserSessionModel session) voidPersistentUserSessionProvider.removeUserSession(RealmModel realm, UserSessionModel session) voidInfinispanUserSessionProvider.removeUserSessions(RealmModel realm) voidInfinispanUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user) protected voidInfinispanUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user, boolean offline) voidPersistentUserSessionProvider.removeUserSessions(RealmModel realm) voidPersistentUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user) protected voidPersistentUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user, boolean offline) voidRootAuthenticationSessionAdapter.restartSession(RealmModel realm) voidUserSessionAdapter.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) PersistentUserSessionProvider.wrapPersistentEntity(RealmModel realm, boolean offline, UserSessionModel persistentUserSession) Constructors in org.keycloak.models.sessions.infinispan with parameters of type RealmModelModifierConstructorDescriptionRootAuthenticationSessionAdapter(KeycloakSession session, InfinispanAuthenticationSessionProvider provider, RealmModel realm, RootAuthenticationSessionEntity entity, int authSessionsLimit) UserSessionAdapter(KeycloakSession session, UserModel user, T provider, SessionsChangelogBasedTransaction<String, UserSessionEntity> userSessionUpdateTx, SessionsChangelogBasedTransaction<EmbeddedClientSessionKey, 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 that return RealmModelMethods in org.keycloak.models.sessions.infinispan.changes with parameters of type RealmModelModifier and TypeMethodDescriptionClientSessionPersistentChangelogBasedTransaction.get(RealmModel realm, ClientModel client, UserSessionModel userSession, EmbeddedClientSessionKey key, boolean offline) UserSessionPersistentChangelogBasedTransaction.get(RealmModel realm, String key, UserSessionModel userSession, boolean offline) SessionEntityWrapper.getClientIfNeeded(RealmModel realm) InfinispanChangelogBasedTransaction.importSession(RealmModel realmModel, K key, SessionEntityWrapper<V> session, long lifespan, long maxIdle) Imports a session from an external source into theCache.PersistentSessionsChangelogBasedTransaction.importSession(RealmModel realmModel, K key, SessionEntityWrapper<V> session, boolean offline, long lifespan, long maxIdle) Imports a session from an external source into theCache.voidInfinispanChangelogBasedTransaction.importSessionsConcurrently(RealmModel realmModel, Map<K, SessionEntityWrapper<V>> sessions, SessionFunction<V> lifespanFunction, SessionFunction<V> maxIdleFunction) Imports multiple sessions from an external source into theCache.voidPersistentSessionsChangelogBasedTransaction.importSessionsConcurrently(RealmModel realmModel, Map<K, SessionEntityWrapper<V>> sessions, boolean offline) Imports multiple sessions from an external source into theCache.voidInfinispanChangelogBasedTransaction.reloadEntityInCurrentTransaction(RealmModel realm, K key, SessionEntityWrapper<V> entity) Deprecated, for removal: This API element is subject to removal in a future version.voidPersistentSessionsChangelogBasedTransaction.reloadEntityInCurrentTransaction(RealmModel realm, K key, SessionEntityWrapper<V> entity) Deprecated, for removal: This API element is subject to removal in a future version.Constructors in org.keycloak.models.sessions.infinispan.changes with parameters of type RealmModelModifierConstructorDescriptionSessionUpdatesList(RealmModel realm, SessionEntityWrapper<S> entityWrapper) SessionUpdatesList(RealmModel realm, SessionEntityWrapper<S> entityWrapper, UserSessionModel.SessionPersistenceState persistenceState) -
Uses of RealmModel in org.keycloak.models.sessions.infinispan.changes.remote.updater.authsession
Methods in org.keycloak.models.sessions.infinispan.changes.remote.updater.authsession that return RealmModelMethods in org.keycloak.models.sessions.infinispan.changes.remote.updater.authsession with parameters of type RealmModelModifier and TypeMethodDescriptionvoidRootAuthenticationSessionUpdater.initialize(KeycloakSession session, RealmModel realm, int authSessionsLimit) voidRootAuthenticationSessionUpdater.restartSession(RealmModel realm) -
Uses of RealmModel in org.keycloak.models.sessions.infinispan.changes.remote.updater.client
Methods in org.keycloak.models.sessions.infinispan.changes.remote.updater.client that return RealmModel -
Uses of RealmModel in org.keycloak.models.sessions.infinispan.changes.remote.updater.user
Methods in org.keycloak.models.sessions.infinispan.changes.remote.updater.user that return RealmModelMethods in org.keycloak.models.sessions.infinispan.changes.remote.updater.user with parameters of type RealmModelModifier and TypeMethodDescriptionvoidUserSessionUpdater.initialize(UserSessionModel.SessionPersistenceState persistenceState, RealmModel realm, UserModel user, AuthenticatedClientSessionMapping clientSessions) Initializes this class with references to other models classes.voidUserSessionUpdater.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) -
Uses of RealmModel in org.keycloak.models.sessions.infinispan.entities
Methods in org.keycloak.models.sessions.infinispan.entities with parameters of type RealmModelModifier and TypeMethodDescriptionAuthenticatedClientSessionEntity.create(RealmModel realm, ClientModel client, UserSessionModel userSession) static RemoteUserSessionEntityRemoteUserSessionEntity.create(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) static UserSessionEntityUserSessionEntity.create(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) static voidUserSessionEntity.updateSessionEntity(UserSessionEntity entity, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) -
Uses of RealmModel in org.keycloak.models.sessions.infinispan.remote
Methods in org.keycloak.models.sessions.infinispan.remote with parameters of type RealmModelModifier and TypeMethodDescriptionRemoteUserLoginFailureProvider.addUserLoginFailure(RealmModel realm, String userId) RemoteUserSessionProvider.createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession) RemoteInfinispanAuthenticationSessionProvider.createRootAuthenticationSession(RealmModel realm) RemoteInfinispanAuthenticationSessionProvider.createRootAuthenticationSession(RealmModel realm, String id) RemoteUserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState) RemoteUserSessionProvider.getActiveClientSessionStats(RealmModel realm, boolean offline) longRemoteUserSessionProvider.getActiveUserSessions(RealmModel realm, ClientModel client) longRemoteUserSessionProvider.getOfflineSessionsCount(RealmModel realm, ClientModel client) RemoteUserSessionProvider.getOfflineUserSession(RealmModel realm, String userSessionId) RemoteUserSessionProvider.getOfflineUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId) RemoteUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults) RemoteUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user) RemoteInfinispanAuthenticationSessionProvider.getRootAuthenticationSession(RealmModel realm, String authenticationSessionId) intRemoteUserSessionProvider.getStartupTime(RealmModel realm) RemoteUserLoginFailureProvider.getUserLoginFailure(RealmModel realm, String userId) RemoteUserSessionProvider.getUserSession(RealmModel realm, String id) RemoteUserSessionProvider.getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId) RemoteUserSessionProvider.getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId) RemoteUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client) RemoteUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults) RemoteUserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user) RemoteUserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate) voidRemoteInfinispanAuthenticationSessionProvider.onClientRemoved(RealmModel realm, ClientModel client) voidRemoteUserSessionProvider.onClientRemoved(RealmModel realm, ClientModel client) voidRemoteInfinispanAuthenticationSessionProvider.onRealmRemoved(RealmModel realm) voidRemoteUserSessionProvider.onRealmRemoved(RealmModel realm) voidRemoteUserLoginFailureProvider.removeAllUserLoginFailures(RealmModel realm) voidRemoteInfinispanAuthenticationSessionProvider.removeExpired(RealmModel realm) voidRemoteUserSessionProvider.removeExpired(RealmModel realm) voidRemoteUserSessionProvider.removeOfflineUserSession(RealmModel realm, UserSessionModel userSession) voidRemoteInfinispanAuthenticationSessionProvider.removeRootAuthenticationSession(RealmModel realm, RootAuthenticationSessionModel authenticationSession) voidRemoteUserLoginFailureProvider.removeUserLoginFailure(RealmModel realm, String userId) voidRemoteUserSessionProvider.removeUserSession(RealmModel realm, UserSessionModel userSession) voidRemoteUserSessionProvider.removeUserSessions(RealmModel realm) voidRemoteUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user) -
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 longSessionTimeouts.getAuthSessionLifespanMS(RealmModel realm, ClientModel client, RootAuthenticationSessionEntity entity) static longSessionTimeouts.getAuthSessionMaxIdleMS(RealmModel realm, ClientModel client, RootAuthenticationSessionEntity entity) static longSessionTimeouts.getClientSessionLifespanMs(RealmModel realm, ClientModel client, boolean offline, boolean isUserSessionRememberMe, int started, int userSessionStarted) static longSessionTimeouts.getClientSessionLifespanMs(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity clientSessionEntity) Get the maximum lifespan, which this clientSession can remain in the infinispan cache.static longSessionTimeouts.getClientSessionMaxIdleMs(RealmModel realm, ClientModel client, boolean offline, boolean isUserSessionRememberMe, int timestamp) static longSessionTimeouts.getClientSessionMaxIdleMs(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity clientSessionEntity) Get the maxIdle, which this clientSession will use.static longSessionTimeouts.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 longSessionTimeouts.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 longSessionTimeouts.getOfflineClientSessionLifespanMs(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity authenticatedClientSessionEntity) Get the maximum lifespan, which this offline clientSession can remain in the infinispan cache.static longSessionTimeouts.getOfflineClientSessionMaxIdleMs(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity authenticatedClientSessionEntity) Get the maxIdle, which this offline clientSession will use.static longSessionTimeouts.getOfflineSessionLifespanMs(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum lifespan, which this offline userSession can remain in the infinispan cache.static longSessionTimeouts.getOfflineSessionMaxIdleMs(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum idle time for this offline userSession.static longSessionTimeouts.getUserSessionLifespanMs(RealmModel realm, boolean offline, boolean rememberMe, int started) static longSessionTimeouts.getUserSessionLifespanMs(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum lifespan, which this userSession can remain in the infinispan cache.static longSessionTimeouts.getUserSessionMaxIdleMs(RealmModel realm, boolean offline, boolean rememberMe, int lastSessionRefresh) static longSessionTimeouts.getUserSessionMaxIdleMs(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum idle time for this userSession. -
Uses of RealmModel in org.keycloak.models.utils
Classes in org.keycloak.models.utils that implement RealmModelMethods in org.keycloak.models.utils that return RealmModelMethods in org.keycloak.models.utils with parameters of type RealmModelModifier and TypeMethodDescriptionvoidDefaultRequiredActions.Action.addAction(RealmModel realm) static voidDefaultRequiredActions.addAction(RealmModel realm, DefaultRequiredActions.Action action) Add default required action to the realmstatic voidDefaultRequiredActions.addActions(RealmModel realm) Add default required actions to the realmstatic voidDefaultRequiredActions.addConfigureTotpAction(RealmModel realm) static voidDefaultRequiredActions.addDeleteAccountAction(RealmModel realm) static voidDefaultRequiredActions.addDeleteCredentialAction(RealmModel realm) static voidDefaultAuthenticationFlows.addFlows(RealmModel realm) static voidDefaultAuthenticationFlows.addIdentityProviderAuthenticator(RealmModel realm, String defaultProvider) static voidDefaultRequiredActions.addIdpLink(RealmModel realm) static voidDefaultAuthenticationFlows.addOrganizationBrowserFlowStep(RealmModel realm, AuthenticationFlowModel flow) static voidDefaultRequiredActions.addRecoveryAuthnCodesAction(RealmModel realm) static voidDefaultRequiredActions.addTermsAndConditionsAction(RealmModel realm) static voidDefaultRequiredActions.addUpdateEmailAction(RealmModel realm) static voidDefaultRequiredActions.addUpdateLocaleAction(RealmModel realm) static voidDefaultRequiredActions.addUpdatePasswordAction(RealmModel realm) static voidDefaultRequiredActions.addUpdateProfileAction(RealmModel realm) static voidDefaultRequiredActions.addVerifyEmailAction(RealmModel realm) static voidDefaultRequiredActions.addVerifyProfile(RealmModel realm) static voidDefaultRequiredActions.addWebAuthnPasswordlessRegisterAction(RealmModel realm) static voidDefaultRequiredActions.addWebAuthnRegisterAction(RealmModel realm) static voidDefaultAuthenticationFlows.browserFlow(RealmModel realm) static voidDefaultAuthenticationFlows.browserFlow(RealmModel realm, boolean migrate) static longSessionExpirationUtils.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 longSessionExpirationUtils.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 longSessionExpirationUtils.calculateUserSessionIdleTimestamp(boolean offline, boolean isRememberMe, long lastRefreshed, RealmModel realm) Calculates the time in which the user session is expired via the idle configuration.static longSessionExpirationUtils.calculateUserSessionMaxLifespanTimestamp(boolean offline, boolean isRememberMe, long created, RealmModel realm) Calculates the time in which the session is expired via max lifetime configuration.static voidDefaultAuthenticationFlows.clientAuthFlow(RealmModel realm) static voidDefaultKeyProviders.createAesProvider(RealmModel realm) static ClientModelRepresentationToModel.createClient(KeycloakSession session, RealmModel realm, ClientRepresentation resourceRep) Does not create scope or role mappings!static ClientModelRepresentationToModel.createClient(KeycloakSession session, RealmModel realm, ClientRepresentation resourceRep, Map<String, String> mappedFlows) static ClientScopeModelRepresentationToModel.createClientScope(RealmModel realm, ClientScopeRepresentation resourceRep) static voidRepresentationToModel.createCredentials(UserRepresentation userRep, KeycloakSession session, RealmModel realm, UserModel user, boolean adminRequest) static voidDefaultClientScopes.createDefaultClientScopes(KeycloakSession session, RealmModel realm, boolean addScopesToExistingClients) static voidRepresentationToModel.createFederatedIdentities(UserRepresentation userRep, KeycloakSession session, RealmModel realm, UserModel user) static voidRepresentationToModel.createGroups(KeycloakSession session, UserRepresentation userRep, RealmModel newRealm, UserModel user) static ClientModelKeycloakModelUtils.createManagementClient(RealmModel realm, String name) static voidDefaultClientScopes.createOfflineAccessClientScope(RealmModel newRealm, RoleModel offlineRole) static voidDefaultKeyProviders.createProviders(RealmModel realm) static voidDefaultKeyProviders.createProviders(RealmModel realm, String privateKeyPem, String certificatePem) static ClientModelKeycloakModelUtils.createPublicClient(RealmModel realm, String name) static RoleModelRepresentationToModel.createRole(RealmModel newRealm, RoleRepresentation roleRep) static voidRepresentationToModel.createRoleMappings(UserRepresentation userRep, UserModel user, RealmModel realm) static voidDefaultKeyProviders.createSecretProvider(RealmModel realm) static UserModelRepresentationToModel.createUser(KeycloakSession session, RealmModel newRealm, UserRepresentation userRep) static voidKeycloakModelUtils.deepDeleteAuthenticationExecutor(KeycloakSession session, RealmModel realm, AuthenticationExecutionModel authExecutor, Runnable flowUnavailableHandler, Runnable builtinFlowHandler) Recursively remove authentication executor (including sub-flows and configs) from the model storagestatic voidKeycloakModelUtils.deepDeleteAuthenticationFlow(KeycloakSession session, RealmModel realm, AuthenticationFlowModel authFlow, Runnable flowUnavailableHandler, Runnable builtinFlowHandler) Recursively remove authentication flow (including all subflows and executions) from the model storagestatic voidKeycloakModelUtils.deepFindAuthenticationExecutions(RealmModel realm, AuthenticationFlowModel flow, List<AuthenticationExecutionModel> result) Recursively find all AuthenticationExecutionModel from specified flow or all it's subflowsstatic voidDefaultAuthenticationFlows.directGrantFlow(RealmModel realm, boolean migrate) static voidDefaultAuthenticationFlows.dockerAuthenticationFlow(RealmModel realm) static voidModelToRepresentation.exportAuthenticationFlows(KeycloakSession session, RealmModel realm, RealmRepresentation rep) static voidModelToRepresentation.exportGroups(KeycloakSession session, RealmModel realm, RealmRepresentation rep) static voidModelToRepresentation.exportRequiredActions(RealmModel realm, RealmRepresentation rep) static ClientScopeModelKeycloakModelUtils.findClientScopeById(RealmModel realm, ClientModel client, String clientScopeId) Lookup clientScope OR client by id.static GroupModelKeycloakModelUtils.findGroupByPath(KeycloakSession session, RealmModel realm, String path) Finds group by path.static GroupModelKeycloakModelUtils.findGroupByPath(KeycloakSession session, RealmModel realm, String[] path) Finds group by path.static UserModelKeycloakModelUtils.findUserByNameOrEmail(KeycloakSession session, RealmModel realm, String username) If "Login with email" is enabled and the given username contains '@', attempts to find the user by email for authentication.static voidDefaultAuthenticationFlows.firstBrokerLoginFlow(RealmModel realm, boolean migrate) static longSessionExpiration.getAuthSessionExpiration(RealmModel realm, int timestamp) static intSessionExpiration.getAuthSessionLifespan(RealmModel realm) static ClientScopeModelKeycloakModelUtils.getClientScopeByName(RealmModel realm, String clientScopeName) static intSessionExpirationUtils.getOfflineSessionIdleTimeout(RealmModel realm) static RoleModelKeycloakModelUtils.getRoleFromString(RealmModel realm, String roleName) static intSessionExpirationUtils.getSsoSessionIdleTimeout(RealmModel realm) static ClientModelSystemClientUtil.getSystemClient(RealmModel realm) protected static booleanDefaultKeyProviders.hasProvider(RealmModel realm, String providerId) protected static booleanDefaultKeyProviders.hasProvider(RealmModel realm, String providerId, String algorithm) static voidRepresentationToModel.importGroup(RealmModel realm, GroupModel parent, GroupRepresentation group) static voidRepresentationToModel.importRealm(KeycloakSession session, RealmRepresentation rep, RealmModel newRealm, Runnable userImport) static voidRepresentationToModel.importRoles(RolesRepresentation realmRoles, RealmModel realm) static booleanKeycloakModelUtils.isFlowUsed(KeycloakSession session, RealmModel realm, AuthenticationFlowModel model) Check to see if a flow is currently in usestatic booleanRoleUtils.isRealmRole(RoleModel r, RealmModel realm) static voidDefaultAuthenticationFlows.migrateFlows(RealmModel realm) static voidComponentUtil.notifyCreated(KeycloakSession session, RealmModel realm, ComponentModel model) static voidComponentUtil.notifyPreRemove(KeycloakSession session, RealmModel realm, ComponentModel model) static voidComponentUtil.notifyUpdated(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) static voidDefaultAuthenticationFlows.registrationFlow(RealmModel realm, boolean migrate) static voidDefaultAuthenticationFlows.resetCredentialsFlow(RealmModel realm) voidUserSessionModelDelegate.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) static <T> TKeycloakModelUtils.runOnRealm(KeycloakSession session, RealmModel target, Function<KeycloakSession, T> operation) Runs the givenoperationwithin the scope of the given @{target} realm.static voidDefaultAuthenticationFlows.samlEcpProfile(RealmModel realm) static voidKeycloakModelUtils.setDefaultGroups(KeycloakSession session, RealmModel realm, Stream<String> groups) Sets the default groups on the realmstatic voidKeycloakModelUtils.setupAuthorizationServices(RealmModel realm) static voidKeycloakModelUtils.setupDefaultRole(RealmModel realm, String defaultRoleName) Creates default role for particular realm with the given name.static RoleModelKeycloakModelUtils.setupOfflineRole(RealmModel realm) static RealmRepresentationModelToRepresentation.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 AuthenticationExecutionModelRepresentationToModel.toModel(KeycloakSession session, RealmModel realm, AuthenticationExecutionRepresentation rep) static IdentityProviderModelRepresentationToModel.toModel(RealmModel realm, IdentityProviderRepresentation representation, KeycloakSession session) static UserConsentModelRepresentationToModel.toModel(RealmModel newRealm, UserConsentRepresentation consentRep) static RealmRepresentationModelToRepresentation.toRepresentation(KeycloakSession session, RealmModel realm, boolean internal) static RealmRepresentationModelToRepresentation.toRepresentation(KeycloakSession session, RealmModel realm, boolean internal, boolean export) ModelToRepresentation.toRepresentation(KeycloakSession session, RealmModel realm, AuthenticationExecutionModel model) ModelToRepresentation.toRepresentation(KeycloakSession session, RealmModel realm, AuthenticationFlowModel model) static UserRepresentationModelToRepresentation.toRepresentation(KeycloakSession session, RealmModel realm, UserModel user) static UserRepresentationModelToRepresentation.toRepresentation(KeycloakSession session, RealmModel realm, UserModel user, UserRepresentation rep, boolean setUserAttributes) ModelToRepresentation.toRepresentation(RealmModel realm, IdentityProviderModel identityProviderModel) ModelToRepresentation.toRepresentation(RealmModel realm, IdentityProviderModel identityProviderModel, boolean export) static voidRepresentationToModel.updateRealm(RealmRepresentation rep, RealmModel realm, KeycloakSession session) Constructors in org.keycloak.models.utils with parameters of type RealmModel -
Uses of RealmModel in org.keycloak.models.workflow
Methods in org.keycloak.models.workflow that return RealmModel -
Uses of RealmModel in org.keycloak.organization.authentication.authenticators.broker
Methods in org.keycloak.organization.authentication.authenticators.broker with parameters of type RealmModelModifier and TypeMethodDescriptionbooleanIdpAddOrganizationMemberAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.organization.authentication.authenticators.browser
Methods in org.keycloak.organization.authentication.authenticators.browser with parameters of type RealmModelModifier and TypeMethodDescriptionbooleanOrganizationAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of RealmModel in org.keycloak.organization.forms.login.freemarker.model
Constructors in org.keycloak.organization.forms.login.freemarker.model with parameters of type RealmModel -
Uses of RealmModel in org.keycloak.organization.jpa
Constructors in org.keycloak.organization.jpa with parameters of type RealmModelModifierConstructorDescriptionOrganizationAdapter(KeycloakSession session, RealmModel realm, OrganizationEntity entity, OrganizationProvider provider) -
Uses of RealmModel in org.keycloak.organization.protocol.mappers.oidc
Methods in org.keycloak.organization.protocol.mappers.oidc with parameters of type RealmModelModifier and TypeMethodDescriptionOrganizationMembershipMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel model) -
Uses of RealmModel in org.keycloak.organization.utils
Methods in org.keycloak.organization.utils with parameters of type RealmModelModifier and TypeMethodDescriptionstatic booleanOrganizations.isRegistrationAllowed(KeycloakSession session, RealmModel realm) static Consumer<GroupModel>Organizations.removeGroup(KeycloakSession session, RealmModel realm) -
Uses of RealmModel in org.keycloak.partialimport
Methods in org.keycloak.partialimport with parameters of type RealmModelModifier and TypeMethodDescriptionabstract voidAbstractPartialImport.create(RealmModel realm, KeycloakSession session, T resourceRep) voidClientsPartialImport.create(RealmModel realm, KeycloakSession session, ClientRepresentation clientRep) voidGroupsPartialImport.create(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep) voidIdentityProviderMappersPartialImport.create(RealmModel realm, KeycloakSession session, IdentityProviderMapperRepresentation idpMapperRep) voidIdentityProvidersPartialImport.create(RealmModel realm, KeycloakSession session, IdentityProviderRepresentation idpRep) voidRealmRolesPartialImport.create(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep) voidUsersPartialImport.create(RealmModel realm, KeycloakSession session, UserRepresentation user) voidClientRolesPartialImport.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 booleanAbstractPartialImport.exists(RealmModel realm, KeycloakSession session, T resourceRep) booleanClientRolesPartialImport.exists(RealmModel realm, KeycloakSession session, String clientId, RoleRepresentation roleRep) booleanClientsPartialImport.exists(RealmModel realm, KeycloakSession session, ClientRepresentation clientRep) booleanGroupsPartialImport.exists(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep) booleanIdentityProviderMappersPartialImport.exists(RealmModel realm, KeycloakSession session, IdentityProviderMapperRepresentation idpMapperRep) booleanIdentityProvidersPartialImport.exists(RealmModel realm, KeycloakSession session, IdentityProviderRepresentation idpRep) booleanRealmRolesPartialImport.exists(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep) booleanUsersPartialImport.exists(RealmModel realm, KeycloakSession session, UserRepresentation user) abstract StringAbstractPartialImport.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 StringAbstractPartialImport.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) voidAbstractPartialImport.prepare(PartialImportRepresentation partialImportRep, RealmModel realm, KeycloakSession session) voidClientRolesPartialImport.prepare(PartialImportRepresentation partialImportRep, RealmModel realm, KeycloakSession session) voidPartialImport.prepare(PartialImportRepresentation rep, RealmModel realm, KeycloakSession session) Find which resources will need to be skipped or overwritten.voidRolesPartialImport.prepare(PartialImportRepresentation rep, RealmModel realm, KeycloakSession session) abstract voidAbstractPartialImport.remove(RealmModel realm, KeycloakSession session, T resourceRep) voidClientsPartialImport.remove(RealmModel realm, KeycloakSession session, ClientRepresentation clientRep) voidGroupsPartialImport.remove(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep) voidIdentityProviderMappersPartialImport.remove(RealmModel realm, KeycloakSession session, IdentityProviderMapperRepresentation idpMapperRep) voidIdentityProvidersPartialImport.remove(RealmModel realm, KeycloakSession session, IdentityProviderRepresentation idpRep) voidRealmRolesPartialImport.remove(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep) voidUsersPartialImport.remove(RealmModel realm, KeycloakSession session, UserRepresentation user) voidAbstractPartialImport.removeOverwrites(RealmModel realm, KeycloakSession session) voidPartialImport.removeOverwrites(RealmModel realm, KeycloakSession session) Delete resources that will be overwritten.voidRolesPartialImport.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 TypeMethodDescriptionAgePasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) BlacklistPasswordPolicyProvider.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) NotContainsUsernamePasswordPolicyProvider.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) Deprecated.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 voidAbstractLoginProtocolFactory.addDefaultClientScopes(RealmModel realm, Stream<ClientModel> newClients) protected voidAbstractLoginProtocolFactory.addDefaultClientScopes(RealmModel realm, ClientModel newClient) voidAbstractLoginProtocolFactory.createDefaultClientScopes(RealmModel newRealm, boolean addScopesToExistingClients) voidLoginProtocolFactory.createDefaultClientScopes(RealmModel newRealm, boolean addScopesToExistingClients) Called when new realm is createdprotected abstract voidAbstractLoginProtocolFactory.createDefaultClientScopesImpl(RealmModel newRealm) Impl should create default client scopes.jakarta.ws.rs.core.ResponseClientInstallationProvider.generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) default ProtocolMapperModelProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel) Get effective configuration of protocol mapper.static AuthenticationSessionModelRestartLoginCookie.restartSession(KeycloakSession session, RealmModel realm, RootAuthenticationSessionModel rootSession, String expectedClientId, String encodedCookie) default booleanLoginProtocol.sendPushRevocationPolicyRequest(RealmModel realm, ClientModel resource, int notBefore, String managementUrl) Send not-before revocation policy to the given client.LoginProtocol.setRealm(RealmModel realm) default voidProtocolMapper.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 TypeMethodDescriptionbooleanDockerAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) protected voidDockerAuthV2ProtocolFactory.createDefaultClientScopesImpl(RealmModel newRealm) protected voidDockerAuthenticator.notValidCredentialsAction(AuthenticationFlowContext context, RealmModel realm, UserModel user) protected voidDockerAuthenticator.nullUserAction(AuthenticationFlowContext context, RealmModel realm, String userId) DockerAuthV2Protocol.setRealm(RealmModel realm) protected voidDockerAuthenticator.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.ResponseDockerComposeYamlInstallationProvider.generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) jakarta.ws.rs.core.ResponseDockerRegistryConfigFileInstallationProvider.generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) jakarta.ws.rs.core.ResponseDockerVariableOverrideInstallationProvider.generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) -
Uses of RealmModel in org.keycloak.protocol.oid4vc
Methods in org.keycloak.protocol.oid4vc with parameters of type RealmModelModifier and TypeMethodDescriptionvoidOID4VCLoginProtocolFactory.createDefaultClientScopes(RealmModel newRealm, boolean addScopesToExistingClients) -
Uses of RealmModel in org.keycloak.protocol.oid4vc.issuance
Methods in org.keycloak.protocol.oid4vc.issuance with parameters of type RealmModelModifier and TypeMethodDescriptionOID4VCIssuerWellKnownProvider.getBatchCredentialIssuance(RealmModel realm) Returns the batch credential issuance configuration for the given realm. -
Uses of RealmModel in org.keycloak.protocol.oid4vc.issuance.keybinding
Methods in org.keycloak.protocol.oid4vc.issuance.keybinding with parameters of type RealmModelModifier and TypeMethodDescriptionprotected KeyWrapperJwtCNonceHandler.selectSigningKey(RealmModel realm) -
Uses of RealmModel in org.keycloak.protocol.oid4vc.issuance.mappers
Methods in org.keycloak.protocol.oid4vc.issuance.mappers with parameters of type RealmModelModifier and TypeMethodDescriptionvoidOID4VCTargetRoleMapper.validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel) -
Uses of RealmModel in org.keycloak.protocol.oidc
Fields in org.keycloak.protocol.oidc declared as RealmModelModifier and TypeFieldDescriptionprotected final RealmModelAccessTokenIntrospectionProvider.realmprotected RealmModelOIDCLoginProtocol.realmMethods in org.keycloak.protocol.oidc that return RealmModelMethods in org.keycloak.protocol.oidc with parameters of type RealmModelModifier and TypeMethodDescriptionOIDCLoginProtocolFactory.addAcrClientScope(RealmModel newRealm) OIDCLoginProtocolFactory.addBasicClientScope(RealmModel newRealm) OIDCLoginProtocolFactory.addMicroprofileJWTClientScope(RealmModel newRealm) Adds themicroprofile-jwtoptional client scope to the specified realm.OIDCLoginProtocolFactory.addRolesClientScope(RealmModel newRealm) OIDCLoginProtocolFactory.addServiceAccountClientScope(RealmModel newRealm) OIDCLoginProtocolFactory.addWebOriginsClientScope(RealmModel newRealm) TokenManager.createClientAccessToken(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx) protected voidOIDCLoginProtocolFactory.createDefaultClientScopesImpl(RealmModel newRealm) static TokenManager.NotBeforeCheckTokenManager.NotBeforeCheck.forModel(KeycloakSession session, RealmModel realmModel, UserModel userModel) static TokenManager.NotBeforeCheckTokenManager.NotBeforeCheck.forModel(RealmModel realmModel) OIDCWellKnownProvider.getPromptValuesSupported(RealmModel realm) protected AccessTokenTokenManager.initToken(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx, jakarta.ws.rs.core.UriInfo uriInfo) static booleanTokenManager.isUserValid(KeycloakSession session, RealmModel realm, AccessToken token, UserModel user) static UserModelTokenManager.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, String scopeParameter) TokenManager.responseBuilder(RealmModel realm, ClientModel client, EventBuilder event, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx) booleanOIDCLoginProtocol.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, String oldTokenScope) voidTokenManager.validateTokenReuse(KeycloakSession session, RealmModel realm, AccessToken refreshToken, AuthenticatedClientSessionModel clientSession, boolean refreshFlag) TokenManager.verifyIDToken(KeycloakSession session, RealmModel realm, String encodedIDToken) 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, Cors 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
Fields in org.keycloak.protocol.oidc.grants declared as RealmModelModifier and TypeFieldDescriptionprotected RealmModelOAuth2GrantType.Context.realmprotected RealmModelOAuth2GrantTypeBase.realmMethods in org.keycloak.protocol.oidc.grants that return RealmModel -
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 booleanDeviceGrantType.approveUserCode(KeycloakSession session, RealmModel realm, String userCode, String userSessionId, Map<String, String> additionalParams) static booleanDeviceGrantType.denyUserCode(KeycloakSession session, RealmModel realm, String userCode) static OAuth2DeviceCodeModelDeviceGrantType.getDeviceByDeviceCode(KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, String deviceCode) static booleanDeviceGrantType.isDeviceCodeDeniedForDeviceVerificationFlow(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession) static voidDeviceGrantType.removeDeviceByUserCode(KeycloakSession session, RealmModel realm, String userCode) -
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 OAuth2DeviceCodeModelDeviceEndpoint.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.ResponseKeycloakOIDCClientInstallation.generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.ResponseKeycloakOIDCJbossSubsystemClientCliInstallation.generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.ResponseKeycloakOIDCJbossSubsystemClientInstallation.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 TypeMethodDescriptionAmrProtocolMapper.getAmr(AuthenticatedClientSessionModel clientSession, RealmModel realmModel) Extract the AMR values from the existing session.AbstractOIDCProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel) AllowedWebOriginsProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel) AudienceResolveProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel) voidAbstractPairwiseSubMapper.validateAdditionalConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, ProtocolMapperModel mapperModel) Override to add additional configuration validation.voidSHA256PairwiseSubMapper.validateAdditionalConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, ProtocolMapperModel mapperModel) final voidAbstractPairwiseSubMapper.validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, ProtocolMapperModel mapperModel) voidScriptBasedOIDCProtocolMapper.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.tokenexchange
Fields in org.keycloak.protocol.oidc.tokenexchange 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) AmrUtils.getAuthenticationExecutionReferences(Map<String, Integer> executions, RealmModel realmModel) Get the configured authenticator reference values for the specified executions.static JSONWebKeySetJWKSServerUtils.getRealmJwks(KeycloakSession session, RealmModel realm) static OAuth2CodeParser.ParseResultOAuth2CodeParser.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 voidSamlProtocolFactory.createDefaultClientScopesImpl(RealmModel newRealm) SamlSessionUtils.getClientSession(KeycloakSession session, RealmModel realm, String sessionIndex) static StringSamlService.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 StringSamlProtocol.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 voidKeycloakSamlClientInstallation.baseXml(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri, SamlClient samlClient, StringBuilder buffer) jakarta.ws.rs.core.ResponseKeycloakSamlClientInstallation.generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.ResponseKeycloakSamlSubsystemCliInstallation.generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.ResponseKeycloakSamlSubsystemInstallation.generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.ResponseModAuthMellonClientInstallation.generateInstallation(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) jakarta.ws.rs.core.ResponseSamlSPDescriptorClientInstallation.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 TypeMethodDescriptionvoidScriptBasedMapper.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 TypeMethodDescriptionbooleanHttpBasicAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) protected voidHttpBasicAuthenticator.notValidCredentialsAction(AuthenticationFlowContext context, RealmModel realm, UserModel user) protected voidHttpBasicAuthenticator.nullUserAction(AuthenticationFlowContext context, RealmModel realm, String user) voidHttpBasicAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) protected voidHttpBasicAuthenticator.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, boolean includeGlobalPolicies) when getting client policies via Admin REST API, returns the existing client policies set on the realm.DefaultClientPolicyManager.getClientPolicies(RealmModel realm, boolean includeGlobalPolicies) 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) voidClientPolicyManager.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.voidDefaultClientPolicyManager.setupClientPoliciesOnCreatedRealm(RealmModel realm) voidClientPolicyManager.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.voidDefaultClientPolicyManager.updateClientPolicies(RealmModel realm, ClientPoliciesRepresentation clientPolicies) voidClientPolicyManager.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.voidDefaultClientPolicyManager.updateClientProfiles(RealmModel realm, ClientProfilesRepresentation clientProfiles) voidClientPolicyManager.updateRealmModelFromRepresentation(RealmModel realm, RealmRepresentation rep) when importing a realm, or updating a realm, update model from the representation objectvoidDefaultClientPolicyManager.updateRealmModelFromRepresentation(RealmModel realm, RealmRepresentation rep) voidClientPolicyManager.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.voidDefaultClientPolicyManager.updateRealmRepresentationFromModel(RealmModel realm, RealmRepresentation rep) -
Uses of RealmModel in org.keycloak.services.clientpolicy.condition
Methods in org.keycloak.services.clientpolicy.condition with parameters of type RealmModelModifier and TypeMethodDescriptiondefault voidClientPolicyConditionProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ClientPolicyConditionRepresentation conditionRepresentation) Called before a Client Policy is created or updated.voidClientScopesConditionFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ClientPolicyConditionRepresentation conditionRepresentation) -
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 StringClientRegistrationTokenUtils.createInitialAccessToken(KeycloakSession session, RealmModel realm, ClientInitialAccessModel model) static StringClientRegistrationTokenUtils.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 voidDefaultClientRegistrationPolicies.addDefaultPolicies(RealmModel realm) voidAbstractClientRegistrationPolicyFactory.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 TypeMethodDescriptionvoidClientScopesClientRegistrationPolicyFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) voidMaxClientsClientRegistrationPolicyFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) voidTrustedHostClientRegistrationPolicyFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) -
Uses of RealmModel in org.keycloak.services.clienttype
Methods in org.keycloak.services.clienttype with parameters of type RealmModelModifier and TypeMethodDescriptionDefaultClientTypeManager.getClientType(RealmModel realm, String typeName) DefaultClientTypeManager.getClientTypes(RealmModel realm) voidDefaultClientTypeManager.updateClientTypes(RealmModel realm, ClientTypesRepresentation clientTypes) -
Uses of RealmModel in org.keycloak.services.logging
Methods in org.keycloak.services.logging with parameters of type RealmModelModifier and TypeMethodDescriptionvoidDefaultMappedDiagnosticContextProviderFactory.update(KeycloakContext keycloakContext, RealmModel realm) -
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) RealmManager.importRealm(RealmRepresentation rep) RealmManager.importRealm(RealmRepresentation rep, boolean skipUserDependent) Deprecated.RealmManager.importRealm(RealmRepresentation rep, Runnable userImport) Methods in org.keycloak.services.managers with parameters of type RealmModelModifier and TypeMethodDescriptionstatic voidUserConsentManager.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 BackchannelLogoutResponseAuthenticationManager.backchannelLogout(KeycloakSession session, RealmModel realm, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection, jakarta.ws.rs.core.HttpHeaders headers, boolean logoutBroker) static BackchannelLogoutResponseAuthenticationManager.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 voidAuthenticationManager.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.ResponseAuthenticationManager.browserLogout(KeycloakSession session, RealmModel realm, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection, jakarta.ws.rs.core.HttpHeaders headers) static LDAPConfigLDAPServerCapabilitiesManager.buildLDAPConfig(TestLdapConnectionRepresentation config, RealmModel realm) voidBruteForceProtector.cleanUpPermanentLockout(KeycloakSession session, RealmModel realm, UserModel user) Clears any remaining traces of the permanent lockout.voidDefaultBruteForceProtector.cleanUpPermanentLockout(KeycloakSession session, RealmModel realm, UserModel user) AuthenticationSessionManager.createAuthenticationSession(RealmModel realm, boolean browserCookie) Creates a fresh authentication session for the given realm .static ClientModelClientManager.createClient(KeycloakSession session, RealmModel realm, ClientRepresentation rep) Should not be called from an import.protected voidRealmManager.createDefaultClientScopes(RealmModel realm) static IdentityCookieTokenAuthenticationManager.createIdentityToken(KeycloakSession keycloakSession, RealmModel realm, UserModel user, UserSessionModel session, String issuer) static voidAuthenticationManager.createLoginCookie(KeycloakSession keycloakSession, RealmModel realm, UserModel user, UserSessionModel session, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection) static AuthenticationSessionModelAuthenticationManager.createOrJoinLogoutSession(KeycloakSession session, RealmModel realm, AuthenticationSessionManager asm, UserSessionModel userSession, boolean browserCookie, boolean initiateLogout) 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 voidAuthenticationManager.evaluateRequiredActionTriggers(KeycloakSession session, AuthenticationSessionModel authSession, HttpRequest request, EventBuilder event, RealmModel realm, UserModel user) protected static jakarta.ws.rs.core.ResponseAuthenticationManager.executionActions(KeycloakSession session, AuthenticationSessionModel authSession, HttpRequest request, EventBuilder event, RealmModel realm, UserModel user, Set<String> ignoredActions) static booleanAuthenticationManager.expireUserSessionCookie(KeycloakSession session, UserSessionModel userSession, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.HttpHeaders headers, ClientConnection connection) voidBruteForceProtector.failedLogin(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo) voidDefaultBruteForceProtector.failedLogin(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo) protected voidDefaultBlockingBruteForceProtector.failure(KeycloakSession session, RealmModel realm, String userId, String remoteAddr, long failureTime) protected voidDefaultBruteForceProtector.failure(KeycloakSession session, RealmModel realm, String userId, String remoteAddr, long failureTime) 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.ResponseAuthenticationManager.finishBrowserLogout(KeycloakSession session, RealmModel realm, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection, jakarta.ws.rs.core.HttpHeaders headers) static voidAuthenticationManager.finishUnconfirmedUserSession(KeycloakSession session, RealmModel realm, UserSessionModel userSessionModel) AuthenticationSessionManager.getAuthenticationSessionByEncodedIdAndClient(RealmModel realm, String encodedAuthSesionId, ClientModel client, String tabId) 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 UserConsentModelUserConsentManager.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) RealmManager.getRealmAdminClientId(RealmModel realm) static StringAuthenticationManager.getRealmCookiePath(RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo) protected UserLoginFailureModelDefaultBruteForceProtector.getUserFailureModel(KeycloakSession session, RealmModel realm, String userId) AuthenticationSessionManager.getUserSessionFromAuthenticationCookie(RealmModel realm) UserSessionCrossDCManager.getUserSessionIfExistsRemotely(AuthenticationSessionManager asm, RealmModel realm) Deprecated, for removal: This API element is subject to removal in a future version.To be removed in Keycloak 27+.UserSessionCrossDCManager.getUserSessionWithClient(RealmModel realm, String id, boolean offline, String clientUUID) Deprecated, for removal: This API element is subject to removal in a future version.To be removed in Keycloak 27+.UserSessionCrossDCManager.getUserSessionWithClient(RealmModel realm, String id, String clientUUID) Deprecated, for removal: This API element is subject to removal in a future version.To be removed in Keycloak 27+.UserSessionCrossDCManager.getUserSessionWithImpersonatorClient(RealmModel realm, String id, boolean offline, String clientUUID) Deprecated, for removal: This API element is subject to removal in a future version.To be removed in Keycloak 27+.static booleanRealmManager.isAdministrationRealm(RealmModel realm) static booleanAuthenticationManager.isClientSessionValid(RealmModel realm, ClientModel client, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession) booleanBruteForceProtector.isPermanentlyLockedOut(KeycloakSession session, RealmModel realm, UserModel user) booleanDefaultBlockingBruteForceProtector.isPermanentlyLockedOut(KeycloakSession session, RealmModel realm, UserModel user) booleanDefaultBruteForceProtector.isPermanentlyLockedOut(KeycloakSession session, RealmModel realm, UserModel user) static booleanAuthenticationManager.isSessionValid(RealmModel realm, UserSessionModel userSession) booleanBruteForceProtector.isTemporarilyDisabled(KeycloakSession session, RealmModel realm, UserModel user) booleanDefaultBlockingBruteForceProtector.isTemporarilyDisabled(KeycloakSession session, RealmModel realm, UserModel user) booleanDefaultBruteForceProtector.isTemporarilyDisabled(KeycloakSession session, RealmModel realm, UserModel user) ResourceAdminManager.logoutAll(RealmModel realm) ResourceAdminManager.logoutClient(RealmModel realm, ClientModel resource) protected GlobalRequestResultResourceAdminManager.logoutClient(RealmModel realm, ClientModel resource, int notBefore) jakarta.ws.rs.core.ResponseResourceAdminManager.logoutClientSession(RealmModel realm, ClientModel resource, AuthenticatedClientSessionModel clientSession) protected jakarta.ws.rs.core.ResponseResourceAdminManager.logoutClientSessions(RealmModel realm, ClientModel resource, List<AuthenticatedClientSessionModel> clientSessions) static UserModelAuthenticationManager.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) protected voidDefaultBlockingBruteForceProtector.processLogin(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo, boolean success) protected voidDefaultBruteForceProtector.processLogin(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo, boolean success) ResourceAdminManager.pushClientRevocationPolicy(RealmModel realm, ClientModel client) ResourceAdminManager.pushRealmRevocationPolicy(RealmModel realm) protected GlobalRequestResultResourceAdminManager.pushRevocationPolicy(RealmModel realm, ClientModel resource, int notBefore) static Set<LDAPCapabilityRepresentation>LDAPServerCapabilitiesManager.queryServerCapabilities(TestLdapConnectionRepresentation config, KeycloakSession session, RealmModel realm) static jakarta.ws.rs.core.ResponseAuthenticationManager.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.ResponseAuthenticationManager.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.ResponseAuthenticationManager.redirectToRequiredActions(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession, jakarta.ws.rs.core.UriInfo uriInfo, String requiredAction) voidAuthenticationSessionManager.removeAuthenticationSession(RealmModel realm, AuthenticationSessionModel authSession, boolean expireRestartCookie) booleanClientManager.removeClient(RealmModel realm, ClientModel client) booleanUserSessionManager.removeClientFromOfflineUserSession(RealmModel realm, UserSessionModel userSession, ClientModel client, UserModel user) booleanRealmManager.removeRealm(RealmModel realm) booleanAuthenticationSessionManager.removeTabIdInAuthenticationSession(RealmModel realm, AuthenticationSessionModel authSession) Remove authentication session from root session.static voidAuthenticationManager.resolveLightweightAccessTokenRoles(KeycloakSession session, AccessToken accessToken, RealmModel realm) static booleanUserConsentManager.revokeConsentForClient(KeycloakSession session, RealmModel realm, UserModel user, String clientInternalId) Remove a user consent given by the user and client idprotected voidDefaultBruteForceProtector.sendEvent(KeycloakSession session, RealmModel realm, UserLoginFailureModel userLoginFailure, EventType type) protected jakarta.ws.rs.core.ResponseResourceAdminManager.sendLogoutRequest(RealmModel realm, ClientModel resource, List<String> adapterSessionIds, List<String> userSessions, int notBefore, String managementUrl) protected booleanResourceAdminManager.sendPushRevocationPolicyRequest(RealmModel realm, ClientModel resource, int notBefore, String managementUrl) protected booleanResourceAdminManager.sendTestNodeAvailabilityRequest(RealmModel realm, ClientModel client, String managementUrl) voidRealmManager.setDefaultsForNewRealm(RealmModel realm) AppAuthManager.BearerTokenAuthenticator.setRealm(RealmModel realm) voidRealmManager.setupAdminCli(RealmModel realm) protected voidRealmManager.setupAdminConsole(RealmModel realm) protected voidRealmManager.setupAdminConsoleLocaleMapper(RealmModel realm) protected voidRealmManager.setupAuthenticationFlows(RealmModel realm) voidRealmManager.setupBrokerService(RealmModel realm) voidRealmManager.setupImpersonationService(RealmModel realm) voidRealmManager.setupMasterAdminManagement(RealmModel realm) protected voidRealmManager.setupRealmDefaults(RealmModel realm) protected voidRealmManager.setupRequiredActions(RealmModel realm) protected voidDefaultBlockingBruteForceProtector.success(KeycloakSession session, RealmModel realm, String userId) protected voidDefaultBruteForceProtector.success(KeycloakSession session, RealmModel realm, String userId) voidBruteForceProtector.successfulLogin(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo) voidDefaultBruteForceProtector.successfulLogin(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo) static voidLDAPServerCapabilitiesManager.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) voidAuthenticationSessionManager.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 voidUserConsentManager.updateConsent(KeycloakSession session, RealmModel realm, UserModel user, UserConsentModel consent) Update client scopes in the stored user consentvoidRealmManager.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, Consumer<TokenVerifier<AccessToken>> verifierConsumer) 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 TypeMethodDescriptionDefaultMigrationProvider.addOIDCAcrClientScope(RealmModel realm) DefaultMigrationProvider.addOIDCBasicClientScope(RealmModel realm) DefaultMigrationProvider.addOIDCMicroprofileJWTClientScope(RealmModel realm) DefaultMigrationProvider.addOIDCRolesClientScope(RealmModel realm) DefaultMigrationProvider.addOIDCServiceAccountClientScope(RealmModel realm) DefaultMigrationProvider.addOIDCWebOriginsClientScope(RealmModel realm) voidDefaultMigrationProvider.setupAdminCli(RealmModel realm) -
Uses of RealmModel in org.keycloak.services.resources
Fields in org.keycloak.services.resources declared as RealmModelModifier and TypeFieldDescriptionprotected final RealmModelAbstractSecuredLocalService.realmprotected final RealmModelPublicRealmResource.realmMethods in org.keycloak.services.resources with parameters of type RealmModelModifier and TypeMethodDescriptionstatic voidLoginActionsServiceChecks.checkIsUserValid(KeycloakSession session, RealmModel realm, String userId, Consumer<UserModel> userSetter, EventBuilder event) Verifies whether the user given by ID both exists in the current realm.static PublishedRealmRepresentationPublicRealmResource.realmRep(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo) static jakarta.ws.rs.core.ResponseLoginActionsService.redirectToAfterBrokerLoginEndpoint(KeycloakSession session, RealmModel realm, jakarta.ws.rs.core.UriInfo uriInfo, AuthenticationSessionModel authSession, boolean firstBrokerLogin) jakarta.ws.rs.core.ResponseIdentityBrokerService.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 clientData, String flowPath) -
Uses of RealmModel in org.keycloak.services.resources.account
Methods in org.keycloak.services.resources.account with parameters of type RealmModelModifier and TypeMethodDescriptionprotected ClientModelAccountConsoleFactory.getAccountManagementClient(RealmModel realm) LinkedAccountsResource.getLinkedAccounts(KeycloakSession session, RealmModel realm, UserModel user) Deprecated.booleanPasswordUtil.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 RealmModelAdminConsole.realmprotected final RealmModelAttackDetectionResource.realmprotected final RealmModelClearCrlCacheResource.realmprotected final RealmModelClearKeysCacheResource.realmprotected final RealmModelClearRealmCacheResource.realmprotected final RealmModelClearUserCacheResource.realmprotected final RealmModelClientAttributeCertificateResource.realmprotected final RealmModelClientPoliciesResource.realmprotected final RealmModelClientProfilesResource.realmprotected RealmModelClientResource.realmprotected RealmModelClientRoleMappingsResource.realmprotected RealmModelClientScopeResource.realmprotected final RealmModelClientScopesResource.realmprotected final RealmModelClientsResource.realmprotected final RealmModelClientTypesResource.realmprotected final RealmModelComponentResource.realmprotected final RealmModelLdapServerCapabilitiesResource.realmprotected final RealmModelProtocolMappersResource.realmprotected final RealmModelRealmAdminResource.realmprotected final RealmModelRoleMapperResource.realmprotected RealmModelRoleResource.realmprotected RealmModelScopeMappedClientResource.realmprotected RealmModelScopeMappedResource.realmprotected final RealmModelTestLdapConnectionResource.realmprotected final RealmModelUserProfileResource.realmprotected final RealmModelUserResource.realmprotected final RealmModelUsersResource.realmprotected final RealmModelUserStorageProviderResource.realmMethods in org.keycloak.services.resources.admin that return RealmModelModifier and TypeMethodDescriptionprotected RealmModelAdminConsole.getAdminstrationRealm(RealmManager realmManager) AdminAuth.getRealm()Methods in org.keycloak.services.resources.admin with parameters of type RealmModelModifier and TypeMethodDescriptionAdminEventBuilder.authRealm(RealmModel realm) static voidAuthenticationManagementResource.copy(KeycloakSession session, RealmModel realm, String newName, AuthenticationFlowModel from, AuthenticationFlowModel to) static AuthenticationFlowModelAuthenticationManagementResource.copyFlow(KeycloakSession session, RealmModel realm, AuthenticationFlowModel flow, String newName) static PropertiesAdminRoot.getMessages(KeycloakSession session, RealmModel realm, String lang) static PropertiesAdminRoot.getMessages(KeycloakSession session, RealmModel realm, String lang, String... bundles) ClearCrlCacheRealmAdminProvider.getResource(KeycloakSession session, RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) 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 ThemeAdminRoot.getTheme(KeycloakSession session, RealmModel realm) AdminEventBuilder.realm(RealmModel realm) protected RealmRepresentationRealmsAdminResource.toRealmRep(RealmModel realm, boolean briefRep) static voidGroupResource.updateGroup(GroupRepresentation rep, GroupModel model, RealmModel realm, KeycloakSession session) protected voidRoleResource.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) ClientTypesResource(ClientTypeManager manager, RealmModel realm, AdminPermissionEvaluator auth) 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.fgap
Methods in org.keycloak.services.resources.admin.fgap with parameters of type RealmModelModifier and TypeMethodDescriptionbooleanRealmsPermissionEvaluator.canView(RealmModel realm) static AdminPermissionEvaluatorAdminPermissions.evaluator(KeycloakSession session, RealmModel realm, RealmModel adminsRealm, UserModel admin) static AdminPermissionEvaluatorAdminPermissions.evaluator(KeycloakSession session, RealmModel realm, AdminAuth auth) booleanRealmsPermissionEvaluator.isAdmin(RealmModel realm) static AdminPermissionManagementAdminPermissions.management(KeycloakSession session, RealmModel realm) -
Uses of RealmModel in org.keycloak.services.util
Methods in org.keycloak.services.util with parameters of type RealmModelModifier and TypeMethodDescriptionstatic PropertiesLocaleUtil.enhancePropertiesWithRealmLocalizationTexts(RealmModel realm, Locale locale, Map<Locale, Properties> themeMessages) Enhance the properties from a theme with realm localization texts.UserSessionUtil.findValidSessionForAccessToken(KeycloakSession session, RealmModel realm, AccessToken token, ClientModel client, Consumer<UserSessionModel> invalidSessionCallback) UserSessionUtil.findValidSessionForIdentityCookie(KeycloakSession session, RealmModel realm, AccessToken token, Consumer<UserSessionModel> invalidSessionCallback) UserSessionUtil.findValidSessionForRefreshToken(KeycloakSession session, RealmModel realm, RefreshToken token, ClientModel client, Consumer<UserSessionModel> invalidSessionCallback) static Map<Locale,Properties> LocaleUtil.getRealmLocalizationTexts(RealmModel realm, Locale locale) static UserSessionModelUserSessionUtil.getUserSessionWithImpersonatorClient(KeycloakSession session, RealmModel realm, String userSessionId, boolean offline, String clientUUID) static voidLocaleUtil.processLocaleParam(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession) static TokenVerifier<AccessToken>DPoPUtil.withDPoPVerifier(TokenVerifier<AccessToken> verifier, RealmModel realm, DPoPUtil.Validator validator) 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.voidAuthenticationSessionProvider.onClientRemoved(RealmModel realm, ClientModel client) Removes all associated root authentication sessions to the given realm and client which was removed.voidAuthenticationSessionProvider.onRealmRemoved(RealmModel realm) Removes all associated root authentication sessions to the given realm which was removed.voidAuthenticationSessionProvider.removeExpired(RealmModel realm) Deprecated.manual removal of expired entities should not be used anymore.voidAuthenticationSessionProvider.removeRootAuthenticationSession(RealmModel realm, RootAuthenticationSessionModel authenticationSession) Removes provided root authentication session.voidRootAuthenticationSessionModel.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 RealmModelTwitterIdentityProvider.Endpoint.realmMethods 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 RealmModelImportRealmFromRepresentationEvent.fire(KeycloakSession session, RealmRepresentation rep) Deprecated.PartialImportRealmFromRepresentationEvent.getRealm()Deprecated.StoreMigrateRepresentationEvent.getRealm()StoreSyncEvent.getRealm()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) voidClientStorageManager.addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) voidClientStorageManager.addClientScopeToAllClients(RealmModel realm, ClientScopeModel clientScope, boolean defaultClientScope) voidUserStorageManager.addConsent(RealmModel realm, String userId, UserConsentModel consent) voidUserStorageManager.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) RoleStorageManager.addRealmRole(RealmModel realm, String name) RoleStorageManager.addRealmRole(RealmModel realm, String id, String name) voidGroupStorageManager.addTopLevelGroup(RealmModel realm, GroupModel subGroup) UserStorageManager.addUser(RealmModel realm, String username) UserRegistrationProvidermethods implementations start hereUserStorageManager.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) UserStorageProvidermethods implementation end hereUserProvidermethods implementations start here -> no StorageProviders involvedprotected <T> voidAbstractStorageManager.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, GroupModel.Type type, String name, GroupModel toParent) ExportImportManager.createUser(RealmModel realm, UserRepresentation userRep) protected voidUserStorageManager.deleteInvalidUser(RealmModel realm, UserModel user) protected voidUserStorageManager.deleteInvalidUserCache(RealmModel realm, UserModel user) voidExportImportManager.exportRealm(RealmModel realm, ExportOptions options, ExportAdapter callback) static PartialImportResultsPartialImportRealmFromRepresentationEvent.fire(KeycloakSession session, PartialImportRepresentation rep, RealmModel realm) Deprecated.static voidSetDefaultsForNewRealm.fire(KeycloakSession session, RealmModel realm) static voidStoreMigrateRepresentationEvent.fire(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) static voidStoreSyncEvent.fire(KeycloakSession session, RealmModel realm, boolean removed) 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.getClientScopesByAttributes(RealmModel realm, Map<String, String> searchMap, boolean useOr) ClientScopeStorageManager.getClientScopesByProtocol(RealmModel realm, String protocol) ClientScopeStorageManager.getClientScopesStream(RealmModel realm) longClientStorageManager.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) UserLookupProvidermethods implementations end hereUserQueryProvidermethods implementation start hereUserStorageManager.getGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, Integer firstResult, Integer maxResults) GroupStorageManager.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) intUserStorageManager.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 ClientStorageProviderClientStorageManager.getStorageProvider(KeycloakSession session, RealmModel realm, String componentId) static RoleStorageProviderRoleStorageManager.getStorageProvider(KeycloakSession session, RealmModel realm, String componentId) protected <T> TAbstractStorageManager.getStorageProviderInstance(RealmModel realm, String providerId, Class<T> capabilityInterface) protected <T> TAbstractStorageManager.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 StorageProviderModelTypeAbstractStorageManager.getStorageProviderModel(RealmModel realm, String providerId) Returns an instance of StorageProvider model corresponding realm and providerIdstatic ClientStorageProviderModelClientStorageManager.getStorageProviderModel(RealmModel realm, String componentId) static RoleStorageProviderModelRoleStorageManager.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) UserRegistrationProvidermethods implementations end hereUserLookupProvidermethods implementations start hereUserStorageManager.getUserByUsername(RealmModel realm, String username) intUserStorageManager.getUsersCount(RealmModel realm) intUserStorageManager.getUsersCount(RealmModel realm, boolean includeServiceAccount) intUserStorageManager.getUsersCount(RealmModel realm, String search) intUserStorageManager.getUsersCount(RealmModel realm, String search, Set<String> groupIds) intUserStorageManager.getUsersCount(RealmModel realm, Map<String, String> params) intUserStorageManager.getUsersCount(RealmModel realm, Map<String, String> params, Set<String> groupIds) intUserStorageManager.getUsersCount(RealmModel realm, Set<String> groupIds) voidUserStorageManager.grantToAllUsers(RealmModel realm, RoleModel role) UserQueryProvidermethods implementation end hereUserBulkUpdateProvidermethods implementation start herestatic booleanClientStorageManager.hasEnabledStorageProviders(KeycloakSession session, RealmModel realm, Class<?> type) voidExportImportManager.importRealm(RealmRepresentation rep, RealmModel newRealm, Runnable userImport) UserStorageManager.importValidation(RealmModel realm, Stream<UserModel> users) static booleanClientStorageManager.isStorageProviderEnabled(RealmModel realm, String providerId) static booleanRoleStorageManager.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.voidMigrationManager.migrate(RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) voidGroupStorageManager.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent) voidUserStorageManager.onCache(RealmModel realm, CachedUserModel user, UserModel delegate) voidOnCreateComponent.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) voidUserStorageManager.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) default voidUserStorageProviderFactory.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) Called when UserStorageProviderModel is created.voidOnUpdateComponent.onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) voidUserStorageManager.onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) ExportImportManager.partialImportRealm(RealmModel realm, InputStream requestBody) voidGroupStorageManager.preRemove(RealmModel realm) voidUserStorageManager.preRemove(RealmModel realm) UserBulkUpdateProvidermethods implementation end hereUserStorageProvidermethods implementations start here -> no StorageProviders involvedvoidUserStorageManager.preRemove(RealmModel realm, ComponentModel component) voidUserStorageManager.preRemove(RealmModel realm, ClientModel client) voidUserStorageManager.preRemove(RealmModel realm, GroupModel group) voidUserStorageManager.preRemove(RealmModel realm, IdentityProviderModel provider) voidUserStorageManager.preRemove(RealmModel realm, RoleModel role) default voidUserStorageProvider.preRemove(RealmModel realm) Callback when a realm is removed.default voidUserStorageProvider.preRemove(RealmModel realm, GroupModel group) Callback when a group is removed.default voidUserStorageProvider.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) booleanClientStorageManager.removeClient(RealmModel realm, String id) voidClientStorageManager.removeClients(RealmModel realm) booleanClientScopeStorageManager.removeClientScope(RealmModel realm, String id) voidClientStorageManager.removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope) voidClientScopeStorageManager.removeClientScopes(RealmModel realm) booleanUserStorageManager.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) booleanGroupStorageManager.removeGroup(RealmModel realm, GroupModel group) voidUserStorageManager.removeImportedUsers(RealmModel realm, String storageProviderId) voidRoleStorageManager.removeRoles(RealmModel realm) booleanUserStorageManager.removeUser(RealmModel realm, UserModel user) booleanUserStorageManager.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) voidUserStorageManager.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore) voidImportRealmFromRepresentationEvent.setRealmModel(RealmModel realmModel) Deprecated.voidUserStorageManager.unlinkUsers(RealmModel realm, String storageProviderId) voidUserStorageManager.updateConsent(RealmModel realm, String userId, UserConsentModel consent) voidUserStorageManager.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) voidExportImportManager.updateRealm(RealmRepresentation rep, RealmModel realm) default voidUserStorageProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) protected UserModelUserStorageManager.validateUser(RealmModel realm, UserModel user) Allows a UserStorageProvider to proxy and/or synchronize an imported user.Constructors in org.keycloak.storage with parameters of type RealmModelModifierConstructorDescriptionPartialImportRealmFromRepresentationEvent(KeycloakSession session, PartialImportRepresentation rep, RealmModel realm) Deprecated.SetDefaultsForNewRealm(KeycloakSession session, RealmModel realmModel) StoreMigrateRepresentationEvent(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) StoreSyncEvent(KeycloakSession session, RealmModel realm, boolean removed) -
Uses of RealmModel in org.keycloak.storage.adapter
Fields in org.keycloak.storage.adapter declared as RealmModelModifier and TypeFieldDescriptionprotected RealmModelAbstractInMemoryUserAdapter.realmprotected RealmModelAbstractUserAdapter.realmprotected RealmModelAbstractUserAdapterFederatedStorage.realmConstructors in org.keycloak.storage.adapter with parameters of type RealmModelModifierConstructorDescriptionprotectedAbstractInMemoryUserAdapter(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 (ifdefaultScopeistrue) or all optional scopes (ifdefaultScopeisfalse) linked with the clientdefault voidClientStorageProviderFactory.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) Called when ClientStorageProviderModel is created.default voidClientStorageProvider.preRemove(RealmModel realm) Callback when a realm is removed.default voidClientStorageProvider.preRemove(RealmModel realm, GroupModel group) Callback when a group is removed.default voidClientStorageProvider.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 voidClientStorageProviderFactory.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 voidClientScopeStorageProviderFactory.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) Called when ClientScopeStorageProviderFactory is created.default voidClientScopeStorageProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) -
Uses of RealmModel in org.keycloak.storage.datastore
Methods in org.keycloak.storage.datastore that return RealmModelModifier and TypeMethodDescriptionDefaultExportImportManager.importRealm(InputStream requestBody) Methods in org.keycloak.storage.datastore with parameters of type RealmModelModifier and TypeMethodDescriptionstatic ComponentModelDefaultExportImportManager.convertFedMapperToComponent(RealmModel realm, ComponentModel parent, UserFederationMapperRepresentation rep, String newMapperType) static voidDefaultExportImportManager.createClientScopeMappings(RealmModel realm, ClientModel clientModel, List<ScopeMappingRepresentation> mappings) DefaultExportImportManager.createUser(RealmModel newRealm, UserRepresentation userRep) voidDefaultExportImportManager.exportRealm(RealmModel realm, ExportOptions options, ExportAdapter callback) DefaultExportImportManager.importAuthenticationFlows(KeycloakSession session, RealmModel newRealm, RealmRepresentation rep) protected static voidDefaultExportImportManager.importComponents(RealmModel newRealm, MultivaluedHashMap<String, ComponentExportRepresentation> components, String parentId) static voidDefaultExportImportManager.importFederatedUser(KeycloakSession session, RealmModel newRealm, UserRepresentation userRep) voidDefaultExportImportManager.importGroups(RealmModel realm, RealmRepresentation rep) voidDefaultExportImportManager.importRealm(RealmRepresentation rep, RealmModel newRealm, Runnable userImport) static voidDefaultExportImportManager.importRealmAuthorizationSettings(RealmRepresentation rep, RealmModel newRealm, KeycloakSession session) static voidDefaultExportImportManager.importUserFederationProvidersAndMappers(KeycloakSession session, RealmRepresentation rep, RealmModel newRealm) voidDefaultMigrationManager.migrate(RealmModel realm, RealmRepresentation rep, boolean skipUserDependent) DefaultExportImportManager.partialImportRealm(RealmModel realm, InputStream requestBody) static voidDefaultExportImportManager.renameRealm(RealmModel realm, String name) voidDefaultExportImportManager.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 TypeMethodDescriptionvoidUserConsentFederatedStorage.addConsent(RealmModel realm, String userId, UserConsentModel consent) voidUserBrokerLinkFederatedStorage.addFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel socialLink) voidUserRequiredActionsFederatedStorage.addRequiredAction(RealmModel realm, String userId, String action) UserFederatedUserCredentialStore.createCredential(RealmModel realm, String userId, CredentialModel cred) voidUserRoleMappingsFederatedStorage.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 givengroupin the specifiedrealm.intUserNotBeforeFederatedStorage.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 givenrolein 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 typetypethat are associated with the federated user identified byuserId.UserFederatedUserCredentialStore.getStoredCredentialsStream(RealmModel realm, String userId) Obtains the credentials associated with the federated user identified byuserId.intUserFederatedStorageProvider.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 specifiednameandvalue.voidUserRoleMappingsFederatedStorage.grantRole(RealmModel realm, String userId, RoleModel role) voidUserGroupMembershipFederatedStorage.joinGroup(RealmModel realm, String userId, GroupModel group) voidUserGroupMembershipFederatedStorage.leaveGroup(RealmModel realm, String userId, GroupModel group) voidUserBrokerLinkFederatedStorage.preRemove(RealmModel realm, IdentityProviderModel provider) voidUserFederatedStorageProvider.preRemove(RealmModel realm) voidUserFederatedStorageProvider.preRemove(RealmModel realm, ComponentModel model) voidUserFederatedStorageProvider.preRemove(RealmModel realm, ClientModel client) voidUserFederatedStorageProvider.preRemove(RealmModel realm, GroupModel group) voidUserFederatedStorageProvider.preRemove(RealmModel realm, RoleModel role) voidUserFederatedStorageProvider.preRemove(RealmModel realm, UserModel user) voidUserAttributeFederatedStorage.removeAttribute(RealmModel realm, String userId, String name) booleanUserBrokerLinkFederatedStorage.removeFederatedIdentity(RealmModel realm, String userId, String socialProvider) voidUserRequiredActionsFederatedStorage.removeRequiredAction(RealmModel realm, String userId, String action) booleanUserFederatedUserCredentialStore.removeStoredCredential(RealmModel realm, String userId, String id) booleanUserConsentFederatedStorage.revokeConsentForClient(RealmModel realm, String userId, String clientInternalId) voidUserAttributeFederatedStorage.setAttribute(RealmModel realm, String userId, String name, List<String> values) voidUserNotBeforeFederatedStorage.setNotBeforeForUser(RealmModel realm, String userId, int notBefore) voidUserAttributeFederatedStorage.setSingleAttribute(RealmModel realm, String userId, String name, String value) voidUserConsentFederatedStorage.updateConsent(RealmModel realm, String userId, UserConsentModel consent) voidUserFederatedUserCredentialStore.updateCredential(RealmModel realm, String userId, CredentialModel cred) voidUserBrokerLinkFederatedStorage.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 GroupModelGroupLookupProvider.getGroupByName(RealmModel realm, GroupModel parent, String name) Returns a group from the given realm with the corresponding name and parentdefault voidGroupStorageProviderFactory.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 voidGroupStorageProviderFactory.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 TypeMethodDescriptionvoidJpaUserFederatedStorageProvider.addConsent(RealmModel realm, String userId, UserConsentModel consent) voidJpaUserFederatedStorageProvider.addFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel link) voidJpaUserFederatedStorageProvider.addRequiredAction(RealmModel realm, String userId, String action) JpaUserFederatedStorageProvider.createCredential(RealmModel realm, String userId, CredentialModel cred) JpaUserFederatedStorageProvider.createCredential(RealmModel realm, UserModel user, CredentialModel cred) protected voidJpaUserFederatedStorageProvider.createIndex(RealmModel realm, String userId) We create an entry so that its easy to iterate over all things in the database.voidJpaUserFederatedStorageProvider.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) intJpaUserFederatedStorageProvider.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) intJpaUserFederatedStorageProvider.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) voidJpaUserFederatedStorageProvider.grantRole(RealmModel realm, String userId, RoleModel role) voidJpaUserFederatedStorageProvider.joinGroup(RealmModel realm, String userId, GroupModel group) voidJpaUserFederatedStorageProvider.leaveGroup(RealmModel realm, String userId, GroupModel group) booleanJpaUserFederatedStorageProvider.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) voidJpaUserFederatedStorageProvider.preRemove(RealmModel realm) voidJpaUserFederatedStorageProvider.preRemove(RealmModel realm, ComponentModel model) voidJpaUserFederatedStorageProvider.preRemove(RealmModel realm, ClientModel client) voidJpaUserFederatedStorageProvider.preRemove(RealmModel realm, GroupModel group) voidJpaUserFederatedStorageProvider.preRemove(RealmModel realm, IdentityProviderModel provider) voidJpaUserFederatedStorageProvider.preRemove(RealmModel realm, RoleModel role) voidJpaUserFederatedStorageProvider.preRemove(RealmModel realm, UserModel user) voidJpaUserFederatedStorageProvider.removeAttribute(RealmModel realm, String userId, String name) booleanJpaUserFederatedStorageProvider.removeFederatedIdentity(RealmModel realm, String userId, String socialProvider) voidJpaUserFederatedStorageProvider.removeRequiredAction(RealmModel realm, String userId, String action) booleanJpaUserFederatedStorageProvider.removeStoredCredential(RealmModel realm, String userId, String id) booleanJpaUserFederatedStorageProvider.removeStoredCredential(RealmModel realm, UserModel user, String id) booleanJpaUserFederatedStorageProvider.revokeConsentForClient(RealmModel realm, String userId, String clientInternalId) voidJpaUserFederatedStorageProvider.setAttribute(RealmModel realm, String userId, String name, List<String> values) voidJpaUserFederatedStorageProvider.setNotBeforeForUser(RealmModel realm, String userId, int notBefore) voidJpaUserFederatedStorageProvider.setSingleAttribute(RealmModel realm, String userId, String name, String value) voidJpaUserFederatedStorageProvider.updateConsent(RealmModel realm, String userId, UserConsentModel consent) voidJpaUserFederatedStorageProvider.updateCredential(RealmModel realm, String userId, CredentialModel cred) voidJpaUserFederatedStorageProvider.updateCredential(RealmModel realm, UserModel user, CredentialModel cred) voidJpaUserFederatedStorageProvider.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 LDAPObjectLDAPUtils.addUserToLDAP(LDAPStorageProvider ldapProvider, RealmModel realm, UserModel user) Method to create a user in the LDAP.static LDAPObjectLDAPUtils.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 LDAPQueryLDAPUtils.createQueryForUserSearch(LDAPStorageProvider ldapProvider, RealmModel realm) voidLDAPStorageProvider.disableCredentialType(RealmModel realm, UserModel user, String credentialType) protected UserModelLDAPStorageProvider.findOrCreateAuthenticatedUser(RealmModel realm, KerberosPrincipal kerberosPrincipal) Called after successful kerberos authenticationLDAPStorageProvider.getCredentials(RealmModel realm, UserModel user) LDAPStorageProvider.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 UserModelLDAPStorageProvider.importUserFromLDAP(KeycloakSession session, RealmModel realm, LDAPObject ldapUser) protected UserModelLDAPStorageProvider.importUserFromLDAP(KeycloakSession session, RealmModel realm, LDAPObject ldapUser, LDAPStorageProvider.ImportType importType) booleanLDAPStorageProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanLDAPStorageProvider.isValid(RealmModel realm, UserModel user, CredentialInput input) protected LDAPObjectLDAPStorageProvider.loadAndValidateUser(RealmModel realm, UserModel local) LDAPStorageProvider.loadLDAPUserByDN(RealmModel realm, LDAPDn dn) LDAPStorageProvider.loadLDAPUserByUsername(RealmModel realm, String username) LDAPStorageProvider.loadLDAPUserByUuid(RealmModel realm, String uuid) LDAPStorageProvider.loadUsersByDNs(RealmModel realm, Collection<LDAPDn> dns, int firstResult, int maxResults) LDAPStorageProvider.loadUsersByUniqueAttribute(RealmModel realm, String uidName, Collection<String> uids, int firstResult, int maxResults) LDAPStorageProvider.loadUsersByUsernames(List<String> usernames, RealmModel realm) voidLDAPStorageProviderFactory.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) voidLDAPStorageProviderFactory.onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) voidLDAPStorageProvider.preRemove(RealmModel realm) voidLDAPStorageProvider.preRemove(RealmModel realm, GroupModel group) voidLDAPStorageProvider.preRemove(RealmModel realm, RoleModel role) voidLDAPStorageProviderFactory.preRemove(KeycloakSession session, RealmModel realm, ComponentModel model) protected UserModelLDAPStorageProvider.proxy(RealmModel realm, UserModel local, LDAPObject ldapObject, boolean newUser) protected LDAPObjectLDAPStorageProvider.queryByEmail(RealmModel realm, String email) booleanLDAPStorageProvider.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) LDAP search supportsUserModel.SEARCH,UserModel.EXACTand all the other user attributes that are managed by a mapper (method getUserAttributes).booleanLDAPStorageProvider.updateCredential(RealmModel realm, UserModel user, CredentialInput input) LDAPStorageProvider.validate(RealmModel realm, UserModel local) voidLDAPStorageProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) booleanLDAPStorageProvider.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 voidUserAttributeLDAPStorageMapper.checkDuplicateEmail(String userModelAttrName, String email, RealmModel realm, KeycloakSession session, UserModel user) protected voidUserAttributeLDAPStorageMapper.checkDuplicateUsername(String userModelAttrName, String username, RealmModel realm, KeycloakSession session, UserModel user) protected StringHardcodedLDAPAttributeMapper.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 rolesbooleanAbstractLDAPStorageMapper.onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) booleanLDAPStorageMapper.onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) Called when LDAP authentication of specified user fails.default voidLDAPStorageMapperFactory.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) Called when UserStorageProviderModel is created.voidFullNameLDAPStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidHardcodedAttributeMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidHardcodedLDAPAttributeMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidHardcodedLDAPGroupStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidHardcodedLDAPRoleStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidKerberosPrincipalAttributeMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidLDAPStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) Called when importing user from LDAP to local keycloak DB.voidUserAttributeLDAPStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) default voidLDAPStorageMapperFactory.onParentUpdate(RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel) voidFullNameLDAPStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm) voidHardcodedAttributeMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm) voidHardcodedLDAPAttributeMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm) voidHardcodedLDAPGroupStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm) voidHardcodedLDAPRoleStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm) voidKerberosPrincipalAttributeMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm) voidLDAPStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm) Called when register new user to LDAP - just after user was created in Keycloak DBvoidUserAttributeLDAPStorageMapper.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) KerberosPrincipalAttributeMapper.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 storagevoidCertificateLDAPStorageMapperFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) voidFullNameLDAPStorageMapperFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) voidHardcodedAttributeMapperFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) voidHardcodedLDAPAttributeMapperFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) voidHardcodedLDAPGroupStorageMapperFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) voidHardcodedLDAPRoleStorageMapperFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) default voidLDAPStorageMapperFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) voidUserAttributeLDAPStorageMapperFactory.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) UserRolesRetrieveStrategy.getLDAPRoleMembers(RealmModel realm, CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapRoleOrGroup, int firstResult, int maxResults) UserRolesRetrieveStrategy.GetRolesFromUserMemberOfAttribute.getLDAPRoleMembers(RealmModel realm, CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapRoleOrGroup, int firstResult, int maxResults) UserRolesRetrieveStrategy.LoadRolesByMember.getLDAPRoleMembers(RealmModel realm, CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapRoleOrGroup, 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 TypeMethodDescriptionvoidGroupLDAPStorageMapper.addGroupMappingInLDAP(RealmModel realm, GroupModel kcGroup, LDAPObject ldapUser) protected GroupModelGroupLDAPStorageMapper.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 GroupModelGroupLDAPStorageMapper.findKcGroupByLDAPGroup(RealmModel realm, GroupModel parent, LDAPObject ldapGroup) protected GroupModelGroupLDAPStorageMapper.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 GroupModelGroupLDAPStorageMapper.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.protected booleanGroupLDAPStorageMapper.isGroupInGroupPath(RealmModel realm, GroupModel group) voidGroupLDAPStorageMapperFactory.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) voidGroupLDAPStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidGroupLDAPStorageMapperFactory.onParentUpdate(RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel) voidGroupLDAPStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm) voidGroupLDAPStorageMapperFactory.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) voidGroupLDAPStorageMapperFactory.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 RoleContainerModelRoleLDAPStorageMapper.getTargetRoleContainer(RealmModel realm) voidRoleLDAPStorageMapperFactory.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) voidRoleLDAPStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidRoleLDAPStorageMapperFactory.onParentUpdate(RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel) voidRoleLDAPStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm) voidRoleLDAPStorageMapperFactory.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) voidRoleLDAPStorageMapperFactory.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) booleanMSADUserAccountControlStorageMapper.onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) voidMSADUserAccountControlStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidMSADUserAccountControlStorageMapper.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 TypeMethodDescriptionMSADLDSUserAccountControlStorageMapperFactory.getConfigProperties(RealmModel realm, ComponentModel parent) booleanMSADLDSUserAccountControlStorageMapper.onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) voidMSADLDSUserAccountControlStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidMSADLDSUserAccountControlStorageMapper.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 voidUserStorageSyncManager.notifyToRefreshPeriodicSync(KeycloakSession session, RealmModel realm, UserStorageProviderModel provider, boolean removed) static voidUserStorageSyncManager.notifyToRefreshPeriodicSyncAll(KeycloakSession session, RealmModel realm, boolean removed) static voidUserStorageSyncManager.notifyToRefreshPeriodicSyncSingle(KeycloakSession session, RealmModel realm, ComponentModel component, boolean removed) protected static voidUserStorageSyncManager.refreshPeriodicSyncForProvider(KeycloakSessionFactory sessionFactory, TimerProvider timer, UserStorageProviderModel provider, RealmModel realm) Constructors in org.keycloak.storage.managers with parameters of type RealmModelModifierConstructorDescriptionUserStorageSyncTask(UserStorageProviderModel provider, RealmModel realm, KeycloakSessionFactory sessionFactory, UserStorageSyncManager.UserStorageSyncTask.SyncMode syncMode) -
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 voidRoleStorageProviderFactory.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_idin OIDC orentityIDin 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_idin OIDC orentityIDin 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 voidRoleStorageProviderFactory.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.getGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, Integer first, Integer max) Obtains users that belong to a specific group, filtered according to the search parameters.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 CredentialValidationOutputUserLookupProvider.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 intUserCountMethodsProvider.getUsersCount(RealmModel realm) Returns the number of users, without consider any service account.default intUserCountMethodsProvider.getUsersCount(RealmModel realm, boolean includeServiceAccount) Returns the number of users.default intUserCountMethodsProvider.getUsersCount(RealmModel realm, String search) Deprecated.UseUserCountMethodsProvider.getUsersCount(RealmModel, Map)with anparamsmap containingUserModel.SEARCHinstead.default intUserCountMethodsProvider.getUsersCount(RealmModel realm, String search, Set<String> groupIds) Deprecated.UseUserCountMethodsProvider.getUsersCount(RealmModel, Map, Set)with anparamsmap containingUserModel.SEARCHinstead.default intUserCountMethodsProvider.getUsersCount(RealmModel realm, Map<String, String> params) Returns the number of users that match the given filter parameters.default intUserCountMethodsProvider.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 intUserCountMethodsProvider.getUsersCount(RealmModel realm, Set<String> groupIds) Returns the number of users that are in at least one of the groups given.voidUserBulkUpdateProvider.grantToAllUsers(RealmModel realm, RoleModel role) Grants the given role to all users from particular realm.booleanUserRegistrationProvider.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 anparamsmap containingUserModel.SEARCHinstead.UserQueryMethodsProvider.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults) Deprecated.UseUserQueryMethodsProvider.searchForUserStream(RealmModel, Map, Integer, Integer)with anparamsmap containingUserModel.SEARCHinstead.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 TypeMethodDescriptionvoidDeclarativeUserProfileProviderFactory.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 booleanCredentialHelper.createOTPCredential(KeycloakSession session, RealmModel realm, UserModel user, String totpCode, OTPCredentialModel credentialModel) Create OTP credential either in userStorage or local storage (Keycloak DB)static voidCredentialHelper.createRecoveryCodesCredential(KeycloakSession session, RealmModel realm, UserModel user, RecoveryAuthnCodesCredentialModel credentialModel, List<String> generatedCodes) Create RecoveryCodes credential either in userStorage or local storage (Keycloak DB)static RequiredActionProviderModelRequiredActionHelper.getRequiredActionByProviderId(RealmModel realm, String providerId) static Stream<GroupRepresentation>GroupUtils.populateGroupHierarchyFromSubGroups(KeycloakSession session, RealmModel realm, Stream<GroupModel> groups, boolean full, GroupPermissionEvaluator groupEvaluator, boolean subGroupsCount) 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 StringTotpUtils.qrCode(String totpSecret, RealmModel realm, UserModel user) OAuth2Error.realm(RealmModel realm) static voidCredentialHelper.setOrReplaceAuthenticationRequirement(KeycloakSession session, RealmModel realm, String type, AuthenticationExecutionModel.Requirement requirement, AuthenticationExecutionModel.Requirement currentRequirement)
UserSessionProvider.createUserSession(String, RealmModel, UserModel, String, String, String, boolean, String, String, UserSessionModel.SessionPersistenceState)instead.