Uses of Interface
org.keycloak.models.UserModel

Packages that use UserModel

Package	Description
org.keycloak.authentication
org.keycloak.authentication.authenticators
org.keycloak.authentication.authenticators.access
org.keycloak.authentication.authenticators.broker
org.keycloak.authentication.authenticators.browser
org.keycloak.authentication.authenticators.challenge
org.keycloak.authentication.authenticators.cli
org.keycloak.authentication.authenticators.conditional
org.keycloak.authentication.authenticators.console
org.keycloak.authentication.authenticators.directgrant
org.keycloak.authentication.authenticators.resetcred
org.keycloak.authentication.authenticators.util
org.keycloak.authentication.authenticators.x509
org.keycloak.authentication.forms
org.keycloak.authentication.requiredactions.util
org.keycloak.authorization.common
org.keycloak.broker.oidc
org.keycloak.broker.oidc.mappers
org.keycloak.broker.provider
org.keycloak.broker.saml.mappers
org.keycloak.credential
org.keycloak.email
org.keycloak.email.freemarker
org.keycloak.email.freemarker.beans
org.keycloak.events
org.keycloak.exportimport.dir
org.keycloak.exportimport.util
org.keycloak.federation.kerberos
org.keycloak.federation.sssd
org.keycloak.forms.account
org.keycloak.forms.account.freemarker
org.keycloak.forms.account.freemarker.model
org.keycloak.forms.login
org.keycloak.forms.login.freemarker
org.keycloak.forms.login.freemarker.model
org.keycloak.jose.jws
org.keycloak.locale
org.keycloak.migration.migrators
org.keycloak.models
org.keycloak.models.cache
org.keycloak.models.cache.infinispan
org.keycloak.models.cache.infinispan.entities
org.keycloak.models.jpa
org.keycloak.models.jpa.session
org.keycloak.models.map.authSession
org.keycloak.models.map.storage.chm
org.keycloak.models.map.user
org.keycloak.models.map.userSession
org.keycloak.models.session
org.keycloak.models.sessions.infinispan
org.keycloak.models.utils
org.keycloak.policy
org.keycloak.protocol
org.keycloak.protocol.docker
org.keycloak.protocol.oidc
org.keycloak.protocol.oidc.endpoints
org.keycloak.protocol.oidc.grants.ciba.channel
org.keycloak.protocol.oidc.grants.ciba.resolvers
org.keycloak.protocol.saml.profile.ecp.authenticator
org.keycloak.services
org.keycloak.services.clientpolicy.context
org.keycloak.services.managers
org.keycloak.services.resources
org.keycloak.services.resources.account
org.keycloak.services.resources.account.resources
org.keycloak.services.resources.admin
org.keycloak.services.resources.admin.permissions
org.keycloak.sessions
org.keycloak.social.twitter
org.keycloak.storage
org.keycloak.storage.adapter
org.keycloak.storage.federated
org.keycloak.storage.jpa
org.keycloak.storage.ldap
org.keycloak.storage.ldap.mappers
org.keycloak.storage.ldap.mappers.membership
org.keycloak.storage.ldap.mappers.membership.group
org.keycloak.storage.ldap.mappers.membership.role
org.keycloak.storage.ldap.mappers.msad
org.keycloak.storage.ldap.mappers.msadlds
org.keycloak.storage.user
org.keycloak.userprofile
org.keycloak.utils

Uses of UserModel in org.keycloak.authentication

Fields in org.keycloak.authentication declared as UserModel

Modifier and Type	Field and Description
protected UserModel	RequiredActionContextResult.user

Methods in org.keycloak.authentication that return UserModel

Modifier and Type	Method and Description
UserModel	RequiredActionContext.getUser() Current user
UserModel	FormContext.getUser() Current user attached to this flow.
UserModel	AuthenticationFlowContext.getUser() Current user attached to this flow.
UserModel	RequiredActionContextResult.getUser()
UserModel	AuthenticationProcessor.Result.getUser()

Methods in org.keycloak.authentication with parameters of type UserModel

Modifier and Type	Method and Description
boolean	FormAction.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) Is this FormAction configured for the current user?
boolean	Authenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user) Is this authenticator configured for this user.
default List<CredentialModel>	CredentialValidator.getCredentials(KeycloakSession session, RealmModel realm, UserModel user)
void	AuthenticationProcessor.setAutheticatedUser(UserModel user)
void	FormAction.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticator
void	Authenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticator
void	FormContext.setUser(UserModel user) Attach a specific user to this flow.
void	AuthenticationFlowContext.setUser(UserModel user) Attach a specific user to this flow.
void	AuthenticationProcessor.Result.setUser(UserModel user)
void	AuthenticationProcessor.validateUser(UserModel authenticatedUser)

Constructors in org.keycloak.authentication with parameters of type UserModel

Constructor and Description
RequiredActionContextResult(AuthenticationSessionModel authSession, RealmModel realm, EventBuilder eventBuilder, KeycloakSession session, org.jboss.resteasy.spi.HttpRequest httpRequest, UserModel user, RequiredActionFactory factory)

Uses of UserModel in org.keycloak.authentication.authenticators

Methods in org.keycloak.authentication.authenticators with parameters of type UserModel

Modifier and Type	Method and Description
boolean	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

Methods in org.keycloak.authentication.authenticators.access with parameters of type UserModel

Modifier and Type	Method and Description
boolean	DenyAccessAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	AllowAccessAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
void	DenyAccessAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	AllowAccessAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.authentication.authenticators.broker

Methods in org.keycloak.authentication.authenticators.broker that return UserModel

Modifier and Type	Method and Description
static UserModel	AbstractIdpAuthenticator.getExistingUser(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authSession)

Methods in org.keycloak.authentication.authenticators.broker with parameters of type UserModel

Modifier and Type	Method and Description
boolean	IdpReviewProfileAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	IdpEmailVerificationAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	IdpDetectExistingBrokerUserAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	IdpCreateUserIfUniqueAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	IdpConfirmLinkAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	IdpAutoLinkAuthenticator.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)

Method parameters in org.keycloak.authentication.authenticators.broker with type arguments of type UserModel

Modifier and Type	Method and Description
protected LoginFormsProvider	IdpUsernamePasswordForm.setupForm(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData, Optional<UserModel> existingUser)

Uses of UserModel in org.keycloak.authentication.authenticators.browser

Methods in org.keycloak.authentication.authenticators.browser with parameters of type UserModel

Modifier and Type	Method and Description
boolean	WebAuthnAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	UsernamePasswordForm.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	SpnegoAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	ScriptBasedAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	PasswordForm.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	OTPFormAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	IdentityProviderAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	CookieAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	AbstractUsernameFormAuthenticator.enabledUser(AuthenticationFlowContext context, UserModel user)
protected boolean	AbstractUsernameFormAuthenticator.isDisabledByBruteForce(AuthenticationFlowContext context, UserModel user)
void	WebAuthnPasswordlessAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	WebAuthnAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	UsernamePasswordForm.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	SpnegoAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	ScriptBasedAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	OTPFormAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	IdentityProviderAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	CookieAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	ConditionalOtpFormAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	AbstractUsernameFormAuthenticator.testInvalidUser(AuthenticationFlowContext context, UserModel user)
boolean	AbstractUsernameFormAuthenticator.validatePassword(AuthenticationFlowContext context, UserModel user, javax.ws.rs.core.MultivaluedMap<String,String> inputData)
boolean	AbstractUsernameFormAuthenticator.validatePassword(AuthenticationFlowContext context, UserModel user, javax.ws.rs.core.MultivaluedMap<String,String> inputData, boolean clearUser)

Uses of UserModel in org.keycloak.authentication.authenticators.challenge

Methods in org.keycloak.authentication.authenticators.challenge with parameters of type UserModel

Modifier and Type	Method and Description
boolean	NoCookieFlowRedirectAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	BasicAuthOTPAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	BasicAuthAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
void	NoCookieFlowRedirectAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	BasicAuthAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.authentication.authenticators.cli

Methods in org.keycloak.authentication.authenticators.cli with parameters of type UserModel

Modifier and Type	Method and Description
boolean	CliUsernamePasswordAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
void	CliUsernamePasswordAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.authentication.authenticators.conditional

Methods in org.keycloak.authentication.authenticators.conditional with parameters of type UserModel

Modifier and Type	Method and Description
default boolean	ConditionalAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
void	ConditionalUserConfiguredAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	ConditionalRoleAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.authentication.authenticators.console

Methods in org.keycloak.authentication.authenticators.console with parameters of type UserModel

Modifier and Type	Method and Description
boolean	ConsoleUsernamePasswordAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
void	ConsoleUsernamePasswordAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.authentication.authenticators.directgrant

Methods in org.keycloak.authentication.authenticators.directgrant with parameters of type UserModel

Modifier and Type	Method and Description
boolean	ValidateUsername.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	ValidatePassword.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	ValidateOTP.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
void	ValidateUsername.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	ValidatePassword.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	ValidateOTP.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.authentication.authenticators.resetcred

Methods in org.keycloak.authentication.authenticators.resetcred with parameters of type UserModel

Modifier and Type	Method and Description
boolean	ResetOTP.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	ResetCredentialEmail.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	ResetCredentialChooseUser.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	AbstractSetRequiredActionAuthenticator.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
static Long	ResetCredentialEmail.getLastChangedTimestamp(KeycloakSession session, RealmModel realm, UserModel user)
void	ResetCredentialEmail.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	ResetCredentialChooseUser.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	AbstractSetRequiredActionAuthenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.authentication.authenticators.util

Methods in org.keycloak.authentication.authenticators.util with parameters of type UserModel

