Uses of Interface
org.keycloak.models.UserModel

Packages that use UserModel

Package	Description
org.keycloak.credential
org.keycloak.models
org.keycloak.models.cache
org.keycloak.models.utils
org.keycloak.policy
org.keycloak.storage
org.keycloak.storage.adapter
org.keycloak.storage.federated
org.keycloak.storage.user

Uses of UserModel in org.keycloak.credential

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

Modifier and Type	Method and Description
CredentialModel	UserCredentialStore.createCredential(RealmModel realm, UserModel user, CredentialModel cred)
void	CredentialInputUpdater.disableCredentialType(RealmModel realm, UserModel user, String credentialType)
Set<String>	CredentialInputUpdater.getDisableableCredentialTypes(RealmModel realm, UserModel user) Returns a set of credential types that can be disabled by disableCredentialType() method
CredentialModel	UserCredentialStore.getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	UserCredentialStore.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
List<CredentialModel>	UserCredentialStore.getStoredCredentials(RealmModel realm, UserModel user)
List<CredentialModel>	UserCredentialStore.getStoredCredentialsByType(RealmModel realm, UserModel user, String type)
boolean	CredentialInputValidator.isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	CredentialInputValidator.isValid(RealmModel realm, UserModel user, CredentialInput input)
boolean	UserCredentialStore.removeStoredCredential(RealmModel realm, UserModel user, String id)
boolean	CredentialInputUpdater.updateCredential(RealmModel realm, UserModel user, CredentialInput input)
void	UserCredentialStore.updateCredential(RealmModel realm, UserModel user, CredentialModel cred)

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) Deprecated. 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) Deprecated. Keycloak will search for user in local storage first.
UserModel	UserFederationManager.getUserByUsername(String username, RealmModel realm)
UserModel	UserFederationProvider.register(RealmModel realm, UserModel user) Deprecated. 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) Deprecated. 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) Deprecated. 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) Deprecated. 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.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)
void	UserFederationManager.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)
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)
void	UserCredentialManager.disableCredentialType(RealmModel realm, UserModel user, String credentialType) Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.
Set<String>	UserCredentialManager.getDisableableCredentialTypes(RealmModel realm, UserModel user) Returns a set of credential types that can be disabled by disableCredentialType() method
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)
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)
List<UserSessionModel>	UserSessionProvider.getUserSessions(RealmModel realm, UserModel user)
boolean	UserCredentialManager.isConfiguredFor(RealmModel realm, UserModel user, String type) Checks to see if user has credential type configured.
boolean	UserCredentialManager.isConfiguredLocally(RealmModel realm, UserModel user, String type) Only loops through each CredentialProvider to see if credential type is configured for the user.
boolean	UserFederationProvider.isValid(RealmModel realm, UserModel local) Deprecated. Is the Keycloak UserModel still valid and/or existing in federated storage? Keycloak may call this method in various user operations.
boolean	UserCredentialManager.isValid(RealmModel realm, UserModel user, CredentialInput... inputs) Validates list of credentials.
boolean	UserCredentialManager.isValid(RealmModel realm, UserModel user, List<CredentialInput> inputs) Validates list of credentials.
UserModel	UserFederationProvider.register(RealmModel realm, UserModel user) Deprecated. 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	UserManager.removeUser(RealmModel realm, UserModel user)
boolean	UserFederationProvider.removeUser(RealmModel realm, UserModel user) Deprecated.
boolean	UserFederationManager.removeUser(RealmModel realm, UserModel user)
boolean	UserManager.removeUser(RealmModel realm, UserModel user, UserProvider userProvider)
void	UserSessionProvider.removeUserSessions(RealmModel realm, UserModel user)
Locale	KeycloakContext.resolveLocale(UserModel user)
void	ClientSessionModel.setAuthenticatedUser(UserModel user)
void	UserCredentialManager.updateCredential(RealmModel realm, UserModel user, CredentialInput input) Updates a 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) Deprecated. 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)
void	UserFederationManager.validateUser(RealmModel realm, UserModel user)

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

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

Uses of UserModel in org.keycloak.models.cache

Subinterfaces of UserModel in org.keycloak.models.cache

Modifier and Type	Interface and Description
interface	CachedUserModel Cached users will implement this interface

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

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

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

Modifier and Type	Method and Description
void	UserCache.evict(RealmModel realm, UserModel user) Evict user from cache.
void	OnUserCache.onCache(RealmModel realm, CachedUserModel user, UserModel delegate)

Uses of UserModel in org.keycloak.models.utils

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)

Uses of UserModel in org.keycloak.policy

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

Modifier and Type	Method and Description
PolicyError	PasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)

Uses of UserModel in org.keycloak.storage

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

Modifier and Type	Method and Description
static boolean	StorageId.isLocalStorage(UserModel user)
static String	StorageId.resolveProviderId(UserModel user)

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

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

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

Uses of UserModel in org.keycloak.storage.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)
UserModel	ImportedUserValidation.validate(RealmModel realmm, UserModel user)

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)
UserModel	ImportedUserValidation.validate(RealmModel realmm, UserModel user)