## 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.audit |
  org.keycloak.authentication |
  org.keycloak.authentication.model |
  org.keycloak.email |
  org.keycloak.email.freemarker |
  org.keycloak.login |
  org.keycloak.login.freemarker |
  org.keycloak.login.freemarker.model |
  org.keycloak.models |
  org.keycloak.models.cache |
  org.keycloak.models.jpa |
  org.keycloak.models.mongo.keycloak.adapters |
  org.keycloak.models.mongo.utils |
  org.keycloak.models.utils |
  org.keycloak.services.managers |
  org.keycloak.services.resources.admin |
  org.keycloak.services.resources.flows |

- - ### 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)`
    `AccountSocialBean(RealmModel realm, UserModel user, URI baseUri)`
    `TotpBean(UserModel user, URI baseUri)`

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

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

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

    Methods in org.keycloak.authentication with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | AuthenticationProviderManager.`updatePassword(UserModel user, String password)`
    `AuthProviderStatus` | AuthenticationProviderManager.`validatePassword(UserModel user, String password)`

  - ### Uses of UserModel in org.keycloak.authentication.model

    Methods in org.keycloak.authentication.model with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `protected AuthUser` | AbstractModelAuthenticationProvider.`createAuthenticatedUserInstance(UserModel user)`

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

    Methods in org.keycloak.email with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `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.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` | RealmModel.`addUser(String username)`
    `UserModel` | RealmModel.`addUser(String id, String username)`
    `UserModel` | UserSessionModel.`getUser()`
    `UserModel` | RealmModel.`getUser(String name)`
    `UserModel` | RealmModel.`getUserByEmail(String email)`
    `UserModel` | KeycloakSession.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | RealmModel.`getUserById(String name)`
    `UserModel` | KeycloakSession.`getUserById(String id, RealmModel realm)`
    `UserModel` | RealmModel.`getUserBySocialLink(SocialLinkModel socialLink)`
    `UserModel` | KeycloakSession.`getUserBySocialLink(SocialLinkModel socialLink, RealmModel realm)`
    `UserModel` | KeycloakSession.`getUserByUsername(String username, RealmModel realm)`

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

    Methods in org.keycloak.models with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RealmModel.`addSocialLink(UserModel user, SocialLinkModel socialLink)`
    `UserSessionModel` | KeycloakSession.`createUserSession(RealmModel realm, UserModel user, String ipAddress)`
    `UserSessionModel` | RealmModel.`createUserSession(UserModel user, String ipAddress)`
    `SocialLinkModel` | RealmModel.`getSocialLink(UserModel user, String socialProvider)`
    `SocialLinkModel` | KeycloakSession.`getSocialLink(UserModel user, String socialProvider, RealmModel realm)`
    `Set<SocialLinkModel>` | RealmModel.`getSocialLinks(UserModel user)`
    `Set<SocialLinkModel>` | KeycloakSession.`getSocialLinks(UserModel user, RealmModel realm)`
    `List<UserSessionModel>` | RealmModel.`getUserSessions(UserModel user)`
    `List<UserSessionModel>` | KeycloakSession.`getUserSessions(UserModel user, RealmModel realm)`
    `boolean` | RealmModel.`removeSocialLink(UserModel user, String socialProvider)`
    `void` | KeycloakSession.`removeUserSessions(RealmModel realm, UserModel user)`
    `void` | RealmModel.`removeUserSessions(UserModel user)`
    `void` | UserSessionModel.`setUser(UserModel user)`
    `boolean` | RealmModel.`validatePassword(UserModel user, String password)`
    `boolean` | RealmModel.`validateTOTP(UserModel user, String password, String token)`

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

    Methods in org.keycloak.models.cache that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | RealmAdapter.`addUser(String username)`
    `UserModel` | RealmAdapter.`addUser(String id, String username)`
    `UserModel` | RealmAdapter.`getUser(String name)`
    `UserModel` | RealmAdapter.`getUserByEmail(String email)`
    `UserModel` | NoCacheKeycloakSession.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | DefaultCacheKeycloakSession.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | RealmAdapter.`getUserById(String id)`
    `UserModel` | NoCacheKeycloakSession.`getUserById(String id, RealmModel realm)`
    `UserModel` | DefaultCacheKeycloakSession.`getUserById(String id, RealmModel realm)`
    `UserModel` | RealmAdapter.`getUserBySocialLink(SocialLinkModel socialLink)`
    `UserModel` | NoCacheKeycloakSession.`getUserBySocialLink(SocialLinkModel socialLink, RealmModel realm)`
    `UserModel` | DefaultCacheKeycloakSession.`getUserBySocialLink(SocialLinkModel socialLink, RealmModel realm)`
    `UserModel` | NoCacheKeycloakSession.`getUserByUsername(String username, RealmModel realm)`
    `UserModel` | DefaultCacheKeycloakSession.`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>` | RealmAdapter.`getUsers()`
    `List<UserModel>` | NoCacheKeycloakSession.`getUsers(RealmModel realm)`
    `List<UserModel>` | DefaultCacheKeycloakSession.`getUsers(RealmModel realm)`
    `List<UserModel>` | RealmAdapter.`searchForUser(String search)`
    `List<UserModel>` | NoCacheKeycloakSession.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | DefaultCacheKeycloakSession.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | RealmAdapter.`searchForUserByAttributes(Map<String,String> attributes)`
    `List<UserModel>` | NoCacheKeycloakSession.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm)`
    `List<UserModel>` | DefaultCacheKeycloakSession.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm)`

    Methods in org.keycloak.models.cache with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RealmAdapter.`addSocialLink(UserModel user, SocialLinkModel socialLink)`
    `UserSessionModel` | NoCacheKeycloakSession.`createUserSession(RealmModel realm, UserModel user, String ipAddress)`
    `UserSessionModel` | DefaultCacheKeycloakSession.`createUserSession(RealmModel realm, UserModel user, String ipAddress)`
    `UserSessionModel` | RealmAdapter.`createUserSession(UserModel user, String ipAddress)`
    `SocialLinkModel` | RealmAdapter.`getSocialLink(UserModel user, String socialProvider)`
    `SocialLinkModel` | NoCacheKeycloakSession.`getSocialLink(UserModel user, String socialProvider, RealmModel realm)`
    `SocialLinkModel` | DefaultCacheKeycloakSession.`getSocialLink(UserModel user, String socialProvider, RealmModel realm)`
    `Set<SocialLinkModel>` | RealmAdapter.`getSocialLinks(UserModel user)`
    `Set<SocialLinkModel>` | NoCacheKeycloakSession.`getSocialLinks(UserModel user, RealmModel realm)`
    `Set<SocialLinkModel>` | DefaultCacheKeycloakSession.`getSocialLinks(UserModel user, RealmModel realm)`
    `List<UserSessionModel>` | RealmAdapter.`getUserSessions(UserModel user)`
    `List<UserSessionModel>` | NoCacheKeycloakSession.`getUserSessions(UserModel user, RealmModel realm)`
    `List<UserSessionModel>` | DefaultCacheKeycloakSession.`getUserSessions(UserModel user, RealmModel realm)`
    `boolean` | RealmAdapter.`removeSocialLink(UserModel user, String socialProvider)`
    `void` | NoCacheKeycloakSession.`removeUserSessions(RealmModel realm, UserModel user)`
    `void` | DefaultCacheKeycloakSession.`removeUserSessions(RealmModel realm, UserModel user)`
    `void` | RealmAdapter.`removeUserSessions(UserModel user)`
    `boolean` | RealmAdapter.`validatePassword(UserModel user, String password)`
    `boolean` | RealmAdapter.`validateTOTP(UserModel user, String password, String token)`

  - ### 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` | RealmAdapter.`addUser(String username)`
    `UserModel` | RealmAdapter.`addUser(String id, String username)`
    `UserModel` | UserSessionAdapter.`getUser()`
    `UserModel` | RealmAdapter.`getUser(String name)`
    `UserModel` | RealmAdapter.`getUserByEmail(String email)`
    `UserModel` | JpaKeycloakSession.`getUserByEmail(String email, RealmModel realmModel)`
    `UserModel` | RealmAdapter.`getUserById(String id)`
    `UserModel` | JpaKeycloakSession.`getUserById(String id, RealmModel realmModel)`
    `UserModel` | RealmAdapter.`getUserBySocialLink(SocialLinkModel socialLink)`
    `UserModel` | JpaKeycloakSession.`getUserBySocialLink(SocialLinkModel socialLink, RealmModel realm)`
    `UserModel` | JpaKeycloakSession.`getUserByUsername(String username, RealmModel realmModel)`

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

    Methods in org.keycloak.models.jpa with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RealmAdapter.`addSocialLink(UserModel user, SocialLinkModel socialLink)`
    `UserSessionModel` | JpaKeycloakSession.`createUserSession(RealmModel realm, UserModel user, String ipAddress)`
    `UserSessionModel` | RealmAdapter.`createUserSession(UserModel user, String ipAddress)`
    `SocialLinkModel` | RealmAdapter.`getSocialLink(UserModel user, String socialProvider)`
    `SocialLinkModel` | JpaKeycloakSession.`getSocialLink(UserModel user, String socialProvider, RealmModel realm)`
    `Set<SocialLinkModel>` | RealmAdapter.`getSocialLinks(UserModel user)`
    `Set<SocialLinkModel>` | JpaKeycloakSession.`getSocialLinks(UserModel user, RealmModel realm)`
    `List<UserSessionModel>` | RealmAdapter.`getUserSessions(UserModel user)`
    `List<UserSessionModel>` | JpaKeycloakSession.`getUserSessions(UserModel user, RealmModel realm)`
    `boolean` | RealmAdapter.`removeSocialLink(UserModel user, String socialProvider)`
    `void` | JpaKeycloakSession.`removeUserSessions(RealmModel realm, UserModel user)`
    `void` | RealmAdapter.`removeUserSessions(UserModel user)`
    `void` | UserSessionAdapter.`setUser(UserModel user)`
    `boolean` | RealmAdapter.`validatePassword(UserModel user, String password)`
    `boolean` | RealmAdapter.`validateTOTP(UserModel user, String password, String token)`

  - ### 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` | UserSessionAdapter.`getUser()`
    `UserModel` | RealmAdapter.`getUser(String name)`
    `UserModel` | RealmAdapter.`getUserByEmail(String email)`
    `UserModel` | MongoKeycloakSession.`getUserByEmail(String email, RealmModel realm)`
    `UserModel` | RealmAdapter.`getUserById(String id)`
    `UserModel` | MongoKeycloakSession.`getUserById(String id, RealmModel realm)`
    `UserModel` | RealmAdapter.`getUserBySocialLink(SocialLinkModel socialLink)`
    `UserModel` | MongoKeycloakSession.`getUserBySocialLink(SocialLinkModel socialLink, RealmModel realm)`
    `UserModel` | MongoKeycloakSession.`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>` | MongoKeycloakSession.`convertUserEntities(RealmModel realm, List<MongoUserEntity> userEntities)`
    `List<UserModel>` | RealmAdapter.`getUsers()`
    `List<UserModel>` | MongoKeycloakSession.`getUsers(RealmModel realm)`
    `List<UserModel>` | RealmAdapter.`searchForUser(String search)`
    `List<UserModel>` | MongoKeycloakSession.`searchForUser(String search, RealmModel realm)`
    `List<UserModel>` | RealmAdapter.`searchForUserByAttributes(Map<String,String> attributes)`
    `List<UserModel>` | MongoKeycloakSession.`searchForUserByAttributes(Map<String,String> attributes, RealmModel realm)`

    Methods in org.keycloak.models.mongo.keycloak.adapters with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RealmAdapter.`addSocialLink(UserModel user, SocialLinkModel socialLink)`
    `UserSessionModel` | MongoKeycloakSession.`createUserSession(RealmModel realm, UserModel user, String ipAddress)`
    `UserSessionModel` | RealmAdapter.`createUserSession(UserModel user, String ipAddress)`
    `SocialLinkModel` | RealmAdapter.`getSocialLink(UserModel user, String socialProvider)`
    `SocialLinkModel` | MongoKeycloakSession.`getSocialLink(UserModel user, String socialProvider, RealmModel realm)`
    `Set<SocialLinkModel>` | RealmAdapter.`getSocialLinks(UserModel user)`
    `Set<SocialLinkModel>` | MongoKeycloakSession.`getSocialLinks(UserModel user, RealmModel realm)`
    `List<UserSessionModel>` | RealmAdapter.`getUserSessions(UserModel user)`
    `List<UserSessionModel>` | MongoKeycloakSession.`getUserSessions(UserModel user, RealmModel realm)`
    `boolean` | RealmAdapter.`removeSocialLink(UserModel user, String socialProvider)`
    `void` | MongoKeycloakSession.`removeUserSessions(RealmModel realm, UserModel user)`
    `void` | RealmAdapter.`removeUserSessions(UserModel user)`
    `void` | UserSessionAdapter.`setUser(UserModel user)`
    `boolean` | RealmAdapter.`validatePassword(UserModel user, String password)`
    `boolean` | RealmAdapter.`validateTOTP(UserModel user, String password, String token)`

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

    Methods in org.keycloak.models.utils that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `static UserModel` | KeycloakModelUtils.`findUserByNameOrEmail(RealmModel realm, String username)` Try to find user by given username.

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

    Fields in org.keycloak.services.managers declared as UserModel
    Modifier and Type | Field and Description
    --- | ---
    `protected UserModel` | AccessCodeEntry.`user`

    Methods in org.keycloak.services.managers that return UserModel
    Modifier and Type | Method and Description
    --- | ---
    `UserModel` | RealmManager.`createUser(RealmModel newRealm, UserRepresentation userRep)`
    `UserModel` | AuthenticationManager.AuthResult.`getUser()`
    `UserModel` | AccessCodeEntry.`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
    --- | ---
    `AccessCodeEntry` | TokenManager.`createAccessCode(String scopeParam, String state, String redirect, RealmModel realm, ClientModel client, UserModel user, UserSessionModel session)`
    `AccessToken` | TokenManager.`createClientAccessToken(String scopeParam, RealmModel realm, ClientModel client, UserModel user, UserSessionModel session)`
    `AccessToken` | TokenManager.`createClientAccessToken(String scopeParam, RealmModel realm, ClientModel client, UserModel user, UserSessionModel session, List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`
    `AccessToken` | AuthenticationManager.`createIdentityToken(RealmModel realm, UserModel user, UserSessionModel session)`
    `void` | AuthenticationManager.`createLoginCookie(RealmModel realm, UserModel user, UserSessionModel session, javax.ws.rs.core.UriInfo uriInfo, boolean rememberMe)`
    `TokenManager.AccessTokenResponseBuilder` | TokenManager.AccessTokenResponseBuilder.`generateAccessToken(String scopeParam, ClientModel client, UserModel user, UserSessionModel session)`
    `UserStats` | ResourceAdminManager.`getUserStats(URI requestUri, RealmModel realm, ApplicationModel application, UserModel user)`
    `UserStats` | ResourceAdminManager.`getUserStats(URI requestUri, RealmModel realm, ApplicationModel application, UserModel user, org.jboss.resteasy.client.core.executors.ApacheHttpClient4Executor client)`
    `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` | AccessCodeEntry.`setUser(UserModel user)`
    `static UserRepresentation` | ModelToRepresentation.`toRepresentation(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, boolean cookie)`
    `AuthenticationManager.AuthResult(UserModel user, UserSessionModel session, AccessToken token)`

  - ### 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
    --- | ---
    `protected List<RoleRepresentation>` | UsersResource.`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)`

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

    Methods in org.keycloak.services.resources.flows with parameters of type UserModel
    Modifier and Type | Method and Description
    --- | ---
    `javax.ws.rs.core.Response` | OAuthFlows.`processAccessCode(String scopeParam, String state, String redirect, ClientModel client, UserModel user, UserSessionModel session, String username, boolean rememberMe, String authMethod, Audit audit)`
    `SocialRedirectFlows` | SocialRedirectFlows.`user(UserModel user)`

Copyright © 2014. All Rights Reserved.