## Uses of Interface
org.keycloak.models.UserModel

- Packages that use UserModel
  Package | Description
  --- | ---
  org.keycloak.authentication |
  org.keycloak.authentication.authenticators.broker |
  org.keycloak.authentication.authenticators.browser |
  org.keycloak.authentication.authenticators.directgrant |
  org.keycloak.authentication.authenticators.resetcred |
  org.keycloak.authentication.forms |
  org.keycloak.authentication.requiredactions.util |
  org.keycloak.broker.oidc.mappers |
  org.keycloak.broker.provider |
  org.keycloak.broker.saml.mappers |
  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.ldap |
  org.keycloak.federation.ldap.mappers |
  org.keycloak.federation.ldap.mappers.membership |
  org.keycloak.federation.ldap.mappers.membership.group |
  org.keycloak.federation.ldap.mappers.membership.role |
  org.keycloak.federation.ldap.mappers.msad |
  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.mappers |
  org.keycloak.models |
  org.keycloak.models.cache.infinispan |
  org.keycloak.models.cache.infinispan.entities |
  org.keycloak.models.jpa |
  org.keycloak.models.jpa.session |
  org.keycloak.models.mongo.keycloak.adapters |
  org.keycloak.models.mongo.utils |
  org.keycloak.models.session |
  org.keycloak.models.sessions.infinispan |
  org.keycloak.models.utils |
  org.keycloak.policy |
  org.keycloak.protocol |
  org.keycloak.protocol.oidc |
  org.keycloak.services |
  org.keycloak.services.managers |
  org.keycloak.services.resources |
  org.keycloak.services.resources.admin |
  org.keycloak.services.util |
  org.keycloak.storage |
  org.keycloak.storage.adapter |
  org.keycloak.storage.changeset |
  org.keycloak.storage.federated |
  org.keycloak.storage.jpa |
  org.keycloak.storage.user |
  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` | RequiredActionContextResult.`getUser()`
    `UserModel` | AuthenticationProcessor.Result.`getUser()`
    `UserModel` | RequiredActionContext.`getUser()` Current user
    `UserModel` | FormContext.`getUser()` Current user attached to this flow.
    `UserModel` | AuthenticationFlowContext.`getUser()` Current user attached to this flow.

    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.
    `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` | AuthenticationProcessor.Result.`setUser(UserModel user)`
    `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.`validateUser(UserModel authenticatedUser)`

    Constructors in org.keycloak.authentication with parameters of type UserModel
    Constructor and Description
    `RequiredActionContextResult(UserSessionModel userSession, ClientSessionModel clientSession, RealmModel realm, EventBuilder eventBuilder, KeycloakSession session, org.jboss.resteasy.spi.HttpRequest httpRequest, UserModel user, RequiredActionFactory factory)`

  - ### 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, ClientSessionModel clientSession)`

    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` | IdpCreateUserIfUniqueAuthenticator.`configuredFor(KeycloakSession session, RealmModel realm, UserModel user)`
    `boolean` | IdpConfirmLinkAuthenticator.`configuredFor(KeycloakSession session, RealmModel realm, UserModel user)`
    `void` | AbstractIdpAuthenticator.`setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)`
    `protected LoginFormsProvider` | IdpUsernamePasswordForm.`setupForm(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData, UserModel existingUser)`
    `protected void` | IdpCreateUserIfUniqueAuthenticator.`userRegisteredSuccess(AuthenticationFlowContext context, UserModel registeredUser, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext)`

  - ### 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` | 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` | OTPFormAuthenticator.`configuredFor(KeycloakSession session, RealmModel realm, UserModel user)`
    `boolean` | CookieAuthenticator.`configuredFor(KeycloakSession session, RealmModel realm, UserModel user)`
    `boolean` | AbstractUsernameFormAuthenticator.`enabledUser(AuthenticationFlowContext context, UserModel user)`
    `boolean` | AbstractUsernameFormAuthenticator.`invalidUser(AuthenticationFlowContext context, 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` | CookieAuthenticator.`setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)`
    `boolean` | AbstractUsernameFormAuthenticator.`validatePassword(AuthenticationFlowContext context, UserModel user, javax.ws.rs.core.MultivaluedMap<String,String> inputData)`

  - ### 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` | 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)`
    `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.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.broker.oidc.mappers

    Methods in org.keycloak.broker.oidc.mappers with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | ExternalKeycloakRoleToRoleMapper.`importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)`
    `void` | ClaimToRoleMapper.`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` | ExternalKeycloakRoleToRoleMapper.`updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)`
    `void` | ClaimToRoleMapper.`updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)`
    `void` | AbstractJsonUserAttributeMapper.`updateBrokeredUser(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
    --- | ---
    `void` | IdentityProvider.`importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)`
    `void` | AbstractIdentityProvider.`importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)`
    `void` | HardcodedRoleMapper.`importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, 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` | IdentityProvider.`updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)`
    `void` | AbstractIdentityProvider.`updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, 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.`updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)` Called when this user has logged in before and has already been imported.

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

    Methods in org.keycloak.broker.saml.mappers with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | AttributeToRoleMapper.`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` | AttributeToRoleMapper.`updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)`

  - ### Uses of UserModel in org.keycloak.email

    Methods in org.keycloak.email with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | DefaultEmailSenderProvider.`send(RealmModel realm, UserModel user, String subject, String textBody, String htmlBody)`
    `void` | EmailSenderProvider.`send(RealmModel realm, UserModel user, String subject, String textBody, String htmlBody)`
    `EmailTemplateProvider` | EmailTemplateProvider.`setUser(UserModel user)`

  - ### Uses of UserModel in org.keycloak.email.freemarker

    Methods in org.keycloak.email.freemarker with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `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)` 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)`
    `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.`getUserByUsername(RealmModel realm, String username)`
    `protected UserModel` | KerberosFederationProvider.`importUserToKeycloak(RealmModel realm, String username)`
    `UserModel` | KerberosFederationProvider.`register(RealmModel realm, UserModel user)`
    `UserModel` | KerberosFederationProvider.`validateAndProxy(RealmModel realm, UserModel local)`

    Methods in org.keycloak.federation.kerberos that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | KerberosFederationProvider.`getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)`
    `List<UserModel>` | KerberosFederationProvider.`searchByAttributes(Map<String,String> attributes, RealmModel realm, int maxResults)`

    Methods in org.keycloak.federation.kerberos with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<String>` | KerberosFederationProvider.`getSupportedCredentialTypes(UserModel local)`
    `boolean` | KerberosFederationProvider.`isValid(RealmModel realm, UserModel local)`
    `UserModel` | KerberosFederationProvider.`register(RealmModel realm, UserModel user)`
    `boolean` | KerberosFederationProvider.`removeUser(RealmModel realm, UserModel user)`
    `UserModel` | KerberosFederationProvider.`validateAndProxy(RealmModel realm, UserModel local)`
    `boolean` | KerberosFederationProvider.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | KerberosFederationProvider.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)`

    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.ldap

    Classes in org.keycloak.federation.ldap that implement UserModel
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ReadonlyLDAPUserModelDelegate`
    `class` | `UnsyncedLDAPUserModelDelegate`
    `class` | `WritableLDAPUserModelDelegate`

    Methods in org.keycloak.federation.ldap that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `protected UserModel` | LDAPFederationProvider.`findOrCreateAuthenticatedUser(RealmModel realm, String username)` Called after successful kerberos authentication
    `UserModel` | LDAPFederationProvider.`getUserByEmail(RealmModel realm, String email)`
    `UserModel` | LDAPFederationProvider.`getUserByUsername(RealmModel realm, String username)`
    `protected UserModel` | LDAPFederationProvider.`importUserFromLDAP(KeycloakSession session, RealmModel realm, LDAPObject ldapUser)`
    `protected UserModel` | LDAPFederationProvider.`proxy(RealmModel realm, UserModel local, LDAPObject ldapObject)`
    `UserModel` | LDAPFederationProvider.`register(RealmModel realm, UserModel user)`
    `UserModel` | LDAPFederationProvider.`validateAndProxy(RealmModel realm, UserModel local)`

    Methods in org.keycloak.federation.ldap that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | LDAPFederationProvider.`getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)`
    `List<UserModel>` | LDAPFederationProvider.`loadUsersByUsernames(List<String> usernames, RealmModel realm)`
    `List<UserModel>` | LDAPFederationProvider.`searchByAttributes(Map<String,String> attributes, RealmModel realm, int maxResults)`

    Methods in org.keycloak.federation.ldap with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `static LDAPObject` | LDAPUtils.`addUserToLDAP(LDAPFederationProvider ldapProvider, RealmModel realm, UserModel user)`
    `Set<String>` | LDAPFederationProvider.`getSupportedCredentialTypes(UserModel local)`
    `boolean` | LDAPFederationProvider.`isValid(RealmModel realm, UserModel local)`
    `protected LDAPObject` | LDAPFederationProvider.`loadAndValidateUser(RealmModel realm, UserModel local)`
    `protected UserModel` | LDAPFederationProvider.`proxy(RealmModel realm, UserModel local, LDAPObject ldapObject)`
    `UserModel` | LDAPFederationProvider.`register(RealmModel realm, UserModel user)`
    `boolean` | LDAPFederationProvider.`removeUser(RealmModel realm, UserModel user)`
    `UserModel` | LDAPFederationProvider.`validateAndProxy(RealmModel realm, UserModel local)`
    `boolean` | LDAPFederationProvider.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | LDAPFederationProvider.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)`
    `boolean` | LDAPFederationProvider.`validPassword(RealmModel realm, UserModel user, String password)`

    Constructors in org.keycloak.federation.ldap with parameters of type UserModel
    Constructor and Description
    `ReadonlyLDAPUserModelDelegate(UserModel delegate, LDAPFederationProvider provider)`
    `UnsyncedLDAPUserModelDelegate(UserModel delegate, LDAPFederationProvider provider)`
    `WritableLDAPUserModelDelegate(UserModel delegate, LDAPFederationProvider provider, LDAPObject ldapObject)`

  - ### Uses of UserModel in org.keycloak.federation.ldap.mappers

    Classes in org.keycloak.federation.ldap.mappers that implement UserModel
    Modifier and Type | Class and Description
    --- | ---
    `class` | `TxAwareLDAPUserModelDelegate`

    Methods in org.keycloak.federation.ldap.mappers that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | UserAttributeLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `UserModel` | HardcodedLDAPRoleMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `UserModel` | FullNameLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `abstract UserModel` | AbstractLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `UserModel` | LDAPFederationMapperBridge.`proxy(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel delegate, RealmModel realm)`
    `UserModel` | LDAPFederationMapper.`proxy(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel delegate, RealmModel realm)` Called when invoke proxy on LDAP federation provider

    Methods in org.keycloak.federation.ldap.mappers that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | AbstractLDAPFederationMapper.`getGroupMembers(GroupModel group, int firstResult, int maxResults)`
    `List<UserModel>` | LDAPFederationMapperBridge.`getGroupMembers(UserFederationMapperModel mapperModel, UserFederationProvider ldapProvider, RealmModel realm, GroupModel group, int firstResult, int maxResults)`

    Methods in org.keycloak.federation.ldap.mappers with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | UserAttributeLDAPFederationMapper.`checkDuplicateEmail(String userModelAttrName, String email, RealmModel realm, KeycloakSession session, UserModel user)`
    `boolean` | AbstractLDAPFederationMapper.`onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException)`
    `boolean` | LDAPFederationMapperBridge.`onAuthenticationFailure(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)`
    `boolean` | LDAPFederationMapper.`onAuthenticationFailure(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)` Called when LDAP authentication of specified user fails.
    `void` | UserAttributeLDAPFederationMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | HardcodedLDAPRoleMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | FullNameLDAPFederationMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `abstract void` | AbstractLDAPFederationMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | LDAPFederationMapperBridge.`onImportUserFromLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | LDAPFederationMapper.`onImportUserFromLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)` Called when importing user from LDAP to local keycloak DB.
    `void` | UserAttributeLDAPFederationMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `void` | HardcodedLDAPRoleMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `void` | FullNameLDAPFederationMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `abstract void` | AbstractLDAPFederationMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `void` | LDAPFederationMapperBridge.`onRegisterUserToLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `void` | LDAPFederationMapper.`onRegisterUserToLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel localUser, RealmModel realm)` Called when register new user to LDAP - just after user was created in Keycloak DB
    `UserModel` | UserAttributeLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `UserModel` | HardcodedLDAPRoleMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `UserModel` | FullNameLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `abstract UserModel` | AbstractLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `UserModel` | LDAPFederationMapperBridge.`proxy(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel delegate, RealmModel realm)`
    `UserModel` | LDAPFederationMapper.`proxy(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel delegate, RealmModel realm)` Called when invoke proxy on LDAP federation provider
    `protected void` | UserAttributeLDAPFederationMapper.`setPropertyOnUserModel(Property<Object> userModelProperty, UserModel user, String ldapAttrValue)`

    Constructors in org.keycloak.federation.ldap.mappers with parameters of type UserModel
    Constructor and Description
    `TxAwareLDAPUserModelDelegate(UserModel delegate, LDAPFederationProvider provider, LDAPObject ldapUser)`

  - ### Uses of UserModel in org.keycloak.federation.ldap.mappers.membership

    Methods in org.keycloak.federation.ldap.mappers.membership that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `abstract List<UserModel>` | MembershipType.`getGroupMembers(GroupLDAPFederationMapper groupMapper, LDAPObject ldapGroup, int firstResult, int maxResults)`

  - ### Uses of UserModel in org.keycloak.federation.ldap.mappers.membership.group

    Classes in org.keycloak.federation.ldap.mappers.membership.group that implement UserModel
    Modifier and Type | Class and Description
    --- | ---
    `class` | `GroupLDAPFederationMapper.LDAPGroupMappingsUserDelegate`

    Methods in org.keycloak.federation.ldap.mappers.membership.group that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | GroupLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`

    Methods in org.keycloak.federation.ldap.mappers.membership.group that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | GroupLDAPFederationMapper.`getGroupMembers(GroupModel kcGroup, int firstResult, int maxResults)`

    Methods in org.keycloak.federation.ldap.mappers.membership.group with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `protected GroupModel` | GroupLDAPFederationMapper.`findKcGroupOrSyncFromLDAP(LDAPObject ldapGroup, UserModel user)`
    `void` | GroupLDAPFederationMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | GroupLDAPFederationMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `UserModel` | GroupLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`

    Constructors in org.keycloak.federation.ldap.mappers.membership.group with parameters of type UserModel
    Constructor and Description
    `LDAPGroupMappingsUserDelegate(UserModel user, LDAPObject ldapUser)`

  - ### Uses of UserModel in org.keycloak.federation.ldap.mappers.membership.role

    Classes in org.keycloak.federation.ldap.mappers.membership.role that implement UserModel
    Modifier and Type | Class and Description
    --- | ---
    `class` | `RoleLDAPFederationMapper.LDAPRoleMappingsUserDelegate`

    Methods in org.keycloak.federation.ldap.mappers.membership.role that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | RoleLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`

    Methods in org.keycloak.federation.ldap.mappers.membership.role with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoleLDAPFederationMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | RoleLDAPFederationMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `UserModel` | RoleLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`

    Constructors in org.keycloak.federation.ldap.mappers.membership.role with parameters of type UserModel
    Constructor and Description
    `LDAPRoleMappingsUserDelegate(UserModel user, LDAPObject ldapUser)`

  - ### Uses of UserModel in org.keycloak.federation.ldap.mappers.msad

    Classes in org.keycloak.federation.ldap.mappers.msad that implement UserModel
    Modifier and Type | Class and Description
    --- | ---
    `class` | `MSADUserAccountControlMapper.MSADUserModelDelegate`

    Methods in org.keycloak.federation.ldap.mappers.msad that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | MSADUserAccountControlMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`

    Methods in org.keycloak.federation.ldap.mappers.msad with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | MSADUserAccountControlMapper.`onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException)`
    `void` | MSADUserAccountControlMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | MSADUserAccountControlMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `protected boolean` | MSADUserAccountControlMapper.`processAuthErrorCode(String errorCode, UserModel user)`
    `UserModel` | MSADUserAccountControlMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`

    Constructors in org.keycloak.federation.ldap.mappers.msad with parameters of type UserModel
    Constructor and Description
    `MSADUserModelDelegate(UserModel delegate, LDAPObject ldapUser)`

  - ### 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

    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

    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)`
    `TotpBean(KeycloakSession session, RealmModel realm, UserModel user)`

  - ### 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

    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(RealmModel realm, UserModel user)`

  - ### Uses of UserModel in org.keycloak.mappers

    Methods in org.keycloak.mappers that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | UserFederationMapper.`getGroupMembers(UserFederationMapperModel mapperModel, UserFederationProvider federationProvider, RealmModel realm, GroupModel group, int firstResult, int maxResults)` Return empty list if doesn't support storing of groups

  - ### Uses of UserModel in org.keycloak.models

    Methods in org.keycloak.models that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | UserFederationManager.`addUser(RealmModel realm, String username)`
    `UserModel` | UserProvider.`addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)` only used for local storage
    `UserModel` | UserFederationManager.`addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)`
    `UserModel` | CredentialValidationOutput.`getAuthenticatedUser()`
    `UserModel` | ClientSessionModel.`getAuthenticatedUser()`
    `UserModel` | UserProvider.`getServiceAccount(ClientModel client)`
    `UserModel` | UserFederationManager.`getServiceAccount(ClientModel client)`
    `UserModel` | UserSessionModel.`getUser()`
    `UserModel` | UserModel.UserRemovedEvent.`getUser()`
    `UserModel` | UserFederationProvider.`getUserByEmail(RealmModel realm, String email)` Keycloak will search for user in local storage first.
    `UserModel` | UserFederationManager.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | UserProvider.`getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)`
    `UserModel` | UserFederationManager.`getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)`
    `UserModel` | UserFederationManager.`getUserById(String id, RealmModel realm)`
    `UserModel` | UserFederationProvider.`getUserByUsername(RealmModel realm, String username)` Keycloak will search for user in local storage first.
    `UserModel` | UserFederationManager.`getUserByUsername(String username, RealmModel realm)`
    `UserModel` | UserFederationProvider.`register(RealmModel realm, UserModel user)` Called if this federation provider has priority and supports synchronized registrations.
    `protected UserModel` | UserFederationManager.`registerWithFederation(RealmModel realm, UserModel user)`
    `UserModel` | UserFederationProvider.`validateAndProxy(RealmModel realm, UserModel local)` Gives the provider an option to validate if user still exists in federation backend and then proxy UserModel loaded from local storage.
    `protected UserModel` | UserFederationManager.`validateAndProxyUser(RealmModel realm, UserModel user)`

    Methods in org.keycloak.models that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | UserFederationManager.`getGroupMembers(RealmModel realm, GroupModel group)`
    `List<UserModel>` | UserFederationProvider.`getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)` Return group members from federation storage.
    `List<UserModel>` | UserFederationManager.`getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)`
    `List<UserModel>` | UserFederationManager.`getUsers(RealmModel realm)`
    `List<UserModel>` | UserProvider.`getUsers(RealmModel realm, boolean includeServiceAccounts)`
    `List<UserModel>` | UserFederationManager.`getUsers(RealmModel realm, boolean includeServiceAccounts)`
    `List<UserModel>` | UserFederationManager.`getUsers(RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserProvider.`getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)`
    `List<UserModel>` | UserFederationManager.`getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)`
    `protected List<UserModel>` | UserFederationManager.`query(org.keycloak.models.UserFederationManager.PaginatedQuery pagedQuery, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserFederationProvider.`searchByAttributes(Map<String,String> attributes, RealmModel realm, int maxResults)` Keycloak does not search in local storage first before calling this method.
    `List<UserModel>` | UserFederationManager.`searchForUser(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | UserFederationManager.`searchForUser(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserFederationManager.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | UserFederationManager.`searchForUser(String search, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserFederationManager.`searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)`

    Methods in org.keycloak.models with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserProvider.`addConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | UserFederationManager.`addConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | UserProvider.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)`
    `void` | UserFederationManager.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)`
    `boolean` | UserFederationManager.`configuredForCredentialType(String type, RealmModel realm, UserModel user)` Is the user configured to use this credential type
    `UserSessionModel` | UserSessionProvider.`createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)`
    `protected void` | UserFederationManager.`deleteInvalidUser(RealmModel realm, UserModel user)`
    `UserConsentModel` | UserProvider.`getConsentByClient(RealmModel realm, UserModel user, String clientInternalId)`
    `UserConsentModel` | UserFederationManager.`getConsentByClient(RealmModel realm, UserModel user, String clientInternalId)`
    `List<UserConsentModel>` | UserProvider.`getConsents(RealmModel realm, UserModel user)`
    `List<UserConsentModel>` | UserFederationManager.`getConsents(RealmModel realm, UserModel user)`
    `Set<FederatedIdentityModel>` | UserProvider.`getFederatedIdentities(UserModel user, RealmModel realm)`
    `Set<FederatedIdentityModel>` | UserFederationManager.`getFederatedIdentities(UserModel user, RealmModel realm)`
    `FederatedIdentityModel` | UserProvider.`getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)`
    `FederatedIdentityModel` | UserFederationManager.`getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)`
    `protected UserFederationProvider` | UserFederationManager.`getFederationLink(RealmModel realm, UserModel user)`
    `String` | OTPPolicy.`getKeyURI(RealmModel realm, UserModel user, String secret)` Constructs the `otpauth://` URI based on the Key-Uri-Format.
    `List<ClientSessionModel>` | UserSessionProvider.`getOfflineClientSessions(RealmModel realm, UserModel user)`
    `Set<String>` | UserFederationProvider.`getSupportedCredentialTypes(UserModel user)` What UserCredentialModel types should be handled by this provider for this user? Keycloak will only call validCredentials() with the credential types specified in this method.
    `List<UserSessionModel>` | UserSessionProvider.`getUserSessions(RealmModel realm, UserModel user)`
    `boolean` | UserFederationProvider.`isValid(RealmModel realm, UserModel local)` Is the Keycloak UserModel still valid and/or existing in federated storage? Keycloak may call this method in various user operations.
    `void` | UserSessionProvider.`onUserRemoved(RealmModel realm, UserModel user)`
    `UserModel` | UserFederationProvider.`register(RealmModel realm, UserModel user)` Called if this federation provider has priority and supports synchronized registrations.
    `protected UserModel` | UserFederationManager.`registerWithFederation(RealmModel realm, UserModel user)`
    `boolean` | UserProvider.`removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)`
    `boolean` | UserFederationManager.`removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)`
    `boolean` | UserFederationProvider.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | UserFederationManager.`removeUser(RealmModel realm, UserModel user)`
    `void` | UserSessionProvider.`removeUserSessions(RealmModel realm, UserModel user)`
    `Locale` | KeycloakContext.`resolveLocale(UserModel user)`
    `boolean` | UserProvider.`revokeConsentForClient(RealmModel realm, UserModel user, String clientInternalId)`
    `boolean` | UserFederationManager.`revokeConsentForClient(RealmModel realm, UserModel user, String clientInternalId)`
    `void` | ClientSessionModel.`setAuthenticatedUser(UserModel user)`
    `void` | UserProvider.`updateConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | UserFederationManager.`updateConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | UserFederationManager.`updateCredential(RealmModel realm, UserModel user, UserCredentialModel credential)`
    `void` | UserProvider.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)`
    `void` | UserFederationManager.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)`
    `UserModel` | UserFederationProvider.`validateAndProxy(RealmModel realm, UserModel local)` Gives the provider an option to validate if user still exists in federation backend and then proxy UserModel loaded from local storage.
    `protected UserModel` | UserFederationManager.`validateAndProxyUser(RealmModel realm, UserModel user)`
    `protected void` | UserFederationManager.`validateUser(RealmModel realm, UserModel user)`
    `boolean` | UserFederationManager.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | UserProvider.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel... input)`
    `boolean` | UserFederationManager.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel... input)`
    `boolean` | UserFederationProvider.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)` Validate credentials for this user.
    `boolean` | UserFederationProvider.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)`

    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.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)`
    `UserModel` | UserCacheSession.`getServiceAccount(ClientModel client)`
    `UserModel` | UserCacheSession.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | UserCacheSession.`getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)`
    `UserModel` | UserCacheSession.`getUserById(String id, RealmModel realm)`
    `UserModel` | UserCacheSession.`getUserByUsername(String username, RealmModel realm)`

    Methods in org.keycloak.models.cache.infinispan that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | UserCacheSession.`getGroupMembers(RealmModel realm, GroupModel group)`
    `List<UserModel>` | UserCacheSession.`getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)`
    `List<UserModel>` | UserCacheSession.`getUsers(RealmModel realm)`
    `List<UserModel>` | UserCacheSession.`getUsers(RealmModel realm, boolean includeServiceAccounts)`
    `List<UserModel>` | UserCacheSession.`getUsers(RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserCacheSession.`getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)`
    `List<UserModel>` | UserCacheSession.`searchForUser(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | UserCacheSession.`searchForUser(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserCacheSession.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | UserCacheSession.`searchForUser(String search, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserCacheSession.`searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)`

    Methods in org.keycloak.models.cache.infinispan with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserCacheSession.`addConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | UserCacheSession.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)`
    `UserConsentModel` | UserCacheSession.`getConsentByClient(RealmModel realm, UserModel user, String clientId)`
    `List<UserConsentModel>` | UserCacheSession.`getConsents(RealmModel realm, UserModel user)`
    `Set<FederatedIdentityModel>` | UserCacheSession.`getFederatedIdentities(UserModel user, RealmModel realm)`
    `FederatedIdentityModel` | UserCacheSession.`getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)`
    `protected void` | UserCacheSession.`invalidateUser(RealmModel realm, UserModel user)`
    `boolean` | UserCacheSession.`removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)`
    `boolean` | UserCacheSession.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | UserCacheSession.`revokeConsentForClient(RealmModel realm, UserModel user, String clientInternalId)`
    `void` | UserCacheSession.`updateConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | UserCacheSession.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)`
    `boolean` | UserCacheSession.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | UserCacheSession.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel... input)`

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

    Constructors in org.keycloak.models.cache.infinispan.entities with parameters of type UserModel
    Constructor and Description
    `CachedUser(Long revision, RealmModel realm, UserModel user)`

  - ### 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(String email, RealmModel realm)`
    `UserModel` | JpaUserProvider.`getUserByFederatedIdentity(FederatedIdentityModel identity, RealmModel realm)`
    `UserModel` | JpaUserProvider.`getUserById(String id, RealmModel realm)`
    `UserModel` | JpaUserProvider.`getUserByUsername(String username, RealmModel realm)`

    Methods in org.keycloak.models.jpa that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | JpaUserProvider.`getGroupMembers(RealmModel realm, GroupModel group)`
    `List<UserModel>` | JpaUserProvider.`getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)`
    `List<UserModel>` | JpaUserProvider.`getUsers(RealmModel realm)`
    `List<UserModel>` | JpaUserProvider.`getUsers(RealmModel realm, boolean includeServiceAccounts)`
    `List<UserModel>` | JpaUserProvider.`getUsers(RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | JpaUserProvider.`getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)`
    `List<UserModel>` | JpaUserProvider.`searchForUser(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | JpaUserProvider.`searchForUser(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | JpaUserProvider.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | JpaUserProvider.`searchForUser(String search, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | JpaUserProvider.`searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)`

    Methods in org.keycloak.models.jpa with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | JpaUserProvider.`addConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | JpaUserProvider.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel identity)`
    `UserConsentModel` | JpaUserProvider.`getConsentByClient(RealmModel realm, UserModel user, String clientId)`
    `List<UserConsentModel>` | JpaUserProvider.`getConsents(RealmModel realm, UserModel user)`
    `Set<FederatedIdentityModel>` | JpaUserProvider.`getFederatedIdentities(UserModel user, RealmModel realm)`
    `FederatedIdentityModel` | JpaUserProvider.`getFederatedIdentity(UserModel user, String identityProvider, RealmModel realm)`
    `boolean` | JpaUserProvider.`removeFederatedIdentity(RealmModel realm, UserModel user, String identityProvider)`
    `boolean` | JpaUserProvider.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | JpaUserProvider.`revokeConsentForClient(RealmModel realm, UserModel user, String clientId)`
    `void` | JpaUserProvider.`updateConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | JpaUserProvider.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)`
    `boolean` | JpaUserProvider.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | JpaUserProvider.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel... input)`

  - ### 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
    --- | ---
    `void` | JpaUserSessionPersisterProvider.`onUserRemoved(RealmModel realm, UserModel user)`

  - ### Uses of UserModel in org.keycloak.models.mongo.keycloak.adapters

    Methods in org.keycloak.models.mongo.keycloak.adapters that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | MongoUserProvider.`addUser(RealmModel realm, String username)`
    `UserModel` | MongoUserProvider.`getServiceAccount(ClientModel client)`
    `UserModel` | MongoUserProvider.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | MongoUserProvider.`getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)`
    `UserModel` | MongoUserProvider.`getUserByUsername(String username, RealmModel realm)`

    Methods in org.keycloak.models.mongo.keycloak.adapters that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `protected List<UserModel>` | MongoUserProvider.`convertUserEntities(RealmModel realm, List<MongoUserEntity> userEntities)`
    `List<UserModel>` | MongoUserProvider.`getGroupMembers(RealmModel realm, GroupModel group)`
    `List<UserModel>` | MongoUserProvider.`getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)`
    `List<UserModel>` | MongoUserProvider.`getUsers(RealmModel realm)`
    `List<UserModel>` | MongoUserProvider.`getUsers(RealmModel realm, boolean includeServiceAccounts)`
    `List<UserModel>` | MongoUserProvider.`getUsers(RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | MongoUserProvider.`getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)`
    `List<UserModel>` | MongoUserProvider.`searchForUser(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | MongoUserProvider.`searchForUser(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | MongoUserProvider.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | MongoUserProvider.`searchForUser(String search, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | MongoUserProvider.`searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)`

    Methods in org.keycloak.models.mongo.keycloak.adapters with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | MongoUserProvider.`addConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | MongoUserProvider.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel identity)`
    `UserConsentModel` | MongoUserProvider.`getConsentByClient(RealmModel realm, UserModel user, String clientId)`
    `List<UserConsentModel>` | MongoUserProvider.`getConsents(RealmModel realm, UserModel user)`
    `Set<FederatedIdentityModel>` | MongoUserProvider.`getFederatedIdentities(UserModel userModel, RealmModel realm)`
    `FederatedIdentityModel` | MongoUserProvider.`getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)`
    `void` | MongoUserSessionPersisterProvider.`onUserRemoved(RealmModel realm, UserModel user)`
    `boolean` | MongoUserProvider.`removeFederatedIdentity(RealmModel realm, UserModel userModel, String socialProvider)`
    `boolean` | MongoUserProvider.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | MongoUserProvider.`revokeConsentForClient(RealmModel realm, UserModel user, String clientId)`
    `void` | MongoUserProvider.`updateConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | MongoUserProvider.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)`
    `boolean` | MongoUserProvider.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | MongoUserProvider.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel... input)`

  - ### Uses of UserModel in org.keycloak.models.mongo.utils

    Methods in org.keycloak.models.mongo.utils with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `static List<RoleModel>` | MongoModelUtils.`getAllRolesOfUser(RealmModel realm, UserModel user)`

  - ### Uses of UserModel in org.keycloak.models.session

    Methods in org.keycloak.models.session that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | PersistentClientSessionAdapter.`getAuthenticatedUser()`
    `UserModel` | PersistentUserSessionAdapter.`getUser()`

    Methods in org.keycloak.models.session with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserSessionPersisterProvider.`onUserRemoved(RealmModel realm, UserModel user)`
    `void` | DisabledUserSessionPersisterProvider.`onUserRemoved(RealmModel realm, UserModel user)`
    `void` | PersistentClientSessionAdapter.`setAuthenticatedUser(UserModel user)`

    Constructors in org.keycloak.models.session with parameters of type UserModel
    Constructor and Description
    `PersistentUserSessionAdapter(PersistentUserSessionModel model, RealmModel realm, UserModel user, List<ClientSessionModel> clientSessions)`

  - ### 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` | ClientSessionAdapter.`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)`
    `List<ClientSessionModel>` | InfinispanUserSessionProvider.`getOfflineClientSessions(RealmModel realm, UserModel user)`
    `List<UserSessionModel>` | InfinispanUserSessionProvider.`getUserSessions(RealmModel realm, UserModel user)`
    `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` | ClientSessionAdapter.`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` | `UserModelDelegate`

    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
    `UserModel` | UserModelDelegate.`getDelegate()`

    Methods in org.keycloak.models.utils with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `static void` | DefaultRoles.`addDefaultRoles(RealmModel realm, UserModel userModel)`
    `static void` | RepresentationToModel.`createClientRoleMappings(ClientModel clientModel, UserModel user, List<String> roleNames)`
    `static void` | RepresentationToModel.`createCredentials(UserRepresentation userRep, UserModel user)`
    `static void` | RepresentationToModel.`createRoleMappings(UserRepresentation userRep, UserModel user, RealmModel realm)`
    `static UserCredentialValueModel` | FederatedCredentials.`getCredentialByType(UserFederatedStorageProvider provider, RealmModel realm, UserModel user, String type)`
    `static LinkedList<UserCredentialValueModel>` | FederatedCredentials.`getCredentialsByType(UserFederatedStorageProvider provider, RealmModel realm, UserModel user, String type)`
    `static List<String>` | KeycloakModelUtils.`resolveAttribute(UserModel user, String name)`
    `static String` | KeycloakModelUtils.`resolveFirstAttribute(UserModel user, String name)`
    `static UserRepresentation` | ModelToRepresentation.`toRepresentation(UserModel user)`
    `static void` | FederatedCredentials.`updateCredential(KeycloakSession session, UserFederatedStorageProvider provider, RealmModel realm, UserModel user, UserCredentialModel cred)`
    `static void` | FederatedCredentials.`updateOtpCredential(KeycloakSession session, UserFederatedStorageProvider provider, RealmModel realm, UserModel user, UserCredentialModel cred)`
    `static void` | FederatedCredentials.`updatePasswordCredential(KeycloakSession session, UserFederatedStorageProvider provider, RealmModel realm, UserModel user, UserCredentialModel cred)`
    `static boolean` | FederatedCredentialValidation.`validateHashedCredential(KeycloakSession session, RealmModel realm, UserModel user, String unhashedCredValue, UserCredentialValueModel credential)`
    `static boolean` | CredentialValidation.`validateHashedCredential(KeycloakSession session, RealmModel realm, UserModel user, String unhashedCredValue, UserCredentialValueModel credential)`
    `static boolean` | CredentialValidation.`validCredential(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel credential)`
    `static boolean` | FederatedCredentialValidation.`validCredential(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel credential, List<UserCredentialValueModel> fedCreds)`
    `static boolean` | CredentialValidation.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> credentials)` Must validate all credentials.
    `static boolean` | CredentialValidation.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel... credentials)` Must validate all credentials.
    `static boolean` | FederatedCredentialValidation.`validHOTP(KeycloakSession session, RealmModel realm, UserModel user, String otp, List<UserCredentialValueModel> fedCreds)`
    `static boolean` | CredentialValidation.`validHOTP(RealmModel realm, UserModel user, String otp)`
    `static boolean` | CredentialValidation.`validPassword(KeycloakSession session, RealmModel realm, UserModel user, String password)` Will update password if hash iteration policy has changed
    `static boolean` | FederatedCredentialValidation.`validPassword(KeycloakSession session, RealmModel realm, UserModel user, String password, UserCredentialValueModel fedCred)` Will update password if hash iteration policy has changed
    `static boolean` | FederatedCredentialValidation.`validPasswordToken(RealmModel realm, UserModel user, String encodedPasswordToken)`
    `static boolean` | CredentialValidation.`validPasswordToken(RealmModel realm, UserModel user, String encodedPasswordToken)`
    `static boolean` | CredentialValidation.`validSecret(RealmModel realm, UserModel user, String secret)`
    `static boolean` | FederatedCredentialValidation.`validSecret(RealmModel realm, UserModel user, String secret, UserCredentialValueModel cred)`
    `static boolean` | CredentialValidation.`validTOTP(RealmModel realm, UserModel user, String otp)`
    `static boolean` | FederatedCredentialValidation.`validTOTP(RealmModel realm, UserModel user, String otp, List<UserCredentialValueModel> fedCreds)`

    Constructors in org.keycloak.models.utils with parameters of type UserModel
    Constructor and Description
    `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(UserModel user, String password)`
    `PolicyError` | SpecialCharsPasswordPolicyProvider.`validate(UserModel user, String password)`
    `PolicyError` | RegexPatternsPasswordPolicyProvider.`validate(UserModel user, String password)`
    `PolicyError` | PasswordPolicyProvider.`validate(UserModel user, String password)`
    `PolicyError` | PasswordPolicyManagerProvider.`validate(UserModel user, String password)`
    `PolicyError` | NotUsernamePasswordPolicyProvider.`validate(UserModel user, String password)`
    `PolicyError` | LowerCasePasswordPolicyProvider.`validate(UserModel user, String password)`
    `PolicyError` | LengthPasswordPolicyProvider.`validate(UserModel user, String password)`
    `PolicyError` | HistoryPasswordPolicyProvider.`validate(UserModel user, String password)`
    `PolicyError` | HashIterationsPasswordPolicyProviderFactory.`validate(UserModel user, String password)`
    `PolicyError` | HashAlgorithmPasswordPolicyProviderFactory.`validate(UserModel user, String password)`
    `PolicyError` | ForceExpiredPasswordPolicyProviderFactory.`validate(UserModel user, String password)`
    `PolicyError` | DigitsPasswordPolicyProvider.`validate(UserModel user, String password)`
    `PolicyError` | DefaultPasswordPolicyManagerProvider.`validate(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.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 with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `AccessToken` | TokenManager.`createClientAccessToken(KeycloakSession session, Set<RoleModel> requestedRoles, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionModel clientSession)`
    `static Set<RoleModel>` | TokenManager.`getAccess(String scopeParam, boolean applyScopeParam, ClientModel client, UserModel user)`
    `protected AccessToken` | TokenManager.`initToken(RealmModel realm, ClientModel client, UserModel user, UserSessionModel session, ClientSessionModel clientSession, javax.ws.rs.core.UriInfo uriInfo)`
    `AccessToken` | TokenManager.`transformAccessToken(KeycloakSession session, AccessToken token, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionModel clientSession)`
    `void` | TokenManager.`transformIDToken(KeycloakSession session, IDToken token, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionModel clientSession)`
    `AccessToken` | TokenManager.`transformUserInfoAccessToken(KeycloakSession session, AccessToken token, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionModel clientSession)`

    Constructors in org.keycloak.protocol.oidc with parameters of type UserModel
    Constructor and Description
    `TokenValidation(UserModel user, UserSessionModel userSession, ClientSessionModel clientSession, AccessToken newToken)`

  - ### 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.managers

    Methods in org.keycloak.services.managers that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | AuthenticationManager.AuthResult.`getUser()`
    `UserModel` | Auth.`getUser()`

    Methods in org.keycloak.services.managers that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | RealmManager.`searchUsers(String searchString, RealmModel realmModel)` Query users based on a search string: "Bill Burke" first and last name "bburke@redhat.com" email "Burke" lastname or username

    Methods in org.keycloak.services.managers with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `static void` | AuthenticationManager.`backchannelUserFromClient(KeycloakSession session, RealmModel realm, UserModel user, ClientModel client, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders headers)`
    `static AccessToken` | AuthenticationManager.`createIdentityToken(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, UserSessionModel userSession, ClientSessionModel clientSession, ClientConnection clientConnection, org.jboss.resteasy.spi.HttpRequest request, javax.ws.rs.core.UriInfo uriInfo, EventBuilder event, RealmModel realm, UserModel user)`
    `protected static javax.ws.rs.core.Response` | AuthenticationManager.`executionActions(KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession, org.jboss.resteasy.spi.HttpRequest request, EventBuilder event, RealmModel realm, UserModel user, Set<String> requiredActions)`
    `void` | DefaultBruteForceProtector.`failedLogin(RealmModel realm, UserModel user, ClientConnection clientConnection)`
    `void` | BruteForceProtector.`failedLogin(RealmModel realm, UserModel user, ClientConnection clientConnection)`
    `Set<ClientModel>` | UserSessionManager.`findClientsWithOfflineToken(RealmModel realm, UserModel user)`
    `List<UserSessionModel>` | UserSessionManager.`findOfflineSessions(RealmModel realm, ClientModel client, UserModel user)`
    `boolean` | DefaultBruteForceProtector.`isTemporarilyDisabled(KeycloakSession session, RealmModel realm, UserModel user)`
    `boolean` | BruteForceProtector.`isTemporarilyDisabled(KeycloakSession session, RealmModel realm, UserModel user)`
    `void` | ResourceAdminManager.`logoutUser(URI requestUri, RealmModel realm, UserModel user, KeycloakSession keycloakSession)`
    `void` | ResourceAdminManager.`logoutUserFromClient(URI requestUri, RealmModel realm, ClientModel resource, UserModel user)`
    `boolean` | UserManager.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | UserManager.`removeUser(RealmModel realm, UserModel user, UserProvider userProvider)`
    `boolean` | UserSessionManager.`revokeOfflineToken(UserModel user, ClientModel client)`

    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
    --- | ---
    `static boolean` | AccountService.`isPasswordSet(KeycloakSession session, RealmModel realm, UserModel user)`
    `static void` | AttributeFormDataProcessor.`process(javax.ws.rs.core.MultivaluedMap<String,String> formData, RealmModel realm, UserModel user)` Looks for "user.attributes." keys in the form data and sets the appropriate UserModel.attribute from it.
    `javax.ws.rs.core.Response` | IdentityBrokerService.`validateUser(UserModel user, RealmModel realm)`

  - ### 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` | UsersResource.`updateUserFromRep(UserModel user, UserRepresentation rep, Set<String> attrsToRemove, RealmModel realm, KeycloakSession session, boolean removeMissingRequiredActions)`

    Constructors in org.keycloak.services.resources.admin with parameters of type UserModel
    Constructor and Description
    `AdminAuth(RealmModel realm, AccessToken token, UserModel user, ClientModel client)`

  - ### Uses of UserModel in org.keycloak.services.util

    Methods in org.keycloak.services.util with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `static Locale` | LocaleHelper.`getLocale(KeycloakSession session, RealmModel realm, UserModel user)`

  - ### 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)`
    `UserModel` | UserStorageManager.`addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)`
    `UserModel` | UserStorageManager.`getServiceAccount(ClientModel client)`
    `UserModel` | UserStorageManager.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | UserStorageManager.`getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)`
    `UserModel` | UserStorageManager.`getUserById(String id, RealmModel realm)`
    `UserModel` | UserStorageManager.`getUserByUsername(String username, RealmModel realm)`

    Methods in org.keycloak.storage that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | UserStorageManager.`getGroupMembers(RealmModel realm, GroupModel group)`
    `List<UserModel>` | UserStorageManager.`getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)`
    `List<UserModel>` | UserStorageManager.`getUsers(RealmModel realm)`
    `List<UserModel>` | UserStorageManager.`getUsers(RealmModel realm, boolean includeServiceAccounts)`
    `List<UserModel>` | UserStorageManager.`getUsers(RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserStorageManager.`getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)`
    `protected List<UserModel>` | UserStorageManager.`query(org.keycloak.storage.UserStorageManager.PaginatedQuery pagedQuery, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserStorageManager.`searchForUser(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | UserStorageManager.`searchForUser(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserStorageManager.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | UserStorageManager.`searchForUser(String search, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserStorageManager.`searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)`

    Methods in org.keycloak.storage with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserStorageManager.`addConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | UserStorageManager.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)`
    `UserConsentModel` | UserStorageManager.`getConsentByClient(RealmModel realm, UserModel user, String clientInternalId)`
    `List<UserConsentModel>` | UserStorageManager.`getConsents(RealmModel realm, UserModel user)`
    `Set<FederatedIdentityModel>` | UserStorageManager.`getFederatedIdentities(UserModel user, RealmModel realm)`
    `FederatedIdentityModel` | UserStorageManager.`getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)`
    `static boolean` | StorageId.`isLocalStorage(UserModel user)`
    `boolean` | UserStorageManager.`removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)`
    `boolean` | UserStorageManager.`removeUser(RealmModel realm, UserModel user)`
    `static String` | StorageId.`resolveProviderId(UserModel user)`
    `boolean` | UserStorageManager.`revokeConsentForClient(RealmModel realm, UserModel user, String clientInternalId)`
    `void` | UserStorageManager.`updateConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | UserStorageManager.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)`
    `boolean` | UserStorageManager.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | UserStorageManager.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel... input)`

  - ### 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().
    `class` | `AbstractUserAdapterFederatedStorage` Assumes everything is managed by federated storage except for username.

  - ### Uses of UserModel in org.keycloak.storage.changeset

    Classes in org.keycloak.storage.changeset that implement UserModel
    Modifier and Type | Class and Description
    --- | ---
    `class` | `UserDataAdapter`

  - ### 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` | UserConsentFederatedStorage.`addConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | UserBrokerLinkFederatedStorage.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)`
    `void` | UserRequiredActionsFederatedStorage.`addRequiredAction(RealmModel realm, UserModel user, String action)`
    `void` | UserRoleMappingsFederatedStorage.`deleteRoleMapping(RealmModel realm, UserModel user, RoleModel role)`
    `MultivaluedHashMap<String,String>` | UserAttributeFederatedStorage.`getAttributes(RealmModel realm, UserModel user)`
    `UserConsentModel` | UserConsentFederatedStorage.`getConsentByClient(RealmModel realm, UserModel user, String clientInternalId)`
    `List<UserConsentModel>` | UserConsentFederatedStorage.`getConsents(RealmModel realm, UserModel user)`
    `List<UserCredentialValueModel>` | UserCredentialsFederatedStorage.`getCredentials(RealmModel realm, UserModel user)`
    `Set<FederatedIdentityModel>` | UserBrokerLinkFederatedStorage.`getFederatedIdentities(UserModel user, RealmModel realm)`
    `FederatedIdentityModel` | UserBrokerLinkFederatedStorage.`getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)`
    `Set<GroupModel>` | UserGroupMembershipFederatedStorage.`getGroups(RealmModel realm, UserModel user)`
    `Set<String>` | UserRequiredActionsFederatedStorage.`getRequiredActions(RealmModel realm, UserModel user)`
    `Set<RoleModel>` | UserRoleMappingsFederatedStorage.`getRoleMappings(RealmModel realm, UserModel user)`
    `void` | UserRoleMappingsFederatedStorage.`grantRole(RealmModel realm, UserModel user, RoleModel role)`
    `void` | UserGroupMembershipFederatedStorage.`joinGroup(RealmModel realm, UserModel user, GroupModel group)`
    `void` | UserGroupMembershipFederatedStorage.`leaveGroup(RealmModel realm, UserModel user, GroupModel group)`
    `void` | UserFederatedStorageProvider.`preRemove(RealmModel realm, UserModel user)`
    `void` | UserAttributeFederatedStorage.`removeAttribute(RealmModel realm, UserModel user, String name)`
    `void` | UserCredentialsFederatedStorage.`removeCredential(RealmModel realm, UserModel user, UserCredentialValueModel cred)`
    `boolean` | UserBrokerLinkFederatedStorage.`removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)`
    `void` | UserRequiredActionsFederatedStorage.`removeRequiredAction(RealmModel realm, UserModel user, String action)`
    `boolean` | UserConsentFederatedStorage.`revokeConsentForClient(RealmModel realm, UserModel user, String clientInternalId)`
    `void` | UserAttributeFederatedStorage.`setAttribute(RealmModel realm, UserModel user, String name, List<String> values)`
    `void` | UserAttributeFederatedStorage.`setSingleAttribute(RealmModel realm, UserModel user, String name, String value)`
    `void` | UserConsentFederatedStorage.`updateConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | UserCredentialsFederatedStorage.`updateCredential(RealmModel realm, UserModel user, UserCredentialModel cred)`
    `void` | UserCredentialsFederatedStorage.`updateCredential(RealmModel realm, UserModel user, UserCredentialValueModel cred)`
    `void` | UserBrokerLinkFederatedStorage.`updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)`

  - ### 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
    --- | ---
    `void` | JpaUserFederatedStorageProvider.`addConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | JpaUserFederatedStorageProvider.`addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel link)`
    `void` | JpaUserFederatedStorageProvider.`addRequiredAction(RealmModel realm, UserModel user, String action)`
    `void` | JpaUserFederatedStorageProvider.`deleteRoleMapping(RealmModel realm, UserModel user, RoleModel role)`
    `MultivaluedHashMap<String,String>` | JpaUserFederatedStorageProvider.`getAttributes(RealmModel realm, UserModel user)`
    `UserConsentModel` | JpaUserFederatedStorageProvider.`getConsentByClient(RealmModel realm, UserModel user, String clientInternalId)`
    `List<UserConsentModel>` | JpaUserFederatedStorageProvider.`getConsents(RealmModel realm, UserModel user)`
    `List<UserCredentialValueModel>` | JpaUserFederatedStorageProvider.`getCredentials(RealmModel realm, UserModel user)`
    `Set<FederatedIdentityModel>` | JpaUserFederatedStorageProvider.`getFederatedIdentities(UserModel user, RealmModel realm)`
    `FederatedIdentityModel` | JpaUserFederatedStorageProvider.`getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)`
    `Set<GroupModel>` | JpaUserFederatedStorageProvider.`getGroups(RealmModel realm, UserModel user)`
    `Set<String>` | JpaUserFederatedStorageProvider.`getRequiredActions(RealmModel realm, UserModel user)`
    `Set<RoleModel>` | JpaUserFederatedStorageProvider.`getRoleMappings(RealmModel realm, UserModel user)`
    `void` | JpaUserFederatedStorageProvider.`grantRole(RealmModel realm, UserModel user, RoleModel role)`
    `boolean` | JpaUserFederatedStorageProvider.`isMemberOf(RealmModel realm, UserModel user, GroupModel group)`
    `void` | JpaUserFederatedStorageProvider.`joinGroup(RealmModel realm, UserModel user, GroupModel group)`
    `void` | JpaUserFederatedStorageProvider.`leaveGroup(RealmModel realm, UserModel user, GroupModel group)`
    `void` | JpaUserFederatedStorageProvider.`preRemove(RealmModel realm, UserModel user)`
    `void` | JpaUserFederatedStorageProvider.`removeAttribute(RealmModel realm, UserModel user, String name)`
    `void` | JpaUserFederatedStorageProvider.`removeCredential(RealmModel realm, UserModel user, UserCredentialValueModel cred)`
    `boolean` | JpaUserFederatedStorageProvider.`removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)`
    `void` | JpaUserFederatedStorageProvider.`removeRequiredAction(RealmModel realm, UserModel user, String action)`
    `boolean` | JpaUserFederatedStorageProvider.`revokeConsentForClient(RealmModel realm, UserModel user, String clientInternalId)`
    `void` | JpaUserFederatedStorageProvider.`setAttribute(RealmModel realm, UserModel user, String name, List<String> values)`
    `void` | JpaUserFederatedStorageProvider.`setSingleAttribute(RealmModel realm, UserModel user, String name, String value)`
    `void` | JpaUserFederatedStorageProvider.`updateConsent(RealmModel realm, UserModel user, UserConsentModel consent)`
    `void` | JpaUserFederatedStorageProvider.`updateCredential(RealmModel realm, UserModel user, UserCredentialModel cred)`
    `void` | JpaUserFederatedStorageProvider.`updateCredential(RealmModel realm, UserModel user, UserCredentialValueModel cred)`
    `void` | JpaUserFederatedStorageProvider.`updateFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel model)`

  - ### 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)`
    `UserModel` | UserLookupProvider.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | UserLookupProvider.`getUserById(String id, RealmModel realm)`
    `UserModel` | UserLookupProvider.`getUserByUsername(String username, RealmModel realm)`

    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)`
    `List<UserModel>` | UserQueryProvider.`getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)`
    `List<UserModel>` | UserQueryProvider.`getUsers(RealmModel realm)`
    `List<UserModel>` | UserQueryProvider.`getUsers(RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserQueryProvider.`searchForUser(Map<String,String> params, RealmModel realm)` Search for user by parameter.
    `List<UserModel>` | UserQueryProvider.`searchForUser(Map<String,String> params, RealmModel realm, int firstResult, int maxResults)` Search for user by parameter.
    `List<UserModel>` | UserQueryProvider.`searchForUser(String search, RealmModel realm)` Search for users with username, email or first + last name that is like search string.
    `List<UserModel>` | UserQueryProvider.`searchForUser(String search, RealmModel realm, int firstResult, int maxResults)` Search for users with username, email or first + last name that is like search string.
    `List<UserModel>` | UserQueryProvider.`searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)`

    Methods in org.keycloak.storage.user with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | UserRegistrationProvider.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | UserCredentialValidatorProvider.`validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> input)`

  - ### Uses of UserModel in org.keycloak.utils

    Methods in org.keycloak.utils with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `static String` | TotpUtils.`qrCode(String totpSecret, RealmModel realm, UserModel user)`

Copyright © 2016 JBoss by Red Hat. All rights reserved.