Modifier and Type	Method and Description
static String	AuthenticatorUtils.getDisabledByBruteForceEventError(BruteForceProtector protector, KeycloakSession session, RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.authentication.authenticators.x509

Methods in org.keycloak.authentication.authenticators.x509 that return UserModel

Modifier and Type	Method and Description
abstract UserModel	UserIdentityToModelMapper.find(AuthenticationFlowContext context, Object userIdentity)

Methods in org.keycloak.authentication.authenticators.x509 with parameters of type UserModel

Modifier and Type	Method and Description
boolean	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

Methods in org.keycloak.authentication.forms with parameters of type UserModel

Modifier and Type	Method and Description
boolean	RegistrationUserCreation.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	RegistrationRecaptcha.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	RegistrationProfile.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
boolean	RegistrationPassword.configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
void	RegistrationUserCreation.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	RegistrationRecaptcha.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	RegistrationProfile.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	RegistrationPassword.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.authentication.requiredactions.util

Constructors in org.keycloak.authentication.requiredactions.util with parameters of type UserModel

Constructor and Description
UserUpdateProfileContext(RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.authorization.common

Fields in org.keycloak.authorization.common declared as UserModel

Modifier and Type	Field and Description
protected UserModel	ClientModelIdentity.serviceAccount
protected UserModel	UserModelIdentity.user

Constructors in org.keycloak.authorization.common with parameters of type UserModel

Constructor and Description
UserModelIdentity(RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.broker.oidc

Methods in org.keycloak.broker.oidc with parameters of type UserModel

Modifier and Type	Method and Description
javax.ws.rs.core.Response	AbstractOAuth2IdentityProvider.exchangeFromToken(javax.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, javax.ws.rs.core.MultivaluedMap<String,String> params)
protected javax.ws.rs.core.Response	OIDCIdentityProvider.exchangeSessionToken(javax.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
protected javax.ws.rs.core.Response	AbstractOAuth2IdentityProvider.exchangeSessionToken(javax.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
protected javax.ws.rs.core.Response	OIDCIdentityProvider.exchangeStoredToken(javax.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
protected javax.ws.rs.core.Response	AbstractOAuth2IdentityProvider.exchangeStoredToken(javax.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)

Uses of UserModel in org.keycloak.broker.oidc.mappers

Methods in org.keycloak.broker.oidc.mappers with parameters of type UserModel

Modifier and Type	Method and Description
void	AbstractClaimToRoleMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
void	UsernameTemplateMapper.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	AbstractJsonUserAttributeMapper.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	UsernameTemplateMapper.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	AbstractJsonUserAttributeMapper.updateBrokeredUserLegacy(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
void	AbstractClaimToRoleMapper.updateBrokeredUserLegacy(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)

Uses of UserModel in org.keycloak.broker.provider

Methods in org.keycloak.broker.provider with parameters of type UserModel

Modifier and Type	Method and Description
static void	IdentityProviderMapperSyncModeDelegate.delegateUpdateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context, IdentityProviderMapper mapper)
javax.ws.rs.core.Response	ExchangeTokenToIdentityProviderToken.exchangeFromToken(javax.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, javax.ws.rs.core.MultivaluedMap<String,String> params)
javax.ws.rs.core.Response	AbstractIdentityProvider.exchangeNotLinked(javax.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
javax.ws.rs.core.Response	AbstractIdentityProvider.exchangeNotLinkedNoStore(javax.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
javax.ws.rs.core.Response	AbstractIdentityProvider.exchangeTokenExpired(javax.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
void	IdentityProvider.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void	AbstractIdentityProvider.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	AbstractIdentityProviderMapper.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	HardcodedRoleMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
void	IdentityProvider.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void	AbstractIdentityProvider.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.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	HardcodedRoleMapper.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	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.
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)

Uses of UserModel in org.keycloak.broker.saml.mappers

Methods in org.keycloak.broker.saml.mappers with parameters of type UserModel

Modifier and Type	Method and Description
void	AbstractAttributeToRoleMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
void	UsernameTemplateMapper.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	AbstractAttributeToRoleMapper.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

Methods in org.keycloak.credential that return UserModel

Modifier and Type	Method and Description
UserModel	CredentialTypeMetadataContext.getUser()

Methods in org.keycloak.credential with parameters of type UserModel

Modifier and Type	Method and Description
CredentialModel	UserCredentialStore.createCredential(RealmModel realm, UserModel user, CredentialModel cred)
CredentialModel	UserCredentialStoreManager.createCredential(RealmModel realm, UserModel user, CredentialModel cred)
CredentialModel	OTPCredentialProvider.createCredential(RealmModel realm, UserModel user, OTPCredentialModel credentialModel)
CredentialModel	PasswordCredentialProvider.createCredential(RealmModel realm, UserModel user, PasswordCredentialModel credentialModel)
boolean	PasswordCredentialProvider.createCredential(RealmModel realm, UserModel user, String password)
CredentialModel	CredentialProvider.createCredential(RealmModel realm, UserModel user, T credentialModel)
CredentialModel	WebAuthnCredentialProvider.createCredential(RealmModel realm, UserModel user, WebAuthnCredentialModel credentialModel)
CredentialModel	UserCredentialStoreManager.createCredentialThroughProvider(RealmModel realm, UserModel user, CredentialModel model)
boolean	CredentialProvider.deleteCredential(RealmModel realm, UserModel user, String credentialId)
boolean	WebAuthnCredentialProvider.deleteCredential(RealmModel realm, UserModel user, String credentialId)
boolean	PasswordCredentialProvider.deleteCredential(RealmModel realm, UserModel user, String credentialId)
boolean	OTPCredentialProvider.deleteCredential(RealmModel realm, UserModel user, String credentialId)
void	CredentialInputUpdater.disableCredentialType(RealmModel realm, UserModel user, String credentialType)
void	UserCredentialStoreManager.disableCredentialType(RealmModel realm, UserModel user, String credentialType)
void	PasswordCredentialProvider.disableCredentialType(RealmModel realm, UserModel user, String credentialType)
Stream<String>	UserCredentialStoreManager.getConfiguredUserStorageCredentialTypesStream(RealmModel realm, UserModel user)
default T	CredentialProvider.getDefaultCredential(KeycloakSession session, RealmModel realm, UserModel user)
Set<String>	CredentialInputUpdater.getDisableableCredentialTypes(RealmModel realm, UserModel user) Deprecated. Use getDisableableCredentialTypesStream instead.
default Set<String>	CredentialInputUpdater.Streams.getDisableableCredentialTypes(RealmModel realm, UserModel user)
default Stream<String>	CredentialInputUpdater.getDisableableCredentialTypesStream(RealmModel realm, UserModel user) Obtains the set of credential types that can be disabled via disableCredentialType.
Stream<String>	CredentialInputUpdater.Streams.getDisableableCredentialTypesStream(RealmModel realm, UserModel user)
Stream<String>	UserCredentialStoreManager.getDisableableCredentialTypesStream(RealmModel realm, UserModel user)
Stream<String>	PasswordCredentialProvider.getDisableableCredentialTypesStream(RealmModel realm, UserModel user)
PasswordCredentialModel	PasswordCredentialProvider.getPassword(RealmModel realm, UserModel user)
CredentialModel	UserCredentialStore.getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	UserCredentialStoreManager.getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	UserCredentialStore.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
CredentialModel	UserCredentialStoreManager.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
List<CredentialModel>	UserCredentialStore.getStoredCredentials(RealmModel realm, UserModel user) Deprecated. Use getStoredCredentialsStream instead.
default List<CredentialModel>	UserCredentialStore.Streams.getStoredCredentials(RealmModel realm, UserModel user)
List<CredentialModel>	UserCredentialStore.getStoredCredentialsByType(RealmModel realm, UserModel user, String type) Deprecated. Use getStoredCredentialsByTypeStream instead.
default List<CredentialModel>	UserCredentialStore.Streams.getStoredCredentialsByType(RealmModel realm, UserModel user, String type)
default Stream<CredentialModel>	UserCredentialStore.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type) Obtains the stored credentials associated with the specified user that match the specified type.
Stream<CredentialModel>	UserCredentialStore.Streams.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)
Stream<CredentialModel>	UserCredentialStoreManager.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)
default Stream<CredentialModel>	UserCredentialStore.getStoredCredentialsStream(RealmModel realm, UserModel user) Obtains the stored credentials associated with the specified user.
Stream<CredentialModel>	UserCredentialStore.Streams.getStoredCredentialsStream(RealmModel realm, UserModel user)
Stream<CredentialModel>	UserCredentialStoreManager.getStoredCredentialsStream(RealmModel realm, UserModel user)
protected UserCredentialStore	UserCredentialStoreManager.getStoreForUser(UserModel user)
boolean	OTPCredentialProvider.isConfiguredFor(RealmModel realm, UserModel user)
boolean	CredentialInputValidator.isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	WebAuthnCredentialProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	UserCredentialStoreManager.isConfiguredFor(RealmModel realm, UserModel user, String type)
boolean	PasswordCredentialProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	OTPCredentialProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	UserCredentialStoreManager.isConfiguredLocally(RealmModel realm, UserModel user, String type)
boolean	UserCredentialStoreManager.isValid(RealmModel realm, UserModel user, CredentialInput... inputs)
boolean	CredentialInputValidator.isValid(RealmModel realm, UserModel user, CredentialInput credentialInput) Tests whether a credential is valid
boolean	WebAuthnCredentialProvider.isValid(RealmModel realm, UserModel user, CredentialInput input)
boolean	PasswordCredentialProvider.isValid(RealmModel realm, UserModel user, CredentialInput input)
boolean	OTPCredentialProvider.isValid(RealmModel realm, UserModel user, CredentialInput credentialInput)
boolean	UserCredentialStoreManager.isValid(RealmModel realm, UserModel user, List<CredentialInput> inputs)
boolean	UserCredentialStore.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
boolean	UserCredentialStoreManager.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
void	UserCredentialStoreManager.onCache(RealmModel realm, CachedUserModel user, UserModel delegate)
void	PasswordCredentialProvider.onCache(RealmModel realm, CachedUserModel user, UserModel delegate)
boolean	UserCredentialStore.removeStoredCredential(RealmModel realm, UserModel user, String id)
boolean	UserCredentialStoreManager.removeStoredCredential(RealmModel realm, UserModel user, String id)
boolean	CredentialInputUpdater.updateCredential(RealmModel realm, UserModel user, CredentialInput input)
boolean	UserCredentialStoreManager.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)
void	UserCredentialStoreManager.updateCredential(RealmModel realm, UserModel user, CredentialModel cred)
void	UserCredentialStoreManager.updateCredentialLabel(RealmModel realm, UserModel user, String credentialId, String userLabel)
CredentialTypeMetadataContext.CredentialTypeMetadataContextBuilder	CredentialTypeMetadataContext.CredentialTypeMetadataContextBuilder.user(UserModel user)

Uses of UserModel in org.keycloak.email

Methods in org.keycloak.email with parameters of type UserModel

Modifier and Type	Method and Description
protected String	DefaultEmailSenderProvider.retrieveEmailAddress(UserModel user)
void	EmailSenderProvider.send(Map<String,String> config, UserModel user, String subject, String textBody, String htmlBody)
void	DefaultEmailSenderProvider.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
EmailTemplateProvider	EmailTemplateProvider.setUser(UserModel user)

Uses of UserModel in org.keycloak.email.freemarker

Fields in org.keycloak.email.freemarker declared as UserModel

Modifier and Type	Field and Description
protected UserModel	FreeMarkerEmailTemplateProvider.user

Methods in org.keycloak.email.freemarker with parameters of type UserModel

Modifier and Type	Method and Description
void	FreeMarkerEmailTemplateProvider.sendSmtpTestEmail(Map<String,String> config, UserModel user)
EmailTemplateProvider	FreeMarkerEmailTemplateProvider.setUser(UserModel user)

Uses of UserModel in org.keycloak.email.freemarker.beans

Constructors in org.keycloak.email.freemarker.beans with parameters of type UserModel

Constructor and Description
ProfileBean(UserModel user)

Uses of UserModel in org.keycloak.events

Methods in org.keycloak.events with parameters of type UserModel

Modifier and Type	Method and Description
EventBuilder	EventBuilder.user(UserModel user)

Uses of UserModel in org.keycloak.exportimport.dir

Method parameters in org.keycloak.exportimport.dir with type arguments of type UserModel

Modifier and Type	Method and Description
protected void	DirExportProvider.writeUsers(String fileName, KeycloakSession session, RealmModel realm, List<UserModel> users)

Uses of UserModel in org.keycloak.exportimport.util

Methods in org.keycloak.exportimport.util with parameters of type UserModel

Modifier and Type	Method and Description
static UserRepresentation	ExportUtils.exportUser(KeycloakSession session, RealmModel realm, UserModel user, ExportOptions options, boolean internal) Full export of user (including role mappings and credentials)

Method parameters in org.keycloak.exportimport.util with type arguments of type UserModel

Modifier and Type	Method and Description
static void	ExportUtils.exportUsersToStream(KeycloakSession session, RealmModel realm, List<UserModel> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os)
static void	ExportUtils.exportUsersToStream(KeycloakSession session, RealmModel realm, List<UserModel> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os, ExportOptions options)
protected abstract void	MultipleStepsExportProvider.writeUsers(String fileName, KeycloakSession session, RealmModel realm, List<UserModel> users)

Uses of UserModel in org.keycloak.federation.kerberos

Classes in org.keycloak.federation.kerberos that implement UserModel

Modifier and Type	Class and Description
class	ReadOnlyKerberosUserModelDelegate

Methods in org.keycloak.federation.kerberos that return UserModel

Modifier and Type	Method and Description
protected UserModel	KerberosFederationProvider.findOrCreateAuthenticatedUser(RealmModel realm, String username) Called after successful authentication
UserModel	KerberosFederationProvider.getUserByEmail(RealmModel realm, String email)
UserModel	KerberosFederationProvider.getUserById(RealmModel realm, String id)
UserModel	KerberosFederationProvider.getUserByUsername(RealmModel realm, String username)
protected UserModel	KerberosFederationProvider.importUserToKeycloak(RealmModel realm, String username)
UserModel	KerberosFederationProvider.validate(RealmModel realm, UserModel user)

Methods in org.keycloak.federation.kerberos with parameters of type UserModel

Modifier and Type	Method and Description
void	KerberosFederationProvider.disableCredentialType(RealmModel realm, UserModel user, String credentialType)
Stream<String>	KerberosFederationProvider.getDisableableCredentialTypesStream(RealmModel realm, UserModel user)
boolean	KerberosFederationProvider.isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	KerberosFederationProvider.isValid(RealmModel realm, UserModel local)
boolean	KerberosFederationProvider.isValid(RealmModel realm, UserModel user, CredentialInput input)
boolean	KerberosFederationProvider.updateCredential(RealmModel realm, UserModel user, CredentialInput input)
UserModel	KerberosFederationProvider.validate(RealmModel realm, UserModel user)

Constructors in org.keycloak.federation.kerberos with parameters of type UserModel

Constructor and Description
ReadOnlyKerberosUserModelDelegate(UserModel delegate, KerberosFederationProvider provider)

Uses of UserModel in org.keycloak.federation.sssd

Classes in org.keycloak.federation.sssd that implement UserModel

Modifier and Type	Class and Description
class	ReadonlySSSDUserModelDelegate Readonly proxy for a SSSD UserModel that prevents attributes from being updated.

Methods in org.keycloak.federation.sssd that return UserModel

Modifier and Type	Method and Description
protected UserModel	SSSDFederationProvider.findOrCreateAuthenticatedUser(RealmModel realm, String username) Called after successful authentication
UserModel	SSSDFederationProvider.getUserByEmail(RealmModel realm, String email)
UserModel	SSSDFederationProvider.getUserById(RealmModel realm, String id)
UserModel	SSSDFederationProvider.getUserByUsername(RealmModel realm, String username)
protected UserModel	SSSDFederationProvider.importUserToKeycloak(RealmModel realm, String username)
UserModel	SSSDFederationProvider.validate(RealmModel realm, UserModel user)
UserModel	SSSDFederationProvider.validateAndProxy(RealmModel realm, UserModel local)

Methods in org.keycloak.federation.sssd with parameters of type UserModel

Modifier and Type	Method and Description
void	SSSDFederationProvider.disableCredentialType(RealmModel realm, UserModel user, String credentialType)
Stream<String>	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)
UserModel	SSSDFederationProvider.validate(RealmModel realm, UserModel user)
UserModel	SSSDFederationProvider.validateAndProxy(RealmModel realm, UserModel local)

Constructors in org.keycloak.federation.sssd with parameters of type UserModel

Constructor and Description
ReadonlySSSDUserModelDelegate(UserModel delegate, SSSDFederationProvider provider)

Uses of UserModel in org.keycloak.forms.account

Methods in org.keycloak.forms.account with parameters of type UserModel

Modifier and Type	Method and Description
AccountProvider	AccountProvider.setUser(UserModel user)

Uses of UserModel in org.keycloak.forms.account.freemarker

Fields in org.keycloak.forms.account.freemarker declared as UserModel

Modifier and Type	Field and Description
protected UserModel	FreeMarkerAccountProvider.user

Methods in org.keycloak.forms.account.freemarker with parameters of type UserModel

Modifier and Type	Method and Description
AccountProvider	FreeMarkerAccountProvider.setUser(UserModel user)

Uses of UserModel in org.keycloak.forms.account.freemarker.model

Methods in org.keycloak.forms.account.freemarker.model that return UserModel

Modifier and Type	Method and Description
UserModel	AuthorizationBean.RequesterBean.getRequester()
UserModel	AuthorizationBean.ResourceBean.getUserOwner()

Constructors in org.keycloak.forms.account.freemarker.model with parameters of type UserModel

Constructor and Description
AccountBean(UserModel user, javax.ws.rs.core.MultivaluedMap<String,String> profileFormData)
AccountFederatedIdentityBean(KeycloakSession session, RealmModel realm, UserModel user, URI baseUri, String stateChecker)
ApplicationsBean(KeycloakSession session, RealmModel realm, UserModel user)
AuthorizationBean(KeycloakSession session, UserModel user, javax.ws.rs.core.UriInfo uriInfo)
TotpBean(KeycloakSession session, RealmModel realm, UserModel user, javax.ws.rs.core.UriBuilder uriBuilder)

Uses of UserModel in org.keycloak.forms.login

Methods in org.keycloak.forms.login with parameters of type UserModel

Modifier and Type	Method and Description
LoginFormsProvider	LoginFormsProvider.setUser(UserModel user)

Uses of UserModel in org.keycloak.forms.login.freemarker

Fields in org.keycloak.forms.login.freemarker declared as UserModel

Modifier and Type	Field and Description
protected UserModel	FreeMarkerLoginFormsProvider.user

Methods in org.keycloak.forms.login.freemarker with parameters of type UserModel

Modifier and Type	Method and Description
FreeMarkerLoginFormsProvider	FreeMarkerLoginFormsProvider.setUser(UserModel user)

Constructors in org.keycloak.forms.login.freemarker with parameters of type UserModel

Constructor and Description
AuthenticatorConfiguredMethod(RealmModel realm, UserModel user, KeycloakSession session)

Uses of UserModel in org.keycloak.forms.login.freemarker.model

Constructors in org.keycloak.forms.login.freemarker.model with parameters of type UserModel

Constructor and Description
TotpBean(KeycloakSession session, RealmModel realm, UserModel user, javax.ws.rs.core.UriBuilder uriBuilder)
TotpLoginBean(KeycloakSession session, RealmModel realm, UserModel user, String selectedCredentialId)
VerifyProfileBean(UserModel user, javax.ws.rs.core.MultivaluedMap<String,String> formData, KeycloakSession session)
WebAuthnAuthenticatorsBean(KeycloakSession session, RealmModel realm, UserModel user, String credentialType)

Uses of UserModel in org.keycloak.jose.jws

Methods in org.keycloak.jose.jws with parameters of type UserModel

Modifier and Type	Method and Description
LogoutToken	DefaultTokenManager.initLogoutToken(ClientModel client, UserModel user, AuthenticatedClientSessionModel clientSession)

Uses of UserModel in org.keycloak.locale

Methods in org.keycloak.locale with parameters of type UserModel

Modifier and Type	Method and Description
Locale	LocaleSelectorProvider.resolveLocale(RealmModel realm, UserModel user) Resolve the locale which should be used for the request
Locale	DefaultLocaleSelectorProvider.resolveLocale(RealmModel realm, UserModel user)
void	LocaleUpdaterProvider.updateUsersLocale(UserModel user, String locale)
void	DefaultLocaleUpdaterProvider.updateUsersLocale(UserModel user, String locale)

Uses of UserModel in org.keycloak.migration.migrators

Methods in org.keycloak.migration.migrators with parameters of type UserModel

Modifier and Type	Method and Description
static void	MigrationUtils.migrateOldOfflineToken(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user)

Uses of UserModel in org.keycloak.models

Subinterfaces of UserModel in org.keycloak.models

Modifier and Type	Interface and Description
static interface	UserModel.Streams The UserModel.Streams interface makes all collection-based methods in UserModel default by providing implementations that delegate to the Stream-based variants instead of the other way around.

Classes in org.keycloak.models that implement UserModel

Modifier and Type	Class and Description
class	UserModelDefaultMethods
static class	UserModelDefaultMethods.Streams The UserModelDefaultMethods.Streams class extends the UserModelDefaultMethods abstract class and implements the UserModel.Streams interface, allowing subclasses to focus on the implementation of the Stream-based query methods and providing default implementations for the collections-based variants that delegate to their Stream counterparts.

Fields in org.keycloak.models with type parameters of type UserModel

Modifier and Type	Field and Description
static SearchableModelField<UserModel>	UserModel.SearchableFields.ASSIGNED_GROUP
static SearchableModelField<UserModel>	UserModel.SearchableFields.ASSIGNED_ROLE
static SearchableModelField<UserModel>	UserModel.SearchableFields.ATTRIBUTE Search for attribute value.
static Comparator<UserModel>	UserModel.COMPARE_BY_USERNAME
static SearchableModelField<UserModel>	UserModel.SearchableFields.CONSENT_CLIENT_FEDERATION_LINK Search for users that have consent set for a particular client that originates in the given client provider.
static SearchableModelField<UserModel>	UserModel.SearchableFields.CONSENT_FOR_CLIENT Search for users that have consent set for a particular client.
static SearchableModelField<UserModel>	UserModel.SearchableFields.CONSENT_WITH_CLIENT_SCOPE Search for users that have consent that has given client scope.
static SearchableModelField<UserModel>	UserModel.SearchableFields.EMAIL
static SearchableModelField<UserModel>	UserModel.SearchableFields.EMAIL_VERIFIED
static SearchableModelField<UserModel>	UserModel.SearchableFields.ENABLED
static SearchableModelField<UserModel>	UserModel.SearchableFields.FEDERATION_LINK
static SearchableModelField<UserModel>	UserModel.SearchableFields.FIRST_NAME
static SearchableModelField<UserModel>	UserModel.SearchableFields.ID
static SearchableModelField<UserModel>	UserModel.SearchableFields.IDP_AND_USER This field can only searched either for users coming from an IDP, then the operand is (idp_alias), or as user coming from a particular IDP with given username there, then the operand is a pair (idp_alias, idp_user_id).
static SearchableModelField<UserModel>	UserModel.SearchableFields.LAST_NAME
static SearchableModelField<UserModel>	UserModel.SearchableFields.REALM_ID
static SearchableModelField<UserModel>	UserModel.SearchableFields.SERVICE_ACCOUNT_CLIENT ID of the client corresponding to the service account
static SearchableModelField<UserModel>	UserModel.SearchableFields.USERNAME

Methods in org.keycloak.models that return UserModel

Modifier and Type	Method and Description
UserModel	UserProvider.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) Adds a new user into the storage.
UserModel	CredentialValidationOutput.getAuthenticatedUser()
UserModel	UserProvider.getServiceAccount(ClientModel client) Return a UserModel representing service account of the client
UserModel	UserSessionModel.getUser()
UserModel	UserModel.UserRemovedEvent.getUser()
UserModel	UserProvider.getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm) Deprecated. Use getUserByFederatedIdentity instead.
default UserModel	UserProvider.Streams.getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)
default UserModel	UserProvider.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink) Returns a userModel that corresponds to the given socialLink.
UserModel	UserProvider.Streams.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)

