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

- Packages that use UserModel
  Package | Description
  --- | ---
  org.keycloak.account |
  org.keycloak.account.freemarker |
  org.keycloak.account.freemarker.model |
  org.keycloak.email |
  org.keycloak.email.freemarker |
  org.keycloak.events |
  org.keycloak.examples.federation.properties |
  org.keycloak.exportimport.dir |
  org.keycloak.exportimport.util |
  org.keycloak.exportimport.zip |
  org.keycloak.federation.ldap |
  org.keycloak.login |
  org.keycloak.login.freemarker |
  org.keycloak.login.freemarker.model |
  org.keycloak.models |
  org.keycloak.models.cache |
  org.keycloak.models.cache.entities |
  org.keycloak.models.jpa |
  org.keycloak.models.mongo.keycloak.adapters |
  org.keycloak.models.mongo.utils |
  org.keycloak.models.sessions.infinispan |
  org.keycloak.models.sessions.jpa |
  org.keycloak.models.sessions.mem |
  org.keycloak.models.sessions.mongo |
  org.keycloak.models.utils |
  org.keycloak.protocol.oidc |
  org.keycloak.protocol.saml |
  org.keycloak.services.managers |
  org.keycloak.services.resources |
  org.keycloak.services.resources.admin |
  org.keycloak.test.tools.jobs |
  org.keycloak.testutils |

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

    Methods in org.keycloak.account with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `AccountProvider` | AccountProvider.`setUser(UserModel user)`

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

    Methods in org.keycloak.account.freemarker with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `AccountProvider` | FreeMarkerAccountProvider.`setUser(UserModel user)`

  - ### Uses of UserModel in org.keycloak.account.freemarker.model

    Constructors in org.keycloak.account.freemarker.model with parameters of type UserModel
    Constructor and Description
    `AccountBean(UserModel user, javax.ws.rs.core.MultivaluedMap<String,String> profileFormData)`
    `AccountSocialBean(KeycloakSession session, RealmModel realm, UserModel user, URI baseUri, String stateChecker)`
    `TotpBean(RealmModel realm, UserModel user, URI baseUri)`

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

    Methods in org.keycloak.email with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `EmailProvider` | EmailProvider.`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
    --- | ---
    `EmailProvider` | FreeMarkerEmailProvider.`setUser(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.examples.federation.properties

    Classes in org.keycloak.examples.federation.properties that implement UserModel
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ReadonlyUserModelProxy` Readonly proxy for a UserModel that prevents passwords from being updated.
    `class` | `WritableUserModelProxy` Proxy that will synchronize password updates to the properties file.

    Methods in org.keycloak.examples.federation.properties that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | BasePropertiesFederationProvider.`getUserByEmail(RealmModel realm, String email)`
    `UserModel` | BasePropertiesFederationProvider.`getUserByUsername(RealmModel realm, String username)`
    `UserModel` | FilePropertiesFederationProvider.`proxy(UserModel local)` Keycloak will call this method if it finds an imported UserModel.
    `UserModel` | ClasspathPropertiesFederationProvider.`proxy(UserModel local)` Keycloak will call this method if it finds an imported UserModel.
    `UserModel` | FilePropertiesFederationProvider.`register(RealmModel realm, UserModel user)` Update the properties file with the new user.
    `UserModel` | ClasspathPropertiesFederationProvider.`register(RealmModel realm, UserModel user)` The properties file is readonly so don't suppport registration.

    Methods in org.keycloak.examples.federation.properties that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | BasePropertiesFederationProvider.`searchByAttributes(Map<String,String> attributes, RealmModel realm, int maxResults)` We only search for Usernames as that is all that is stored in the properties file.

    Methods in org.keycloak.examples.federation.properties with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<String>` | BasePropertiesFederationProvider.`getSupportedCredentialTypes(UserModel user)` hardcoded to only return PASSWORD
    `boolean` | BasePropertiesFederationProvider.`isValid(UserModel local)` See if the user is still in the properties file
    `UserModel` | FilePropertiesFederationProvider.`proxy(UserModel local)` Keycloak will call this method if it finds an imported UserModel.
    `UserModel` | ClasspathPropertiesFederationProvider.`proxy(UserModel local)` Keycloak will call this method if it finds an imported UserModel.
    `UserModel` | FilePropertiesFederationProvider.`register(RealmModel realm, UserModel user)` Update the properties file with the new user.
    `UserModel` | ClasspathPropertiesFederationProvider.`register(RealmModel realm, UserModel user)` The properties file is readonly so don't suppport registration.
    `boolean` | FilePropertiesFederationProvider.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | ClasspathPropertiesFederationProvider.`removeUser(RealmModel realm, UserModel user)` The properties file is readonly so don't removing a user
    `boolean` | BasePropertiesFederationProvider.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | BasePropertiesFederationProvider.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)`

    Constructors in org.keycloak.examples.federation.properties with parameters of type UserModel
    Constructor and Description
    `ReadonlyUserModelProxy(UserModel delegate)`
    `WritableUserModelProxy(UserModel delegate, FilePropertiesFederationProvider provider)`

  - ### 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, org.codehaus.jackson.map.ObjectMapper mapper, OutputStream os)`
    `protected abstract void` | MultipleStepsExportProvider.`writeUsers(String fileName, KeycloakSession session, RealmModel realm, List<UserModel> users)`

  - ### Uses of UserModel in org.keycloak.exportimport.zip

    Method parameters in org.keycloak.exportimport.zip with type arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | ZipExportProvider.`writeUsers(String fileName, KeycloakSession session, RealmModel realm, List<UserModel> users)`

  - ### 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
    --- | ---
    `UserModel` | LDAPFederationProvider.`getUserByEmail(RealmModel realm, String email)`
    `UserModel` | LDAPFederationProvider.`getUserByUsername(RealmModel realm, String username)`
    `protected UserModel` | LDAPFederationProvider.`importUserFromPicketlink(RealmModel realm, org.picketlink.idm.model.basic.User picketlinkUser)`
    `UserModel` | LDAPFederationProvider.`proxy(UserModel local)`
    `UserModel` | LDAPFederationProvider.`register(RealmModel realm, UserModel user)`

    Methods in org.keycloak.federation.ldap that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `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
    --- | ---
    `Set<String>` | LDAPFederationProvider.`getSupportedCredentialTypes(UserModel local)`
    `boolean` | LDAPFederationProvider.`isValid(UserModel local)`
    `UserModel` | LDAPFederationProvider.`proxy(UserModel local)`
    `UserModel` | LDAPFederationProvider.`register(RealmModel realm, UserModel user)`
    `boolean` | LDAPFederationProvider.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | LDAPFederationProvider.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | LDAPFederationProvider.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)`

    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)`

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

    Methods in org.keycloak.login with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | LoginFormsProvider.`setUser(UserModel user)`

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

    Methods in org.keycloak.login.freemarker with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `FreeMarkerLoginFormsProvider` | FreeMarkerLoginFormsProvider.`setUser(UserModel user)`

  - ### Uses of UserModel in org.keycloak.login.freemarker.model

    Constructors in org.keycloak.login.freemarker.model with parameters of type UserModel
    Constructor and Description
    `ProfileBean(UserModel user)`
    `TotpBean(RealmModel realm, UserModel user, URI baseUri)`

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

    Methods in org.keycloak.models that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | UserProvider.`addUser(RealmModel realm, String username)`
    `UserModel` | UserFederationManager.`addUser(RealmModel realm, String username)`
    `UserModel` | UserProvider.`addUser(RealmModel realm, String id, String username, boolean addDefaultRoles)`
    `UserModel` | UserFederationManager.`addUser(RealmModel realm, String id, String username, boolean addDefaultRoles)`
    `UserModel` | UserSessionModel.`getUser()`
    `UserModel` | UserFederationProvider.`getUserByEmail(RealmModel realm, String email)` Required to import into local storage any user found.
    `UserModel` | UserProvider.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | UserFederationManager.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | UserProvider.`getUserById(String id, RealmModel realm)`
    `UserModel` | UserFederationManager.`getUserById(String id, RealmModel realm)`
    `UserModel` | UserProvider.`getUserBySocialLink(SocialLinkModel socialLink, RealmModel realm)`
    `UserModel` | UserFederationManager.`getUserBySocialLink(SocialLinkModel socialLink, RealmModel realm)`
    `UserModel` | UserFederationProvider.`getUserByUsername(RealmModel realm, String username)` Required to import into local storage any user found.
    `UserModel` | UserProvider.`getUserByUsername(String username, RealmModel realm)`
    `UserModel` | UserFederationManager.`getUserByUsername(String username, RealmModel realm)`
    `UserModel` | UserFederationProvider.`proxy(UserModel local)` Gives the provider an option to proxy UserModels loaded from local storage.
    `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)`
    `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>` | UserProvider.`getUsers(RealmModel realm)`
    `List<UserModel>` | UserFederationManager.`getUsers(RealmModel realm)`
    `List<UserModel>` | UserProvider.`getUsers(RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserFederationManager.`getUsers(RealmModel realm, int firstResult, int maxResults)`
    `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)` Required to import into local storage any user found.
    `List<UserModel>` | UserProvider.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | UserFederationManager.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | UserProvider.`searchForUser(String search, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserFederationManager.`searchForUser(String search, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserProvider.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | UserFederationManager.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | UserProvider.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | UserFederationManager.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)`

    Methods in org.keycloak.models with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserProvider.`addSocialLink(RealmModel realm, UserModel user, SocialLinkModel socialLink)`
    `void` | UserFederationManager.`addSocialLink(RealmModel realm, UserModel user, SocialLinkModel socialLink)`
    `UserSessionModel` | UserSessionProvider.`createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe)`
    `protected void` | UserFederationManager.`deleteInvalidUser(RealmModel realm, UserModel user)`
    `protected UserFederationProvider` | UserFederationManager.`getFederationLink(RealmModel realm, UserModel user)`
    `SocialLinkModel` | UserProvider.`getSocialLink(UserModel user, String socialProvider, RealmModel realm)`
    `SocialLinkModel` | UserFederationManager.`getSocialLink(UserModel user, String socialProvider, RealmModel realm)`
    `Set<SocialLinkModel>` | UserProvider.`getSocialLinks(UserModel user, RealmModel realm)`
    `Set<SocialLinkModel>` | UserFederationManager.`getSocialLinks(UserModel user, RealmModel realm)`
    `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)`
    `protected boolean` | UserFederationManager.`isValid(RealmModel realm, UserModel user)`
    `boolean` | UserFederationProvider.`isValid(UserModel local)` Is the Keycloak UserModel still valid and/or existing in federated storage?
    `void` | UserSessionProvider.`onUserRemoved(RealmModel realm, UserModel user)`
    `UserModel` | UserFederationProvider.`proxy(UserModel local)` Gives the provider an option to proxy UserModels loaded from local storage.
    `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.`removeSocialLink(RealmModel realm, UserModel user, String socialProvider)`
    `boolean` | UserFederationManager.`removeSocialLink(RealmModel realm, UserModel user, String socialProvider)`
    `boolean` | UserProvider.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | UserFederationManager.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | UserFederationProvider.`removeUser(RealmModel realm, UserModel user)`
    `void` | UserSessionProvider.`removeUserSessions(RealmModel realm, UserModel user)`
    `void` | UserFederationManager.`updateCredential(RealmModel realm, UserModel user, UserCredentialModel credential)`
    `protected UserModel` | UserFederationManager.`validateAndProxyUser(RealmModel realm, UserModel user)`
    `protected void` | UserFederationManager.`validateUser(RealmModel realm, UserModel user)`
    `boolean` | UserProvider.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | UserFederationManager.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | UserFederationProvider.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)` Validate credentials for this user.
    `boolean` | UserProvider.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)`
    `boolean` | UserFederationManager.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)`
    `boolean` | UserFederationProvider.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)`

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

    Classes in org.keycloak.models.cache that implement UserModel
    Modifier and Type | Class and Description
    --- | ---
    `class` | `UserAdapter`

    Fields in org.keycloak.models.cache declared as UserModel
    Modifier and Type | Field and Description
    --- | ---
    `protected UserModel` | UserAdapter.`updated`

    Fields in org.keycloak.models.cache with type parameters of type UserModel
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<String,UserModel>` | DefaultCacheUserProvider.`managedUsers`

    Methods in org.keycloak.models.cache that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | DefaultCacheUserProvider.`addUser(RealmModel realm, String username)`
    `UserModel` | NoCacheUserProvider.`addUser(RealmModel realm, String username)`
    `UserModel` | DefaultCacheUserProvider.`addUser(RealmModel realm, String id, String username, boolean addDefaultRoles)`
    `UserModel` | NoCacheUserProvider.`addUser(RealmModel realm, String id, String username, boolean addDefaultRoles)`
    `UserModel` | DefaultCacheUserProvider.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | NoCacheUserProvider.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | DefaultCacheUserProvider.`getUserById(String id, RealmModel realm)`
    `UserModel` | NoCacheUserProvider.`getUserById(String id, RealmModel realm)`
    `UserModel` | DefaultCacheUserProvider.`getUserBySocialLink(SocialLinkModel socialLink, RealmModel realm)`
    `UserModel` | NoCacheUserProvider.`getUserBySocialLink(SocialLinkModel socialLink, RealmModel realm)`
    `UserModel` | DefaultCacheUserProvider.`getUserByUsername(String username, RealmModel realm)`
    `UserModel` | NoCacheUserProvider.`getUserByUsername(String username, RealmModel realm)`

    Methods in org.keycloak.models.cache that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | DefaultCacheUserProvider.`getUsers(RealmModel realm)`
    `List<UserModel>` | NoCacheUserProvider.`getUsers(RealmModel realm)`
    `List<UserModel>` | DefaultCacheUserProvider.`getUsers(RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | NoCacheUserProvider.`getUsers(RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | DefaultCacheUserProvider.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | NoCacheUserProvider.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | DefaultCacheUserProvider.`searchForUser(String search, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | NoCacheUserProvider.`searchForUser(String search, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | DefaultCacheUserProvider.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | NoCacheUserProvider.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | DefaultCacheUserProvider.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)`
    `List<UserModel>` | NoCacheUserProvider.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)`

    Methods in org.keycloak.models.cache with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | DefaultCacheUserProvider.`addSocialLink(RealmModel realm, UserModel user, SocialLinkModel socialLink)`
    `void` | NoCacheUserProvider.`addSocialLink(RealmModel realm, UserModel user, SocialLinkModel socialLink)`
    `SocialLinkModel` | DefaultCacheUserProvider.`getSocialLink(UserModel user, String socialProvider, RealmModel realm)`
    `SocialLinkModel` | NoCacheUserProvider.`getSocialLink(UserModel user, String socialProvider, RealmModel realm)`
    `Set<SocialLinkModel>` | DefaultCacheUserProvider.`getSocialLinks(UserModel user, RealmModel realm)`
    `Set<SocialLinkModel>` | NoCacheUserProvider.`getSocialLinks(UserModel user, RealmModel realm)`
    `boolean` | DefaultCacheUserProvider.`removeSocialLink(RealmModel realm, UserModel user, String socialProvider)`
    `boolean` | NoCacheUserProvider.`removeSocialLink(RealmModel realm, UserModel user, String socialProvider)`
    `boolean` | DefaultCacheUserProvider.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | NoCacheUserProvider.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | DefaultCacheUserProvider.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | NoCacheUserProvider.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | DefaultCacheUserProvider.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)`
    `boolean` | NoCacheUserProvider.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)`

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

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

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

    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)`
    `UserModel` | JpaUserProvider.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | JpaUserProvider.`getUserById(String id, RealmModel realm)`
    `UserModel` | JpaUserProvider.`getUserBySocialLink(SocialLinkModel socialLink, 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.`getUsers(RealmModel realm)`
    `List<UserModel>` | JpaUserProvider.`getUsers(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.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | JpaUserProvider.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)`

    Methods in org.keycloak.models.jpa with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | JpaUserProvider.`addSocialLink(RealmModel realm, UserModel user, SocialLinkModel socialLink)`
    `SocialLinkModel` | JpaUserProvider.`getSocialLink(UserModel user, String socialProvider, RealmModel realm)`
    `Set<SocialLinkModel>` | JpaUserProvider.`getSocialLinks(UserModel user, RealmModel realm)`
    `boolean` | JpaUserProvider.`removeSocialLink(RealmModel realm, UserModel user, String socialProvider)`
    `boolean` | JpaUserProvider.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | JpaUserProvider.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | JpaUserProvider.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)`

  - ### 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.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | MongoUserProvider.`getUserById(String id, RealmModel realm)`
    `UserModel` | MongoUserProvider.`getUserBySocialLink(SocialLinkModel 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.`getUsers(RealmModel realm)`
    `List<UserModel>` | MongoUserProvider.`getUsers(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.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | MongoUserProvider.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)`

    Methods in org.keycloak.models.mongo.keycloak.adapters with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | MongoUserProvider.`addSocialLink(RealmModel realm, UserModel user, SocialLinkModel socialLink)`
    `SocialLinkModel` | MongoUserProvider.`getSocialLink(UserModel user, String socialProvider, RealmModel realm)`
    `Set<SocialLinkModel>` | MongoUserProvider.`getSocialLinks(UserModel userModel, RealmModel realm)`
    `boolean` | MongoUserProvider.`removeSocialLink(RealmModel realm, UserModel userModel, String socialProvider)`
    `boolean` | MongoUserProvider.`removeUser(RealmModel realm, UserModel user)`
    `boolean` | MongoUserProvider.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)`
    `boolean` | MongoUserProvider.`validCredentials(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<MongoRoleEntity>` | MongoModelUtils.`getAllRolesOfUser(UserModel user, MongoStoreInvocationContext invContext)`

  - ### 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` | 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)`
    `List<UserSessionModel>` | InfinispanUserSessionProvider.`getUserSessions(RealmModel realm, UserModel user)`
    `void` | InfinispanUserSessionProvider.`onUserRemoved(RealmModel realm, UserModel user)`
    `void` | InfinispanUserSessionProvider.`removeUserSessions(RealmModel realm, UserModel user)`

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

    Methods in org.keycloak.models.sessions.jpa that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | UserSessionAdapter.`getUser()`

    Methods in org.keycloak.models.sessions.jpa with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserSessionModel` | JpaUserSessionProvider.`createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe)`
    `List<UserSessionModel>` | JpaUserSessionProvider.`getUserSessions(RealmModel realm, UserModel user)`
    `void` | JpaUserSessionProvider.`onUserRemoved(RealmModel realm, UserModel user)`
    `void` | JpaUserSessionProvider.`removeUserSessions(RealmModel realm, UserModel user)`

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

    Methods in org.keycloak.models.sessions.mem that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | UserSessionAdapter.`getUser()`

    Methods in org.keycloak.models.sessions.mem with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserSessionModel` | MemUserSessionProvider.`createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe)`
    `List<UserSessionModel>` | MemUserSessionProvider.`getUserSessions(RealmModel realm, UserModel user)`
    `void` | MemUserSessionProvider.`onUserRemoved(RealmModel realm, UserModel user)`
    `void` | MemUserSessionProvider.`removeUserSessions(RealmModel realm, UserModel user)`
    `void` | UserSessionAdapter.`setUser(UserModel user)`

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

    Methods in org.keycloak.models.sessions.mongo that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | UserSessionAdapter.`getUser()`

    Methods in org.keycloak.models.sessions.mongo with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserSessionModel` | MongoUserSessionProvider.`createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe)`
    `List<UserSessionModel>` | MongoUserSessionProvider.`getUserSessions(RealmModel realm, UserModel user)`
    `void` | MongoUserSessionProvider.`onUserRemoved(RealmModel realm, UserModel user)`
    `void` | MongoUserSessionProvider.`removeUserSessions(RealmModel realm, 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, Map<String,ApplicationModel> appMap)`
    `static UserModel` | KeycloakModelUtils.`findUserByNameOrEmail(KeycloakSession session, RealmModel realm, String username)` Try to find user by given username.

    Methods in org.keycloak.models.utils with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `static void` | RepresentationToModel.`createApplicationRoleMappings(ApplicationModel applicationModel, UserModel user, List<String> roleNames)`
    `static UserRepresentation` | ModelToRepresentation.`toRepresentation(UserModel user)`
    `static boolean` | CredentialValidation.`validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> credentials)` Must validate all credentials.
    `static boolean` | CredentialValidation.`validCredentials(RealmModel realm, UserModel user, UserCredentialModel... credentials)` Must validate all credentials.
    `static boolean` | CredentialValidation.`validPassword(RealmModel realm, UserModel user, String password)` Will update password if hash iteration policy has changed
    `static boolean` | CredentialValidation.`validPasswordToken(RealmModel realm, UserModel user, String encodedPasswordToken)`
    `static boolean` | CredentialValidation.`validSecret(RealmModel realm, UserModel user, String secret)`
    `static boolean` | CredentialValidation.`validTOTP(RealmModel realm, UserModel user, String otp)`

    Constructors in org.keycloak.models.utils with parameters of type UserModel
    Constructor and Description
    `UserModelDelegate(UserModel delegate)`

  - ### Uses of UserModel in org.keycloak.protocol.oidc

    Methods in org.keycloak.protocol.oidc with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `AccessToken` | TokenManager.`createClientAccessToken(Set<RoleModel> requestedRoles, RealmModel realm, ClientModel client, UserModel user, UserSessionModel session)`
    `TokenManager.AccessTokenResponseBuilder` | TokenManager.AccessTokenResponseBuilder.`generateAccessToken(String scopeParam, ClientModel client, UserModel user, UserSessionModel session)`
    `static Set<RoleModel>` | TokenManager.`getAccess(String scopeParam, ClientModel client, UserModel user)`
    `void` | TokenManager.`initClaims(IDToken token, ClientModel model, UserModel user)`
    `protected IDToken` | TokenManager.`initIDToken(RealmModel realm, ClientModel claimer, UserModel client, UserModel user)`
    `protected AccessToken` | TokenManager.`initToken(RealmModel realm, ClientModel client, UserModel user, UserSessionModel session)`
    `void` | TokenManager.`verifyAccess(AccessToken token, RealmModel realm, ClientModel client, UserModel user)`

  - ### Uses of UserModel in org.keycloak.protocol.saml

    Methods in org.keycloak.protocol.saml with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | SamlProtocol.`initClaims(SALM2LoginResponseBuilder builder, ClientModel model, 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` | Auth.`getUser()`
    `UserModel` | AuthenticationManager.AuthResult.`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 AccessToken` | AuthenticationManager.`createIdentityToken(RealmModel realm, UserModel user, UserSessionModel session)`
    `static void` | AuthenticationManager.`createLoginCookie(RealmModel realm, UserModel user, UserSessionModel session, javax.ws.rs.core.UriInfo uriInfo, ClientConnection connection)`
    `protected static void` | AuthenticationManager.`isEmailVerificationRequired(RealmModel realm, UserModel user)`
    `protected static void` | AuthenticationManager.`isTotpConfigurationRequired(RealmModel realm, UserModel user)`
    `void` | ResourceAdminManager.`logoutUser(URI requestUri, RealmModel realm, UserModel user, KeycloakSession keycloakSession)`
    `void` | ResourceAdminManager.`logoutUserFromApplication(URI requestUri, RealmModel realm, ApplicationModel resource, UserModel user, KeycloakSession session)`
    `boolean` | UserManager.`removeUser(RealmModel realm, UserModel user)`

    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)`
    `AuthenticationManager.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(UserModel user)`

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

    Fields in org.keycloak.services.resources.admin declared as UserModel
    Modifier and Type | Field and Description
    --- | ---
    `protected UserModel` | UserApplicationRoleMappingsResource.`user`

    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
    --- | ---
    `static List<RoleRepresentation>` | UserApplicationRoleMappingsResource.`getAvailableRoles(UserModel user, Set<RoleModel> available)`

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

  - ### Uses of UserModel in org.keycloak.test.tools.jobs

    Methods in org.keycloak.test.tools.jobs with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | UsersJob.`grantRole(UserModel user, String roleName, Set<RoleModel> realmRoles, Map<String,Set<RoleModel>> appRoles)`

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

    Methods in org.keycloak.testutils that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | DummyUserFederationProvider.`getUserByEmail(RealmModel realm, String email)`
    `UserModel` | DummyUserFederationProvider.`getUserByUsername(RealmModel realm, String username)`
    `UserModel` | DummyUserFederationProvider.`proxy(UserModel local)`
    `UserModel` | DummyUserFederationProvider.`register(RealmModel realm, UserModel user)`

    Methods in org.keycloak.testutils that return types with arguments of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `List<UserModel>` | DummyUserFederationProvider.`searchByAttributes(Map<String,String> attributes, RealmModel realm, int maxResults)`

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

Copyright © 2014. All Rights Reserved.