org.keycloak.models

Interface UserProvider

All Superinterfaces:

Provider

All Known Subinterfaces:

CacheUserProvider

All Known Implementing Classes:

UserFederationManager

public interface UserProvider
extends Provider

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
void	addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)
UserModel	addUser(RealmModel realm, String username)
UserModel	addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
void	close()
Set<FederatedIdentityModel>	getFederatedIdentities(UserModel user, RealmModel realm)
FederatedIdentityModel	getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)
List<UserModel>	getGroupMembers(RealmModel realm, GroupModel group)
List<UserModel>	getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
UserModel	getUserByEmail(String email, RealmModel realm)
UserModel	getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)
UserModel	getUserById(String id, RealmModel realm)
UserModel	getUserByServiceAccountClient(ClientModel client)
UserModel	getUserByUsername(String username, RealmModel realm)
List<UserModel>	getUsers(RealmModel realm, boolean includeServiceAccounts)
List<UserModel>	getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)
int	getUsersCount(RealmModel realm)
void	grantToAllUsers(RealmModel realm, RoleModel role)
void	preRemove(ProtocolMapperModel protocolMapper)
void	preRemove(RealmModel realm)
void	preRemove(RealmModel realm, ClientModel client)
void	preRemove(RealmModel realm, GroupModel group)
void	preRemove(RealmModel realm, RoleModel role)
void	preRemove(RealmModel realm, UserFederationProviderModel link)
boolean	removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)
boolean	removeUser(RealmModel realm, UserModel user)
List<UserModel>	searchForUser(String search, RealmModel realm)
List<UserModel>	searchForUser(String search, RealmModel realm, int firstResult, int maxResults)
List<UserModel>	searchForUserByAttributes(Map<String,String> attributes, RealmModel realm)
List<UserModel>	searchForUserByAttributes(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)
List<UserModel>	searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)
void	updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)
CredentialValidationOutput	validCredentials(KeycloakSession session, RealmModel realm, UserCredentialModel... input)
boolean	validCredentials(KeycloakSession session, RealmModel realm, UserModel user, List<UserCredentialModel> input)
boolean	validCredentials(KeycloakSession session, RealmModel realm, UserModel user, UserCredentialModel... input)

Method Detail

addUser

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

addUser

UserModel addUser(RealmModel realm,
                  String username)

removeUser

boolean removeUser(RealmModel realm,
                   UserModel user)

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)

getUserById

UserModel getUserById(String id,
                      RealmModel realm)

getUserByUsername

UserModel getUserByUsername(String username,
                            RealmModel realm)

getUserByEmail

UserModel getUserByEmail(String email,
                         RealmModel realm)

getGroupMembers

List<UserModel> getGroupMembers(RealmModel realm,
                                GroupModel group,
                                int firstResult,
                                int maxResults)

getUserByFederatedIdentity

UserModel getUserByFederatedIdentity(FederatedIdentityModel socialLink,
                                     RealmModel realm)

getUserByServiceAccountClient

UserModel getUserByServiceAccountClient(ClientModel client)

getUsers

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

getUsersCount

int getUsersCount(RealmModel realm)

getGroupMembers

List<UserModel> getGroupMembers(RealmModel realm,
                                GroupModel group)

getUsers

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

searchForUser

List<UserModel> searchForUser(String search,
                              RealmModel realm)

searchForUser

List<UserModel> searchForUser(String search,
                              RealmModel realm,
                              int firstResult,
                              int maxResults)

searchForUserByAttributes

List<UserModel> searchForUserByAttributes(Map<String,String> attributes,
                                          RealmModel realm)

searchForUserByAttributes

List<UserModel> searchForUserByAttributes(Map<String,String> attributes,
                                          RealmModel realm,
                                          int firstResult,
                                          int maxResults)

searchForUserByUserAttribute

List<UserModel> searchForUserByUserAttribute(String attrName,
                                             String attrValue,
                                             RealmModel realm)

getFederatedIdentities

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

getFederatedIdentity

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

grantToAllUsers

void grantToAllUsers(RealmModel realm,
                     RoleModel role)

preRemove

void preRemove(RealmModel realm)

preRemove

void preRemove(RealmModel realm,
               UserFederationProviderModel link)

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)

validCredentials

boolean validCredentials(KeycloakSession session,
                         RealmModel realm,
                         UserModel user,
                         List<UserCredentialModel> input)

validCredentials

boolean validCredentials(KeycloakSession session,
                         RealmModel realm,
                         UserModel user,
                         UserCredentialModel... input)

validCredentials

CredentialValidationOutput validCredentials(KeycloakSession session,
                                            RealmModel realm,
                                            UserCredentialModel... input)

close

void close()

Specified by:

close in interface Provider