Methods in org.keycloak.models that return types with arguments of type UserModel

Modifier and Type	Method and Description
List<UserModel>	UserProvider.getUsers(RealmModel realm, boolean includeServiceAccounts) Deprecated. Use getUsersStream instead.
default List<UserModel>	UserProvider.Streams.getUsers(RealmModel realm, boolean includeServiceAccounts)
List<UserModel>	UserProvider.getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts) Deprecated. Use getUsersStream instead.
default List<UserModel>	UserProvider.Streams.getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)
default Stream<UserModel>	UserProvider.getUsersStream(RealmModel realm, boolean includeServiceAccounts) Obtains the users associated with the specified realm.
default Stream<UserModel>	UserProvider.Streams.getUsersStream(RealmModel realm, boolean includeServiceAccounts)
default Stream<UserModel>	UserProvider.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults, boolean includeServiceAccounts) Obtains the users associated with the specified realm.
Stream<UserModel>	UserProvider.Streams.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults, boolean includeServiceAccounts)

Methods in org.keycloak.models with parameters of type UserModel

Modifier and Type	Method and Description
void	UserProvider.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) Adds a federated identity link for the user within the realm
CredentialModel	UserCredentialManager.createCredentialThroughProvider(RealmModel realm, UserModel user, CredentialModel model) Creates a credential from the credentialModel, by looping through the providers to find a match for the type
UserSessionModel	UserSessionProvider.createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
UserSessionModel	UserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)
void	UserCredentialManager.disableCredentialType(RealmModel realm, UserModel user, String credentialType) Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.
List<String>	UserCredentialManager.getConfiguredUserStorageCredentialTypes(RealmModel realm, UserModel user) Deprecated. Use getConfiguredUserStorageCredentialTypesStream instead.
default List<String>	UserCredentialManager.Streams.getConfiguredUserStorageCredentialTypes(RealmModel realm, UserModel user)
default Stream<String>	UserCredentialManager.getConfiguredUserStorageCredentialTypesStream(RealmModel realm, UserModel user) Obtains the credential types provided by the user storage where the specified user is stored.
Stream<String>	UserCredentialManager.Streams.getConfiguredUserStorageCredentialTypesStream(RealmModel realm, UserModel user)
Set<String>	UserCredentialManager.getDisableableCredentialTypes(RealmModel realm, UserModel user) Deprecated. Use getDisableableCredentialTypesStream instead.
default Set<String>	UserCredentialManager.Streams.getDisableableCredentialTypes(RealmModel realm, UserModel user)
default Stream<String>	UserCredentialManager.getDisableableCredentialTypesStream(RealmModel realm, UserModel user) Obtains the credential types that can be disabled by means of the UserCredentialManager.disableCredentialType(RealmModel, UserModel, String) method.
Stream<String>	UserCredentialManager.Streams.getDisableableCredentialTypesStream(RealmModel realm, UserModel user)
Set<FederatedIdentityModel>	UserProvider.getFederatedIdentities(UserModel user, RealmModel realm) Deprecated. Use getFederatedIdentitiesStream instead.
default Set<FederatedIdentityModel>	UserProvider.Streams.getFederatedIdentities(UserModel user, RealmModel realm)
default Stream<FederatedIdentityModel>	UserProvider.getFederatedIdentitiesStream(RealmModel realm, UserModel user) Obtains the federated identities of the specified user.
Stream<FederatedIdentityModel>	UserProvider.Streams.getFederatedIdentitiesStream(RealmModel realm, UserModel user)
default FederatedIdentityModel	UserProvider.getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) Returns details of the association between the user and the socialProvider.
FederatedIdentityModel	UserProvider.Streams.getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)
FederatedIdentityModel	UserProvider.getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm) Deprecated. Use getFederatedIdentity instead.
default FederatedIdentityModel	UserProvider.Streams.getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)
String	OTPPolicy.getKeyURI(RealmModel realm, UserModel user, String secret) Constructs the otpauth:// URI based on the Key-Uri-Format.
int	UserProvider.getNotBeforeOfUser(RealmModel realm, UserModel user) Gets the notBefore value for the given user
default List<UserSessionModel>	UserSessionProvider.getOfflineUserSessions(RealmModel realm, UserModel user) Deprecated. Use getOfflineUserSessionsStream instead.
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user) Obtains the offline user sessions associated with the specified user.
default List<UserSessionModel>	UserSessionProvider.getUserSessions(RealmModel realm, UserModel user) Deprecated. Use getUserSessionsStream instead.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user) Obtains the online user sessions associated with the specified user.
LogoutToken	TokenManager.initLogoutToken(ClientModel client, UserModel user, AuthenticatedClientSessionModel clientSessionModel)
boolean	UserCredentialManager.isConfiguredFor(RealmModel realm, UserModel user, String type) Checks to see if user has credential type configured.
boolean	UserCredentialManager.isConfiguredLocally(RealmModel realm, UserModel user, String type) Only loops through each CredentialProvider to see if credential type is configured for the user.
boolean	UserCredentialManager.isValid(RealmModel realm, UserModel user, CredentialInput... inputs) Validates list of credentials.
boolean	UserCredentialManager.isValid(RealmModel realm, UserModel user, List<CredentialInput> inputs) Validates list of credentials.
boolean	UserProvider.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) Removes federation link between the user and the identity provider given by its id
boolean	UserManager.removeUser(RealmModel realm, UserModel user)
boolean	UserManager.removeUser(RealmModel realm, UserModel user, UserProvider userProvider)
void	UserSessionProvider.removeUserSessions(RealmModel realm, UserModel user)
Locale	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 user
boolean	UserCredentialManager.updateCredential(RealmModel realm, UserModel user, CredentialInput input) Updates a credential.
void	UserCredentialManager.updateCredentialLabel(RealmModel realm, UserModel user, String credentialId, String userLabel) Updates the credential label and invalidates the cache for the user.
void	UserProvider.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) Update details of association between the federatedUser and the idp given by the federatedIdentityModel

