Uses of Interface
org.keycloak.models.UserModel

Packages that use UserModel

Package	Description
org.keycloak.credential
org.keycloak.locale
org.keycloak.models
org.keycloak.models.utils
org.keycloak.policy
org.keycloak.sessions
org.keycloak.storage
org.keycloak.storage.user

Uses of UserModel in org.keycloak.credential

Methods in org.keycloak.credential that return UserModel

Modifier and Type	Method	Description
UserModel	CredentialTypeMetadataContext.getUser()

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

Modifier and Type	Method	Description
CredentialModel	CredentialProvider.createCredential(RealmModel realm, UserModel user, T credentialModel)
CredentialModel	UserCredentialStore.createCredential(RealmModel realm, UserModel user, CredentialModel cred)
boolean	CredentialProvider.deleteCredential(RealmModel realm, UserModel user, String credentialId)
void	CredentialInputUpdater.disableCredentialType(RealmModel realm, UserModel user, String credentialType)
default T	CredentialProvider.getDefaultCredential(KeycloakSession session, RealmModel realm, UserModel user)
Stream<String>	CredentialInputUpdater.getDisableableCredentialTypesStream(RealmModel realm, UserModel user)	Obtains the set of credential types that can be disabled via disableCredentialType.
CredentialModel	UserCredentialStore.getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	UserCredentialStore.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
Stream<CredentialModel>	UserCredentialStore.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)	Obtains the stored credentials associated with the specified user that match the specified type.
Stream<CredentialModel>	UserCredentialStore.getStoredCredentialsStream(RealmModel realm, UserModel user)	Obtains the stored credentials associated with the specified user.
boolean	CredentialInputValidator.isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	CredentialInputValidator.isValid(RealmModel realm, UserModel user, CredentialInput credentialInput)	Tests whether a credential is valid
boolean	UserCredentialStore.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
boolean	UserCredentialStore.removeStoredCredential(RealmModel realm, UserModel user, String id)	Removes credential with the id for the user.
boolean	CredentialInputUpdater.updateCredential(RealmModel realm, UserModel user, CredentialInput input)
void	UserCredentialStore.updateCredential(RealmModel realm, UserModel user, CredentialModel cred)
CredentialTypeMetadataContext.CredentialTypeMetadataContextBuilder	CredentialTypeMetadataContext.CredentialTypeMetadataContextBuilder.user(UserModel user)

Uses of UserModel in org.keycloak.locale

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

Modifier and Type	Method	Description
Locale	LocaleSelectorProvider.resolveLocale(RealmModel realm, UserModel user)	Resolve the locale which should be used for the request
void	LocaleUpdaterProvider.updateUsersLocale(UserModel user, String locale)

Uses of UserModel in org.keycloak.models

Subinterfaces of UserModel in org.keycloak.models

Modifier and Type	Interface	Description
static interface	UserModel.Streams	Deprecated. This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

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

Modifier and Type	Field	Description
static SearchableModelField<UserModel>	UserModel.SearchableFields.ASSIGNED_GROUP
static SearchableModelField<UserModel>	UserModel.SearchableFields.ASSIGNED_ROLE
static SearchableModelField<UserModel>	UserModel.SearchableFields.ATTRIBUTE	Search for attribute value.
static Comparator<UserModel>	UserModel.COMPARE_BY_USERNAME
static SearchableModelField<UserModel>	UserModel.SearchableFields.CONSENT_CLIENT_FEDERATION_LINK	Search for users that have consent set for a particular client that originates in the given client provider.
static SearchableModelField<UserModel>	UserModel.SearchableFields.CONSENT_FOR_CLIENT	Search for users that have consent set for a particular client.
static SearchableModelField<UserModel>	UserModel.SearchableFields.CONSENT_WITH_CLIENT_SCOPE	Search for users that have consent that has given client scope.
static SearchableModelField<UserModel>	UserModel.SearchableFields.EMAIL
static SearchableModelField<UserModel>	UserModel.SearchableFields.EMAIL_VERIFIED
static SearchableModelField<UserModel>	UserModel.SearchableFields.ENABLED
static SearchableModelField<UserModel>	UserModel.SearchableFields.FEDERATION_LINK
static SearchableModelField<UserModel>	UserModel.SearchableFields.FIRST_NAME
static SearchableModelField<UserModel>	UserModel.SearchableFields.ID
static SearchableModelField<UserModel>	UserModel.SearchableFields.IDP_AND_USER	This field can only searched either for users coming from an IDP, then the operand is (idp_alias), or as user coming from a particular IDP with given username there, then the operand is a pair (idp_alias, idp_user_id).
static SearchableModelField<UserModel>	UserModel.SearchableFields.LAST_NAME
static SearchableModelField<UserModel>	UserModel.SearchableFields.REALM_ID
static SearchableModelField<UserModel>	UserModel.SearchableFields.SERVICE_ACCOUNT_CLIENT	ID of the client corresponding to the service account
static SearchableModelField<UserModel>	UserModel.SearchableFields.USERNAME	Search for user's username in case sensitive mode.
static SearchableModelField<UserModel>	UserModel.SearchableFields.USERNAME_CASE_INSENSITIVE	Search for user's username in case insensitive mode.

