org.keycloak.models

Interface UserProvider

All Superinterfaces:

Provider, UserBulkUpdateProvider, UserLookupProvider, UserQueryProvider, UserRegistrationProvider

All Known Subinterfaces:

UserCache

public interface UserProvider
extends Provider, UserLookupProvider, UserQueryProvider, UserRegistrationProvider, UserBulkUpdateProvider

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
void	addConsent(RealmModel realm, String userId, UserConsentModel consent)
void	addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)
UserModel	addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) only used for local storage
void	close()
UserConsentModel	getConsentByClient(RealmModel realm, String userId, String clientInternalId)
List<UserConsentModel>	getConsents(RealmModel realm, String userId)
Set<FederatedIdentityModel>	getFederatedIdentities(UserModel user, RealmModel realm)
FederatedIdentityModel	getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)
int	getNotBeforeOfUser(RealmModel realm, UserModel user)
UserModel	getServiceAccount(ClientModel client)
UserModel	getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)
List<UserModel>	getUsers(RealmModel realm, boolean includeServiceAccounts)
List<UserModel>	getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)
void	preRemove(ClientScopeModel clientScope)
void	preRemove(ProtocolMapperModel protocolMapper)
void	preRemove(RealmModel realm)
void	preRemove(RealmModel realm, ClientModel client)
void	preRemove(RealmModel realm, ComponentModel component)
void	preRemove(RealmModel realm, GroupModel group)
void	preRemove(RealmModel realm, RoleModel role)
boolean	removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)
void	removeImportedUsers(RealmModel realm, String storageProviderId) Removes any imported users from a specific User Storage Provider.
boolean	revokeConsentForClient(RealmModel realm, String userId, String clientInternalId)
void	setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore)
void	unlinkUsers(RealmModel realm, String storageProviderId) Set federation link to null to imported users of a specific User Storage Provider
void	updateConsent(RealmModel realm, String userId, UserConsentModel consent)
void	updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)

Methods inherited from interface org.keycloak.storage.user.UserLookupProvider

getUserByEmail, getUserById, getUserByUsername

Methods inherited from interface org.keycloak.storage.user.UserQueryProvider

getGroupMembers, getGroupMembers, getRoleMembers, getRoleMembers, getUsers, getUsers, getUsersCount, getUsersCount, searchForUser, searchForUser, searchForUser, searchForUser, searchForUserByUserAttribute

Methods inherited from interface org.keycloak.storage.user.UserRegistrationProvider

addUser, removeUser

Methods inherited from interface org.keycloak.storage.user.UserBulkUpdateProvider

grantToAllUsers

Method Detail

addFederatedIdentity

void addFederatedIdentity(RealmModel realm,
                          UserModel user,
                          FederatedIdentityModel socialLink)

removeFederatedIdentity

boolean removeFederatedIdentity(RealmModel realm,
                                UserModel user,
                                String socialProvider)

updateFederatedIdentity

void updateFederatedIdentity(RealmModel realm,
                             UserModel federatedUser,
                             FederatedIdentityModel federatedIdentityModel)

getFederatedIdentities

Set<FederatedIdentityModel> getFederatedIdentities(UserModel user,
                                                   RealmModel realm)

getFederatedIdentity

FederatedIdentityModel getFederatedIdentity(UserModel user,
                                            String socialProvider,
                                            RealmModel realm)

getUserByFederatedIdentity

UserModel getUserByFederatedIdentity(FederatedIdentityModel socialLink,
                                     RealmModel realm)

addConsent

void addConsent(RealmModel realm,
                String userId,
                UserConsentModel consent)

getConsentByClient

UserConsentModel getConsentByClient(RealmModel realm,
                                    String userId,
                                    String clientInternalId)

getConsents

List<UserConsentModel> getConsents(RealmModel realm,
                                   String userId)

updateConsent

void updateConsent(RealmModel realm,
                   String userId,
                   UserConsentModel consent)

revokeConsentForClient

boolean revokeConsentForClient(RealmModel realm,
                               String userId,
                               String clientInternalId)

setNotBeforeForUser

void setNotBeforeForUser(RealmModel realm,
                         UserModel user,
                         int notBefore)

getNotBeforeOfUser

int getNotBeforeOfUser(RealmModel realm,
                       UserModel user)

getServiceAccount

UserModel getServiceAccount(ClientModel client)

getUsers

List<UserModel> getUsers(RealmModel realm,
                         boolean includeServiceAccounts)

getUsers

List<UserModel> getUsers(RealmModel realm,
                         int firstResult,
                         int maxResults,
                         boolean includeServiceAccounts)

addUser

UserModel addUser(RealmModel realm,
                  String id,
                  String username,
                  boolean addDefaultRoles,
                  boolean addDefaultRequiredActions)

only used for local storage

Parameters:

realm -

id -

username -

addDefaultRoles -

addDefaultRequiredActions -

Returns:

preRemove

void preRemove(RealmModel realm)

removeImportedUsers

void removeImportedUsers(RealmModel realm,
                         String storageProviderId)

Removes any imported users from a specific User Storage Provider.

Parameters:

realm -

storageProviderId -

unlinkUsers

void unlinkUsers(RealmModel realm,
                 String storageProviderId)

Set federation link to null to imported users of a specific User Storage Provider

Parameters:

realm -

storageProviderId -

preRemove

void preRemove(RealmModel realm,
               RoleModel role)

preRemove

void preRemove(RealmModel realm,
               GroupModel group)

preRemove

void preRemove(RealmModel realm,
               ClientModel client)

preRemove

void preRemove(ProtocolMapperModel protocolMapper)

preRemove

void preRemove(ClientScopeModel clientScope)

close

void close()

Specified by:

close in interface Provider

preRemove

void preRemove(RealmModel realm,
               ComponentModel component)