Constructors in org.keycloak.models with parameters of type UserModel

Constructor and Description
CredentialValidationOutput(UserModel authenticatedUser, CredentialValidationOutput.Status authStatus, Map<String,String> state)

Uses of UserModel in org.keycloak.models.cache

Subinterfaces of UserModel in org.keycloak.models.cache

Modifier and Type	Interface and Description
interface	CachedUserModel Cached users will implement this interface
static interface	CachedUserModel.Streams The CachedUserModel.Streams interface differs from CachedUserModel in that it extends the UserModel.Streams interface, allowing implementations of CachedUserModel to focus on the Stream-based methods in the UserModel interface.

Methods in org.keycloak.models.cache that return UserModel

Modifier and Type	Method and Description
UserModel	CachedUserModel.getDelegateForUpdate() Invalidates the cache for this user and returns a delegate that represents the actual data provider

Methods in org.keycloak.models.cache with parameters of type UserModel

Modifier and Type	Method and Description
void	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

Fields in org.keycloak.models.cache.infinispan declared as UserModel

Modifier and Type	Field and Description
protected UserModel	UserAdapter.updated

Fields in org.keycloak.models.cache.infinispan with type parameters of type UserModel

Modifier and Type	Field and Description
protected Map<String,UserModel>	UserCacheSession.managedUsers

Methods in org.keycloak.models.cache.infinispan that return UserModel

Modifier and Type	Method and Description
UserModel	UserCacheSession.addUser(RealmModel realm, String username)
UserModel	UserCacheSession.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
protected UserModel	UserCacheSession.cacheUser(RealmModel realm, UserModel delegate, Long revision)
UserModel	UserCacheSession.findServiceAccount(ClientModel client)
UserModel	UserAdapter.getDelegateForUpdate()
UserModel	UserCacheSession.getServiceAccount(ClientModel client)
protected UserModel	UserCacheSession.getUserAdapter(RealmModel realm, String userId, Long loaded, UserModel delegate)
UserModel	UserCacheSession.getUserByEmail(RealmModel realm, String email)
UserModel	UserCacheSession.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)
UserModel	UserCacheSession.getUserById(RealmModel realm, String id)
UserModel	UserCacheSession.getUserByUsername(RealmModel realm, String username)
protected UserModel	UserCacheSession.validateCache(RealmModel realm, CachedUser cached)

Methods in org.keycloak.models.cache.infinispan that return types with arguments of type UserModel

Modifier and Type	Method and Description
Stream<UserModel>	UserCacheSession.getGroupMembersStream(RealmModel realm, GroupModel group)
Stream<UserModel>	UserCacheSession.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
Stream<UserModel>	UserCacheSession.getRoleMembersStream(RealmModel realm, RoleModel role)
Stream<UserModel>	UserCacheSession.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<UserModel>	UserCacheSession.getUsersStream(RealmModel realm)
Stream<UserModel>	UserCacheSession.getUsersStream(RealmModel realm, boolean includeServiceAccounts)
Stream<UserModel>	UserCacheSession.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults)
Stream<UserModel>	UserCacheSession.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults, boolean includeServiceAccounts)
Stream<UserModel>	UserCacheSession.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue)
Stream<UserModel>	UserCacheSession.searchForUserStream(RealmModel realm, Map<String,String> attributes)
Stream<UserModel>	UserCacheSession.searchForUserStream(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<UserModel>	UserCacheSession.searchForUserStream(RealmModel realm, String search)
Stream<UserModel>	UserCacheSession.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)

Methods in org.keycloak.models.cache.infinispan with parameters of type UserModel

Modifier and Type	Method and Description
void	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)
Stream<FederatedIdentityModel>	UserCacheSession.getFederatedIdentitiesStream(RealmModel realm, UserModel user)
FederatedIdentityModel	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)

Uses of UserModel in org.keycloak.models.cache.infinispan.entities

Method parameters in org.keycloak.models.cache.infinispan.entities with type arguments of type UserModel

Modifier and Type	Method and Description
MultivaluedHashMap<String,String>	CachedUser.getAttributes(Supplier<UserModel> userModel)
Set<String>	CachedUser.getGroups(Supplier<UserModel> userModel)
Set<String>	CachedUser.getRequiredActions(Supplier<UserModel> userModel)
Set<String>	CachedUser.getRoleMappings(Supplier<UserModel> userModel)

Constructors in org.keycloak.models.cache.infinispan.entities with parameters of type UserModel

Constructor and Description
CachedUser(Long revision, RealmModel realm, UserModel user, int notBefore)

Uses of UserModel in org.keycloak.models.jpa

Classes in org.keycloak.models.jpa that implement UserModel

Modifier and Type	Class and Description
class	UserAdapter

Methods in org.keycloak.models.jpa that return UserModel

Modifier and Type	Method and Description
UserModel	JpaUserProvider.addUser(RealmModel realm, String username)
UserModel	JpaUserProvider.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
UserModel	JpaUserProvider.getServiceAccount(ClientModel client)
UserModel	JpaUserProvider.getUserByEmail(RealmModel realm, String email)
UserModel	JpaUserProvider.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel identity)
UserModel	JpaUserProvider.getUserById(RealmModel realm, String id)
UserModel	JpaUserProvider.getUserByUsername(RealmModel realm, String username)

Methods in org.keycloak.models.jpa that return types with arguments of type UserModel

Modifier and Type	Method and Description
Stream<UserModel>	JpaUserProvider.getGroupMembersStream(RealmModel realm, GroupModel group)
Stream<UserModel>	JpaUserProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
Stream<UserModel>	JpaUserProvider.getRoleMembersStream(RealmModel realm, RoleModel role)
Stream<UserModel>	JpaUserProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<UserModel>	JpaUserProvider.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults)
Stream<UserModel>	JpaUserProvider.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults, boolean includeServiceAccounts)
Stream<UserModel>	JpaUserProvider.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue)
Stream<UserModel>	JpaUserProvider.searchForUserStream(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<UserModel>	JpaUserProvider.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)

Methods in org.keycloak.models.jpa with parameters of type UserModel

Modifier and Type	Method and Description
void	JpaUserProvider.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel identity)
CredentialModel	JpaUserProvider.createCredential(RealmModel realm, UserModel user, CredentialModel cred)
CredentialModel	JpaUserCredentialStore.createCredential(RealmModel realm, UserModel user, CredentialModel cred)
Stream<FederatedIdentityModel>	JpaUserProvider.getFederatedIdentitiesStream(RealmModel realm, UserModel user)
FederatedIdentityModel	JpaUserProvider.getFederatedIdentity(RealmModel realm, UserModel user, String identityProvider)
int	JpaUserProvider.getNotBeforeOfUser(RealmModel realm, UserModel user)
CredentialModel	JpaUserProvider.getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	JpaUserCredentialStore.getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	JpaUserProvider.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
CredentialModel	JpaUserCredentialStore.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
Stream<CredentialModel>	JpaUserProvider.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)
Stream<CredentialModel>	JpaUserCredentialStore.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)
Stream<CredentialModel>	JpaUserProvider.getStoredCredentialsStream(RealmModel realm, UserModel user)
Stream<CredentialModel>	JpaUserCredentialStore.getStoredCredentialsStream(RealmModel realm, UserModel user)
boolean	JpaUserProvider.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
boolean	JpaUserCredentialStore.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
boolean	JpaUserProvider.removeFederatedIdentity(RealmModel realm, UserModel user, String identityProvider)
boolean	JpaUserProvider.removeStoredCredential(RealmModel realm, UserModel user, String id)
boolean	JpaUserCredentialStore.removeStoredCredential(RealmModel realm, UserModel user, String id)
boolean	JpaUserProvider.removeUser(RealmModel realm, UserModel user)
void	JpaUserProvider.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore)
void	JpaUserProvider.updateCredential(RealmModel realm, UserModel user, CredentialModel cred)
void	JpaUserCredentialStore.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

