Uses of Interface
org.keycloak.models.UserModel
Package
Description
-
Uses of UserModel in org.keycloak.authentication
Modifier 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()
Modifier and TypeMethodDescriptionboolean
Authenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) Is this authenticator configured for this user.boolean
FormAction.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) Is this FormAction configured for the current user?default List<CredentialModel>
CredentialValidator.getCredentials
(KeycloakSession session, RealmModel realm, UserModel user) void
AuthenticationProcessor.setAutheticatedUser
(UserModel user) void
Authenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticatorvoid
FormAction.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticatorvoid
Attach a specific user to this flow.void
void
Attach a specific user to this flow.void
AuthenticationProcessor.validateUser
(UserModel authenticatedUser) ModifierConstructorDescriptionRequiredActionContextResult
(AuthenticationSessionModel authSession, RealmModel realm, EventBuilder eventBuilder, KeycloakSession session, HttpRequest httpRequest, UserModel user, RequiredActionFactory factory) -
Uses of UserModel in org.keycloak.authentication.authenticators
Modifier and TypeMethodDescriptionboolean
AttemptedAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
AttemptedAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.authenticators.access
Modifier and TypeMethodDescriptionboolean
AllowAccessAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
DenyAccessAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
AllowAccessAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
DenyAccessAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.authenticators.broker
Modifier and TypeMethodDescriptionstatic UserModel
AbstractIdpAuthenticator.getExistingUser
(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession) Modifier and TypeMethodDescriptionboolean
IdpAutoLinkAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdpConfirmLinkAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdpConfirmOverrideLinkAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdpCreateUserIfUniqueAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdpDetectExistingBrokerUserAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdpEmailVerificationAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdpReviewProfileAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
AbstractIdpAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) protected void
IdpCreateUserIfUniqueAuthenticator.userRegisteredSuccess
(AuthenticationFlowContext context, UserModel registeredUser, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext) Modifier and TypeMethodDescriptionprotected LoginFormsProvider
IdpUsernamePasswordForm.setupForm
(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String, String> formData, Optional<UserModel> existingUser) -
Uses of UserModel in org.keycloak.authentication.authenticators.browser
Modifier and TypeMethodDescriptionboolean
CookieAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
IdentityProviderAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
OTPFormAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
PasswordForm.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
RecoveryAuthnCodesFormAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ScriptBasedAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
SpnegoAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
UsernamePasswordForm.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
WebAuthnAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
AbstractUsernameFormAuthenticator.enabledUser
(AuthenticationFlowContext context, UserModel user) protected String
RecoveryAuthnCodesFormAuthenticator.getDisabledByBruteForceEventError
(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser) protected boolean
AbstractUsernameFormAuthenticator.isDisabledByBruteForce
(AuthenticationFlowContext context, UserModel user) protected boolean
RecoveryAuthnCodesFormAuthenticator.isDisabledByBruteForce
(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser) void
ConditionalOtpFormAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
CookieAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
IdentityProviderAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
OTPFormAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
RecoveryAuthnCodesFormAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ScriptBasedAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
SpnegoAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
UsernamePasswordForm.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
WebAuthnAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
WebAuthnPasswordlessAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
AbstractUsernameFormAuthenticator.testInvalidUser
(AuthenticationFlowContext context, UserModel user) boolean
AbstractUsernameFormAuthenticator.validatePassword
(AuthenticationFlowContext context, UserModel user, jakarta.ws.rs.core.MultivaluedMap<String, String> inputData, boolean clearUser) -
Uses of UserModel in org.keycloak.authentication.authenticators.conditional
Modifier and TypeMethodDescriptiondefault boolean
ConditionalAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
ConditionalLoaAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ConditionalRoleAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ConditionalUserAttributeValue.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ConditionalUserConfiguredAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.authenticators.directgrant
Modifier and TypeMethodDescriptionboolean
ValidateOTP.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ValidatePassword.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ValidateUsername.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
ValidateOTP.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ValidatePassword.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ValidateUsername.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.authenticators.resetcred
Modifier and TypeMethodDescriptionboolean
AbstractSetRequiredActionAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ResetCredentialChooseUser.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ResetCredentialEmail.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
ResetOTP.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) static Long
ResetCredentialEmail.getLastChangedTimestamp
(KeycloakSession session, RealmModel realm, UserModel user) void
AbstractSetRequiredActionAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ResetCredentialChooseUser.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
ResetCredentialEmail.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.authenticators.sessionlimits
Modifier and TypeMethodDescriptionboolean
UserSessionLimitsAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
UserSessionLimitsAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.authenticators.util
Modifier and TypeMethodDescriptionstatic String
AuthenticatorUtils.getDisabledByBruteForceEventError
(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser) static String
AuthenticatorUtils.getDisabledByBruteForceEventError
(BruteForceProtector protector, KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.authenticators.x509
Modifier and TypeMethodDescriptionabstract UserModel
UserIdentityToModelMapper.find
(AuthenticationFlowContext context, Object userIdentity) Modifier and TypeMethodDescriptionboolean
AbstractX509ClientCertificateAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
AbstractX509ClientCertificateAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.forms
Modifier and TypeMethodDescriptionboolean
AbstractRegistrationRecaptcha.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
RegistrationPassword.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
RegistrationTermsAndConditions.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) boolean
RegistrationUserCreation.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) void
AbstractRegistrationRecaptcha.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
RegistrationPassword.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
RegistrationTermsAndConditions.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) void
RegistrationUserCreation.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.authentication.requiredactions
Modifier and TypeMethodDescriptionstatic void
UpdateEmail.updateEmailNow
(EventBuilder event, UserModel user, UserProfile emailUpdateValidationResult) static UserProfile
UpdateEmail.validateEmailUpdate
(KeycloakSession session, UserModel user, String newEmail) -
Uses of UserModel in org.keycloak.authentication.requiredactions.util
Modifier and TypeMethodDescriptionstatic CredentialModel
CredentialDeleteHelper.removeCredential
(KeycloakSession session, UserModel user, String credentialId, Supplier<Integer> currentLoAProvider) Removing credential of given ID of specified user. -
Uses of UserModel in org.keycloak.authorization.common
Modifier and TypeFieldDescriptionprotected final UserModel
ClientModelIdentity.serviceAccount
protected UserModel
UserModelIdentity.user
-
Uses of UserModel in org.keycloak.broker.oidc
Modifier and TypeMethodDescriptionjakarta.ws.rs.core.Response
AbstractOAuth2IdentityProvider.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.Response
AbstractOAuth2IdentityProvider.exchangeSessionToken
(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.Response
OIDCIdentityProvider.exchangeSessionToken
(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.Response
AbstractOAuth2IdentityProvider.exchangeStoredToken
(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.Response
OIDCIdentityProvider.exchangeStoredToken
(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) -
Uses of UserModel in org.keycloak.broker.oidc.mappers
Modifier and TypeMethodDescriptionvoid
AbstractClaimToGroupMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractClaimToRoleMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
ClaimToUserSessionNoteMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractClaimToGroupMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractClaimToRoleMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractJsonUserAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
ClaimToUserSessionNoteMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UserAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UsernameTemplateMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractClaimToRoleMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractJsonUserAttributeMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
ExternalKeycloakRoleToRoleMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UsernameTemplateMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) -
Uses of UserModel in org.keycloak.broker.provider
Modifier and TypeMethodDescriptionstatic void
IdentityProviderMapperSyncModeDelegate.delegateUpdateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context, IdentityProviderMapper mapper) jakarta.ws.rs.core.Response
ExchangeTokenToIdentityProviderToken.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.Response
AbstractIdentityProvider.exchangeNotLinked
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) jakarta.ws.rs.core.Response
AbstractIdentityProvider.exchangeNotLinkedNoStore
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) jakarta.ws.rs.core.Response
AbstractIdentityProvider.exchangeTokenExpired
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) void
AbstractIdentityProvider.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) void
AbstractIdentityProviderMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedRoleMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedUserSessionAttributeMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
IdentityProvider.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) void
IdentityProviderMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) Called after UserModel is created for first time for this user.void
AbstractIdentityProvider.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) void
AbstractIdentityProviderMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedRoleMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedUserSessionAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
IdentityProvider.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) void
IdentityProviderMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) Called when this user has logged in before and has already been imported.void
AbstractIdentityProviderMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
HardcodedRoleMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
IdentityProviderMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) Called when this user has logged in before and has already been imported. -
Uses of UserModel in org.keycloak.broker.saml.mappers
Modifier and TypeMethodDescriptionvoid
AbstractAttributeToGroupMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractAttributeToRoleMapper.importNewUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractAttributeToGroupMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
AbstractAttributeToRoleMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UserAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UsernameTemplateMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
XPathAttributeMapper.updateBrokeredUser
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) void
UsernameTemplateMapper.updateBrokeredUserLegacy
(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) -
Uses of UserModel in org.keycloak.credential
Modifier and TypeMethodDescriptionCredentialProvider.createCredential
(RealmModel realm, UserModel user, T credentialModel) OTPCredentialProvider.createCredential
(RealmModel realm, UserModel user, OTPCredentialModel credentialModel) boolean
PasswordCredentialProvider.createCredential
(RealmModel realm, UserModel user, String password) PasswordCredentialProvider.createCredential
(RealmModel realm, UserModel user, PasswordCredentialModel credentialModel) RecoveryAuthnCodesCredentialProvider.createCredential
(RealmModel realm, UserModel user, RecoveryAuthnCodesCredentialModel credentialModel) UserCredentialStore.createCredential
(RealmModel realm, UserModel user, CredentialModel cred) WebAuthnCredentialProvider.createCredential
(RealmModel realm, UserModel user, WebAuthnCredentialModel credentialModel) boolean
CredentialProvider.deleteCredential
(RealmModel realm, UserModel user, String credentialId) boolean
OTPCredentialProvider.deleteCredential
(RealmModel realm, UserModel user, String credentialId) boolean
PasswordCredentialProvider.deleteCredential
(RealmModel realm, UserModel user, String credentialId) boolean
RecoveryAuthnCodesCredentialProvider.deleteCredential
(RealmModel realm, UserModel user, String credentialId) boolean
WebAuthnCredentialProvider.deleteCredential
(RealmModel realm, UserModel user, String credentialId) void
CredentialInputUpdater.disableCredentialType
(RealmModel realm, UserModel user, String credentialType) void
PasswordCredentialProvider.disableCredentialType
(RealmModel realm, UserModel user, String credentialType) default T
CredentialProvider.getDefaultCredential
(KeycloakSession session, RealmModel realm, UserModel user) CredentialInputUpdater.getDisableableCredentialTypesStream
(RealmModel realm, UserModel user) Obtains the set of credential types that can be disabled viadisableCredentialType
.PasswordCredentialProvider.getDisableableCredentialTypesStream
(RealmModel realm, UserModel user) PasswordCredentialProvider.getPassword
(RealmModel realm, UserModel user) UserCredentialStore.getStoredCredentialById
(RealmModel realm, UserModel user, String id) UserCredentialStore.getStoredCredentialByNameAndType
(RealmModel realm, UserModel user, String name, String type) UserCredentialStore.getStoredCredentialsByTypeStream
(RealmModel realm, UserModel user, String type) Obtains the stored credentials associated with the specified user that match the specified type.UserCredentialStore.getStoredCredentialsStream
(RealmModel realm, UserModel user) Obtains the stored credentials associated with the specified user.boolean
CredentialInputValidator.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
OTPCredentialProvider.isConfiguredFor
(RealmModel realm, UserModel user) boolean
OTPCredentialProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
PasswordCredentialProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
RecoveryAuthnCodesCredentialProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
WebAuthnCredentialProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
CredentialInputValidator.isValid
(RealmModel realm, UserModel user, CredentialInput credentialInput) Tests whether a credential is validboolean
OTPCredentialProvider.isValid
(RealmModel realm, UserModel user, CredentialInput credentialInput) boolean
PasswordCredentialProvider.isValid
(RealmModel realm, UserModel user, CredentialInput input) boolean
RecoveryAuthnCodesCredentialProvider.isValid
(RealmModel realm, UserModel user, CredentialInput credentialInput) boolean
WebAuthnCredentialProvider.isValid
(RealmModel realm, UserModel user, CredentialInput input) boolean
UserCredentialStore.moveCredentialTo
(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) boolean
UserCredentialStore.removeStoredCredential
(RealmModel realm, UserModel user, String id) Removes credential with theid
for theuser
.boolean
CredentialInputUpdater.updateCredential
(RealmModel realm, UserModel user, CredentialInput input) boolean
PasswordCredentialProvider.updateCredential
(RealmModel realm, UserModel user, CredentialInput input) void
UserCredentialStore.updateCredential
(RealmModel realm, UserModel user, CredentialModel cred) ModifierConstructorDescriptionUserCredentialManager
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.email
Modifier and TypeMethodDescriptionprotected String
DefaultEmailSenderProvider.retrieveEmailAddress
(UserModel user) void
DefaultEmailSenderProvider.send
(Map<String, String> config, UserModel user, String subject, String textBody, String htmlBody) default void
EmailSenderProvider.send
(Map<String, String> config, UserModel user, String subject, String textBody, String htmlBody) void
EmailTemplateProvider.sendSmtpTestEmail
(Map<String, String> config, UserModel user) Test SMTP connection with current logged in user -
Uses of UserModel in org.keycloak.email.freemarker
Modifier and TypeMethodDescriptionvoid
FreeMarkerEmailTemplateProvider.sendSmtpTestEmail
(Map<String, String> config, UserModel user) -
Uses of UserModel in org.keycloak.email.freemarker.beans
-
Uses of UserModel in org.keycloak.events
-
Uses of UserModel in org.keycloak.exportimport.dir
Modifier and TypeMethodDescriptionprotected void
DirExportProvider.writeUsers
(String fileName, KeycloakSession session, RealmModel realm, List<UserModel> users) -
Uses of UserModel in org.keycloak.exportimport.util
Modifier and TypeMethodDescriptionstatic UserRepresentation
ExportUtils.exportUser
(KeycloakSession session, RealmModel realm, UserModel user, ExportOptions options, boolean internal) Full export of user (including role mappings and credentials)Modifier and TypeMethodDescriptionstatic void
ExportUtils.exportUsersToStream
(KeycloakSession session, RealmModel realm, List<UserModel> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os) static void
ExportUtils.exportUsersToStream
(KeycloakSession session, RealmModel realm, List<UserModel> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os, ExportOptions options) protected abstract void
MultipleStepsExportProvider.writeUsers
(String fileName, KeycloakSession session, RealmModel realm, List<UserModel> users) -
Uses of UserModel in org.keycloak.federation.kerberos
Modifier and TypeMethodDescriptionKerberosFederationProvider.addUser
(RealmModel realm, String username) protected UserModel
KerberosFederationProvider.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 UserModel
KerberosFederationProvider.importUserToKeycloak
(RealmModel realm, KerberosPrincipal kerberosPrincipal) KerberosFederationProvider.validate
(RealmModel realm, UserModel user) Modifier and TypeMethodDescriptionvoid
KerberosFederationProvider.disableCredentialType
(RealmModel realm, UserModel user, String credentialType) KerberosFederationProvider.getDisableableCredentialTypesStream
(RealmModel realm, UserModel user) boolean
KerberosFederationProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
KerberosFederationProvider.isValid
(RealmModel realm, UserModel user, CredentialInput input) boolean
KerberosFederationProvider.removeUser
(RealmModel realm, UserModel user) boolean
KerberosFederationProvider.updateCredential
(RealmModel realm, UserModel user, CredentialInput input) KerberosFederationProvider.validate
(RealmModel realm, UserModel user) ModifierConstructorDescriptionReadOnlyKerberosUserModelDelegate
(UserModel delegate, KerberosFederationProvider provider) -
Uses of UserModel in org.keycloak.federation.sssd
Modifier and TypeClassDescriptionclass
Readonly proxy for a SSSD UserModel that prevents attributes from being updated.Modifier and TypeMethodDescriptionprotected UserModel
SSSDFederationProvider.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 UserModel
SSSDFederationProvider.importUserToKeycloak
(RealmModel realm, String username) SSSDFederationProvider.validate
(RealmModel realm, UserModel user) SSSDFederationProvider.validateAndProxy
(RealmModel realm, UserModel local) Modifier and TypeMethodDescriptionvoid
SSSDFederationProvider.disableCredentialType
(RealmModel realm, UserModel user, String credentialType) SSSDFederationProvider.getDisableableCredentialTypesStream
(RealmModel realm, UserModel user) boolean
SSSDFederationProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
SSSDFederationProvider.isValid
(RealmModel realm, UserModel local) boolean
SSSDFederationProvider.isValid
(RealmModel realm, UserModel user, CredentialInput input) boolean
SSSDFederationProvider.updateCredential
(RealmModel realm, UserModel user, CredentialInput input) SSSDFederationProvider.validate
(RealmModel realm, UserModel user) SSSDFederationProvider.validateAndProxy
(RealmModel realm, UserModel local) ModifierConstructorDescriptionReadonlySSSDUserModelDelegate
(UserModel delegate, SSSDFederationProvider provider) -
Uses of UserModel in org.keycloak.forms.login
-
Uses of UserModel in org.keycloak.forms.login.freemarker
Modifier and TypeMethodDescriptionModifierConstructorDescriptionAuthenticatorConfiguredMethod
(RealmModel realm, UserModel user, KeycloakSession session) -
Uses of UserModel in org.keycloak.forms.login.freemarker.model
ModifierConstructorDescriptionEmailBean
(UserModel user, jakarta.ws.rs.core.MultivaluedMap<String, String> formData, KeycloakSession session) OrganizationBean
(OrganizationModel organization, UserModel user) RecoveryAuthnCodeInputLoginBean
(KeycloakSession session, RealmModel realm, UserModel user) TotpBean
(KeycloakSession session, RealmModel realm, UserModel user, jakarta.ws.rs.core.UriBuilder uriBuilder) TotpBean
(KeycloakSession session, RealmModel realm, UserModel user, jakarta.ws.rs.core.UriBuilder uriBuilder, String secret) TotpLoginBean
(KeycloakSession session, RealmModel realm, UserModel user, String selectedCredentialId) 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
Modifier and TypeMethodDescriptionDefaultTokenManager.initLogoutToken
(ClientModel client, UserModel user, AuthenticatedClientSessionModel clientSession) -
Uses of UserModel in org.keycloak.locale
Modifier and TypeMethodDescriptionDefaultLocaleSelectorProvider.resolveLocale
(RealmModel realm, UserModel user) LocaleSelectorProvider.resolveLocale
(RealmModel realm, UserModel user) Resolve the locale which should be used for the requestvoid
DefaultLocaleUpdaterProvider.updateUsersLocale
(UserModel user, String locale) void
LocaleUpdaterProvider.updateUsersLocale
(UserModel user, String locale) -
Uses of UserModel in org.keycloak.migration.migrators
Modifier and TypeMethodDescriptionstatic void
MigrationUtils.migrateOldOfflineToken
(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user) -
Uses of UserModel in org.keycloak.models
Modifier and TypeFieldDescriptionstatic final Comparator<UserModel>
UserModel.COMPARE_BY_USERNAME
Modifier 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 clientFederatedIdentityModel.FederatedIdentityCreatedEvent.getUser()
FederatedIdentityModel.FederatedIdentityRemovedEvent.getUser()
UserModel.UserPreRemovedEvent.getUser()
UserModel.UserRemovedEvent.getUser()
UserSessionModel.getUser()
UserProvider.getUserByFederatedIdentity
(RealmModel realm, FederatedIdentityModel socialLink) Returns a userModel that corresponds to the given socialLink.Modifier and TypeMethodDescriptionvoid
UserProvider.addFederatedIdentity
(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) Adds a federated identity link for the user within the realmUserSessionProvider.createUserSession
(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState) Creates a new user session with the given parameters.default UserSessionModel
UserSessionProvider.createUserSession
(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) Deprecated.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.int
UserProvider.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) boolean
boolean
boolean
UserProvider.removeFederatedIdentity
(RealmModel realm, UserModel user, String socialProvider) Removes federation link between the user and the identity provider given by its idboolean
UserManager.removeUser
(RealmModel realm, UserModel user) boolean
UserManager.removeUser
(RealmModel realm, UserModel user, UserProvider userProvider) void
UserSessionProvider.removeUserSessions
(RealmModel realm, UserModel user) KeycloakContext.resolveLocale
(UserModel user) void
UserSessionModel.restartSession
(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) void
UserProvider.setNotBeforeForUser
(RealmModel realm, UserModel user, int notBefore) Sets the notBefore value for the given uservoid
UserProvider.updateFederatedIdentity
(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) Update details of association between the federatedUser and the idp given by the federatedIdentityModelModifierConstructorDescriptionCredentialValidationOutput
(UserModel authenticatedUser, CredentialValidationOutput.Status authStatus, Map<String, String> state) -
Uses of UserModel in org.keycloak.models.cache
Modifier and TypeInterfaceDescriptioninterface
Cached users will implement this interfaceModifier and TypeMethodDescriptionCachedUserModel.getDelegateForUpdate()
Invalidates the cache for this user and returns a delegate that represents the actual data providerModifier and TypeMethodDescriptionvoid
UserCache.evict
(RealmModel realm, UserModel user) Evict user from cache.void
OnUserCache.onCache
(RealmModel realm, CachedUserModel user, UserModel delegate) -
Uses of UserModel in org.keycloak.models.cache.infinispan
Modifier and TypeMethodDescriptionUserCacheSession.addUser
(RealmModel realm, String username) UserCacheSession.addUser
(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) protected UserModel
UserCacheSession.cacheUser
(RealmModel realm, UserModel delegate, Long revision) UserCacheSession.findServiceAccount
(ClientModel client) UserAdapter.getDelegateForUpdate()
UserCacheSession.getServiceAccount
(ClientModel client) protected UserModel
UserCacheSession.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 UserModel
UserCacheSession.validateCache
(RealmModel realm, CachedUser cached) Modifier and TypeMethodDescriptionUserCacheSession.getGroupMembersStream
(RealmModel realm, GroupModel group) UserCacheSession.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) UserCacheSession.getGroupMembersStream
(RealmModel realm, GroupModel group, String search, Boolean exact, Integer firstResult, Integer maxResults) 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) Modifier and TypeMethodDescriptionvoid
UserCacheSession.addFederatedIdentity
(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) protected UserModel
UserCacheSession.cacheUser
(RealmModel realm, UserModel delegate, Long revision) void
UserCacheSession.evict
(RealmModel realm, UserModel user) protected void
UserCacheSession.fullyInvalidateUser
(RealmModel realm, UserModel user) UserCacheSession.getFederatedIdentitiesStream
(RealmModel realm, UserModel user) UserCacheSession.getFederatedIdentity
(RealmModel realm, UserModel user, String socialProvider) int
UserCacheSession.getNotBeforeOfUser
(RealmModel realm, UserModel user) protected UserModel
UserCacheSession.getUserAdapter
(RealmModel realm, String userId, Long loaded, UserModel delegate) boolean
UserCacheSession.removeFederatedIdentity
(RealmModel realm, UserModel user, String socialProvider) boolean
UserCacheSession.removeUser
(RealmModel realm, UserModel user) void
UserCacheSession.setNotBeforeForUser
(RealmModel realm, UserModel user, int notBefore) void
UserCacheSession.updateFederatedIdentity
(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) ModifierConstructorDescriptionSubjectCredentialManagerCacheAdapter
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.models.cache.infinispan.entities
Modifier 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) ModifierConstructorDescriptionCachedUser
(Long revision, RealmModel realm, UserModel user, int notBefore) -
Uses of UserModel in org.keycloak.models.cache.infinispan.organization
Modifier and TypeMethodDescriptionInfinispanOrganizationProvider.getMemberById
(OrganizationModel organization, String id) Modifier and TypeMethodDescriptionInfinispanOrganizationProvider.getMembersStream
(OrganizationModel organization, String search, Boolean exact, Integer first, Integer max) Modifier and TypeMethodDescriptionboolean
InfinispanOrganizationProvider.addManagedMember
(OrganizationModel organization, UserModel user) boolean
InfinispanOrganizationProvider.addMember
(OrganizationModel organization, UserModel user) InfinispanOrganizationProvider.getByMember
(UserModel member) boolean
boolean
InfinispanOrganizationProvider.isManagedMember
(OrganizationModel organization, UserModel user) boolean
boolean
InfinispanOrganizationProvider.removeMember
(OrganizationModel organization, UserModel member) -
Uses of UserModel in org.keycloak.models.jpa
Modifier 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) Modifier and TypeMethodDescriptionJpaUserProvider.getGroupMembersStream
(RealmModel realm, GroupModel group) JpaUserProvider.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) JpaUserProvider.getGroupMembersStream
(RealmModel realm, GroupModel group, String search, Boolean exact, Integer first, Integer max) 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) Modifier and TypeMethodDescriptionvoid
JpaUserProvider.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) int
JpaUserProvider.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) boolean
JpaUserCredentialStore.moveCredentialTo
(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) boolean
JpaUserProvider.moveCredentialTo
(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) boolean
JpaUserProvider.removeFederatedIdentity
(RealmModel realm, UserModel user, String identityProvider) boolean
JpaUserCredentialStore.removeStoredCredential
(RealmModel realm, UserModel user, String id) boolean
JpaUserProvider.removeStoredCredential
(RealmModel realm, UserModel user, String id) boolean
JpaUserProvider.removeUser
(RealmModel realm, UserModel user) void
JpaUserProvider.setNotBeforeForUser
(RealmModel realm, UserModel user, int notBefore) void
JpaUserCredentialStore.updateCredential
(RealmModel realm, UserModel user, CredentialModel cred) void
JpaUserProvider.updateCredential
(RealmModel realm, UserModel user, CredentialModel cred) void
JpaUserProvider.updateFederatedIdentity
(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) -
Uses of UserModel in org.keycloak.models.jpa.session
Modifier and TypeMethodDescriptionJpaUserSessionPersisterProvider.loadUserSessionsStream
(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults) void
JpaUserSessionPersisterProvider.onUserRemoved
(RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.models.light
Modifier and TypeMethodDescriptionstatic boolean
LightweightUserAdapter.isLightweightUser
(UserModel user) -
Uses of UserModel in org.keycloak.models.session
Modifier 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 givenUserModel
in the givenRealmModel
if present.void
DisabledUserSessionPersisterProvider.onUserRemoved
(RealmModel realm, UserModel user) void
UserSessionPersisterProvider.onUserRemoved
(RealmModel realm, UserModel user) void
PersistentUserSessionAdapter.restartSession
(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) void
-
Uses of UserModel in org.keycloak.models.sessions.infinispan
Modifier and TypeMethodDescriptionAuthenticationSessionAdapter.getAuthenticatedUser()
UserSessionAdapter.getUser()
Modifier and TypeMethodDescriptionInfinispanUserSessionProvider.createUserSession
(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState) PersistentUserSessionProvider.createUserSession
(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState) InfinispanUserSessionProvider.getOfflineUserSessionsStream
(RealmModel realm, UserModel user) PersistentUserSessionProvider.getOfflineUserSessionsStream
(RealmModel realm, UserModel user) InfinispanUserSessionProvider.getUserSessionsStream
(RealmModel realm, UserModel user) PersistentUserSessionProvider.getUserSessionsStream
(RealmModel realm, UserModel user) protected void
InfinispanUserSessionProvider.onUserRemoved
(RealmModel realm, UserModel user) protected void
PersistentUserSessionProvider.onUserRemoved
(RealmModel realm, UserModel user) void
InfinispanUserSessionProvider.removeUserSessions
(RealmModel realm, UserModel user) protected void
InfinispanUserSessionProvider.removeUserSessions
(RealmModel realm, UserModel user, boolean offline) void
PersistentUserSessionProvider.removeUserSessions
(RealmModel realm, UserModel user) protected void
PersistentUserSessionProvider.removeUserSessions
(RealmModel realm, UserModel user, boolean offline) void
UserSessionAdapter.restartSession
(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) void
AuthenticationSessionAdapter.setAuthenticatedUser
(UserModel user) ModifierConstructorDescriptionUserSessionAdapter
(KeycloakSession session, UserModel user, T provider, SessionsChangelogBasedTransaction<String, UserSessionEntity> userSessionUpdateTx, SessionsChangelogBasedTransaction<UUID, AuthenticatedClientSessionEntity> clientSessionUpdateTx, RealmModel realm, UserSessionEntity entity, boolean offline) -
Uses of UserModel in org.keycloak.models.sessions.infinispan.changes.remote.updater.user
Modifier and TypeMethodDescriptionvoid
UserSessionUpdater.initialize
(UserSessionModel.SessionPersistenceState persistenceState, RealmModel realm, UserModel user, Map<String, AuthenticatedClientSessionModel> clientSessions) Initializes this class with references to other models classes.void
UserSessionUpdater.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.entities
Modifier and TypeMethodDescriptionstatic RemoteUserSessionEntity
RemoteUserSessionEntity.create
(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) static UserSessionEntity
UserSessionEntity.create
(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) static void
UserSessionEntity.updateSessionEntity
(UserSessionEntity entity, 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.remote
Modifier and TypeMethodDescriptionRemoteUserSessionProvider.createUserSession
(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState) RemoteUserSessionProvider.getOfflineUserSessionsStream
(RealmModel realm, UserModel user) RemoteUserSessionProvider.getUserSessionsStream
(RealmModel realm, UserModel user) void
RemoteUserSessionProvider.removeUserSessions
(RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.models.utils
Modifier and TypeClassDescriptionclass
class
Delegation pattern.Modifier and TypeMethodDescriptionstatic UserModel
RepresentationToModel.createUser
(KeycloakSession session, RealmModel newRealm, UserRepresentation userRep) static UserModel
KeycloakModelUtils.findUserByNameOrEmail
(KeycloakSession session, RealmModel realm, String username) Try to find user by username or email for authenticationUserModelDelegate.getDelegate()
UserSessionModelDelegate.getUser()
Modifier and TypeMethodDescriptionstatic void
RepresentationToModel.createCredentials
(UserRepresentation userRep, KeycloakSession session, RealmModel realm, UserModel user, boolean adminRequest) static void
RepresentationToModel.createFederatedIdentities
(UserRepresentation userRep, KeycloakSession session, RealmModel realm, UserModel user) static void
RepresentationToModel.createGroups
(KeycloakSession session, UserRepresentation userRep, RealmModel newRealm, UserModel user) static void
RepresentationToModel.createRoleMappings
(UserRepresentation userRep, UserModel user, RealmModel realm) RoleUtils.getDeepUserRoleMappings
(UserModel user) static Collection<String>
KeycloakModelUtils.resolveAttribute
(UserModel user, String name, boolean aggregateAttrs) void
UserSessionModelDelegate.restartSession
(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) static UserRepresentation
ModelToRepresentation.toBriefRepresentation
(UserModel user) static UserRepresentation
ModelToRepresentation.toRepresentation
(KeycloakSession session, RealmModel realm, UserModel user) ModifierConstructorDescriptionReadOnlyUserModelDelegate
(UserModel delegate) ReadOnlyUserModelDelegate
(UserModel delegate, Function<String, RuntimeException> exceptionCreator) UserModelDelegate
(UserModel delegate) -
Uses of UserModel in org.keycloak.organization
Modifier and TypeMethodDescriptionOrganizationProvider.getMemberById
(OrganizationModel organization, String id) Returns the member of theOrganizationModel
by itsid
.Modifier and TypeMethodDescriptionOrganizationProvider.getMembersStream
(OrganizationModel organization, String search, Boolean exact, Integer first, Integer max) Returns the members of a givenOrganizationModel
filtered according to the specified parameters.Modifier and TypeMethodDescriptionboolean
OrganizationProvider.addManagedMember
(OrganizationModel organization, UserModel user) Adds the givenUserModel
as a managed member of the givenOrganizationModel
.boolean
OrganizationProvider.addMember
(OrganizationModel organization, UserModel user) Adds the givenUserModel
as an unmanaged member of the givenOrganizationModel
.OrganizationProvider.getByMember
(UserModel member) Returns theOrganizationModel
that themember
belongs to.boolean
OrganizationProvider.isManagedMember
(OrganizationModel organization, UserModel member) Indicates if the givenmember
is managed by the organization.default boolean
OrganizationProvider.isMember
(OrganizationModel organization, UserModel user) Indicates if the givenuser
is a member of the givenorganization
.boolean
OrganizationProvider.removeMember
(OrganizationModel organization, UserModel member) Removes a member from the organization. -
Uses of UserModel in org.keycloak.organization.authentication.authenticators.broker
Modifier and TypeMethodDescriptionboolean
IdpAddOrganizationMemberAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.organization.authentication.authenticators.browser
Modifier and TypeMethodDescriptionboolean
OrganizationAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.organization.jpa
Modifier and TypeMethodDescriptionJpaOrganizationProvider.getMemberById
(OrganizationModel organization, String id) Modifier and TypeMethodDescriptionJpaOrganizationProvider.getMembersStream
(OrganizationModel organization, String search, Boolean exact, Integer first, Integer max) Modifier and TypeMethodDescriptionboolean
JpaOrganizationProvider.addManagedMember
(OrganizationModel organization, UserModel user) boolean
JpaOrganizationProvider.addMember
(OrganizationModel organization, UserModel user) JpaOrganizationProvider.getByMember
(UserModel member) boolean
boolean
JpaOrganizationProvider.isManagedMember
(OrganizationModel organization, UserModel member) boolean
boolean
JpaOrganizationProvider.removeMember
(OrganizationModel organization, UserModel member) -
Uses of UserModel in org.keycloak.organization.protocol.mappers.oidc
Modifier and TypeMethodDescriptionOrganizationScope.resolveOrganizations
(UserModel user, String scope, KeycloakSession session) Returns the organizations mapped from thescope
based on the givenuser
.OrganizationScope.toClientScope
(String name, UserModel user, KeycloakSession session) Returns aClientScopeModel
with the givenname
for this scope. -
Uses of UserModel in org.keycloak.organization.utils
Modifier and TypeMethodDescriptionstatic List<IdentityProviderModel>
Organizations.resolveHomeBroker
(KeycloakSession session, UserModel user) static OrganizationModel
Organizations.resolveOrganization
(KeycloakSession session, UserModel user) static OrganizationModel
Organizations.resolveOrganization
(KeycloakSession session, UserModel user, String domain) -
Uses of UserModel in org.keycloak.policy
Modifier and TypeMethodDescriptionAgePasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) BlacklistPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) DefaultPasswordPolicyManagerProvider.validate
(RealmModel realm, UserModel user, String password) DigitsPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) ForceExpiredPasswordPolicyProviderFactory.validate
(RealmModel realm, UserModel user, String password) HashAlgorithmPasswordPolicyProviderFactory.validate
(RealmModel realm, UserModel user, String password) HashIterationsPasswordPolicyProviderFactory.validate
(RealmModel realm, UserModel user, String password) HistoryPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) LengthPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) LowerCasePasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) MaxAuthAgePasswordPolicyProviderFactory.validate
(RealmModel realm, UserModel user, String password) MaximumLengthPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) NotContainsUsernamePasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) NotEmailPasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) NotUsernamePasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) PasswordPolicyManagerProvider.validate
(RealmModel realm, UserModel user, String password) PasswordPolicyProvider.validate
(RealmModel realm, UserModel user, String password) RecoveryCodesWarningThresholdPasswordPolicyProviderFactory.validate
(RealmModel realm, UserModel user, String password) 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
Modifier and TypeMethodDescriptionstatic String
ProtocolMapperUtils.getUserModelValue
(UserModel user, String propertyName) -
Uses of UserModel in org.keycloak.protocol.docker
Modifier and TypeMethodDescriptionboolean
DockerAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) protected void
DockerAuthenticator.notValidCredentialsAction
(AuthenticationFlowContext context, RealmModel realm, UserModel user) protected void
DockerAuthenticator.userDisabledAction
(AuthenticationFlowContext context, RealmModel realm, UserModel user, String eventError) -
Uses of UserModel in org.keycloak.protocol.oidc
Modifier and TypeMethodDescriptionprotected UserModel
DefaultTokenExchangeProvider.importUserFromExternalIdentity
(BrokeredIdentityContext context) static UserModel
TokenManager.lookupUserFromStatelessToken
(KeycloakSession session, RealmModel realm, AccessToken token) Lookup user from the "stateless" token.Modifier and TypeMethodDescriptionTokenManager.createClientAccessToken
(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx) protected jakarta.ws.rs.core.Response
DefaultTokenExchangeProvider.exchangeClientToClient
(UserModel targetUser, UserSessionModel targetUserSession, AccessToken token, boolean disallowOnHolderOfTokenMismatch) protected jakarta.ws.rs.core.Response
DefaultTokenExchangeProvider.exchangeClientToOIDCClient
(UserModel targetUser, UserSessionModel targetUserSession, String requestedTokenType, ClientModel targetClient, String audience, String scope) protected jakarta.ws.rs.core.Response
DefaultTokenExchangeProvider.exchangeClientToSAML2Client
(UserModel targetUser, UserSessionModel targetUserSession, String requestedTokenType, ClientModel targetClient) protected jakarta.ws.rs.core.Response
DefaultTokenExchangeProvider.exchangeToIdentityProvider
(UserModel targetUser, UserSessionModel targetUserSession, String requestedIssuer) static TokenManager.NotBeforeCheck
TokenManager.NotBeforeCheck.forModel
(KeycloakSession session, RealmModel realmModel, UserModel userModel) TokenManager.generateUserInfoClaims
(AccessToken userInfo, UserModel userModel) TokenManager.getAccess
(UserModel user, ClientModel client, Stream<ClientScopeModel> clientScopes) static Stream<ClientScopeModel>
TokenManager.getRequestedClientScopes
(KeycloakSession session, String scopeParam, ClientModel client, UserModel user) Return client itself + all default client scopes of client + optional client scopes requested by scope parameterprotected AccessToken
TokenManager.initToken
(RealmModel realm, ClientModel client, UserModel user, UserSessionModel session, ClientSessionContext clientSessionCtx, jakarta.ws.rs.core.UriInfo uriInfo) static boolean
TokenManager.isUserValid
(KeycloakSession session, RealmModel realm, AccessToken token, UserModel user) static boolean
TokenManager.isValidScope
(KeycloakSession session, String scopes, ClientModel client, UserModel user) static boolean
TokenManager.isValidScope
(KeycloakSession session, String scopes, AuthorizationRequestContext authorizationRequestContext, ClientModel client, UserModel user) Check that all the ClientScopes that have been parsed into authorization_resources are actually in the requested scopes otherwise, the scope wasn't parsed correctlystatic boolean
TokenManager.verifyConsentStillAvailable
(KeycloakSession session, UserModel user, ClientModel client, Stream<ClientScopeModel> requestedClientScopes) ModifierConstructorDescriptionTokenValidation
(UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx, AccessToken newToken) -
Uses of UserModel in org.keycloak.protocol.oidc.grants
Modifier and TypeMethodDescriptionprotected jakarta.ws.rs.core.Response
OAuth2GrantTypeBase.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
ModifierConstructorDescriptionCIBAAuthenticationRequest
(KeycloakSession session, UserModel user, ClientModel client) -
Uses of UserModel in org.keycloak.protocol.oidc.grants.ciba.resolvers
Modifier and TypeMethodDescriptiondefault UserModel
CIBALoginUserResolver.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 UserModel
CIBALoginUserResolver.getUserFromLoginHint
(String loginHint) This method receives the login_hint parameter and returns its corresponding UserModel.DefaultCIBALoginUserResolver.getUserFromLoginHint
(String loginHint) default UserModel
CIBALoginUserResolver.getUserFromLoginHintToken
(String loginHintToken) This method receives the login_hint_token parameter and returns its corresponding UserModel.Modifier and TypeMethodDescriptiondefault String
CIBALoginUserResolver.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
Modifier and TypeMethodDescriptionboolean
HttpBasicAuthenticator.configuredFor
(KeycloakSession session, RealmModel realm, UserModel user) protected void
HttpBasicAuthenticator.notValidCredentialsAction
(AuthenticationFlowContext context, RealmModel realm, UserModel user) void
HttpBasicAuthenticator.setRequiredActions
(KeycloakSession session, RealmModel realm, UserModel user) protected void
HttpBasicAuthenticator.userDisabledAction
(AuthenticationFlowContext context, RealmModel realm, UserModel user, String eventError) protected void
HttpBasicAuthenticator.userSuccessAction
(AuthenticationFlowContext context, UserModel user) -
Uses of UserModel in org.keycloak.services
-
Uses of UserModel in org.keycloak.services.clientpolicy.context
Modifier and TypeMethodDescriptiondefault UserModel
ClientCRUDContext.getAuthenticatedUser()
returnsUserModel
of the authenticated user. -
Uses of UserModel in org.keycloak.services.managers
Modifier and TypeMethodDescriptionAuth.getUser()
AuthenticationManager.AuthResult.getUser()
static UserModel
AuthenticationManager.lookupUserForBruteForceLog
(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authenticationSession) Modifier and TypeMethodDescriptionstatic void
UserConsentManager.addConsent
(KeycloakSession session, RealmModel realm, UserModel user, UserConsentModel consent) Add user consent for the user.static void
AuthenticationManager.backchannelLogoutUserFromClient
(KeycloakSession session, RealmModel realm, UserModel user, ClientModel client, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.HttpHeaders headers) Logout all clientSessions of this user and clientvoid
BruteForceProtector.cleanUpPermanentLockout
(KeycloakSession session, RealmModel realm, UserModel user) Clears any remaining traces of the permanent lockout.void
DefaultBruteForceProtector.cleanUpPermanentLockout
(KeycloakSession session, RealmModel realm, UserModel user) static IdentityCookieToken
AuthenticationManager.createIdentityToken
(KeycloakSession keycloakSession, RealmModel realm, UserModel user, UserSessionModel session, String issuer) static void
AuthenticationManager.createLoginCookie
(KeycloakSession keycloakSession, RealmModel realm, UserModel user, UserSessionModel session, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection) UserSessionManager.createUserSession
(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState) UserSessionManager.createUserSession
(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) static void
AuthenticationManager.evaluateRequiredActionTriggers
(KeycloakSession session, AuthenticationSessionModel authSession, HttpRequest request, EventBuilder event, RealmModel realm, UserModel user) protected static jakarta.ws.rs.core.Response
AuthenticationManager.executionActions
(KeycloakSession session, AuthenticationSessionModel authSession, HttpRequest request, EventBuilder event, RealmModel realm, UserModel user, Set<String> ignoredActions) void
BruteForceProtector.failedLogin
(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo) void
DefaultBruteForceProtector.failedLogin
(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo) UserSessionManager.findClientsWithOfflineToken
(RealmModel realm, UserModel user) UserSessionManager.findOfflineSessions
(RealmModel realm, UserModel user) Deprecated.UserSessionManager.findOfflineSessionsStream
(RealmModel realm, UserModel user) static UserConsentModel
UserConsentManager.getConsentByClient
(KeycloakSession session, RealmModel realm, UserModel user, String clientInternalId) Returns UserConsentModel given by a user for the client with clientInternalIdstatic Stream<UserConsentModel>
UserConsentManager.getConsentsStream
(KeycloakSession session, RealmModel realm, UserModel user) Obtains the consents associated with the userboolean
BruteForceProtector.isPermanentlyLockedOut
(KeycloakSession session, RealmModel realm, UserModel user) boolean
DefaultBlockingBruteForceProtector.isPermanentlyLockedOut
(KeycloakSession session, RealmModel realm, UserModel user) boolean
DefaultBruteForceProtector.isPermanentlyLockedOut
(KeycloakSession session, RealmModel realm, UserModel user) boolean
BruteForceProtector.isTemporarilyDisabled
(KeycloakSession session, RealmModel realm, UserModel user) boolean
DefaultBlockingBruteForceProtector.isTemporarilyDisabled
(KeycloakSession session, RealmModel realm, UserModel user) boolean
DefaultBruteForceProtector.isTemporarilyDisabled
(KeycloakSession session, RealmModel realm, UserModel user) protected void
DefaultBlockingBruteForceProtector.processLogin
(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo, boolean success) protected void
DefaultBruteForceProtector.processLogin
(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo, boolean success) static boolean
UserConsentManager.revokeConsentForClient
(KeycloakSession session, RealmModel realm, UserModel user, String clientInternalId) Remove a user consent given by the user and client idstatic boolean
UserConsentManager.revokeConsentToClient
(KeycloakSession session, ClientModel client, UserModel user) Revoke consent of given user to given clientboolean
UserSessionManager.revokeOfflineToken
(UserModel user, ClientModel client) void
BruteForceProtector.successfulLogin
(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo) void
DefaultBruteForceProtector.successfulLogin
(RealmModel realm, UserModel user, ClientConnection clientConnection, jakarta.ws.rs.core.UriInfo uriInfo) static void
UserConsentManager.updateConsent
(KeycloakSession session, RealmModel realm, UserModel user, UserConsentModel consent) Update client scopes in the stored user consentModifierConstructorDescriptionAuth
(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
Modifier and TypeMethodDescriptionjakarta.ws.rs.core.Response
IdentityBrokerService.validateUser
(AuthenticationSessionModel authSession, UserModel user, RealmModel realm) Modifier and TypeMethodDescriptionstatic void
LoginActionsServiceChecks.checkIsUserValid
(KeycloakSession session, RealmModel realm, String userId, Consumer<UserModel> userSetter, EventBuilder event) Verifies whether the user given by ID both exists in the current realm. -
Uses of UserModel in org.keycloak.services.resources.account
Modifier and TypeMethodDescriptionLinkedAccountsResource.getLinkedAccounts
(KeycloakSession session, RealmModel realm, UserModel user) Deprecated.boolean
PasswordUtil.isConfigured
(KeycloakSession session, RealmModel realm, UserModel user) Deprecated.Instead, usePasswordUtil.isConfigured()
ModifierConstructorDescriptionAccountCredentialResource
(KeycloakSession session, UserModel user, Auth auth, EventBuilder event) LinkedAccountsResource
(KeycloakSession session, HttpRequest request, Auth auth, EventBuilder event, UserModel user) OrganizationsResource
(KeycloakSession session, Auth auth, UserModel user) PasswordUtil
(KeycloakSession session, UserModel user) Deprecated.PasswordUtil
(UserModel user) -
Uses of UserModel in org.keycloak.services.resources.account.resources
ModifierConstructorDescriptionprotected
AbstractResourceService
(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
Modifier and TypeMethodDescriptionstatic void
UserResource.updateUserFromRep
(UserProfile profile, UserModel user, UserRepresentation rep, KeycloakSession session, boolean isUpdateExistingUser) ModifierConstructorDescriptionAdminAuth
(RealmModel realm, AccessToken token, UserModel user, ClientModel client) UserResource
(KeycloakSession session, UserModel user, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) -
Uses of UserModel in org.keycloak.services.resources.admin.permissions
Modifier and TypeMethodDescriptionboolean
UserPermissionManagement.canClientImpersonate
(ClientModel client, UserModel user) boolean
UserPermissionEvaluator.canImpersonate
(UserModel user, ClientModel requester) boolean
boolean
UserPermissionEvaluator.canManageGroupMembership
(UserModel user) boolean
UserPermissionEvaluator.canMapRoles
(UserModel user) boolean
static AdminPermissionEvaluator
AdminPermissions.evaluator
(KeycloakSession session, RealmModel realm, RealmModel adminsRealm, UserModel admin) boolean
UserPermissionEvaluator.isImpersonatable
(UserModel user, ClientModel requester) boolean
UserPermissionManagement.isImpersonatable
(UserModel user) static RealmsPermissionEvaluator
AdminPermissions.realms
(KeycloakSession session, RealmModel adminsRealm, UserModel admin) void
UserPermissionEvaluator.requireImpersonate
(UserModel user) void
UserPermissionEvaluator.requireManage
(UserModel user) void
UserPermissionEvaluator.requireManageGroupMembership
(UserModel user) void
UserPermissionEvaluator.requireMapRoles
(UserModel user) void
UserPermissionEvaluator.requireView
(UserModel user) -
Uses of UserModel in org.keycloak.sessions
Modifier and TypeMethodDescriptionAuthenticationSessionModel.getAuthenticatedUser()
Returns authenticated user that is associated to the authentication session.Modifier and TypeMethodDescriptionvoid
AuthenticationSessionModel.setAuthenticatedUser
(UserModel user) Sets authenticated user that is associated to the authentication session. -
Uses of UserModel in org.keycloak.social.twitter
Modifier and TypeMethodDescriptionjakarta.ws.rs.core.Response
TwitterIdentityProvider.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.Response
TwitterIdentityProvider.exchangeSessionToken
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.Response
TwitterIdentityProvider.exchangeStoredToken
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) -
Uses of UserModel in org.keycloak.storage
Modifier and TypeMethodDescriptionUserStorageManager.addUser
(RealmModel realm, String username) UserRegistrationProvider
methods implementations start hereUserStorageManager.addUser
(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) UserStorageProvider
methods implementation end hereUserProvider
methods implementations start here -> no StorageProviders 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) UserRegistrationProvider
methods implementations end hereUserLookupProvider
methods implementations start hereUserStorageManager.getUserByUsername
(RealmModel realm, String username) protected UserModel
UserStorageManager.importValidation
(RealmModel realm, UserModel user) Allows a UserStorageProvider to proxy and/or synchronize an imported user.Modifier and TypeMethodDescriptionUserStorageManager.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) UserLookupProvider
methods implementations end hereUserQueryProvider
methods implementation start hereUserStorageManager.getGroupMembersStream
(RealmModel realm, GroupModel group, String search, Boolean exact, Integer firstResult, Integer maxResults) UserStorageManager.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) Modifier and TypeMethodDescriptionvoid
UserStorageManager.addFederatedIdentity
(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) protected void
UserStorageManager.deleteInvalidUser
(RealmModel realm, UserModel user) UserStorageManager.getFederatedIdentitiesStream
(RealmModel realm, UserModel user) UserStorageManager.getFederatedIdentity
(RealmModel realm, UserModel user, String socialProvider) int
UserStorageManager.getNotBeforeOfUser
(RealmModel realm, UserModel user) protected UserModel
UserStorageManager.importValidation
(RealmModel realm, UserModel user) Allows a UserStorageProvider to proxy and/or synchronize an imported user.static boolean
StorageId.isLocalStorage
(UserModel user) Deprecated.UseStorageId.isLocalStorage(String)
instead.void
UserStorageManager.onCache
(RealmModel realm, CachedUserModel user, UserModel delegate) boolean
UserStorageManager.removeFederatedIdentity
(RealmModel realm, UserModel user, String socialProvider) boolean
UserStorageManager.removeUser
(RealmModel realm, UserModel user) static String
StorageId.resolveProviderId
(UserModel user) Deprecated.UseStorageId.providerId(String)
instead.void
UserStorageManager.setNotBeforeForUser
(RealmModel realm, UserModel user, int notBefore) void
UserStorageManager.updateFederatedIdentity
(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) Modifier and TypeMethodDescriptionUserStorageManager.importValidation
(RealmModel realm, Stream<UserModel> users) -
Uses of UserModel in org.keycloak.storage.adapter
Modifier and TypeClassDescriptionclass
class
This abstract class provides implementations for everything but getUsername().static class
TheAbstractUserAdapter.Streams
interface makes all collection-based methods inAbstractUserAdapter
default by providing implementations that delegate to theStream
-based variants instead of the other way around.class
Assumes everything is managed by federated storage except for username.static class
Deprecated.This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directlyclass
class
This will perform update operation for particular attribute/property just if the existing value is not already same. -
Uses of UserModel in org.keycloak.storage.datastore
Modifier and TypeMethodDescriptionDefaultExportImportManager.createUser
(RealmModel newRealm, UserRepresentation userRep) -
Uses of UserModel in org.keycloak.storage.federated
Modifier and TypeMethodDescriptionvoid
UserFederatedStorageProvider.preRemove
(RealmModel realm, UserModel user) -
Uses of UserModel in org.keycloak.storage.jpa
Modifier 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) boolean
JpaUserFederatedStorageProvider.moveCredentialTo
(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) void
JpaUserFederatedStorageProvider.preRemove
(RealmModel realm, UserModel user) boolean
JpaUserFederatedStorageProvider.removeStoredCredential
(RealmModel realm, UserModel user, String id) void
JpaUserFederatedStorageProvider.updateCredential
(RealmModel realm, UserModel user, CredentialModel cred) -
Uses of UserModel in org.keycloak.storage.ldap
Modifier and TypeClassDescriptionclass
User model delegate, which tracks what attributes were written to LDAP in this transaction.class
Will be good to get rid of this class and use ReadOnlyUserModelDelegate, but it can't be done now due the backwards compatibility.Modifier and TypeMethodDescriptionLDAPStorageProvider.addUser
(RealmModel realm, String username) protected UserModel
LDAPStorageProvider.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 UserModel
LDAPStorageProvider.importUserFromLDAP
(KeycloakSession session, RealmModel realm, LDAPObject ldapUser) protected UserModel
LDAPStorageProvider.importUserFromLDAP
(KeycloakSession session, RealmModel realm, LDAPObject ldapUser, LDAPStorageProvider.ImportType importType) protected UserModel
LDAPStorageProvider.proxy
(RealmModel realm, UserModel local, LDAPObject ldapObject, boolean newUser) LDAPStorageProvider.validate
(RealmModel realm, UserModel local) Modifier and TypeMethodDescriptionLDAPStorageProvider.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) LDAPStorageProvider.getRoleMembersStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) LDAPStorageProvider.loadUsersByDNs
(RealmModel realm, Collection<LDAPDn> dns, int firstResult, int maxResults) LDAPStorageProvider.loadUsersByUniqueAttribute
(RealmModel realm, String uidName, Collection<String> uids, int firstResult, int maxResults) LDAPStorageProvider.loadUsersByUsernames
(List<String> usernames, RealmModel realm) LDAPStorageProvider.searchForUserByUserAttributeStream
(RealmModel realm, String attrName, String attrValue) LDAPStorageProvider.searchForUserStream
(RealmModel realm, Map<String, String> params, Integer firstResult, Integer maxResults) Modifier and TypeMethodDescriptionstatic LDAPObject
LDAPUtils.addUserToLDAP
(LDAPStorageProvider ldapProvider, RealmModel realm, UserModel user) Method to create a user in the LDAP.static LDAPObject
LDAPUtils.addUserToLDAP
(LDAPStorageProvider ldapProvider, RealmModel realm, UserModel user, Consumer<LDAPObject> consumerOnCreated) Method that creates a user in the LDAP when all the attributes marked as mandatory by the mappers are set.void
LDAPStorageProvider.disableCredentialType
(RealmModel realm, UserModel user, String credentialType) LDAPStorageProvider.getDisableableCredentialTypesStream
(RealmModel realm, UserModel user) boolean
LDAPStorageProvider.isConfiguredFor
(RealmModel realm, UserModel user, String credentialType) boolean
LDAPStorageProvider.isValid
(RealmModel realm, UserModel user, CredentialInput input) protected LDAPObject
LDAPStorageProvider.loadAndValidateUser
(RealmModel realm, UserModel local) protected UserModel
LDAPStorageProvider.proxy
(RealmModel realm, UserModel local, LDAPObject ldapObject, boolean newUser) boolean
LDAPStorageProvider.removeUser
(RealmModel realm, UserModel user) void
LDAPStorageUserManager.setManagedProxiedUser
(UserModel proxiedUser, LDAPObject ldapObject) boolean
LDAPStorageProvider.updateCredential
(RealmModel realm, UserModel user, CredentialInput input) LDAPStorageProvider.validate
(RealmModel realm, UserModel local) boolean
LDAPStorageProvider.validPassword
(RealmModel realm, UserModel user, String password) ModifierConstructorDescriptionLDAPWritesOnlyUserModelDelegate
(UserModel delegate, LDAPStorageProvider provider) ReadonlyLDAPUserModelDelegate
(UserModel delegate) -
Uses of UserModel in org.keycloak.storage.ldap.mappers
Modifier 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) KerberosPrincipalAttributeMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) LDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Called when invoke proxy on LDAP federation providerUserAttributeLDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Modifier 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 rolesModifier and TypeMethodDescriptionPasswordUpdateCallback.beforePasswordUpdate
(UserModel user, LDAPObject ldapUser, UserCredentialModel password) protected void
UserAttributeLDAPStorageMapper.checkDuplicateEmail
(String userModelAttrName, String email, RealmModel realm, KeycloakSession session, UserModel user) protected void
UserAttributeLDAPStorageMapper.checkDuplicateUsername
(String userModelAttrName, String username, RealmModel realm, KeycloakSession session, UserModel user) protected String
HardcodedLDAPAttributeMapper.computeAttributeValue
(String ldapAttrName, String ldapAttrValue, LDAPObject ldapUser, UserModel localUser, RealmModel realm) boolean
AbstractLDAPStorageMapper.onAuthenticationFailure
(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) boolean
LDAPStorageMapper.onAuthenticationFailure
(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) Called when LDAP authentication of specified user fails.void
FullNameLDAPStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
HardcodedAttributeMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
HardcodedLDAPAttributeMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
HardcodedLDAPGroupStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
HardcodedLDAPRoleStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
KerberosPrincipalAttributeMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
LDAPStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) Called when importing user from LDAP to local keycloak DB.void
UserAttributeLDAPStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
FullNameLDAPStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
HardcodedAttributeMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
HardcodedLDAPAttributeMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
HardcodedLDAPGroupStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
HardcodedLDAPRoleStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
KerberosPrincipalAttributeMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
LDAPStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) Called when register new user to LDAP - just after user was created in Keycloak DBvoid
UserAttributeLDAPStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
PasswordUpdateCallback.passwordUpdated
(UserModel user, LDAPObject ldapUser, UserCredentialModel password) void
PasswordUpdateCallback.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) KerberosPrincipalAttributeMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) LDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Called when invoke proxy on LDAP federation providerUserAttributeLDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) protected void
HardcodedAttributeMapper.setPropertyOnUserModel
(Property<Object> userModelProperty, UserModel user, String ldapAttrValue) protected void
UserAttributeLDAPStorageMapper.setPropertyOnUserModel
(Property<Object> userModelProperty, UserModel user, String ldapAttrValue) ModifierConstructorDescriptionTxAwareLDAPUserModelDelegate
(UserModel delegate, LDAPStorageProvider provider, LDAPObject ldapUser) -
Uses of UserModel in org.keycloak.storage.ldap.mappers.membership
Modifier and TypeMethodDescriptionMembershipType.getGroupMembers
(RealmModel realm, CommonLDAPGroupMapper groupMapper, LDAPObject ldapGroup, int firstResult, int maxResults) -
Uses of UserModel in org.keycloak.storage.ldap.mappers.membership.group
Modifier and TypeMethodDescriptionGroupLDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Modifier and TypeMethodDescriptionGroupLDAPStorageMapper.getGroupMembers
(RealmModel realm, GroupModel kcGroup, int firstResult, int maxResults) Modifier and TypeMethodDescriptionprotected GroupModel
GroupLDAPStorageMapper.findKcGroupOrSyncFromLDAP
(RealmModel realm, GroupModel parent, LDAPObject ldapGroup, UserModel user) void
GroupLDAPStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
GroupLDAPStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) GroupLDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) ModifierConstructorDescriptionLDAPGroupMappingsUserDelegate
(RealmModel realm, UserModel user, LDAPObject ldapUser) -
Uses of UserModel in org.keycloak.storage.ldap.mappers.membership.role
Modifier and TypeMethodDescriptionRoleLDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Modifier and TypeMethodDescriptionRoleLDAPStorageMapper.getRoleMembers
(RealmModel realm, RoleModel role, int firstResult, int maxResults) Modifier and TypeMethodDescriptionvoid
RoleLDAPStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
RoleLDAPStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) RoleLDAPStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) ModifierConstructorDescriptionLDAPRoleMappingsUserDelegate
(RealmModel realm, UserModel user, LDAPObject ldapUser, RoleContainerModel targetRoleContainer) -
Uses of UserModel in org.keycloak.storage.ldap.mappers.msad
Modifier and TypeMethodDescriptionMSADUserAccountControlStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Modifier and TypeMethodDescriptionMSADUserAccountControlStorageMapper.beforePasswordUpdate
(UserModel user, LDAPObject ldapUser, UserCredentialModel password) boolean
MSADUserAccountControlStorageMapper.onAuthenticationFailure
(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) void
MSADUserAccountControlStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
MSADUserAccountControlStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
MSADUserAccountControlStorageMapper.passwordUpdated
(UserModel user, LDAPObject ldapUser, UserCredentialModel password) void
MSADUserAccountControlStorageMapper.passwordUpdateFailed
(UserModel user, LDAPObject ldapUser, UserCredentialModel password, ModelException exception) protected boolean
MSADUserAccountControlStorageMapper.processAuthErrorCode
(String errorCode, UserModel user) MSADUserAccountControlStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) ModifierConstructorDescriptionMSADUserModelDelegate
(UserModel delegate, LDAPObject ldapUser, boolean isAlwaysReadEnabledFromLdap) -
Uses of UserModel in org.keycloak.storage.ldap.mappers.msadlds
Modifier and TypeClassDescriptionclass
Modifier and TypeMethodDescriptionMSADLDSUserAccountControlStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Modifier and TypeMethodDescriptionMSADLDSUserAccountControlStorageMapper.beforePasswordUpdate
(UserModel user, LDAPObject ldapUser, UserCredentialModel password) boolean
MSADLDSUserAccountControlStorageMapper.onAuthenticationFailure
(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) void
MSADLDSUserAccountControlStorageMapper.onImportUserFromLDAP
(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) void
MSADLDSUserAccountControlStorageMapper.onRegisterUserToLDAP
(LDAPObject ldapUser, UserModel localUser, RealmModel realm) void
MSADLDSUserAccountControlStorageMapper.passwordUpdated
(UserModel user, LDAPObject ldapUser, UserCredentialModel password) void
MSADLDSUserAccountControlStorageMapper.passwordUpdateFailed
(UserModel user, LDAPObject ldapUser, UserCredentialModel password, ModelException exception) protected boolean
MSADLDSUserAccountControlStorageMapper.processAuthErrorCode
(String errorCode, UserModel user) MSADLDSUserAccountControlStorageMapper.proxy
(LDAPObject ldapUser, UserModel delegate, RealmModel realm) ModifierConstructorDescriptionMSADUserModelDelegate
(UserModel delegate, LDAPObject ldapUser, boolean isAlwaysReadEnabledFromLdap) -
Uses of UserModel in org.keycloak.storage.user
Modifier 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 removedModifier 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.getGroupMembersStream
(RealmModel realm, GroupModel group, String search, Boolean exact, Integer first, Integer max) Obtains users that belong to a specific group, filtered according to the search parameters.UserQueryMethodsProvider.getRoleMembersStream
(RealmModel realm, RoleModel role) Obtains users that have the specified role.UserQueryMethodsProvider.getRoleMembersStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) Searches for users that have the specified role.UserQueryMethodsProvider.searchForUserByUserAttributeStream
(RealmModel realm, String attrName, String attrValue) Searches for users that have a specific attribute with a specific value.UserQueryMethodsProvider.searchForUserStream
(RealmModel realm, String search) Deprecated.UseUserQueryMethodsProvider.searchForUserStream(RealmModel, Map)
with anparams
map containingSEARCH
instead.UserQueryMethodsProvider.searchForUserStream
(RealmModel realm, String search, Integer firstResult, Integer maxResults) Deprecated.UseUserQueryMethodsProvider.searchForUserStream(RealmModel, Map, Integer, Integer)
with anparams
map containingSEARCH
instead.UserQueryMethodsProvider.searchForUserStream
(RealmModel realm, Map<String, String> params) Searches for user by parameter.UserQueryMethodsProvider.searchForUserStream
(RealmModel realm, Map<String, String> params, Integer firstResult, Integer maxResults) Searches for user by parameter.Modifier and TypeMethodDescriptionboolean
UserRegistrationProvider.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 removedModifier and TypeMethodDescriptionstatic int
UserCountMethodsProvider.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
Modifier and TypeMethodDescriptionDefaultUserProfile.create()
UserProfile.create()
Creates a newUserModel
based on the attributes associated with this instance.AttributeContext.getUser()
Modifier and TypeMethodDescriptionDeclarativeUserProfileProvider.create
(UserProfileContext context, Map<String, ?> attributes, UserModel user) DeclarativeUserProfileProvider.create
(UserProfileContext context, UserModel user) UserProfileProvider.create
(UserProfileContext context, Map<String, ?> attributes, UserModel user) UserProfileProvider.create
(UserProfileContext context, UserModel user) Creates a newUserProfile
instance only for validation purposes to check whether its attributes are in conformance with the givencontext
and profile configuration.protected Attributes
DeclarativeUserProfileProvider.createAttributes
(UserProfileContext context, Map<String, ?> attributes, UserModel user, UserProfileMetadata metadata) void
Method called for each user attribute change.void
EventAuditingAttributeChangeListener.onChange
(String attributeName, UserModel userModel, List<String> oldValue) ModifierConstructorDescriptionAttributeContext
(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) ServiceAccountAttributes
(UserProfileContext context, Map<String, ?> attributes, UserModel user, UserProfileMetadata profileMetadata, KeycloakSession session) ModifierConstructorDescriptionDefaultUserProfile
(UserProfileMetadata metadata, Attributes attributes, Function<Attributes, UserModel> userCreator, UserModel user, KeycloakSession session) -
Uses of UserModel in org.keycloak.utils
Modifier and TypeMethodDescriptionstatic boolean
CredentialHelper.createOTPCredential
(KeycloakSession session, RealmModel realm, UserModel user, String totpCode, OTPCredentialModel credentialModel) Create OTP credential either in userStorage or local storage (Keycloak DB)static void
CredentialHelper.deleteOTPCredential
(KeycloakSession session, RealmModel realm, UserModel user, String credentialId) static String
TotpUtils.qrCode
(String totpSecret, RealmModel realm, UserModel user)
UserSessionProvider.createUserSession(String, RealmModel, UserModel, String, String, String, boolean, String, String, UserSessionModel.SessionPersistenceState)
instead.