org.keycloak.storage.user

Interface UserQueryProvider

All Known Subinterfaces:

UserCache, UserProvider

public interface UserQueryProvider

Optional capability interface implemented by UserStorageProviders. Defines complex queries that are used to locate one or more users. You must implement this interface if you want to view and manager users from the administration console.

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
List<UserModel>	getGroupMembers(RealmModel realm, GroupModel group) Get users that belong to a specific group.
List<UserModel>	getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults) Get users that belong to a specific group.
default List<UserModel>	getRoleMembers(RealmModel realm, RoleModel role) Get users that belong to a specific role.
default List<UserModel>	getRoleMembers(RealmModel realm, RoleModel role, int firstResult, int maxResults) Search for users that have a specific role with a specific roleId.
List<UserModel>	getUsers(RealmModel realm)
List<UserModel>	getUsers(RealmModel realm, int firstResult, int maxResults)
int	getUsersCount(RealmModel realm) Returns the number of users, without consider any service account.
default int	getUsersCount(RealmModel realm, boolean includeServiceAccount) Returns the number of users.
List<UserModel>	searchForUser(Map<String,String> params, RealmModel realm) Search for user by parameter.
List<UserModel>	searchForUser(Map<String,String> params, RealmModel realm, int firstResult, int maxResults) Search for user by parameter.
List<UserModel>	searchForUser(String search, RealmModel realm) Search for users with username, email or first + last name that is like search string.
List<UserModel>	searchForUser(String search, RealmModel realm, int firstResult, int maxResults) Search for users with username, email or first + last name that is like search string.
List<UserModel>	searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm) Search for users that have a specific attribute with a specific value.

Method Detail

getUsersCount

int getUsersCount(RealmModel realm)

Returns the number of users, without consider any service account.

Parameters:

realm - the realm

Returns:

the number of users

getUsersCount

default int getUsersCount(RealmModel realm,
                          boolean includeServiceAccount)

Returns the number of users.

Parameters:

realm - the realm

includeServiceAccount - if true, the number of users will also include service accounts. Otherwise, only the number of users.

Returns:

the number of users

getUsers

List<UserModel> getUsers(RealmModel realm)

getUsers

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

searchForUser

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

Search for users with username, email or first + last name that is like search string. If possible, implementations should treat the parameter values as partial match patterns i.e. in RDMBS terms use LIKE. This method is used by the admin console search box

Parameters:

search -

realm -

Returns:

searchForUser

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

Search for users with username, email or first + last name that is like search string. If possible, implementations should treat the parameter values as partial match patterns i.e. in RDMBS terms use LIKE. This method is used by the admin console search box

Parameters:

search -

realm -

firstResult -

maxResults -

Returns:

searchForUser

List<UserModel> searchForUser(Map<String,String> params,
                              RealmModel realm)

Search for user by parameter. Valid parameters are: "first" - first name "last" - last name "email" - email "username" - username If possible, implementations should treat the parameter values as partial match patterns i.e. in RDMBS terms use LIKE. This method is used by the REST API when querying users.

Parameters:

params -

realm -

Returns:

searchForUser

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

Search for user by parameter. Valid parameters are: "first" - first name "last" - last name "email" - email "username" - username If possible, implementations should treat the parameter values as patterns i.e. in RDMBS terms use LIKE. This method is used by the REST API when querying users.

Parameters:

params -

realm -

firstResult -

maxResults -

Returns:

getGroupMembers

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

Get users that belong to a specific group. Implementations do not have to search in UserFederatedStorageProvider as this is done automatically.

Parameters:

realm -

group -

firstResult -

maxResults -

Returns:

See Also:

UserFederatedStorageProvider

getRoleMembers

default List<UserModel> getRoleMembers(RealmModel realm,
                                       RoleModel role)

Get users that belong to a specific role.

Parameters:

realm -

role -

Returns:

getRoleMembers

default List<UserModel> getRoleMembers(RealmModel realm,
                                       RoleModel role,
                                       int firstResult,
                                       int maxResults)

Search for users that have a specific role with a specific roleId.

Parameters:

firstResult -

maxResults -

role -

Returns:

getGroupMembers

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

Get users that belong to a specific group. Implementations do not have to search in UserFederatedStorageProvider as this is done automatically.

Parameters:

realm -

group -

Returns:

See Also:

UserFederatedStorageProvider

searchForUserByUserAttribute

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

Search for users that have a specific attribute with a specific value. Implementations do not have to search in UserFederatedStorageProvider as this is done automatically.

Parameters:

attrName -

attrValue -

realm -

Returns:

See Also:

UserFederatedStorageProvider