Methods in org.keycloak.models.jpa.session with parameters of type UserModel

Modifier and Type	Method and Description
Stream<UserSessionModel>	JpaUserSessionPersisterProvider.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.map.authSession

Methods in org.keycloak.models.map.authSession that return UserModel

Modifier and Type	Method and Description
UserModel	MapAuthenticationSessionAdapter.getAuthenticatedUser()

Methods in org.keycloak.models.map.authSession with parameters of type UserModel

Modifier and Type	Method and Description
void	MapAuthenticationSessionAdapter.setAuthenticatedUser(UserModel user)

Uses of UserModel in org.keycloak.models.map.storage.chm

Fields in org.keycloak.models.map.storage.chm with type parameters of type UserModel

Modifier and Type	Field and Description
static Map<SearchableModelField<UserModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapUserEntity,UserModel>>	MapFieldPredicates.USER_PREDICATES
static Map<SearchableModelField<UserModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapUserEntity,UserModel>>	MapFieldPredicates.USER_PREDICATES

Uses of UserModel in org.keycloak.models.map.user

Classes in org.keycloak.models.map.user that implement UserModel

Modifier and Type	Class and Description
class	AbstractUserModel<E extends AbstractEntity>
class	MapUserAdapter

Methods in org.keycloak.models.map.user that return UserModel

Modifier and Type	Method and Description
UserModel	MapUserProvider.addUser(RealmModel realm, String username)
UserModel	MapUserProvider.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
UserModel	MapUserProvider.getServiceAccount(ClientModel client)
UserModel	MapUserProvider.getUserByEmail(RealmModel realm, String email)
UserModel	MapUserProvider.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)
UserModel	MapUserProvider.getUserById(RealmModel realm, String id)
UserModel	MapUserProvider.getUserByUsername(RealmModel realm, String username)

Methods in org.keycloak.models.map.user that return types with arguments of type UserModel

Modifier and Type	Method and Description
Stream<UserModel>	MapUserProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
Stream<UserModel>	MapUserProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<UserModel>	MapUserProvider.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults)
Stream<UserModel>	MapUserProvider.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults, boolean includeServiceAccounts)
Stream<UserModel>	MapUserProvider.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue)
Stream<UserModel>	MapUserProvider.searchForUserStream(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<UserModel>	MapUserProvider.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)

Methods in org.keycloak.models.map.user with parameters of type UserModel

Modifier and Type	Method and Description
void	MapUserProvider.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)
CredentialModel	MapUserProvider.createCredential(RealmModel realm, UserModel user, CredentialModel cred)
Stream<FederatedIdentityModel>	MapUserProvider.getFederatedIdentitiesStream(RealmModel realm, UserModel user)
FederatedIdentityModel	MapUserProvider.getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)
int	MapUserProvider.getNotBeforeOfUser(RealmModel realm, UserModel user)
CredentialModel	MapUserProvider.getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	MapUserProvider.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
Stream<CredentialModel>	MapUserProvider.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)
Stream<CredentialModel>	MapUserProvider.getStoredCredentialsStream(RealmModel realm, UserModel user)
boolean	MapUserProvider.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
boolean	MapUserProvider.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)
boolean	MapUserProvider.removeStoredCredential(RealmModel realm, UserModel user, String id)
boolean	MapUserProvider.removeUser(RealmModel realm, UserModel user)
void	MapUserProvider.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore)
void	MapUserProvider.updateCredential(RealmModel realm, UserModel user, CredentialModel cred)
void	MapUserProvider.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)

Constructor parameters in org.keycloak.models.map.user with type arguments of type UserModel

Constructor and Description
MapUserProvider(KeycloakSession session, MapStorage<MapUserEntity,UserModel> store)

Uses of UserModel in org.keycloak.models.map.userSession

Methods in org.keycloak.models.map.userSession that return UserModel

Modifier and Type	Method and Description
UserModel	MapUserSessionAdapter.getUser()

Methods in org.keycloak.models.map.userSession with parameters of type UserModel

Modifier and Type	Method and Description
UserSessionModel	MapUserSessionProvider.createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
UserSessionModel	MapUserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)
Stream<UserSessionModel>	MapUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user)
Stream<UserSessionModel>	MapUserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user)
void	MapUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user)
void	MapUserSessionAdapter.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)

Constructors in org.keycloak.models.map.userSession with parameters of type UserModel

Constructor and Description
MapUserSessionEntity(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, boolean offline)

Uses of UserModel in org.keycloak.models.session

Methods in org.keycloak.models.session that return UserModel

Modifier and Type	Method and Description
UserModel	PersistentUserSessionAdapter.getUser()

Methods in org.keycloak.models.session with parameters of type UserModel

Modifier and Type	Method and Description
Stream<UserSessionModel>	UserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults) Loads the user sessions for the given UserModel in the given RealmModel if present.
Stream<UserSessionModel>	DisabledUserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults)
void	UserSessionPersisterProvider.onUserRemoved(RealmModel realm, UserModel user)
void	DisabledUserSessionPersisterProvider.onUserRemoved(RealmModel realm, UserModel user)
void	PersistentUserSessionAdapter.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)

Uses of UserModel in org.keycloak.models.sessions.infinispan

Methods in org.keycloak.models.sessions.infinispan that return UserModel

Modifier and Type	Method and Description
UserModel	AuthenticationSessionAdapter.getAuthenticatedUser()
UserModel	UserSessionAdapter.getUser()

Methods in org.keycloak.models.sessions.infinispan with parameters of type UserModel

Modifier and Type	Method and Description
UserSessionModel	InfinispanUserSessionProvider.createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
UserSessionModel	InfinispanUserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)
Stream<UserSessionModel>	InfinispanUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user)
Stream<UserSessionModel>	InfinispanUserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user)
protected void	InfinispanUserSessionProvider.onUserRemoved(RealmModel realm, UserModel user)
void	InfinispanUserSessionProvider.removeUserSessions(RealmModel realm, UserModel user)
protected void	InfinispanUserSessionProvider.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)

Uses of UserModel in org.keycloak.models.utils

Classes in org.keycloak.models.utils that implement UserModel

Modifier and Type	Class and Description
class	ReadOnlyUserModelDelegate
class	UserModelDelegate Delegation pattern.

Fields in org.keycloak.models.utils declared as UserModel

Modifier and Type	Field and Description
protected UserModel	UserModelDelegate.delegate

Methods in org.keycloak.models.utils that return UserModel

Modifier and Type	Method and Description
static 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 authentication
UserModel	UserModelDelegate.getDelegate()

Methods in org.keycloak.models.utils with parameters of type UserModel

Modifier and Type	Method and Description
static void	RepresentationToModel.createClientRoleMappings(ClientModel clientModel, UserModel user, List<String> roleNames)
static 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(UserRepresentation userRep, RealmModel newRealm, UserModel user)
static void	RepresentationToModel.createRoleMappings(UserRepresentation userRep, UserModel user, RealmModel realm)
static Set<RoleModel>	RoleUtils.getDeepUserRoleMappings(UserModel user)
static Collection<String>	KeycloakModelUtils.resolveAttribute(UserModel user, String name, boolean aggregateAttrs)
static Stream<GroupRepresentation>	ModelToRepresentation.searchForGroupByName(UserModel user, boolean full, String search, Integer first, Integer max)
static UserRepresentation	ModelToRepresentation.toBriefRepresentation(UserModel user)
static Stream<GroupRepresentation>	ModelToRepresentation.toGroupHierarchy(UserModel user, boolean full)
static Stream<GroupRepresentation>	ModelToRepresentation.toGroupHierarchy(UserModel user, boolean full, Integer first, Integer max)
static UserRepresentation	ModelToRepresentation.toRepresentation(KeycloakSession session, RealmModel realm, UserModel user)

Constructors in org.keycloak.models.utils with parameters of type UserModel

Constructor and Description
ReadOnlyUserModelDelegate(UserModel delegate)
ReadOnlyUserModelDelegate(UserModel delegate, Function<String,RuntimeException> exceptionCreator)
UserModelDelegate(UserModel delegate)

Uses of UserModel in org.keycloak.policy

Methods in org.keycloak.policy with parameters of type UserModel

Modifier and Type	Method and Description
PolicyError	UpperCasePasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	SpecialCharsPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	RegexPatternsPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	PasswordPolicyManagerProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	NotUsernamePasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	NotEmailPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	MaximumLengthPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	LowerCasePasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	LengthPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	HistoryPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	HashIterationsPasswordPolicyProviderFactory.validate(RealmModel realm, UserModel user, String password)
PolicyError	HashAlgorithmPasswordPolicyProviderFactory.validate(RealmModel realm, UserModel user, String password)
PolicyError	ForceExpiredPasswordPolicyProviderFactory.validate(RealmModel realm, UserModel user, String password)
PolicyError	DigitsPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	DefaultPasswordPolicyManagerProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	BlacklistPasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)
PolicyError	PasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)

Uses of UserModel in org.keycloak.protocol

Methods in org.keycloak.protocol with parameters of type UserModel

Modifier and Type	Method and Description
static String	ProtocolMapperUtils.getUserModelValue(UserModel user, String propertyName)

Uses of UserModel in org.keycloak.protocol.docker

Methods in org.keycloak.protocol.docker with parameters of type UserModel

Modifier and Type	Method and Description
boolean	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

Fields in org.keycloak.protocol.oidc declared as UserModel

Modifier and Type	Field and Description
UserModel	TokenManager.TokenValidation.user

Methods in org.keycloak.protocol.oidc that return UserModel

Modifier and Type	Method and Description
protected UserModel	DefaultTokenExchangeProvider.importUserFromExternalIdentity(BrokeredIdentityContext context)
static UserModel	TokenManager.lookupUserFromStatelessToken(KeycloakSession session, RealmModel realm, AccessToken token) Lookup user from the "stateless" token.

Methods in org.keycloak.protocol.oidc with parameters of type UserModel

