Uses of Interface
org.keycloak.models.UserModel

Packages that use UserModel

Package	Description
org.keycloak.authentication
org.keycloak.broker.provider
org.keycloak.email
org.keycloak.events
org.keycloak.forms.account
org.keycloak.forms.login
org.keycloak.mappers
org.keycloak.models
org.keycloak.models.session
org.keycloak.models.utils
org.keycloak.services.managers

Uses of UserModel in org.keycloak.authentication

Methods in org.keycloak.authentication that return UserModel

Modifier and Type	Method and Description
UserModel	FormContext.getUser() Current user attached to this flow.
UserModel	RequiredActionContext.getUser() Current user
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	FormAction.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticator
void	Authenticator.setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) Set actions to configure authenticator
void	FormContext.setUser(UserModel user) Attach a specific user to this flow.
void	AuthenticationFlowContext.setUser(UserModel user) Attach a specific user to this flow.

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	AbstractIdentityProvider.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void	IdentityProvider.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void	IdentityProviderMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) Called after UserModel is created for first time for this user.
void	AbstractIdentityProviderMapper.importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
void	AbstractIdentityProvider.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void	IdentityProvider.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void	IdentityProviderMapper.updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) Called when this user has logged in before and has already been imported.

Uses of UserModel in org.keycloak.email

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

Modifier and Type	Method and Description
void	EmailSenderProvider.send(RealmModel realm, UserModel user, String subject, String textBody, String htmlBody)
EmailTemplateProvider	EmailTemplateProvider.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.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.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.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	UserProvider.addUser(RealmModel realm, String username)
UserModel	UserFederationManager.addUser(RealmModel realm, String username)
UserModel	UserProvider.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
UserModel	UserFederationManager.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
UserModel	CredentialValidationOutput.getAuthenticatedUser()
UserModel	ClientSessionModel.getAuthenticatedUser()
UserModel	UserModel.UserRemovedEvent.getUser()
UserModel	UserSessionModel.getUser()
UserModel	UserFederationProvider.getUserByEmail(RealmModel realm, String email) Keycloak will search for user in local storage first.
UserModel	UserProvider.getUserByEmail(String email, RealmModel realm)
UserModel	UserFederationManager.getUserByEmail(String email, RealmModel realm)
UserModel	UserProvider.getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)
UserModel	UserFederationManager.getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)
UserModel	UserProvider.getUserById(String id, RealmModel realm)
UserModel	UserFederationManager.getUserById(String id, RealmModel realm)
UserModel	UserProvider.getUserByServiceAccountClient(ClientModel client)
UserModel	UserFederationManager.getUserByServiceAccountClient(ClientModel client)
UserModel	UserFederationProvider.getUserByUsername(RealmModel realm, String username) Keycloak will search for user in local storage first.
UserModel	UserProvider.getUserByUsername(String username, RealmModel realm)
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>	UserProvider.getGroupMembers(RealmModel realm, GroupModel group)
List<UserModel>	UserFederationManager.getGroupMembers(RealmModel realm, GroupModel group)
List<UserModel>	UserProvider.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
List<UserModel>	UserFederationManager.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
List<UserModel>	UserFederationProvider.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults) Return group members from federation storage.
List<UserModel>	UserProvider.getUsers(RealmModel realm, boolean includeServiceAccounts)
List<UserModel>	UserFederationManager.getUsers(RealmModel realm, boolean includeServiceAccounts)
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>	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)
List<UserModel>	UserProvider.searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)
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)
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)
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	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)
Locale	KeycloakContext.resolveLocale(UserModel user)
void	ClientSessionModel.setAuthenticatedUser(UserModel user)
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)
PasswordPolicy.Error	PasswordPolicy.validate(KeycloakSession session, UserModel user, String password)
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	UserProvider.validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> input)
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.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.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	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 List<String>	KeycloakModelUtils.resolveAttribute(UserModel user, String name)
static String	KeycloakModelUtils.resolveFirstAttribute(UserModel user, String name)
static UserRepresentation	ModelToRepresentation.toRepresentation(UserModel user)
static boolean	CredentialValidation.validateHashedCredential(KeycloakSession session, RealmModel realm, UserModel user, String unhashedCredValue, UserCredentialValueModel credential)
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	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	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.services.managers

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

Modifier and Type	Method and Description
void	BruteForceProtector.failedLogin(RealmModel realm, UserModel user, org.keycloak.common.ClientConnection clientConnection)
boolean	BruteForceProtector.isTemporarilyDisabled(KeycloakSession session, RealmModel realm, UserModel user)
boolean	UserManager.removeUser(RealmModel realm, UserModel user)
boolean	UserManager.removeUser(RealmModel realm, UserModel user, UserProvider userProvider)