Methods in org.keycloak.models that return UserModel

Modifier and Type	Method	Description
UserModel	UserProvider.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)	Adds a new user into the storage.
UserModel	CredentialValidationOutput.getAuthenticatedUser()
UserModel	UserProvider.getServiceAccount(ClientModel client)	Return a UserModel representing service account of the client
UserModel	UserModel.UserRemovedEvent.getUser()
UserModel	UserSessionModel.getUser()
UserModel	UserProvider.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)	Returns a userModel that corresponds to the given socialLink.

Methods in org.keycloak.models that return types with arguments of type UserModel

Modifier and Type	Method	Description
default Stream<UserModel>	UserProvider.getUsersStream(RealmModel realm, boolean includeServiceAccounts)	Deprecated. Use UserQueryProvider.searchForUserStream(RealmModel, Map) with INCLUDE_SERVICE_ACCOUNT within params instead.
default Stream<UserModel>	UserProvider.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults, boolean includeServiceAccounts)	Deprecated. Use UserQueryProvider.searchForUserStream(RealmModel, Map, Integer, Integer) with INCLUDE_SERVICE_ACCOUNT within params

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

Modifier and Type	Method	Description
void	UserProvider.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)	Adds a federated identity link for the user within the realm
CredentialModel	UserCredentialManager.createCredentialThroughProvider(RealmModel realm, UserModel user, CredentialModel model)	Deprecated. Creates a credential from the credentialModel, by looping through the providers to find a match for the type
UserSessionModel	UserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)
UserSessionModel	UserSessionProvider.createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
void	UserCredentialManager.disableCredentialType(RealmModel realm, UserModel user, String credentialType)	Deprecated. Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.
default Stream<String>	UserCredentialManager.getConfiguredUserStorageCredentialTypesStream(RealmModel realm, UserModel user)	Deprecated. Use credentialManager() and then call SubjectCredentialManager.getConfiguredUserStorageCredentialTypesStream()
default Stream<String>	UserCredentialManager.getDisableableCredentialTypesStream(RealmModel realm, UserModel user)	Deprecated. Use credentialManager() and then call SubjectCredentialManager.getDisableableCredentialTypesStream()
Stream<FederatedIdentityModel>	UserProvider.getFederatedIdentitiesStream(RealmModel realm, UserModel user)	Obtains the federated identities of the specified user.
FederatedIdentityModel	UserProvider.getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)	Returns details of the association between the user and the socialProvider.
String	OTPPolicy.getKeyURI(RealmModel realm, UserModel user, String secret)	Constructs the otpauth:// URI based on the Key-Uri-Format.
int	UserProvider.getNotBeforeOfUser(RealmModel realm, UserModel user)	Gets the notBefore value for the given user
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user)	Obtains the offline user sessions associated with the specified user.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user)	Obtains the online user sessions associated with the specified user.
LogoutToken	TokenManager.initLogoutToken(ClientModel client, UserModel user, AuthenticatedClientSessionModel clientSessionModel)
boolean	UserCredentialManager.isConfiguredFor(RealmModel realm, UserModel user, String type)	Deprecated. Checks to see if user has credential type configured.
boolean	UserCredentialManager.isConfiguredLocally(RealmModel realm, UserModel user, String type)	Deprecated. Only loops through each CredentialProvider to see if credential type is configured for the user.
boolean	UserCredentialManager.isValid(RealmModel realm, UserModel user, List<CredentialInput> inputs)	Deprecated. Validates list of credentials.
boolean	UserCredentialManager.isValid(RealmModel realm, UserModel user, CredentialInput... inputs)	Deprecated. Validates list of credentials.
boolean	UserProvider.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)	Removes federation link between the user and the identity provider given by its id
boolean	UserManager.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	UserSessionModel.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
void	UserProvider.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore)	Sets the notBefore value for the given user
boolean	UserCredentialManager.updateCredential(RealmModel realm, UserModel user, CredentialInput input)	Deprecated. Updates a credential.
void	UserCredentialManager.updateCredentialLabel(RealmModel realm, UserModel user, String credentialId, String userLabel)	Deprecated. Updates the credential label and invalidates the cache for the user.
void	UserProvider.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)	Update details of association between the federatedUser and the idp given by the federatedIdentityModel

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

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