Modifier and Type	Method and Description
AccessToken	TokenManager.createClientAccessToken(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
protected javax.ws.rs.core.Response	DefaultTokenExchangeProvider.exchangeClientToClient(UserModel targetUser, UserSessionModel targetUserSession)
protected javax.ws.rs.core.Response	DefaultTokenExchangeProvider.exchangeClientToOIDCClient(UserModel targetUser, UserSessionModel targetUserSession, String requestedTokenType, ClientModel targetClient, String audience, String scope)
protected javax.ws.rs.core.Response	DefaultTokenExchangeProvider.exchangeClientToSAML2Client(UserModel targetUser, UserSessionModel targetUserSession, String requestedTokenType, ClientModel targetClient, String audience, String scope)
protected javax.ws.rs.core.Response	DefaultTokenExchangeProvider.exchangeToIdentityProvider(UserModel targetUser, UserSessionModel targetUserSession, String requestedIssuer)
static TokenManager.NotBeforeCheck	TokenManager.NotBeforeCheck.forModel(KeycloakSession session, RealmModel realmModel, UserModel userModel)
Map<String,Object>	TokenManager.generateUserInfoClaims(AccessToken userInfo, UserModel userModel)
static Set<RoleModel>	TokenManager.getAccess(UserModel user, ClientModel client, Stream<ClientScopeModel> clientScopes)
protected AccessToken	TokenManager.initToken(RealmModel realm, ClientModel client, UserModel user, UserSessionModel session, ClientSessionContext clientSessionCtx, javax.ws.rs.core.UriInfo uriInfo)
static boolean	TokenManager.verifyConsentStillAvailable(KeycloakSession session, UserModel user, ClientModel client, Stream<ClientScopeModel> requestedClientScopes)

Constructors in org.keycloak.protocol.oidc with parameters of type UserModel

Constructor and Description
TokenValidation(UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx, AccessToken newToken)

Uses of UserModel in org.keycloak.protocol.oidc.endpoints

Methods in org.keycloak.protocol.oidc.endpoints with parameters of type UserModel

Modifier and Type	Method and Description
javax.ws.rs.core.Response	TokenEndpoint.createTokenResponse(UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx, String scopeParam, boolean code)

Uses of UserModel in org.keycloak.protocol.oidc.grants.ciba.channel

Fields in org.keycloak.protocol.oidc.grants.ciba.channel declared as UserModel

Modifier and Type	Field and Description
protected UserModel	CIBAAuthenticationRequest.user

Methods in org.keycloak.protocol.oidc.grants.ciba.channel that return UserModel

Modifier and Type	Method and Description
UserModel	CIBAAuthenticationRequest.getUser()

Methods in org.keycloak.protocol.oidc.grants.ciba.channel with parameters of type UserModel

Modifier and Type	Method and Description
void	CIBAAuthenticationRequest.setUser(UserModel user)

Constructors in org.keycloak.protocol.oidc.grants.ciba.channel with parameters of type UserModel

Constructor and Description
CIBAAuthenticationRequest(KeycloakSession session, UserModel user, ClientModel client)

Uses of UserModel in org.keycloak.protocol.oidc.grants.ciba.resolvers

Methods in org.keycloak.protocol.oidc.grants.ciba.resolvers that return UserModel

Modifier and Type	Method and Description
default UserModel	CIBALoginUserResolver.getUserFromIdTokenHint(String idToken) This method receives the id_token_hint parameter and returns its corresponding UserModel.
UserModel	DefaultCIBALoginUserResolver.getUserFromInfoUsedByAuthentication(String info)
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.
UserModel	DefaultCIBALoginUserResolver.getUserFromLoginHint(String loginHint)
default UserModel	CIBALoginUserResolver.getUserFromLoginHint(String loginHint) This method receives the login_hint parameter and returns its corresponding UserModel.
default UserModel	CIBALoginUserResolver.getUserFromLoginHintToken(String loginHintToken) This method receives the login_hint_token parameter and returns its corresponding UserModel.

Methods in org.keycloak.protocol.oidc.grants.ciba.resolvers with parameters of type UserModel

Modifier and Type	Method and Description
String	DefaultCIBALoginUserResolver.getInfoUsedByAuthentication(UserModel user)
default 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.

Uses of UserModel in org.keycloak.protocol.saml.profile.ecp.authenticator

Methods in org.keycloak.protocol.saml.profile.ecp.authenticator with parameters of type UserModel

Modifier and Type	Method and Description
boolean	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

Methods in org.keycloak.services with parameters of type UserModel

Modifier and Type	Method and Description
Locale	DefaultKeycloakContext.resolveLocale(UserModel user)

Uses of UserModel in org.keycloak.services.clientpolicy.context

Methods in org.keycloak.services.clientpolicy.context that return UserModel

Modifier and Type	Method and Description
default UserModel	ClientCRUDContext.getAuthenticatedUser() returns UserModel of the authenticated user.

Uses of UserModel in org.keycloak.services.managers

Methods in org.keycloak.services.managers that return UserModel

Modifier and Type	Method and Description
UserModel	AuthenticationManager.AuthResult.getUser()
UserModel	Auth.getUser()
static UserModel	AuthenticationManager.lookupUserForBruteForceLog(KeycloakSession session, RealmModel realm, AuthenticationSessionModel authenticationSession)

Methods in org.keycloak.services.managers with parameters of type UserModel

Modifier and Type	Method and Description
static void	AuthenticationManager.backchannelLogoutUserFromClient(KeycloakSession session, RealmModel realm, UserModel user, ClientModel client, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders headers) Logout all clientSessions of this user and client
void	BruteForceProtector.cleanUpPermanentLockout(KeycloakSession session, RealmModel realm, UserModel user) Clears any remaining traces of the permanent lockout.
void	DefaultBruteForceProtector.cleanUpPermanentLockout(KeycloakSession session, RealmModel realm, UserModel user)
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, javax.ws.rs.core.UriInfo uriInfo, ClientConnection connection)
static void	AuthenticationManager.evaluateRequiredActionTriggers(KeycloakSession session, AuthenticationSessionModel authSession, org.jboss.resteasy.spi.HttpRequest request, EventBuilder event, RealmModel realm, UserModel user)
protected static javax.ws.rs.core.Response	AuthenticationManager.executionActions(KeycloakSession session, AuthenticationSessionModel authSession, org.jboss.resteasy.spi.HttpRequest request, EventBuilder event, RealmModel realm, UserModel user, Stream<String> requiredActions)
void	BruteForceProtector.failedLogin(RealmModel realm, UserModel user, ClientConnection clientConnection)
void	DefaultBruteForceProtector.failedLogin(RealmModel realm, UserModel user, ClientConnection clientConnection)
Set<ClientModel>	UserSessionManager.findClientsWithOfflineToken(RealmModel realm, UserModel user)
List<UserSessionModel>	UserSessionManager.findOfflineSessions(RealmModel realm, UserModel user) Deprecated.
Stream<UserSessionModel>	UserSessionManager.findOfflineSessionsStream(RealmModel realm, UserModel user)
boolean	BruteForceProtector.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	DefaultBruteForceProtector.isTemporarilyDisabled(KeycloakSession session, RealmModel realm, UserModel user)
static boolean	UserConsentManager.revokeConsentToClient(KeycloakSession session, ClientModel client, UserModel user) Revoke consent of given user to given client
boolean	UserSessionManager.revokeOfflineToken(UserModel user, ClientModel client)
void	BruteForceProtector.successfulLogin(RealmModel realm, UserModel user, ClientConnection clientConnection)
void	DefaultBruteForceProtector.successfulLogin(RealmModel realm, UserModel user, ClientConnection clientConnection)

Constructors in org.keycloak.services.managers with parameters of type UserModel

Constructor and Description
Auth(RealmModel realm, AccessToken token, UserModel user, ClientModel client, UserSessionModel session, boolean cookie)
AuthResult(UserModel user, UserSessionModel session, AccessToken token)

Uses of UserModel in org.keycloak.services.resources

Methods in org.keycloak.services.resources with parameters of type UserModel

Modifier and Type	Method and Description
javax.ws.rs.core.Response	IdentityBrokerService.validateUser(AuthenticationSessionModel authSession, UserModel user, RealmModel realm)

Method parameters in org.keycloak.services.resources with type arguments of type UserModel

Modifier and Type	Method and Description
static void	LoginActionsServiceChecks.checkIsUserValid(KeycloakSession session, RealmModel realm, String userId, Consumer<UserModel> userSetter) Verifies whether the user given by ID both exists in the current realm.

Uses of UserModel in org.keycloak.services.resources.account

Methods in org.keycloak.services.resources.account with parameters of type UserModel

Modifier and Type	Method and Description
SortedSet<LinkedAccountRepresentation>	LinkedAccountsResource.getLinkedAccounts(KeycloakSession session, RealmModel realm, UserModel user)
boolean	PasswordUtil.isConfigured(KeycloakSession session, RealmModel realm, UserModel user)
static boolean	AccountFormService.isPasswordSet(KeycloakSession session, RealmModel realm, UserModel user)

Constructors in org.keycloak.services.resources.account with parameters of type UserModel

Constructor and Description
AccountCredentialResource(KeycloakSession session, UserModel user, Auth auth)
LinkedAccountsResource(KeycloakSession session, org.jboss.resteasy.spi.HttpRequest request, ClientModel client, Auth auth, EventBuilder event, UserModel user)
PasswordUtil(KeycloakSession session, UserModel user)

Uses of UserModel in org.keycloak.services.resources.account.resources

Fields in org.keycloak.services.resources.account.resources declared as UserModel

Modifier and Type	Field and Description
protected UserModel	AbstractResourceService.user

Constructors in org.keycloak.services.resources.account.resources with parameters of type UserModel

Constructor and Description
AbstractResourceService(KeycloakSession session, UserModel user, Auth auth, org.jboss.resteasy.spi.HttpRequest request)
ResourcesService(KeycloakSession session, UserModel user, Auth auth, org.jboss.resteasy.spi.HttpRequest request)

Uses of UserModel in org.keycloak.services.resources.admin

Methods in org.keycloak.services.resources.admin that return UserModel

Modifier and Type	Method and Description
UserModel	AdminAuth.getUser()

Methods in org.keycloak.services.resources.admin with parameters of type UserModel

Modifier and Type	Method and Description
AdminEventBuilder	AdminEventBuilder.authUser(UserModel user)
static void	UserResource.updateUserFromRep(UserProfile profile, UserModel user, UserRepresentation rep, KeycloakSession session, boolean isUpdateExistingUser)
static javax.ws.rs.core.Response	UserResource.validateUserProfile(UserProfile profile, UserModel user, KeycloakSession session)

Constructors in org.keycloak.services.resources.admin with parameters of type UserModel

Constructor and Description
AdminAuth(RealmModel realm, AccessToken token, UserModel user, ClientModel client)
AdminMessageFormatter(KeycloakSession session, UserModel user)
UserResource(RealmModel realm, UserModel user, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)

Uses of UserModel in org.keycloak.services.resources.admin.permissions

Methods in org.keycloak.services.resources.admin.permissions with parameters of type UserModel

Modifier and Type	Method and Description
boolean	UserPermissionManagement.canClientImpersonate(ClientModel client, UserModel user)
boolean	UserPermissionEvaluator.canImpersonate(UserModel user)
boolean	UserPermissionEvaluator.canManage(UserModel user)
boolean	UserPermissionEvaluator.canManageGroupMembership(UserModel user)
boolean	UserPermissionEvaluator.canMapRoles(UserModel user)
boolean	UserPermissionEvaluator.canView(UserModel user)
static AdminPermissionEvaluator	AdminPermissions.evaluator(KeycloakSession session, RealmModel realm, RealmModel adminsRealm, UserModel admin)
Map<String,Boolean>	UserPermissionEvaluator.getAccess(UserModel user)
boolean	UserPermissionManagement.isImpersonatable(UserModel user)
boolean	UserPermissionEvaluator.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

Methods in org.keycloak.sessions that return UserModel

Modifier and Type	Method and Description
UserModel	AuthenticationSessionModel.getAuthenticatedUser() Returns authenticated user that is associated to the authentication session.

Methods in org.keycloak.sessions with parameters of type UserModel

Modifier and Type	Method and Description
void	AuthenticationSessionModel.setAuthenticatedUser(UserModel user) Sets authenticated user that is associated to the authentication session.

Uses of UserModel in org.keycloak.social.twitter

Methods in org.keycloak.social.twitter with parameters of type UserModel

Modifier and Type	Method and Description
javax.ws.rs.core.Response	TwitterIdentityProvider.exchangeFromToken(javax.ws.rs.core.UriInfo uriInfo, EventBuilder builder, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, javax.ws.rs.core.MultivaluedMap<String,String> params)
protected javax.ws.rs.core.Response	TwitterIdentityProvider.exchangeSessionToken(javax.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
protected javax.ws.rs.core.Response	TwitterIdentityProvider.exchangeStoredToken(javax.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)

Uses of UserModel in org.keycloak.storage

Methods in org.keycloak.storage that return UserModel

Modifier and Type	Method and Description
UserModel	UserStorageManager.addUser(RealmModel realm, String username) UserRegistrationProvider methods implementations start here
UserModel	UserStorageManager.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) UserStorageProvider methods implementation end here UserProvider methods implementations start here -> no StorageProviders involved
UserModel	UserStorageManager.getServiceAccount(ClientModel client)
UserModel	UserStorageManager.getUserByEmail(RealmModel realm, String email)
UserModel	UserStorageManager.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)
UserModel	UserStorageManager.getUserById(RealmModel realm, String id) UserRegistrationProvider methods implementations end here UserLookupProvider methods implementations start here
UserModel	UserStorageManager.getUserByUsername(RealmModel realm, String username)
protected UserModel	UserStorageManager.importValidation(RealmModel realm, UserModel user) Allows a UserStorageProvider to proxy and/or synchronize an imported user.

