Uses of Interface
org.keycloak.models.UserModel
Packages that use UserModel
Package
Description
-
Uses of UserModel in org.keycloak.authentication
Fields in org.keycloak.authentication declared as UserModelMethods in org.keycloak.authentication that return UserModelModifier and TypeMethodDescriptionAuthenticationFlowContext.getUser()Current user attached to this flow.AuthenticationProcessor.Result.getUser()FormContext.getUser()Current user attached to this flow.RequiredActionContext.getUser()Current userRequiredActionContextResult.getUser()Methods in org.keycloak.authentication with parameters of type UserModelModifier and TypeMethodDescriptionbooleanAuthenticator.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) voidAuthenticationProcessor.setAutheticatedUser(UserModel user) voidAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticatorvoidFormAction.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticatorvoidAttach a specific user to this flow.voidvoidAttach a specific user to this flow.voidAuthenticationProcessor.validateUser(UserModel authenticatedUser) Constructors in org.keycloak.authentication with parameters of type UserModelModifierConstructorDescriptionRequiredActionContextResult(AuthenticationSessionModel authSession, RealmModel realm, EventBuilder eventBuilder, KeycloakSession session, HttpRequest httpRequest, UserModel user, RequiredActionFactory factory) -
Uses of UserModel in org.keycloak.authentication.authenticators
Methods in org.keycloak.authentication.authenticators with parameters of type UserModelModifier and TypeMethodDescriptionbooleanAttemptedAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidAttemptedAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.authenticators.access
Methods in org.keycloak.authentication.authenticators.access with parameters of type UserModelModifier 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 UserModel in org.keycloak.authentication.authenticators.broker
Methods in org.keycloak.authentication.authenticators.broker that return UserModelModifier and TypeMethodDescriptionstatic UserModelAbstractIdpAuthenticator.getExistingUser(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession) Methods in org.keycloak.authentication.authenticators.broker with parameters of type UserModelModifier and TypeMethodDescriptionbooleanIdpAutoLinkAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanIdpConfirmLinkAuthenticator.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) voidAbstractIdpAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) protected voidIdpCreateUserIfUniqueAuthenticator.userRegisteredSuccess(AuthenticationFlowContext context, UserModel registeredUser, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext) Method parameters in org.keycloak.authentication.authenticators.broker with type arguments of type UserModelModifier and TypeMethodDescriptionprotected LoginFormsProviderIdpUsernamePasswordForm.setupForm(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String, String> formData, Optional<UserModel> existingUser) -
Uses of UserModel in org.keycloak.authentication.authenticators.browser
Methods in org.keycloak.authentication.authenticators.browser with parameters of type UserModelModifier 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) booleanAbstractUsernameFormAuthenticator.enabledUser(AuthenticationFlowContext context, UserModel user) protected StringRecoveryAuthnCodesFormAuthenticator.getDisabledByBruteForceEventError(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser) protected booleanAbstractUsernameFormAuthenticator.isDisabledByBruteForce(AuthenticationFlowContext context, UserModel user) protected booleanRecoveryAuthnCodesFormAuthenticator.isDisabledByBruteForce(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser) 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) voidAbstractUsernameFormAuthenticator.testInvalidUser(AuthenticationFlowContext context, UserModel user) booleanAbstractUsernameFormAuthenticator.validatePassword(AuthenticationFlowContext context, UserModel user, jakarta.ws.rs.core.MultivaluedMap<String, String> inputData, boolean clearUser) -
Uses of UserModel in org.keycloak.authentication.authenticators.conditional
Methods in org.keycloak.authentication.authenticators.conditional with parameters of type UserModelModifier and TypeMethodDescriptiondefault booleanConditionalAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidConditionalLoaAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidConditionalRoleAuthenticator.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 UserModel in org.keycloak.authentication.authenticators.directgrant
Methods in org.keycloak.authentication.authenticators.directgrant with parameters of type UserModelModifier 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 UserModel in org.keycloak.authentication.authenticators.resetcred
Methods in org.keycloak.authentication.authenticators.resetcred with parameters of type UserModelModifier 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 UserModel in org.keycloak.authentication.authenticators.sessionlimits
Methods in org.keycloak.authentication.authenticators.sessionlimits with parameters of type UserModelModifier and TypeMethodDescriptionbooleanUserSessionLimitsAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidUserSessionLimitsAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.authenticators.util
Methods in org.keycloak.authentication.authenticators.util with parameters of type UserModelModifier and TypeMethodDescriptionstatic StringAuthenticatorUtils.getDisabledByBruteForceEventError(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser) static StringAuthenticatorUtils.getDisabledByBruteForceEventError(BruteForceProtector protector, KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.authenticators.x509
Methods in org.keycloak.authentication.authenticators.x509 that return UserModelModifier and TypeMethodDescriptionabstract UserModelUserIdentityToModelMapper.find(AuthenticationFlowContext context, Object userIdentity) Methods in org.keycloak.authentication.authenticators.x509 with parameters of type UserModelModifier and TypeMethodDescriptionbooleanAbstractX509ClientCertificateAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidAbstractX509ClientCertificateAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.forms
Methods in org.keycloak.authentication.forms with parameters of type UserModelModifier and TypeMethodDescriptionbooleanRegistrationPassword.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanRegistrationProfile.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanRegistrationRecaptcha.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanRegistrationTermsAndConditions.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) booleanRegistrationUserCreation.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) voidRegistrationPassword.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidRegistrationProfile.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) voidRegistrationRecaptcha.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 UserModel in org.keycloak.authentication.requiredactions
Methods in org.keycloak.authentication.requiredactions with parameters of type UserModelModifier and TypeMethodDescriptionstatic voidUpdateEmail.updateEmailNow(EventBuilder event, UserModel user, UserProfile emailUpdateValidationResult) static UserProfileUpdateEmail.validateEmailUpdate(KeycloakSession session, UserModel user, String newEmail) -
Uses of UserModel in org.keycloak.authentication.requiredactions.util
Constructors in org.keycloak.authentication.requiredactions.util with parameters of type UserModel -
Uses of UserModel in org.keycloak.authorization.common
Fields in org.keycloak.authorization.common declared as UserModelModifier and TypeFieldDescriptionprotected UserModelClientModelIdentity.serviceAccountprotected UserModelUserModelIdentity.userConstructors in org.keycloak.authorization.common with parameters of type UserModel -
Uses of UserModel in org.keycloak.broker.oidc
Methods in org.keycloak.broker.oidc with parameters of type UserModelModifier and TypeMethodDescriptionjakarta.ws.rs.core.ResponseAbstractOAuth2IdentityProvider.exchangeFromToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, jakarta.ws.rs.core.MultivaluedMap<String, String> params) protected jakarta.ws.rs.core.ResponseAbstractOAuth2IdentityProvider.exchangeSessionToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.ResponseOIDCIdentityProvider.exchangeSessionToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.ResponseAbstractOAuth2IdentityProvider.exchangeStoredToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.ResponseOIDCIdentityProvider.exchangeStoredToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) -
Uses of UserModel in org.keycloak.broker.oidc.mappers
Methods in org.keycloak.broker.oidc.mappers with parameters of type UserModelModifier 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) 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 UserModel in org.keycloak.broker.provider
Methods in org.keycloak.broker.provider with parameters of type UserModelModifier and TypeMethodDescriptionstatic voidIdentityProviderMapperSyncModeDelegate.delegateUpdateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context, IdentityProviderMapper mapper) jakarta.ws.rs.core.ResponseExchangeTokenToIdentityProviderToken.exchangeFromToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, jakarta.ws.rs.core.MultivaluedMap<String, String> params) jakarta.ws.rs.core.ResponseAbstractIdentityProvider.exchangeNotLinked(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) jakarta.ws.rs.core.ResponseAbstractIdentityProvider.exchangeNotLinkedNoStore(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) jakarta.ws.rs.core.ResponseAbstractIdentityProvider.exchangeTokenExpired(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) 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.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. -
Uses of UserModel in org.keycloak.broker.saml.mappers
Methods in org.keycloak.broker.saml.mappers with parameters of type UserModelModifier 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) 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 UserModel in org.keycloak.credential
Methods in org.keycloak.credential that return UserModelMethods in org.keycloak.credential with parameters of type UserModelModifier and TypeMethodDescriptionCredentialProvider.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) UserCredentialStoreManager.createCredential(RealmModel realm, UserModel user, CredentialModel cred) Deprecated.WebAuthnCredentialProvider.createCredential(RealmModel realm, UserModel user, WebAuthnCredentialModel credentialModel) UserCredentialStoreManager.createCredentialThroughProvider(RealmModel realm, UserModel user, CredentialModel model) Deprecated.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) voidUserCredentialStoreManager.disableCredentialType(RealmModel realm, UserModel user, String credentialType) Deprecated.UserCredentialStoreManager.getConfiguredUserStorageCredentialTypesStream(RealmModel realm, UserModel user) Deprecated.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) UserCredentialStoreManager.getDisableableCredentialTypesStream(RealmModel realm, UserModel user) Deprecated.PasswordCredentialProvider.getPassword(RealmModel realm, UserModel user) UserCredentialStore.getStoredCredentialById(RealmModel realm, UserModel user, String id) UserCredentialStoreManager.getStoredCredentialById(RealmModel realm, UserModel user, String id) Deprecated.UserCredentialStore.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type) UserCredentialStoreManager.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type) Deprecated.UserCredentialStore.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type) Obtains the stored credentials associated with the specified user that match the specified type.UserCredentialStoreManager.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type) Deprecated.UserCredentialStore.getStoredCredentialsStream(RealmModel realm, UserModel user) Obtains the stored credentials associated with the specified user.UserCredentialStoreManager.getStoredCredentialsStream(RealmModel realm, UserModel user) Deprecated.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) booleanUserCredentialStoreManager.isConfiguredFor(RealmModel realm, UserModel user, String type) Deprecated.booleanWebAuthnCredentialProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanUserCredentialStoreManager.isConfiguredLocally(RealmModel realm, UserModel user, String type) Deprecated.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) booleanUserCredentialStoreManager.isValid(RealmModel realm, UserModel user, List<CredentialInput> inputs) Deprecated.booleanUserCredentialStoreManager.isValid(RealmModel realm, UserModel user, CredentialInput... inputs) Deprecated.booleanWebAuthnCredentialProvider.isValid(RealmModel realm, UserModel user, CredentialInput input) booleanUserCredentialStore.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) booleanUserCredentialStoreManager.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) Deprecated.voidUserCredentialStoreManager.onCache(RealmModel realm, CachedUserModel user, UserModel delegate) Deprecated.booleanUserCredentialStore.removeStoredCredential(RealmModel realm, UserModel user, String id) Removes credential with theidfor theuser.booleanUserCredentialStoreManager.removeStoredCredential(RealmModel realm, UserModel user, String id) Deprecated.booleanCredentialInputUpdater.updateCredential(RealmModel realm, UserModel user, CredentialInput input) booleanPasswordCredentialProvider.updateCredential(RealmModel realm, UserModel user, CredentialInput input) voidUserCredentialStore.updateCredential(RealmModel realm, UserModel user, CredentialModel cred) booleanUserCredentialStoreManager.updateCredential(RealmModel realm, UserModel user, CredentialInput input) Deprecated.voidUserCredentialStoreManager.updateCredential(RealmModel realm, UserModel user, CredentialModel cred) Deprecated.voidUserCredentialStoreManager.updateCredentialLabel(RealmModel realm, UserModel user, String credentialId, String userLabel) Deprecated.Constructors in org.keycloak.credential with parameters of type UserModelModifierConstructorDescriptionLegacyUserCredentialManager(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.email
Methods in org.keycloak.email with parameters of type UserModelModifier and TypeMethodDescriptionprotected StringDefaultEmailSenderProvider.retrieveEmailAddress(UserModel user) voidDefaultEmailSenderProvider.send(Map<String, String> config, UserModel user, String subject, String textBody, String htmlBody) default voidEmailSenderProvider.send(Map<String, String> config, UserModel user, String subject, String textBody, String htmlBody) voidEmailTemplateProvider.sendSmtpTestEmail(Map<String, String> config, UserModel user) Test SMTP connection with current logged in user -
Uses of UserModel in org.keycloak.email.freemarker
Fields in org.keycloak.email.freemarker declared as UserModelMethods in org.keycloak.email.freemarker with parameters of type UserModelModifier and TypeMethodDescriptionvoidFreeMarkerEmailTemplateProvider.sendSmtpTestEmail(Map<String, String> config, UserModel user) -
Uses of UserModel in org.keycloak.email.freemarker.beans
Constructors in org.keycloak.email.freemarker.beans with parameters of type UserModel -
Uses of UserModel in org.keycloak.events
Methods in org.keycloak.events with parameters of type UserModel -
Uses of UserModel in org.keycloak.exportimport.dir
Method parameters in org.keycloak.exportimport.dir with type arguments of type UserModelModifier and TypeMethodDescriptionprotected voidDirExportProvider.writeUsers(String fileName, KeycloakSession session, RealmModel realm, List<UserModel> users) -
Uses of UserModel in org.keycloak.exportimport.util
Methods in org.keycloak.exportimport.util with parameters of type UserModelModifier and TypeMethodDescriptionstatic UserRepresentationExportUtils.exportUser(KeycloakSession session, RealmModel realm, UserModel user, ExportOptions options, boolean internal) Full export of user (including role mappings and credentials)Method parameters in org.keycloak.exportimport.util with type arguments of type UserModelModifier and TypeMethodDescriptionstatic 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.writeUsers(String fileName, KeycloakSession session, RealmModel realm, List<UserModel> users) -
Uses of UserModel in org.keycloak.federation.kerberos
Classes in org.keycloak.federation.kerberos that implement UserModelMethods in org.keycloak.federation.kerberos that return UserModelModifier and TypeMethodDescriptionprotected UserModelKerberosFederationProvider.findOrCreateAuthenticatedUser(RealmModel realm, KerberosPrincipal kerberosPrincipal) Called after successful authenticationKerberosFederationProvider.getUserByEmail(RealmModel realm, String email) KerberosFederationProvider.getUserById(RealmModel realm, String id) KerberosFederationProvider.getUserByUsername(RealmModel realm, String username) protected UserModelKerberosFederationProvider.importUserToKeycloak(RealmModel realm, KerberosPrincipal kerberosPrincipal) KerberosFederationProvider.validate(RealmModel realm, UserModel user) Methods in org.keycloak.federation.kerberos with parameters of type UserModelModifier and TypeMethodDescriptionvoidKerberosFederationProvider.disableCredentialType(RealmModel realm, UserModel user, String credentialType) KerberosFederationProvider.getDisableableCredentialTypesStream(RealmModel realm, UserModel user) booleanKerberosFederationProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanKerberosFederationProvider.isValid(RealmModel realm, UserModel user, CredentialInput input) booleanKerberosFederationProvider.updateCredential(RealmModel realm, UserModel user, CredentialInput input) KerberosFederationProvider.validate(RealmModel realm, UserModel user) Constructors in org.keycloak.federation.kerberos with parameters of type UserModelModifierConstructorDescriptionReadOnlyKerberosUserModelDelegate(UserModel delegate, KerberosFederationProvider provider) -
Uses of UserModel in org.keycloak.federation.sssd
Classes in org.keycloak.federation.sssd that implement UserModelModifier and TypeClassDescriptionclassReadonly proxy for a SSSD UserModel that prevents attributes from being updated.Methods in org.keycloak.federation.sssd that return UserModelModifier and TypeMethodDescriptionprotected UserModelSSSDFederationProvider.findOrCreateAuthenticatedUser(RealmModel realm, String username) Called after successful authenticationSSSDFederationProvider.getUserByEmail(RealmModel realm, String email) SSSDFederationProvider.getUserById(RealmModel realm, String id) SSSDFederationProvider.getUserByUsername(RealmModel realm, String username) protected UserModelSSSDFederationProvider.importUserToKeycloak(RealmModel realm, String username) SSSDFederationProvider.validate(RealmModel realm, UserModel user) SSSDFederationProvider.validateAndProxy(RealmModel realm, UserModel local) Methods in org.keycloak.federation.sssd with parameters of type UserModelModifier and TypeMethodDescriptionvoidSSSDFederationProvider.disableCredentialType(RealmModel realm, UserModel user, String credentialType) SSSDFederationProvider.getDisableableCredentialTypesStream(RealmModel realm, UserModel user) booleanSSSDFederationProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanSSSDFederationProvider.isValid(RealmModel realm, UserModel local) booleanSSSDFederationProvider.isValid(RealmModel realm, UserModel user, CredentialInput input) booleanSSSDFederationProvider.updateCredential(RealmModel realm, UserModel user, CredentialInput input) SSSDFederationProvider.validate(RealmModel realm, UserModel user) SSSDFederationProvider.validateAndProxy(RealmModel realm, UserModel local) Constructors in org.keycloak.federation.sssd with parameters of type UserModelModifierConstructorDescriptionReadonlySSSDUserModelDelegate(UserModel delegate, SSSDFederationProvider provider) -
Uses of UserModel in org.keycloak.forms.login
Methods in org.keycloak.forms.login with parameters of type UserModel -
Uses of UserModel in org.keycloak.forms.login.freemarker
Fields in org.keycloak.forms.login.freemarker declared as UserModelMethods in org.keycloak.forms.login.freemarker with parameters of type UserModelModifier and TypeMethodDescriptionConstructors in org.keycloak.forms.login.freemarker with parameters of type UserModelModifierConstructorDescriptionAuthenticatorConfiguredMethod(RealmModel realm, UserModel user, KeycloakSession session) -
Uses of UserModel in org.keycloak.forms.login.freemarker.model
Constructors in org.keycloak.forms.login.freemarker.model with parameters of type UserModelModifierConstructorDescriptionRecoveryAuthnCodeInputLoginBean(KeycloakSession session, RealmModel realm, UserModel user) TotpBean(KeycloakSession session, RealmModel realm, UserModel user, jakarta.ws.rs.core.UriBuilder uriBuilder) TotpLoginBean(KeycloakSession session, RealmModel realm, UserModel user, String selectedCredentialId) VerifyProfileBean(UserModel user, jakarta.ws.rs.core.MultivaluedMap<String, String> formData, KeycloakSession session) WebAuthnAuthenticatorsBean(KeycloakSession session, RealmModel realm, UserModel user, String credentialType) -
Uses of UserModel in org.keycloak.jose.jws
Methods in org.keycloak.jose.jws with parameters of type UserModelModifier and TypeMethodDescriptionDefaultTokenManager.initLogoutToken(ClientModel client, UserModel user, AuthenticatedClientSessionModel clientSession) -
Uses of UserModel in org.keycloak.locale
Methods in org.keycloak.locale with parameters of type UserModelModifier and TypeMethodDescriptionDefaultLocaleSelectorProvider.resolveLocale(RealmModel realm, UserModel user) LocaleSelectorProvider.resolveLocale(RealmModel realm, UserModel user) Resolve the locale which should be used for the requestvoidDefaultLocaleUpdaterProvider.updateUsersLocale(UserModel user, String locale) voidLocaleUpdaterProvider.updateUsersLocale(UserModel user, String locale) -
Uses of UserModel in org.keycloak.migration.migrators
Methods in org.keycloak.migration.migrators with parameters of type UserModelModifier and TypeMethodDescriptionstatic voidMigrationUtils.migrateOldOfflineToken(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user) -
Uses of UserModel in org.keycloak.models
Classes in org.keycloak.models that implement UserModelFields in org.keycloak.models with type parameters of type UserModelModifier and TypeFieldDescriptionstatic final SearchableModelField<UserModel>UserModel.SearchableFields.ASSIGNED_GROUPstatic final SearchableModelField<UserModel>UserModel.SearchableFields.ASSIGNED_ROLEstatic final SearchableModelField<UserModel>UserModel.SearchableFields.ATTRIBUTESearch for attribute value.static final Comparator<UserModel>UserModel.COMPARE_BY_USERNAMEstatic final SearchableModelField<UserModel>UserModel.SearchableFields.CONSENT_CLIENT_FEDERATION_LINKSearch for users that have consent set for a particular client that originates in the given client provider.static final SearchableModelField<UserModel>UserModel.SearchableFields.CONSENT_FOR_CLIENTSearch for users that have consent set for a particular client.static final SearchableModelField<UserModel>UserModel.SearchableFields.CONSENT_WITH_CLIENT_SCOPESearch for users that have consent that has given client scope.static final SearchableModelField<UserModel>UserModel.SearchableFields.EMAILstatic final SearchableModelField<UserModel>UserModel.SearchableFields.EMAIL_VERIFIEDstatic final SearchableModelField<UserModel>UserModel.SearchableFields.ENABLEDstatic final SearchableModelField<UserModel>UserModel.SearchableFields.FEDERATION_LINKstatic final SearchableModelField<UserModel>UserModel.SearchableFields.FIRST_NAMEstatic final SearchableModelField<UserModel>UserModel.SearchableFields.IDstatic final SearchableModelField<UserModel>UserModel.SearchableFields.IDP_AND_USERThis field can only searched either for users coming from an IDP, then the operand is (idp_alias), or as user coming from a particular IDP with given username there, then the operand is a pair (idp_alias, idp_user_id).static final SearchableModelField<UserModel>UserModel.SearchableFields.LAST_NAMEstatic final SearchableModelField<UserModel>UserModel.SearchableFields.REALM_IDstatic final SearchableModelField<UserModel>UserModel.SearchableFields.SERVICE_ACCOUNT_CLIENTID of the client corresponding to the service accountstatic final SearchableModelField<UserModel>UserModel.SearchableFields.USERNAMESearch for user's username in case sensitive mode.static final SearchableModelField<UserModel>UserModel.SearchableFields.USERNAME_CASE_INSENSITIVESearch for user's username in case insensitive mode.Methods in org.keycloak.models that return UserModelModifier and TypeMethodDescriptionUserProvider.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) Adds a new user into the storage.CredentialValidationOutput.getAuthenticatedUser()UserProvider.getServiceAccount(ClientModel client) Return a UserModel representing service account of the clientUserModel.UserRemovedEvent.getUser()UserSessionModel.getUser()UserProvider.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink) Returns a userModel that corresponds to the given socialLink.Methods in org.keycloak.models with parameters of type UserModelModifier and TypeMethodDescriptionvoidUserProvider.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) Adds a federated identity link for the user within the realmUserCredentialManager.createCredentialThroughProvider(RealmModel realm, UserModel user, CredentialModel model) Deprecated.Creates a credential from the credentialModel, by looping through the providers to find a match for the typeUserSessionProvider.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.voidUserCredentialManager.disableCredentialType(RealmModel realm, UserModel user, String credentialType) Deprecated.Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.UserCredentialManager.getConfiguredUserStorageCredentialTypesStream(RealmModel realm, UserModel user) Deprecated.UserCredentialManager.getDisableableCredentialTypesStream(RealmModel realm, UserModel user) Deprecated.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.OTPPolicy.getKeyURI(RealmModel realm, UserModel user, String secret) Constructs theotpauth://URI based on the Key-Uri-Format.intUserProvider.getNotBeforeOfUser(RealmModel realm, UserModel user) Gets the notBefore value for the given userUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user) Obtains the offline user sessions associated with the specified user.UserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user) Obtains the online user sessions associated with the specified user.TokenManager.initLogoutToken(ClientModel client, UserModel user, AuthenticatedClientSessionModel clientSessionModel) booleanUserCredentialManager.isConfiguredFor(RealmModel realm, UserModel user, String type) Deprecated.Checks to see if user has credential type configured.booleanUserCredentialManager.isConfiguredLocally(RealmModel realm, UserModel user, String type) Deprecated.Only loops through each CredentialProvider to see if credential type is configured for the user.booleanUserCredentialManager.isValid(RealmModel realm, UserModel user, List<CredentialInput> inputs) Deprecated.Validates list of credentials.booleanUserCredentialManager.isValid(RealmModel realm, UserModel user, CredentialInput... inputs) Deprecated.Validates list of credentials.booleanUserProvider.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) Removes federation link between the user and the identity provider given by its idbooleanUserManager.removeUser(RealmModel realm, UserModel user) booleanUserManager.removeUser(RealmModel realm, UserModel user, UserProvider userProvider) voidUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user) KeycloakContext.resolveLocale(UserModel user) voidUserSessionModel.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) voidUserProvider.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore) Sets the notBefore value for the given userbooleanUserCredentialManager.updateCredential(RealmModel realm, UserModel user, CredentialInput input) Deprecated.Updates a credential.voidUserCredentialManager.updateCredentialLabel(RealmModel realm, UserModel user, String credentialId, String userLabel) Deprecated.Updates the credential label and invalidates the cache for the user.voidUserProvider.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) Update details of association between the federatedUser and the idp given by the federatedIdentityModelConstructors in org.keycloak.models with parameters of type UserModelModifierConstructorDescriptionCredentialValidationOutput(UserModel authenticatedUser, CredentialValidationOutput.Status authStatus, Map<String, String> state) -
Uses of UserModel in org.keycloak.models.cache
Subinterfaces of UserModel in org.keycloak.models.cacheModifier and TypeInterfaceDescriptioninterfaceCached users will implement this interfaceMethods in org.keycloak.models.cache that return UserModelModifier and TypeMethodDescriptionCachedUserModel.getDelegateForUpdate()Invalidates the cache for this user and returns a delegate that represents the actual data providerMethods in org.keycloak.models.cache with parameters of type UserModelModifier and TypeMethodDescriptionvoidUserCache.evict(RealmModel realm, UserModel user) Evict user from cache.voidOnUserCache.onCache(RealmModel realm, CachedUserModel user, UserModel delegate) -
Uses of UserModel in org.keycloak.models.cache.infinispan
Classes in org.keycloak.models.cache.infinispan that implement UserModelFields in org.keycloak.models.cache.infinispan declared as UserModelFields in org.keycloak.models.cache.infinispan with type parameters of type UserModelMethods in org.keycloak.models.cache.infinispan that return UserModelModifier and TypeMethodDescriptionUserCacheSession.addUser(RealmModel realm, String username) UserCacheSession.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) protected UserModelUserCacheSession.cacheUser(RealmModel realm, UserModel delegate, Long revision) UserCacheSession.findServiceAccount(ClientModel client) UserAdapter.getDelegateForUpdate()UserCacheSession.getServiceAccount(ClientModel client) protected UserModelUserCacheSession.getUserAdapter(RealmModel realm, String userId, Long loaded, UserModel delegate) UserCacheSession.getUserByEmail(RealmModel realm, String email) UserCacheSession.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink) UserCacheSession.getUserById(RealmModel realm, String id) UserCacheSession.getUserByUsername(RealmModel realm, String username) protected UserModelUserCacheSession.validateCache(RealmModel realm, CachedUser cached) Methods in org.keycloak.models.cache.infinispan that return types with arguments of type UserModelModifier and TypeMethodDescriptionUserCacheSession.getGroupMembersStream(RealmModel realm, GroupModel group) UserCacheSession.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) UserCacheSession.getRoleMembersStream(RealmModel realm, RoleModel role) UserCacheSession.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) 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) Methods in org.keycloak.models.cache.infinispan with parameters of type UserModelModifier and TypeMethodDescriptionvoidUserCacheSession.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) protected UserModelUserCacheSession.cacheUser(RealmModel realm, UserModel delegate, Long revision) voidUserCacheSession.evict(RealmModel realm, UserModel user) protected voidUserCacheSession.fullyInvalidateUser(RealmModel realm, UserModel user) UserCacheSession.getFederatedIdentitiesStream(RealmModel realm, UserModel user) UserCacheSession.getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) intUserCacheSession.getNotBeforeOfUser(RealmModel realm, UserModel user) protected UserModelUserCacheSession.getUserAdapter(RealmModel realm, String userId, Long loaded, UserModel delegate) booleanUserCacheSession.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) booleanUserCacheSession.removeUser(RealmModel realm, UserModel user) voidUserCacheSession.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore) voidUserCacheSession.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) Constructors in org.keycloak.models.cache.infinispan with parameters of type UserModelModifierConstructorDescriptionSubjectCredentialManagerCacheAdapter(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.models.cache.infinispan.entities
Method parameters in org.keycloak.models.cache.infinispan.entities with type arguments of type UserModelModifier and TypeMethodDescriptionCachedUser.getAttributes(Supplier<UserModel> userModel) CachedUser.getFirstAttribute(String name, Supplier<UserModel> userModel) CachedUser.getRequiredActions(Supplier<UserModel> userModel) CachedUser.getRoleMappings(Supplier<UserModel> userModel) CachedUser.getStoredCredentials(Supplier<UserModel> userModel) Constructors in org.keycloak.models.cache.infinispan.entities with parameters of type UserModelModifierConstructorDescriptionCachedUser(Long revision, RealmModel realm, UserModel user, int notBefore) -
Uses of UserModel in org.keycloak.models.jpa
Classes in org.keycloak.models.jpa that implement UserModelMethods in org.keycloak.models.jpa that return UserModelModifier and TypeMethodDescriptionJpaUserProvider.addUser(RealmModel realm, String username) JpaUserProvider.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) JpaUserProvider.getServiceAccount(ClientModel client) JpaUserProvider.getUserByEmail(RealmModel realm, String email) JpaUserProvider.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel identity) JpaUserProvider.getUserById(RealmModel realm, String id) JpaUserProvider.getUserByUsername(RealmModel realm, String username) Methods in org.keycloak.models.jpa that return types with arguments of type UserModelModifier and TypeMethodDescriptionJpaUserProvider.getGroupMembersStream(RealmModel realm, GroupModel group) JpaUserProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) JpaUserProvider.getRoleMembersStream(RealmModel realm, RoleModel role) JpaUserProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) 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) Methods in org.keycloak.models.jpa with parameters of type UserModelModifier and TypeMethodDescriptionvoidJpaUserProvider.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel identity) JpaUserCredentialStore.createCredential(RealmModel realm, UserModel user, CredentialModel cred) JpaUserProvider.createCredential(RealmModel realm, UserModel user, CredentialModel cred) JpaUserProvider.getFederatedIdentitiesStream(RealmModel realm, UserModel user) JpaUserProvider.getFederatedIdentity(RealmModel realm, UserModel user, String identityProvider) intJpaUserProvider.getNotBeforeOfUser(RealmModel realm, UserModel user) 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) booleanJpaUserCredentialStore.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) booleanJpaUserProvider.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) booleanJpaUserProvider.removeFederatedIdentity(RealmModel realm, UserModel user, String identityProvider) booleanJpaUserCredentialStore.removeStoredCredential(RealmModel realm, UserModel user, String id) booleanJpaUserProvider.removeStoredCredential(RealmModel realm, UserModel user, String id) booleanJpaUserProvider.removeUser(RealmModel realm, UserModel user) voidJpaUserProvider.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore) voidJpaUserCredentialStore.updateCredential(RealmModel realm, UserModel user, CredentialModel cred) voidJpaUserProvider.updateCredential(RealmModel realm, UserModel user, CredentialModel cred) voidJpaUserProvider.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) -
Uses of UserModel in org.keycloak.models.jpa.session
Methods in org.keycloak.models.jpa.session with parameters of type UserModelModifier and TypeMethodDescriptionJpaUserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults) voidJpaUserSessionPersisterProvider.onUserRemoved(RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.models.map.authSession
Methods in org.keycloak.models.map.authSession that return UserModelMethods in org.keycloak.models.map.authSession with parameters of type UserModelModifier and TypeMethodDescriptionvoidMapAuthenticationSessionAdapter.setAuthenticatedUser(UserModel user) -
Uses of UserModel in org.keycloak.models.map.credential
Constructors in org.keycloak.models.map.credential with parameters of type UserModelModifierConstructorDescriptionMapUserCredentialManager(KeycloakSession session, RealmModel realm, UserModel user, MapUserEntity entity) -
Uses of UserModel in org.keycloak.models.map.datastore
Methods in org.keycloak.models.map.datastore that return UserModelModifier and TypeMethodDescriptionMapExportImportManager.createUser(RealmModel newRealm, UserRepresentation userRep) -
Uses of UserModel in org.keycloak.models.map.storage.chm
Fields in org.keycloak.models.map.storage.chm with type parameters of type UserModelModifier and TypeFieldDescriptionstatic final Map<SearchableModelField<UserModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object, MapUserEntity, UserModel>> MapFieldPredicates.USER_PREDICATESstatic final Map<SearchableModelField<UserModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object, MapUserEntity, UserModel>> MapFieldPredicates.USER_PREDICATES -
Uses of UserModel in org.keycloak.models.map.storage.jpa.user
Method parameters in org.keycloak.models.map.storage.jpa.user with type arguments of type UserModelModifier and TypeMethodDescriptionJpaUserModelCriteriaBuilder.compare(SearchableModelField<? super UserModel> modelField, ModelCriteriaBuilder.Operator op, Object... value) -
Uses of UserModel in org.keycloak.models.map.user
Classes in org.keycloak.models.map.user that implement UserModelMethods in org.keycloak.models.map.user that return UserModelModifier and TypeMethodDescriptionMapUserProvider.addUser(RealmModel realm, String username) MapUserProvider.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) MapUserProvider.getServiceAccount(ClientModel client) MapUserProvider.getUserByEmail(RealmModel realm, String email) MapUserProvider.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink) MapUserProvider.getUserById(RealmModel realm, String id) MapUserProvider.getUserByUsername(RealmModel realm, String username) Methods in org.keycloak.models.map.user that return types with arguments of type UserModelModifier and TypeMethodDescriptionMapUserProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) MapUserProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) MapUserProvider.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue) MapUserProvider.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults) MapUserProvider.searchForUserStream(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) Methods in org.keycloak.models.map.user with parameters of type UserModelModifier and TypeMethodDescriptionvoidMapUserProvider.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) MapUserProvider.getFederatedIdentitiesStream(RealmModel realm, UserModel user) MapUserProvider.getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) intMapUserProvider.getNotBeforeOfUser(RealmModel realm, UserModel user) booleanMapUserProvider.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) booleanMapUserProvider.removeUser(RealmModel realm, UserModel user) voidMapUserProvider.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore) voidMapUserProvider.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) Constructor parameters in org.keycloak.models.map.user with type arguments of type UserModelModifierConstructorDescriptionMapUserProvider(KeycloakSession session, MapStorage<MapUserEntity, UserModel> store) -
Uses of UserModel in org.keycloak.models.map.userSession
Methods in org.keycloak.models.map.userSession that return UserModelMethods in org.keycloak.models.map.userSession with parameters of type UserModelModifier and TypeMethodDescriptionMapUserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState) MapUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user) MapUserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user) voidMapUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user) voidMapUserSessionAdapter.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) Constructors in org.keycloak.models.map.userSession with parameters of type UserModelModifierConstructorDescriptionMapUserSessionAdapter(KeycloakSession session, RealmModel realm, UserModel userModel, MapUserSessionEntity entity) -
Uses of UserModel in org.keycloak.models.session
Methods in org.keycloak.models.session that return UserModelMethods in org.keycloak.models.session with parameters of type UserModelModifier and TypeMethodDescriptionDisabledUserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults) UserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults) Loads the user sessions for the givenUserModelin the givenRealmModelif present.voidDisabledUserSessionPersisterProvider.onUserRemoved(RealmModel realm, UserModel user) voidUserSessionPersisterProvider.onUserRemoved(RealmModel realm, UserModel user) voidPersistentUserSessionAdapter.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) -
Uses of UserModel in org.keycloak.models.sessions.infinispan
Methods in org.keycloak.models.sessions.infinispan that return UserModelModifier and TypeMethodDescriptionAuthenticationSessionAdapter.getAuthenticatedUser()UserSessionAdapter.getUser()Methods in org.keycloak.models.sessions.infinispan with parameters of type UserModelModifier and TypeMethodDescriptionInfinispanUserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState) InfinispanUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user) InfinispanUserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user) protected voidInfinispanUserSessionProvider.onUserRemoved(RealmModel realm, UserModel user) voidInfinispanUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user) protected voidInfinispanUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user, boolean offline) voidUserSessionAdapter.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) voidAuthenticationSessionAdapter.setAuthenticatedUser(UserModel user) Constructors in org.keycloak.models.sessions.infinispan with parameters of type UserModelModifierConstructorDescriptionUserSessionAdapter(KeycloakSession session, UserModel user, InfinispanUserSessionProvider provider, InfinispanChangelogBasedTransaction<String, UserSessionEntity> userSessionUpdateTx, InfinispanChangelogBasedTransaction<UUID, AuthenticatedClientSessionEntity> clientSessionUpdateTx, RealmModel realm, UserSessionEntity entity, boolean offline) -
Uses of UserModel in org.keycloak.models.utils
Classes in org.keycloak.models.utils that implement UserModelModifier and TypeClassDescriptionclassclassDelegation pattern.Fields in org.keycloak.models.utils declared as UserModelMethods in org.keycloak.models.utils that return UserModelModifier and TypeMethodDescriptionstatic UserModelRepresentationToModel.createUser(KeycloakSession session, RealmModel newRealm, UserRepresentation userRep) static UserModelKeycloakModelUtils.findUserByNameOrEmail(KeycloakSession session, RealmModel realm, String username) Try to find user by username or email for authenticationUserModelDelegate.getDelegate()Methods in org.keycloak.models.utils with parameters of type UserModelModifier and TypeMethodDescriptionstatic voidRepresentationToModel.createCredentials(UserRepresentation userRep, KeycloakSession session, RealmModel realm, UserModel user, boolean adminRequest) static voidRepresentationToModel.createFederatedIdentities(UserRepresentation userRep, KeycloakSession session, RealmModel realm, UserModel user) static voidRepresentationToModel.createGroups(UserRepresentation userRep, RealmModel newRealm, UserModel user) static voidRepresentationToModel.createRoleMappings(UserRepresentation userRep, UserModel user, RealmModel realm) RoleUtils.getDeepUserRoleMappings(UserModel user) static Collection<String>KeycloakModelUtils.resolveAttribute(UserModel user, String name, boolean aggregateAttrs) static Stream<GroupRepresentation>ModelToRepresentation.searchForGroupByName(UserModel user, boolean full, String search, Integer first, Integer max) static UserRepresentationModelToRepresentation.toBriefRepresentation(UserModel user) static Stream<GroupRepresentation>ModelToRepresentation.toGroupHierarchy(UserModel user, boolean full) static Stream<GroupRepresentation>ModelToRepresentation.toGroupHierarchy(UserModel user, boolean full, Integer first, Integer max) static UserRepresentationModelToRepresentation.toRepresentation(KeycloakSession session, RealmModel realm, UserModel user) Constructors in org.keycloak.models.utils with parameters of type UserModelModifierConstructorDescriptionReadOnlyUserModelDelegate(UserModel delegate) ReadOnlyUserModelDelegate(UserModel delegate, Function<String, RuntimeException> exceptionCreator) UserModelDelegate(UserModel delegate) -
Uses of UserModel in org.keycloak.policy
Methods in org.keycloak.policy with parameters of type UserModelModifier and TypeMethodDescriptionBlacklistPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) DefaultPasswordPolicyManagerProvider.validate(RealmModel realm, UserModel user, String password) DigitsPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) ForceExpiredPasswordPolicyProviderFactory.validate(RealmModel realm, UserModel user, String password) HashAlgorithmPasswordPolicyProviderFactory.validate(RealmModel realm, UserModel user, String password) HashIterationsPasswordPolicyProviderFactory.validate(RealmModel realm, UserModel user, String password) HistoryPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) LengthPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) LowerCasePasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) MaximumLengthPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) NotEmailPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) NotUsernamePasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) PasswordPolicyManagerProvider.validate(RealmModel realm, UserModel user, String password) PasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) RecoveryCodesWarningThresholdPasswordPolicyProviderFactory.validate(RealmModel realm, UserModel user, String password) RegexPatternsPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) SpecialCharsPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) UpperCasePasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password) -
Uses of UserModel in org.keycloak.protocol
Methods in org.keycloak.protocol with parameters of type UserModelModifier and TypeMethodDescriptionstatic StringProtocolMapperUtils.getUserModelValue(UserModel user, String propertyName) -
Uses of UserModel in org.keycloak.protocol.docker
Methods in org.keycloak.protocol.docker with parameters of type UserModelModifier and TypeMethodDescriptionbooleanDockerAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) protected voidDockerAuthenticator.notValidCredentialsAction(AuthenticationFlowContext context, RealmModel realm, UserModel user) protected voidDockerAuthenticator.userDisabledAction(AuthenticationFlowContext context, RealmModel realm, UserModel user, String eventError) -
Uses of UserModel in org.keycloak.protocol.oidc
Fields in org.keycloak.protocol.oidc declared as UserModelMethods in org.keycloak.protocol.oidc that return UserModelModifier and TypeMethodDescriptionprotected UserModelDefaultTokenExchangeProvider.importUserFromExternalIdentity(BrokeredIdentityContext context) static UserModelTokenManager.lookupUserFromStatelessToken(KeycloakSession session, RealmModel realm, AccessToken token) Lookup user from the "stateless" token.Methods in org.keycloak.protocol.oidc with parameters of type UserModelModifier and TypeMethodDescriptionTokenManager.createClientAccessToken(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx) protected jakarta.ws.rs.core.ResponseDefaultTokenExchangeProvider.exchangeClientToClient(UserModel targetUser, UserSessionModel targetUserSession, AccessToken token, boolean disallowOnHolderOfTokenMismatch) protected jakarta.ws.rs.core.ResponseDefaultTokenExchangeProvider.exchangeClientToOIDCClient(UserModel targetUser, UserSessionModel targetUserSession, String requestedTokenType, ClientModel targetClient, String audience, String scope) protected jakarta.ws.rs.core.ResponseDefaultTokenExchangeProvider.exchangeClientToSAML2Client(UserModel targetUser, UserSessionModel targetUserSession, String requestedTokenType, ClientModel targetClient) protected jakarta.ws.rs.core.ResponseDefaultTokenExchangeProvider.exchangeToIdentityProvider(UserModel targetUser, UserSessionModel targetUserSession, String requestedIssuer) static TokenManager.NotBeforeCheckTokenManager.NotBeforeCheck.forModel(KeycloakSession session, RealmModel realmModel, UserModel userModel) TokenManager.generateUserInfoClaims(AccessToken userInfo, UserModel userModel) TokenManager.getAccess(UserModel user, ClientModel client, Stream<ClientScopeModel> clientScopes) protected AccessTokenTokenManager.initToken(RealmModel realm, ClientModel client, UserModel user, UserSessionModel session, ClientSessionContext clientSessionCtx, jakarta.ws.rs.core.UriInfo uriInfo) static booleanTokenManager.verifyConsentStillAvailable(KeycloakSession session, UserModel user, ClientModel client, Stream<ClientScopeModel> requestedClientScopes) Constructors in org.keycloak.protocol.oidc with parameters of type UserModelModifierConstructorDescriptionTokenValidation(UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx, AccessToken newToken) -
Uses of UserModel in org.keycloak.protocol.oidc.endpoints
Methods in org.keycloak.protocol.oidc.endpoints with parameters of type UserModelModifier and TypeMethodDescriptionjakarta.ws.rs.core.ResponseTokenEndpoint.createTokenResponse(UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx, String scopeParam, boolean code, Function<TokenManager.AccessTokenResponseBuilder, ClientPolicyContext> clientPolicyContextGenerator) -
Uses of UserModel in org.keycloak.protocol.oidc.grants.ciba.channel
Fields in org.keycloak.protocol.oidc.grants.ciba.channel declared as UserModelMethods in org.keycloak.protocol.oidc.grants.ciba.channel that return UserModelMethods in org.keycloak.protocol.oidc.grants.ciba.channel with parameters of type UserModelConstructors in org.keycloak.protocol.oidc.grants.ciba.channel with parameters of type UserModelModifierConstructorDescriptionCIBAAuthenticationRequest(KeycloakSession session, UserModel user, ClientModel client) -
Uses of UserModel in org.keycloak.protocol.oidc.grants.ciba.resolvers
Methods in org.keycloak.protocol.oidc.grants.ciba.resolvers that return UserModelModifier and TypeMethodDescriptiondefault UserModelCIBALoginUserResolver.getUserFromIdTokenHint(String idToken) This method receives the id_token_hint parameter and returns its corresponding UserModel.CIBALoginUserResolver.getUserFromInfoUsedByAuthentication(String info) This method converts the user identifier that can be recognized by the external entity executing AuthN and AuthZ by AD to the corresponding UserModel.DefaultCIBALoginUserResolver.getUserFromInfoUsedByAuthentication(String info) default UserModelCIBALoginUserResolver.getUserFromLoginHint(String loginHint) This method receives the login_hint parameter and returns its corresponding UserModel.DefaultCIBALoginUserResolver.getUserFromLoginHint(String loginHint) default UserModelCIBALoginUserResolver.getUserFromLoginHintToken(String loginHintToken) This method receives the login_hint_token parameter and returns its corresponding UserModel.Methods in org.keycloak.protocol.oidc.grants.ciba.resolvers with parameters of type UserModelModifier and TypeMethodDescriptiondefault StringCIBALoginUserResolver.getInfoUsedByAuthentication(UserModel user) This method converts the UserModel to its corresponding user identifier that can be recognized by the external entity executing AuthN and AuthZ by AD.DefaultCIBALoginUserResolver.getInfoUsedByAuthentication(UserModel user) -
Uses of UserModel in org.keycloak.protocol.saml.profile.ecp.authenticator
Methods in org.keycloak.protocol.saml.profile.ecp.authenticator with parameters of type UserModelModifier and TypeMethodDescriptionbooleanHttpBasicAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) protected voidHttpBasicAuthenticator.notValidCredentialsAction(AuthenticationFlowContext context, RealmModel realm, UserModel user) voidHttpBasicAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) protected voidHttpBasicAuthenticator.userDisabledAction(AuthenticationFlowContext context, RealmModel realm, UserModel user, String eventError) protected voidHttpBasicAuthenticator.userSuccessAction(AuthenticationFlowContext context, UserModel user) -
Uses of UserModel in org.keycloak.services
Methods in org.keycloak.services with parameters of type UserModel -
Uses of UserModel in org.keycloak.services.clientpolicy.context
Methods in org.keycloak.services.clientpolicy.context that return UserModelModifier and TypeMethodDescriptiondefault UserModelClientCRUDContext.getAuthenticatedUser()returnsUserModelof the authenticated user. -
Uses of UserModel in org.keycloak.services.managers
Methods in org.keycloak.services.managers that return UserModelModifier and TypeMethodDescriptionAuth.getUser()AuthenticationManager.AuthResult.getUser()static UserModelAuthenticationManager.lookupUserForBruteForceLog(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authenticationSession) Methods in org.keycloak.services.managers with parameters of type UserModelModifier and TypeMethodDescriptionstatic 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 clientvoidBruteForceProtector.cleanUpPermanentLockout(KeycloakSession session, RealmModel realm, UserModel user) Clears any remaining traces of the permanent lockout.voidDefaultBruteForceProtector.cleanUpPermanentLockout(KeycloakSession session, RealmModel realm, UserModel user) 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) 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, Stream<String> requiredActions) voidBruteForceProtector.failedLogin(RealmModel realm, UserModel user, ClientConnection clientConnection) voidDefaultBruteForceProtector.failedLogin(RealmModel realm, UserModel user, ClientConnection clientConnection) UserSessionManager.findClientsWithOfflineToken(RealmModel realm, UserModel user) UserSessionManager.findOfflineSessions(RealmModel realm, UserModel user) Deprecated.UserSessionManager.findOfflineSessionsStream(RealmModel realm, UserModel user) booleanBruteForceProtector.isPermanentlyLockedOut(KeycloakSession session, RealmModel realm, UserModel user) booleanDefaultBruteForceProtector.isPermanentlyLockedOut(KeycloakSession session, RealmModel realm, UserModel user) booleanBruteForceProtector.isTemporarilyDisabled(KeycloakSession session, RealmModel realm, UserModel user) booleanDefaultBruteForceProtector.isTemporarilyDisabled(KeycloakSession session, RealmModel realm, UserModel user) static booleanUserConsentManager.revokeConsentToClient(KeycloakSession session, ClientModel client, UserModel user) Revoke consent of given user to given clientbooleanUserSessionManager.revokeOfflineToken(UserModel user, ClientModel client) voidBruteForceProtector.successfulLogin(RealmModel realm, UserModel user, ClientConnection clientConnection) voidDefaultBruteForceProtector.successfulLogin(RealmModel realm, UserModel user, ClientConnection clientConnection) Constructors in org.keycloak.services.managers with parameters of type UserModelModifierConstructorDescriptionAuth(RealmModel realm, AccessToken token, UserModel user, ClientModel client, UserSessionModel session, boolean cookie) AuthResult(UserModel user, UserSessionModel session, AccessToken token, ClientModel client) -
Uses of UserModel in org.keycloak.services.resources
Methods in org.keycloak.services.resources with parameters of type UserModelModifier and TypeMethodDescriptionjakarta.ws.rs.core.ResponseIdentityBrokerService.validateUser(AuthenticationSessionModel authSession, UserModel user, RealmModel realm) Method parameters in org.keycloak.services.resources with type arguments of type UserModelModifier and TypeMethodDescriptionstatic voidLoginActionsServiceChecks.checkIsUserValid(KeycloakSession session, RealmModel realm, String userId, Consumer<UserModel> userSetter) Verifies whether the user given by ID both exists in the current realm. -
Uses of UserModel in org.keycloak.services.resources.account
Methods in org.keycloak.services.resources.account with parameters of type UserModelModifier and TypeMethodDescriptionLinkedAccountsResource.getLinkedAccounts(KeycloakSession session, RealmModel realm, UserModel user) booleanPasswordUtil.isConfigured(KeycloakSession session, RealmModel realm, UserModel user) Deprecated.Instead, usePasswordUtil.isConfigured()Constructors in org.keycloak.services.resources.account with parameters of type UserModelModifierConstructorDescriptionAccountCredentialResource(KeycloakSession session, UserModel user, Auth auth) LinkedAccountsResource(KeycloakSession session, HttpRequest request, Auth auth, EventBuilder event, UserModel user) PasswordUtil(KeycloakSession session, UserModel user) Deprecated.PasswordUtil(UserModel user) -
Uses of UserModel in org.keycloak.services.resources.account.resources
Fields in org.keycloak.services.resources.account.resources declared as UserModelConstructors in org.keycloak.services.resources.account.resources with parameters of type UserModelModifierConstructorDescriptionprotectedAbstractResourceService(KeycloakSession session, UserModel user, Auth auth, HttpRequest request) ResourcesService(KeycloakSession session, UserModel user, Auth auth, HttpRequest request) -
Uses of UserModel in org.keycloak.services.resources.admin
Methods in org.keycloak.services.resources.admin that return UserModelMethods in org.keycloak.services.resources.admin with parameters of type UserModelModifier and TypeMethodDescriptionstatic voidUserResource.updateUserFromRep(UserProfile profile, UserModel user, UserRepresentation rep, KeycloakSession session, boolean isUpdateExistingUser) Constructors in org.keycloak.services.resources.admin with parameters of type UserModelModifierConstructorDescriptionAdminAuth(RealmModel realm, AccessToken token, UserModel user, ClientModel client) AdminMessageFormatter(KeycloakSession session, UserModel user) UserResource(KeycloakSession session, UserModel user, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) -
Uses of UserModel in org.keycloak.services.resources.admin.permissions
Methods in org.keycloak.services.resources.admin.permissions with parameters of type UserModelModifier and TypeMethodDescriptionbooleanUserPermissionManagement.canClientImpersonate(ClientModel client, UserModel user) booleanUserPermissionEvaluator.canImpersonate(UserModel user, ClientModel requester) booleanbooleanUserPermissionEvaluator.canManageGroupMembership(UserModel user) booleanUserPermissionEvaluator.canMapRoles(UserModel user) booleanstatic AdminPermissionEvaluatorAdminPermissions.evaluator(KeycloakSession session, RealmModel realm, RealmModel adminsRealm, UserModel admin) booleanUserPermissionEvaluator.isImpersonatable(UserModel user, ClientModel requester) booleanUserPermissionManagement.isImpersonatable(UserModel user) static RealmsPermissionEvaluatorAdminPermissions.realms(KeycloakSession session, RealmModel adminsRealm, UserModel admin) voidUserPermissionEvaluator.requireImpersonate(UserModel user) voidUserPermissionEvaluator.requireManage(UserModel user) voidUserPermissionEvaluator.requireManageGroupMembership(UserModel user) voidUserPermissionEvaluator.requireMapRoles(UserModel user) voidUserPermissionEvaluator.requireView(UserModel user) -
Uses of UserModel in org.keycloak.sessions
Methods in org.keycloak.sessions that return UserModelModifier and TypeMethodDescriptionAuthenticationSessionModel.getAuthenticatedUser()Returns authenticated user that is associated to the authentication session.Methods in org.keycloak.sessions with parameters of type UserModelModifier and TypeMethodDescriptionvoidAuthenticationSessionModel.setAuthenticatedUser(UserModel user) Sets authenticated user that is associated to the authentication session. -
Uses of UserModel in org.keycloak.social.twitter
Methods in org.keycloak.social.twitter with parameters of type UserModelModifier and TypeMethodDescriptionjakarta.ws.rs.core.ResponseTwitterIdentityProvider.exchangeFromToken(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder builder, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, jakarta.ws.rs.core.MultivaluedMap<String, String> params) protected jakarta.ws.rs.core.ResponseTwitterIdentityProvider.exchangeSessionToken(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.ResponseTwitterIdentityProvider.exchangeStoredToken(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) -
Uses of UserModel in org.keycloak.storage
Methods in org.keycloak.storage that return UserModelModifier and TypeMethodDescriptionUserStorageManager.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 involvedExportImportManager.createUser(RealmModel realm, UserRepresentation userRep) UserStorageManager.getServiceAccount(ClientModel client) 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) protected UserModelUserStorageManager.importValidation(RealmModel realm, UserModel user) Allows a UserStorageProvider to proxy and/or synchronize an imported user.Methods in org.keycloak.storage that return types with arguments of type UserModelModifier and TypeMethodDescriptionUserStorageManager.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) UserLookupProvidermethods implementations end hereUserQueryProvidermethods implementation start hereUserStorageManager.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) UserStorageManager.importValidation(RealmModel realm, Stream<UserModel> users) 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) UserStorageManager.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue) UserStorageManager.searchForUserStream(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) Methods in org.keycloak.storage with parameters of type UserModelModifier and TypeMethodDescriptionvoidUserStorageManager.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) protected voidUserStorageManager.deleteInvalidUser(RealmModel realm, UserModel user) UserStorageManager.getFederatedIdentitiesStream(RealmModel realm, UserModel user) UserStorageManager.getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) intUserStorageManager.getNotBeforeOfUser(RealmModel realm, UserModel user) protected UserModelUserStorageManager.importValidation(RealmModel realm, UserModel user) Allows a UserStorageProvider to proxy and/or synchronize an imported user.static booleanStorageId.isLocalStorage(UserModel user) Deprecated.UseStorageId.isLocalStorage(String)instead.voidUserStorageManager.onCache(RealmModel realm, CachedUserModel user, UserModel delegate) booleanUserStorageManager.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) booleanUserStorageManager.removeUser(RealmModel realm, UserModel user) static StringStorageId.resolveProviderId(UserModel user) Deprecated.UseStorageId.providerId(String)instead.voidUserStorageManager.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore) voidUserStorageManager.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) Method parameters in org.keycloak.storage with type arguments of type UserModelModifier and TypeMethodDescriptionUserStorageManager.importValidation(RealmModel realm, Stream<UserModel> users) -
Uses of UserModel in org.keycloak.storage.adapter
Classes in org.keycloak.storage.adapter that implement UserModelModifier and TypeClassDescriptionclassThis abstract class provides implementations for everything but getUsername().static classTheAbstractUserAdapter.Streamsinterface makes all collection-based methods inAbstractUserAdapterdefault by providing implementations that delegate to theStream-based variants instead of the other way around.classAssumes everything is managed by federated storage except for username.static classDeprecated.This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directlyclassclassThis will perform update operation for particular attribute/property just if the existing value is not already same.Constructors in org.keycloak.storage.adapter with parameters of type UserModel -
Uses of UserModel in org.keycloak.storage.datastore
Methods in org.keycloak.storage.datastore that return UserModelModifier and TypeMethodDescriptionLegacyExportImportManager.createUser(RealmModel newRealm, UserRepresentation userRep) -
Uses of UserModel in org.keycloak.storage.federated
Methods in org.keycloak.storage.federated with parameters of type UserModelModifier and TypeMethodDescriptionvoidUserFederatedStorageProvider.preRemove(RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.storage.jpa
Methods in org.keycloak.storage.jpa with parameters of type UserModelModifier and TypeMethodDescriptionJpaUserFederatedStorageProvider.createCredential(RealmModel realm, UserModel user, CredentialModel cred) JpaUserFederatedStorageProvider.getStoredCredentialById(RealmModel realm, UserModel user, String id) JpaUserFederatedStorageProvider.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type) JpaUserFederatedStorageProvider.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type) JpaUserFederatedStorageProvider.getStoredCredentialsStream(RealmModel realm, UserModel user) booleanJpaUserFederatedStorageProvider.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) voidJpaUserFederatedStorageProvider.preRemove(RealmModel realm, UserModel user) booleanJpaUserFederatedStorageProvider.removeStoredCredential(RealmModel realm, UserModel user, String id) voidJpaUserFederatedStorageProvider.updateCredential(RealmModel realm, UserModel user, CredentialModel cred) -
Uses of UserModel in org.keycloak.storage.ldap
Classes in org.keycloak.storage.ldap that implement UserModelModifier and TypeClassDescriptionclassUser model delegate, which tracks what attributes were written to LDAP in this transaction.classWill be good to get rid of this class and use ReadOnlyUserModelDelegate, but it can't be done now due the backwards compatibility.Methods in org.keycloak.storage.ldap that return UserModelModifier and TypeMethodDescriptionLDAPStorageProvider.addUser(RealmModel realm, String username) protected UserModelLDAPStorageProvider.findOrCreateAuthenticatedUser(RealmModel realm, KerberosPrincipal kerberosPrincipal) Called after successful kerberos authenticationLDAPStorageUserManager.getManagedProxiedUser(String userId) 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.proxy(RealmModel realm, UserModel local, LDAPObject ldapObject, boolean newUser) LDAPStorageProvider.validate(RealmModel realm, UserModel local) Methods in org.keycloak.storage.ldap that return types with arguments of type UserModelModifier and TypeMethodDescriptionLDAPStorageProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) LDAPStorageProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) LDAPStorageProvider.loadUsersByUsernames(List<String> usernames, RealmModel realm) LDAPStorageProvider.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue) LDAPStorageProvider.searchForUserStream(RealmModel realm, Map<String, String> params, Integer firstResult, Integer maxResults) Methods in org.keycloak.storage.ldap with parameters of type UserModelModifier and TypeMethodDescriptionstatic LDAPObjectLDAPUtils.addUserToLDAP(LDAPStorageProvider ldapProvider, RealmModel realm, UserModel user) Method to crate 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.voidLDAPStorageProvider.disableCredentialType(RealmModel realm, UserModel user, String credentialType) LDAPStorageProvider.getDisableableCredentialTypesStream(RealmModel realm, UserModel user) booleanLDAPStorageProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType) booleanLDAPStorageProvider.isValid(RealmModel realm, UserModel user, CredentialInput input) protected LDAPObjectLDAPStorageProvider.loadAndValidateUser(RealmModel realm, UserModel local) protected UserModelLDAPStorageProvider.proxy(RealmModel realm, UserModel local, LDAPObject ldapObject, boolean newUser) booleanLDAPStorageProvider.removeUser(RealmModel realm, UserModel user) voidLDAPStorageUserManager.setManagedProxiedUser(UserModel proxiedUser, LDAPObject ldapObject) booleanLDAPStorageProvider.updateCredential(RealmModel realm, UserModel user, CredentialInput input) LDAPStorageProvider.validate(RealmModel realm, UserModel local) booleanLDAPStorageProvider.validPassword(RealmModel realm, UserModel user, String password) Constructors in org.keycloak.storage.ldap with parameters of type UserModelModifierConstructorDescriptionLDAPWritesOnlyUserModelDelegate(UserModel delegate, LDAPStorageProvider provider) ReadonlyLDAPUserModelDelegate(UserModel delegate) -
Uses of UserModel in org.keycloak.storage.ldap.mappers
Classes in org.keycloak.storage.ldap.mappers that implement UserModelMethods in org.keycloak.storage.ldap.mappers that return UserModelModifier and TypeMethodDescriptionFullNameLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedAttributeMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedLDAPAttributeMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedLDAPGroupStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedLDAPRoleStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) LDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Called when invoke proxy on LDAP federation providerUserAttributeLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Methods in org.keycloak.storage.ldap.mappers that return types with arguments of type UserModelModifier and TypeMethodDescriptionAbstractLDAPStorageMapper.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 rolesMethods in org.keycloak.storage.ldap.mappers with parameters of type UserModelModifier and TypeMethodDescriptionPasswordUpdateCallback.beforePasswordUpdate(UserModel user, LDAPObject ldapUser, UserCredentialModel password) protected 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) booleanAbstractLDAPStorageMapper.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.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) 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) 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) 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) voidPasswordUpdateCallback.passwordUpdated(UserModel user, LDAPObject ldapUser, UserCredentialModel password) voidPasswordUpdateCallback.passwordUpdateFailed(UserModel user, LDAPObject ldapUser, UserCredentialModel password, ModelException exception) FullNameLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedAttributeMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedLDAPAttributeMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedLDAPGroupStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) HardcodedLDAPRoleStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) LDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Called when invoke proxy on LDAP federation providerUserAttributeLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) protected voidHardcodedAttributeMapper.setPropertyOnUserModel(Property<Object> userModelProperty, UserModel user, String ldapAttrValue) protected voidUserAttributeLDAPStorageMapper.setPropertyOnUserModel(Property<Object> userModelProperty, UserModel user, String ldapAttrValue) Constructors in org.keycloak.storage.ldap.mappers with parameters of type UserModelModifierConstructorDescriptionTxAwareLDAPUserModelDelegate(UserModel delegate, LDAPStorageProvider provider, LDAPObject ldapUser) -
Uses of UserModel in org.keycloak.storage.ldap.mappers.membership
Methods in org.keycloak.storage.ldap.mappers.membership that return types with arguments of type UserModelModifier and TypeMethodDescriptionMembershipType.getGroupMembers(RealmModel realm, CommonLDAPGroupMapper groupMapper, LDAPObject ldapGroup, int firstResult, int maxResults) -
Uses of UserModel in org.keycloak.storage.ldap.mappers.membership.group
Classes in org.keycloak.storage.ldap.mappers.membership.group that implement UserModelMethods in org.keycloak.storage.ldap.mappers.membership.group that return UserModelModifier and TypeMethodDescriptionGroupLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Methods in org.keycloak.storage.ldap.mappers.membership.group that return types with arguments of type UserModelModifier and TypeMethodDescriptionGroupLDAPStorageMapper.getGroupMembers(RealmModel realm, GroupModel kcGroup, int firstResult, int maxResults) Methods in org.keycloak.storage.ldap.mappers.membership.group with parameters of type UserModelModifier and TypeMethodDescriptionprotected GroupModelGroupLDAPStorageMapper.findKcGroupOrSyncFromLDAP(RealmModel realm, GroupModel parent, LDAPObject ldapGroup, UserModel user) voidGroupLDAPStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidGroupLDAPStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm) GroupLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Constructors in org.keycloak.storage.ldap.mappers.membership.group with parameters of type UserModelModifierConstructorDescriptionLDAPGroupMappingsUserDelegate(RealmModel realm, UserModel user, LDAPObject ldapUser) -
Uses of UserModel in org.keycloak.storage.ldap.mappers.membership.role
Classes in org.keycloak.storage.ldap.mappers.membership.role that implement UserModelMethods in org.keycloak.storage.ldap.mappers.membership.role that return UserModelModifier and TypeMethodDescriptionRoleLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Methods in org.keycloak.storage.ldap.mappers.membership.role that return types with arguments of type UserModelModifier and TypeMethodDescriptionRoleLDAPStorageMapper.getRoleMembers(RealmModel realm, RoleModel role, int firstResult, int maxResults) Methods in org.keycloak.storage.ldap.mappers.membership.role with parameters of type UserModelModifier and TypeMethodDescriptionvoidRoleLDAPStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) voidRoleLDAPStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm) RoleLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Constructors in org.keycloak.storage.ldap.mappers.membership.role with parameters of type UserModelModifierConstructorDescriptionLDAPRoleMappingsUserDelegate(RealmModel realm, UserModel user, LDAPObject ldapUser, RoleContainerModel targetRoleContainer) -
Uses of UserModel in org.keycloak.storage.ldap.mappers.msad
Classes in org.keycloak.storage.ldap.mappers.msad that implement UserModelMethods in org.keycloak.storage.ldap.mappers.msad that return UserModelModifier and TypeMethodDescriptionMSADUserAccountControlStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Methods in org.keycloak.storage.ldap.mappers.msad with parameters of type UserModelModifier and TypeMethodDescriptionMSADUserAccountControlStorageMapper.beforePasswordUpdate(UserModel user, LDAPObject ldapUser, UserCredentialModel password) 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) voidMSADUserAccountControlStorageMapper.passwordUpdated(UserModel user, LDAPObject ldapUser, UserCredentialModel password) voidMSADUserAccountControlStorageMapper.passwordUpdateFailed(UserModel user, LDAPObject ldapUser, UserCredentialModel password, ModelException exception) protected booleanMSADUserAccountControlStorageMapper.processAuthErrorCode(String errorCode, UserModel user) MSADUserAccountControlStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Constructors in org.keycloak.storage.ldap.mappers.msad with parameters of type UserModel -
Uses of UserModel in org.keycloak.storage.ldap.mappers.msadlds
Classes in org.keycloak.storage.ldap.mappers.msadlds that implement UserModelModifier and TypeClassDescriptionclassMethods in org.keycloak.storage.ldap.mappers.msadlds that return UserModelModifier and TypeMethodDescriptionMSADLDSUserAccountControlStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Methods in org.keycloak.storage.ldap.mappers.msadlds with parameters of type UserModelModifier and TypeMethodDescriptionMSADLDSUserAccountControlStorageMapper.beforePasswordUpdate(UserModel user, LDAPObject ldapUser, UserCredentialModel password) 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) voidMSADLDSUserAccountControlStorageMapper.passwordUpdated(UserModel user, LDAPObject ldapUser, UserCredentialModel password) voidMSADLDSUserAccountControlStorageMapper.passwordUpdateFailed(UserModel user, LDAPObject ldapUser, UserCredentialModel password, ModelException exception) protected booleanMSADLDSUserAccountControlStorageMapper.processAuthErrorCode(String errorCode, UserModel user) MSADLDSUserAccountControlStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Constructors in org.keycloak.storage.ldap.mappers.msadlds with parameters of type UserModel -
Uses of UserModel in org.keycloak.storage.user
Methods in org.keycloak.storage.user that return UserModelModifier and TypeMethodDescriptionUserRegistrationProvider.addUser(RealmModel realm, String username) All storage providers that implement this interface will be looped through.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.ImportedUserValidation.validate(RealmModel realm, UserModel user) If this method returns null, then the user in local storage will be removedMethods in org.keycloak.storage.user that return types with arguments of type UserModelModifier and TypeMethodDescriptionUserQueryMethodsProvider.getGroupMembersStream(RealmModel realm, GroupModel group) Obtains users that belong to a specific group.UserQueryMethodsProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) Obtains users that belong to a specific group.UserQueryMethodsProvider.getRoleMembersStream(RealmModel realm, RoleModel role) Obtains users that have the specified role.UserQueryMethodsProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) Searches for users that have the specified role.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 containingSEARCHinstead.UserQueryMethodsProvider.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults) Deprecated.UseUserQueryMethodsProvider.searchForUserStream(RealmModel, Map, Integer, Integer)with anparamsmap containingSEARCHinstead.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.Methods in org.keycloak.storage.user with parameters of type UserModelModifier and TypeMethodDescriptionbooleanUserRegistrationProvider.removeUser(RealmModel realm, UserModel user) Called if user originated from this provider.ImportedUserValidation.validate(RealmModel realm, UserModel user) If this method returns null, then the user in local storage will be removedMethod parameters in org.keycloak.storage.user with type arguments of type UserModelModifier and TypeMethodDescriptionstatic intUserCountMethodsProvider.countUsersInGroups(Stream<UserModel> users, Set<String> groupIds) Returns the number of users from the given list of users that are in at least one of the groups given in the groups set. -
Uses of UserModel in org.keycloak.userprofile
Fields in org.keycloak.userprofile declared as UserModelMethods in org.keycloak.userprofile that return UserModelModifier and TypeMethodDescriptionDefaultUserProfile.create()UserProfile.create()Creates a newUserModelbased on the attributes associated with this instance.AttributeContext.getUser()Methods in org.keycloak.userprofile with parameters of type UserModelModifier and TypeMethodDescriptionAbstractUserProfileProvider.create(UserProfileContext context, Map<String, ?> attributes, UserModel user) AbstractUserProfileProvider.create(UserProfileContext context, UserModel user) UserProfileProvider.create(UserProfileContext context, Map<String, ?> attributes, UserModel user) UserProfileProvider.create(UserProfileContext context, UserModel user) Creates a newUserProfileinstance only for validation purposes to check whether its attributes are in conformance with the givencontextand profile configuration.protected AttributesAbstractUserProfileProvider.createAttributes(UserProfileContext context, Map<String, ?> attributes, UserModel user, UserProfileMetadata metadata) protected AttributesDeclarativeUserProfileProvider.createAttributes(UserProfileContext context, Map<String, ?> attributes, UserModel user, UserProfileMetadata metadata) voidMethod called for each user attribute change.voidEventAuditingAttributeChangeListener.onChange(String attributeName, UserModel userModel, List<String> oldValue) Constructors in org.keycloak.userprofile with parameters of type UserModelModifierConstructorDescriptionAttributeContext(UserProfileContext context, KeycloakSession session, Map.Entry<String, List<String>> attribute, UserModel user, AttributeMetadata metadata, Attributes attributes) DefaultAttributes(UserProfileContext context, Map<String, ?> attributes, UserModel user, UserProfileMetadata profileMetadata, KeycloakSession session) DefaultUserProfile(UserProfileMetadata metadata, Attributes attributes, Function<Attributes, UserModel> userCreator, UserModel user, KeycloakSession session) LegacyAttributes(UserProfileContext context, Map<String, ?> attributes, UserModel user, UserProfileMetadata profileMetadata, KeycloakSession session) Constructor parameters in org.keycloak.userprofile with type arguments of type UserModelModifierConstructorDescriptionDefaultUserProfile(UserProfileMetadata metadata, Attributes attributes, Function<Attributes, UserModel> userCreator, UserModel user, KeycloakSession session) -
Uses of UserModel in org.keycloak.utils
Methods in org.keycloak.utils with parameters of type UserModelModifier 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.deleteOTPCredential(KeycloakSession session, RealmModel realm, UserModel user, String credentialId) static StringTotpUtils.qrCode(String totpSecret, RealmModel realm, UserModel user)
UserSessionProvider.createUserSession(String, RealmModel, UserModel, String, String, String, boolean, String, String, UserSessionModel.SessionPersistenceState)instead.