Uses of UserModel in org.keycloak.models.utils

Classes in org.keycloak.models.utils that implement UserModel

Modifier and Type	Class	Description
class	UserModelDelegate	Delegation pattern.

Fields in org.keycloak.models.utils declared as UserModel

Modifier and Type	Field	Description
protected UserModel	UserModelDelegate.delegate

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

Modifier and Type	Method	Description
UserModel	UserModelDelegate.getDelegate()

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

Modifier and Type	Method	Description
static Set<RoleModel>	RoleUtils.getDeepUserRoleMappings(UserModel user)

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

Constructor	Description
UserModelDelegate(UserModel delegate)

Uses of UserModel in org.keycloak.policy

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

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

Uses of UserModel in org.keycloak.sessions

Methods in org.keycloak.sessions that return UserModel

Modifier and Type	Method	Description
UserModel	AuthenticationSessionModel.getAuthenticatedUser()	Returns authenticated user that is associated to the authentication session.

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

Modifier and Type	Method	Description
void	AuthenticationSessionModel.setAuthenticatedUser(UserModel user)	Sets authenticated user that is associated to the authentication session.

Uses of UserModel in org.keycloak.storage

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

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

Uses of UserModel in org.keycloak.storage.user

Methods in org.keycloak.storage.user that return UserModel

Modifier and Type	Method	Description
UserModel	UserRegistrationProvider.addUser(RealmModel realm, String username)	All storage providers that implement this interface will be looped through.
UserModel	UserLookupProvider.getUserByEmail(RealmModel realm, String email)	Returns a user with the given email belonging to the realm
UserModel	UserLookupProvider.getUserById(RealmModel realm, String id)	Returns a user with the given id belonging to the realm
UserModel	UserLookupProvider.getUserByUsername(RealmModel realm, String username)	Exact search for a user by its username.

Methods in org.keycloak.storage.user that return types with arguments of type UserModel

Modifier and Type	Method	Description
default Stream<UserModel>	UserQueryProvider.getGroupMembersStream(RealmModel realm, GroupModel group)	Obtains users that belong to a specific group.
Stream<UserModel>	UserQueryProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)	Obtains users that belong to a specific group.
default Stream<UserModel>	UserQueryProvider.getRoleMembersStream(RealmModel realm, RoleModel role)	Obtains users that have the specified role.
default Stream<UserModel>	UserQueryProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)	Searches for users that have the specified role.
default Stream<UserModel>	UserQueryProvider.getUsersStream(RealmModel realm)	Deprecated. Use UserQueryProvider.searchForUserStream(RealmModel, Map) with an empty params map instead.
default Stream<UserModel>	UserQueryProvider.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults)	Deprecated. Use UserQueryProvider.searchForUserStream(RealmModel, Map, Integer, Integer) with an empty params map instead.
Stream<UserModel>	UserQueryProvider.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue)	Searches for users that have a specific attribute with a specific value.
default Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, String search)	Searches for users whose username, email, first name or last name contain any of the strings in search separated by whitespace.
Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)	Searches for users whose username, email, first name or last name contain any of the strings in search separated by whitespace.
default Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, Map<String,String> params)	Searches for user by parameter.
Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, Map<String,String> params, Integer firstResult, Integer maxResults)	Searches for user by parameter.

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

Modifier and Type	Method	Description
boolean	UserRegistrationProvider.removeUser(RealmModel realm, UserModel user)	Called if user originated from this provider.

Method parameters in org.keycloak.storage.user with type arguments of type UserModel

Modifier and Type	Method	Description
static int	UserQueryProvider.countUsersInGroups(Stream<UserModel> users, Set<String> groupIds)	Returns the number of users from the given list of users that are in at least one of the groups given in the groups set.