Methods in org.keycloak.storage that return types with arguments of type UserModel

Modifier and Type	Method and Description
Stream<UserModel>	UserStorageManager.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) UserLookupProvider methods implementations end here UserQueryProvider methods implementation start here
Stream<UserModel>	UserStorageManager.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<UserModel>	UserStorageManager.getUsersStream(RealmModel realm)
Stream<UserModel>	UserStorageManager.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults)
Stream<UserModel>	UserStorageManager.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults, boolean includeServiceAccounts)
protected Stream<UserModel>	UserStorageManager.importValidation(RealmModel realm, Stream<UserModel> users)
protected Stream<UserModel>	UserStorageManager.query(org.keycloak.storage.UserStorageManager.PaginatedQuery pagedQuery, RealmModel realm, Integer firstResult, Integer maxResults)
protected Stream<UserModel>	UserStorageManager.query(org.keycloak.storage.UserStorageManager.PaginatedQuery pagedQuery, org.keycloak.storage.UserStorageManager.CountQuery countQuery, RealmModel realm, Integer firstResult, Integer maxResults)
Stream<UserModel>	UserStorageManager.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue)
Stream<UserModel>	UserStorageManager.searchForUserStream(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<UserModel>	UserStorageManager.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)

Methods in org.keycloak.storage with parameters of type UserModel

Modifier and Type	Method and Description
void	UserStorageManager.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)
protected void	UserStorageManager.deleteInvalidUser(RealmModel realm, UserModel user)
Stream<FederatedIdentityModel>	UserStorageManager.getFederatedIdentitiesStream(RealmModel realm, UserModel user)
FederatedIdentityModel	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)
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)
void	UserStorageManager.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore)
void	UserStorageManager.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)

Method parameters in org.keycloak.storage with type arguments of type UserModel

Modifier and Type	Method and Description
protected Stream<UserModel>	UserStorageManager.importValidation(RealmModel realm, Stream<UserModel> users)

Uses of UserModel in org.keycloak.storage.adapter

Classes in org.keycloak.storage.adapter that implement UserModel

Modifier and Type	Class and Description
class	AbstractUserAdapter This abstract class provides implementations for everything but getUsername().
static class	AbstractUserAdapter.Streams The AbstractUserAdapter.Streams class extends the AbstractUserAdapter abstract class and implements the UserModel.Streams interface, allowing subclasses to focus on the implementation of the Stream-based query methods and providing default implementations for the collections-based variants that delegate to their Stream counterparts.
class	AbstractUserAdapterFederatedStorage Assumes everything is managed by federated storage except for username.
static class	AbstractUserAdapterFederatedStorage.Streams The AbstractUserAdapterFederatedStorage.Streams class extends the AbstractUserAdapterFederatedStorage abstract class and implements the UserModel.Streams interface, allowing subclasses to focus on the implementation of the Stream-based query methods and providing default implementations for the collections-based variants that delegate to their Stream counterparts.
class	InMemoryUserAdapter
class	UpdateOnlyChangeUserModelDelegate This will perform update operation for particular attribute/property just if the existing value is not already same.

Constructors in org.keycloak.storage.adapter with parameters of type UserModel

Constructor and Description
UpdateOnlyChangeUserModelDelegate(UserModel delegate)

Uses of UserModel in org.keycloak.storage.federated

Methods in org.keycloak.storage.federated with parameters of type UserModel

Modifier and Type	Method and Description
void	UserFederatedStorageProvider.preRemove(RealmModel realm, UserModel user)

Uses of UserModel in org.keycloak.storage.jpa

Methods in org.keycloak.storage.jpa with parameters of type UserModel

Modifier and Type	Method and Description
CredentialModel	JpaUserFederatedStorageProvider.createCredential(RealmModel realm, UserModel user, CredentialModel cred)
CredentialModel	JpaUserFederatedStorageProvider.getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	JpaUserFederatedStorageProvider.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
Stream<CredentialModel>	JpaUserFederatedStorageProvider.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)
Stream<CredentialModel>	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

Classes in org.keycloak.storage.ldap that implement UserModel

Modifier and Type	Class and Description
class	LDAPWritesOnlyUserModelDelegate User model delegate, which tracks what attributes were written to LDAP in this transaction.
class	ReadonlyLDAPUserModelDelegate Will be good to get rid of this class and use ReadOnlyUserModelDelegate, but it can't be done now due the backwards compatibility.

Methods in org.keycloak.storage.ldap that return UserModel

Modifier and Type	Method and Description
UserModel	LDAPStorageProvider.addUser(RealmModel realm, String username)
protected UserModel	LDAPStorageProvider.findOrCreateAuthenticatedUser(RealmModel realm, String username) Called after successful kerberos authentication
UserModel	LDAPStorageUserManager.getManagedProxiedUser(String userId)
UserModel	LDAPStorageProvider.getUserByEmail(RealmModel realm, String email)
UserModel	LDAPStorageProvider.getUserById(RealmModel realm, String id)
UserModel	LDAPStorageProvider.getUserByUsername(RealmModel realm, String username)
protected UserModel	LDAPStorageProvider.importUserFromLDAP(KeycloakSession session, RealmModel realm, LDAPObject ldapUser)
protected UserModel	LDAPStorageProvider.proxy(RealmModel realm, UserModel local, LDAPObject ldapObject, boolean newUser)
UserModel	LDAPStorageProvider.validate(RealmModel realm, UserModel local)

Methods in org.keycloak.storage.ldap that return types with arguments of type UserModel

Modifier and Type	Method and Description
Stream<UserModel>	LDAPStorageProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
Stream<UserModel>	LDAPStorageProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<UserModel>	LDAPStorageProvider.getUsersStream(RealmModel realm)
Stream<UserModel>	LDAPStorageProvider.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults)
List<UserModel>	LDAPStorageProvider.loadUsersByUsernames(List<String> usernames, RealmModel realm)
Stream<UserModel>	LDAPStorageProvider.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue)
Stream<UserModel>	LDAPStorageProvider.searchForUserStream(RealmModel realm, Map<String,String> params, Integer firstResult, Integer maxResults)
Stream<UserModel>	LDAPStorageProvider.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)

Methods in org.keycloak.storage.ldap with parameters of type UserModel

Modifier and Type	Method and Description
static LDAPObject	LDAPUtils.addUserToLDAP(LDAPStorageProvider ldapProvider, RealmModel realm, UserModel user)
void	LDAPStorageProvider.disableCredentialType(RealmModel realm, UserModel user, String credentialType)
Stream<String>	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)
UserModel	LDAPStorageProvider.validate(RealmModel realm, UserModel local)
boolean	LDAPStorageProvider.validPassword(RealmModel realm, UserModel user, String password)

Constructors in org.keycloak.storage.ldap with parameters of type UserModel

Constructor and Description
LDAPWritesOnlyUserModelDelegate(UserModel delegate, LDAPStorageProvider provider)
ReadonlyLDAPUserModelDelegate(UserModel delegate)

Uses of UserModel in org.keycloak.storage.ldap.mappers

Classes in org.keycloak.storage.ldap.mappers that implement UserModel

Modifier and Type	Class and Description
class	TxAwareLDAPUserModelDelegate

Methods in org.keycloak.storage.ldap.mappers that return UserModel

Modifier and Type	Method and Description
UserModel	UserAttributeLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
UserModel	LDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Called when invoke proxy on LDAP federation provider
UserModel	HardcodedLDAPRoleStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
UserModel	HardcodedLDAPGroupStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
UserModel	HardcodedLDAPAttributeMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
UserModel	HardcodedAttributeMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
UserModel	FullNameLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)

Methods in org.keycloak.storage.ldap.mappers that return types with arguments of type UserModel

Modifier and Type	Method and Description
List<UserModel>	LDAPStorageMapper.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults) Return empty list if doesn't support storing of groups
List<UserModel>	AbstractLDAPStorageMapper.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
List<UserModel>	LDAPStorageMapper.getRoleMembers(RealmModel realm, RoleModel role, int firstResult, int maxResults) Return empty list if doesn't support storing of roles
List<UserModel>	AbstractLDAPStorageMapper.getRoleMembers(RealmModel realm, RoleModel role, int firstResult, int maxResults)

Methods in org.keycloak.storage.ldap.mappers with parameters of type UserModel

Modifier and Type	Method and Description
LDAPOperationDecorator	PasswordUpdateCallback.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	LDAPStorageMapper.onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) Called when LDAP authentication of specified user fails.
boolean	AbstractLDAPStorageMapper.onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)
void	UserAttributeLDAPStorageMapper.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	HardcodedLDAPRoleStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)
void	HardcodedLDAPGroupStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)
void	HardcodedLDAPAttributeMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)
void	HardcodedAttributeMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)
void	FullNameLDAPStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)
void	UserAttributeLDAPStorageMapper.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 DB
void	HardcodedLDAPRoleStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)
void	HardcodedLDAPGroupStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)
void	HardcodedLDAPAttributeMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)
void	HardcodedAttributeMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)
void	FullNameLDAPStorageMapper.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)
UserModel	UserAttributeLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
UserModel	LDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm) Called when invoke proxy on LDAP federation provider
UserModel	HardcodedLDAPRoleStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
UserModel	HardcodedLDAPGroupStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
UserModel	HardcodedLDAPAttributeMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
UserModel	HardcodedAttributeMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
UserModel	FullNameLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
protected void	UserAttributeLDAPStorageMapper.setPropertyOnUserModel(Property<Object> userModelProperty, UserModel user, String ldapAttrValue)
protected void	HardcodedAttributeMapper.setPropertyOnUserModel(Property<Object> userModelProperty, UserModel user, String ldapAttrValue)

Constructors in org.keycloak.storage.ldap.mappers with parameters of type UserModel

Constructor and Description
TxAwareLDAPUserModelDelegate(UserModel delegate, LDAPStorageProvider provider, LDAPObject ldapUser)

Uses of UserModel in org.keycloak.storage.ldap.mappers.membership

Methods in org.keycloak.storage.ldap.mappers.membership that return types with arguments of type UserModel

Modifier and Type	Method and Description
abstract List<UserModel>	MembershipType.getGroupMembers(RealmModel realm, CommonLDAPGroupMapper groupMapper, LDAPObject ldapGroup, int firstResult, int maxResults)

Uses of UserModel in org.keycloak.storage.ldap.mappers.membership.group

Classes in org.keycloak.storage.ldap.mappers.membership.group that implement UserModel

Modifier and Type	Class and Description
class	GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate

Methods in org.keycloak.storage.ldap.mappers.membership.group that return UserModel

Modifier and Type	Method and Description
UserModel	GroupLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)

Methods in org.keycloak.storage.ldap.mappers.membership.group that return types with arguments of type UserModel

Modifier and Type	Method and Description
List<UserModel>	GroupLDAPStorageMapper.getGroupMembers(RealmModel realm, GroupModel kcGroup, int firstResult, int maxResults)

Methods in org.keycloak.storage.ldap.mappers.membership.group with parameters of type UserModel

Modifier and Type	Method and Description
protected GroupModel	GroupLDAPStorageMapper.findKcGroupOrSyncFromLDAP(RealmModel realm, LDAPObject ldapGroup, UserModel user)
void	GroupLDAPStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)
void	GroupLDAPStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)
UserModel	GroupLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)

Constructors in org.keycloak.storage.ldap.mappers.membership.group with parameters of type UserModel

Constructor and Description
LDAPGroupMappingsUserDelegate(RealmModel realm, UserModel user, LDAPObject ldapUser)

Uses of UserModel in org.keycloak.storage.ldap.mappers.membership.role

Classes in org.keycloak.storage.ldap.mappers.membership.role that implement UserModel

Modifier and Type	Class and Description
class	RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate

Methods in org.keycloak.storage.ldap.mappers.membership.role that return UserModel

Modifier and Type	Method and Description
UserModel	RoleLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)

Methods in org.keycloak.storage.ldap.mappers.membership.role that return types with arguments of type UserModel

