public interface UserLookupProvider
UserStorageProvider
that supports basic user querying. You must
implement this interface if you want to be able to log in to keycloak using users from your storage.
Note that all methods in this interface should limit search only to data available within the storage that is
represented by this provider. They should not lookup other storage providers for additional information.
Optional capability interface implemented by UserStorageProviders.Modifier and Type | Interface and Description |
---|---|
static interface |
UserLookupProvider.Streams |
Modifier and Type | Method and Description |
---|---|
default UserModel |
getUserByEmail(RealmModel realm,
String email)
Returns a user with the given email belonging to the realm
|
UserModel |
getUserByEmail(String email,
RealmModel realm)
Deprecated.
Use
getUserByEmail instead. |
default UserModel |
getUserById(RealmModel realm,
String id)
Returns a user with the given id belonging to the realm
|
UserModel |
getUserById(String id,
RealmModel realm)
Deprecated.
Use
getUserById instead. |
default UserModel |
getUserByUsername(RealmModel realm,
String username)
Returns a user with the given username belonging to the realm
|
UserModel |
getUserByUsername(String username,
RealmModel realm)
Deprecated.
Use
getUserByUsername instead. |
default UserModel getUserById(RealmModel realm, String id)
id
- id of the userrealm
- the realm modelnull
if no such user exists@Deprecated UserModel getUserById(String id, RealmModel realm)
getUserById
instead.default UserModel getUserByUsername(RealmModel realm, String username)
username
- case insensitive username (case-sensitivity is controlled by storage)realm
- the realm modelnull
if no such user exists@Deprecated UserModel getUserByUsername(String username, RealmModel realm)
getUserByUsername
instead.default UserModel getUserByEmail(RealmModel realm, String email)
email
- case insensitive email address (case-sensitivity is controlled by storage)realm
- the realm modelnull
if no such user existsModelDuplicateException
- when there are more users with same email@Deprecated UserModel getUserByEmail(String email, RealmModel realm)
getUserByEmail
instead.Copyright © 2021 JBoss by Red Hat. All rights reserved.