Modifier and Type	Method and Description
List<UserModel>	RoleLDAPStorageMapper.getRoleMembers(RealmModel realm, RoleModel role, int firstResult, int maxResults)

Methods in org.keycloak.storage.ldap.mappers.membership.role with parameters of type UserModel

Modifier and Type	Method and Description
void	RoleLDAPStorageMapper.onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)
void	RoleLDAPStorageMapper.onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)
UserModel	RoleLDAPStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)

Constructors in org.keycloak.storage.ldap.mappers.membership.role with parameters of type UserModel

Constructor and Description
LDAPRoleMappingsUserDelegate(RealmModel realm, UserModel user, LDAPObject ldapUser)

Uses of UserModel in org.keycloak.storage.ldap.mappers.msad

Classes in org.keycloak.storage.ldap.mappers.msad that implement UserModel

Modifier and Type	Class and Description
class	MSADUserAccountControlStorageMapper.MSADUserModelDelegate

Methods in org.keycloak.storage.ldap.mappers.msad that return UserModel

Modifier and Type	Method and Description
UserModel	MSADUserAccountControlStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)

Methods in org.keycloak.storage.ldap.mappers.msad with parameters of type UserModel

Modifier and Type	Method and Description
LDAPOperationDecorator	MSADUserAccountControlStorageMapper.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)
UserModel	MSADUserAccountControlStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)

Constructors in org.keycloak.storage.ldap.mappers.msad with parameters of type UserModel

Constructor and Description
MSADUserModelDelegate(UserModel delegate, LDAPObject ldapUser)

Uses of UserModel in org.keycloak.storage.ldap.mappers.msadlds

Classes in org.keycloak.storage.ldap.mappers.msadlds that implement UserModel

Modifier and Type	Class and Description
class	MSADLDSUserAccountControlStorageMapper.MSADUserModelDelegate

Methods in org.keycloak.storage.ldap.mappers.msadlds that return UserModel

Modifier and Type	Method and Description
UserModel	MSADLDSUserAccountControlStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)

Methods in org.keycloak.storage.ldap.mappers.msadlds with parameters of type UserModel

Modifier and Type	Method and Description
LDAPOperationDecorator	MSADLDSUserAccountControlStorageMapper.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)
UserModel	MSADLDSUserAccountControlStorageMapper.proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)

Constructors in org.keycloak.storage.ldap.mappers.msadlds with parameters of type UserModel

Constructor and Description
MSADUserModelDelegate(UserModel delegate, LDAPObject ldapUser)

Uses of UserModel in org.keycloak.storage.user

Methods in org.keycloak.storage.user that return UserModel

Modifier and Type	Method and Description
UserModel	UserRegistrationProvider.addUser(RealmModel realm, String username) All storage providers that implement this interface will be looped through.
default UserModel	UserLookupProvider.getUserByEmail(RealmModel realm, String email) Returns a user with the given email belonging to the realm
UserModel	UserLookupProvider.Streams.getUserByEmail(RealmModel realm, String email)
UserModel	UserLookupProvider.getUserByEmail(String email, RealmModel realm) Deprecated. Use getUserByEmail instead.
default UserModel	UserLookupProvider.Streams.getUserByEmail(String email, RealmModel realm)
default UserModel	UserLookupProvider.getUserById(RealmModel realm, String id) Returns a user with the given id belonging to the realm
UserModel	UserLookupProvider.Streams.getUserById(RealmModel realm, String id)
UserModel	UserLookupProvider.getUserById(String id, RealmModel realm) Deprecated. Use getUserById instead.
default UserModel	UserLookupProvider.Streams.getUserById(String id, RealmModel realm)
default UserModel	UserLookupProvider.getUserByUsername(RealmModel realm, String username) Returns a user with the given username belonging to the realm
UserModel	UserLookupProvider.Streams.getUserByUsername(RealmModel realm, String username)
UserModel	UserLookupProvider.getUserByUsername(String username, RealmModel realm) Deprecated. Use getUserByUsername instead.
default UserModel	UserLookupProvider.Streams.getUserByUsername(String username, RealmModel realm)
UserModel	ImportedUserValidation.validate(RealmModel realm, UserModel user) If this method returns null, then the user in local storage will be removed

Methods in org.keycloak.storage.user that return types with arguments of type UserModel

Modifier and Type	Method and Description
List<UserModel>	UserQueryProvider.getGroupMembers(RealmModel realm, GroupModel group) Deprecated. Use getGroupMembersStream instead.
default List<UserModel>	UserQueryProvider.Streams.getGroupMembers(RealmModel realm, GroupModel group)
List<UserModel>	UserQueryProvider.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults) Deprecated. Use getGroupMembersStream instead.
default List<UserModel>	UserQueryProvider.Streams.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
default Stream<UserModel>	UserQueryProvider.getGroupMembersStream(RealmModel realm, GroupModel group) Obtains users that belong to a specific group.
default Stream<UserModel>	UserQueryProvider.Streams.getGroupMembersStream(RealmModel realm, GroupModel group)
default Stream<UserModel>	UserQueryProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) Obtains users that belong to a specific group.
Stream<UserModel>	UserQueryProvider.Streams.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
default List<UserModel>	UserQueryProvider.getRoleMembers(RealmModel realm, RoleModel role) Deprecated. Use getRoleMembersStream instead.
default List<UserModel>	UserQueryProvider.getRoleMembers(RealmModel realm, RoleModel role, int firstResult, int maxResults) Deprecated. Use getRoleMembersStream instead.
default Stream<UserModel>	UserQueryProvider.getRoleMembersStream(RealmModel realm, RoleModel role) Obtains users that have the specified role.
default Stream<UserModel>	UserQueryProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) Searches for users that have the specified role.
List<UserModel>	UserQueryProvider.getUsers(RealmModel realm) Deprecated. Use getUsersStream instead.
default List<UserModel>	UserQueryProvider.Streams.getUsers(RealmModel realm)
List<UserModel>	UserQueryProvider.getUsers(RealmModel realm, int firstResult, int maxResults) Deprecated. Use getUsersStream instead.
default List<UserModel>	UserQueryProvider.Streams.getUsers(RealmModel realm, int firstResult, int maxResults)
default Stream<UserModel>	UserQueryProvider.getUsersStream(RealmModel realm) Searches all users in the realm.
default Stream<UserModel>	UserQueryProvider.Streams.getUsersStream(RealmModel realm)
default Stream<UserModel>	UserQueryProvider.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults) Searches all users in the realm, starting from the firstResult and containing at most maxResults.
Stream<UserModel>	UserQueryProvider.Streams.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults)
List<UserModel>	UserQueryProvider.searchForUser(Map<String,String> params, RealmModel realm) Deprecated. Use searchForUserStream instead.
default List<UserModel>	UserQueryProvider.Streams.searchForUser(Map<String,String> params, RealmModel realm)
List<UserModel>	UserQueryProvider.searchForUser(Map<String,String> params, RealmModel realm, int firstResult, int maxResults) Deprecated. Use searchForUserStream instead.
default List<UserModel>	UserQueryProvider.Streams.searchForUser(Map<String,String> params, RealmModel realm, int firstResult, int maxResults)
List<UserModel>	UserQueryProvider.searchForUser(String search, RealmModel realm) Deprecated. Use searchForUserStream instead.
default List<UserModel>	UserQueryProvider.Streams.searchForUser(String search, RealmModel realm)
List<UserModel>	UserQueryProvider.searchForUser(String search, RealmModel realm, int firstResult, int maxResults) Deprecated. Use searchForUserStream instead.
default List<UserModel>	UserQueryProvider.Streams.searchForUser(String search, RealmModel realm, int firstResult, int maxResults)
List<UserModel>	UserQueryProvider.searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm) Deprecated. Use searchForUserByUserAttributeStream instead.
default List<UserModel>	UserQueryProvider.Streams.searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)
default Stream<UserModel>	UserQueryProvider.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue) Searches for users that have a specific attribute with a specific value.
Stream<UserModel>	UserQueryProvider.Streams.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue)
default Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, Map<String,String> params) Searches for user by parameter.
default Stream<UserModel>	UserQueryProvider.Streams.searchForUserStream(RealmModel realm, Map<String,String> params)
default Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, Map<String,String> params, Integer firstResult, Integer maxResults) Searches for user by parameter.
Stream<UserModel>	UserQueryProvider.Streams.searchForUserStream(RealmModel realm, Map<String,String> params, Integer firstResult, Integer maxResults)
default Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, String search) Searches for users whose username, email, first name or last name contain any of the strings in search separated by whitespace.
default Stream<UserModel>	UserQueryProvider.Streams.searchForUserStream(RealmModel realm, String search)
default Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults) Searches for users whose username, email, first name or last name contain any of the strings in search separated by whitespace.
Stream<UserModel>	UserQueryProvider.Streams.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)

Methods in org.keycloak.storage.user with parameters of type UserModel

Modifier and Type	Method and Description
boolean	UserRegistrationProvider.removeUser(RealmModel realm, UserModel user) Called if user originated from this provider.
UserModel	ImportedUserValidation.validate(RealmModel realm, UserModel user) If this method returns null, then the user in local storage will be removed

Method parameters in org.keycloak.storage.user with type arguments of type UserModel

Modifier and Type	Method and Description
static int	UserQueryProvider.countUsersInGroups(Stream<UserModel> users, Set<String> groupIds) Returns the number of users from the given list of users that are in at least one of the groups given in the groups set.

Uses of UserModel in org.keycloak.userprofile

Fields in org.keycloak.userprofile declared as UserModel

Modifier and Type	Field and Description
protected UserModel	DefaultAttributes.user

Methods in org.keycloak.userprofile that return UserModel

Modifier and Type	Method and Description
UserModel	UserProfile.create() Creates a new UserModel based on the attributes associated with this instance.
UserModel	DefaultUserProfile.create()
UserModel	AttributeContext.getUser()

Methods in org.keycloak.userprofile with parameters of type UserModel

Modifier and Type	Method and Description
UserProfile	UserProfileProvider.create(UserProfileContext context, Map<String,?> attributes, UserModel user) Creates a new UserProfile instance for a given context and attributes for update purposes.
UserProfile	AbstractUserProfileProvider.create(UserProfileContext context, Map<String,?> attributes, UserModel user)
UserProfile	UserProfileProvider.create(UserProfileContext context, UserModel user) Creates a new UserProfile instance only for validation purposes to check whether its attributes are in conformance with the given context and profile configuration.
UserProfile	AbstractUserProfileProvider.create(UserProfileContext context, UserModel user)
protected Attributes	DeclarativeUserProfileProvider.createAttributes(UserProfileContext context, Map<String,?> attributes, UserModel user, UserProfileMetadata metadata)
protected Attributes	AbstractUserProfileProvider.createAttributes(UserProfileContext context, Map<String,?> attributes, UserModel user, UserProfileMetadata metadata)

Constructors in org.keycloak.userprofile with parameters of type UserModel

Constructor and Description
AttributeContext(UserProfileContext context, KeycloakSession session, Map.Entry<String,List<String>> attribute, UserModel user, AttributeMetadata metadata)
DefaultAttributes(UserProfileContext context, Map<String,?> attributes, UserModel user, UserProfileMetadata profileMetadata, KeycloakSession session)
DefaultUserProfile(UserProfileMetadata metadata, Attributes attributes, Function<Attributes,UserModel> userCreator, UserModel user, KeycloakSession session)
LegacyAttributes(UserProfileContext context, Map<String,?> attributes, UserModel user, UserProfileMetadata profileMetadata, KeycloakSession session)

Constructor parameters in org.keycloak.userprofile with type arguments of type UserModel

Constructor and Description
DefaultUserProfile(UserProfileMetadata metadata, Attributes attributes, Function<Attributes,UserModel> userCreator, UserModel user, KeycloakSession session)

Uses of UserModel in org.keycloak.utils

Methods in org.keycloak.utils with parameters of type UserModel

Modifier and Type	Method and Description
static 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)