Package org.gcube.service.idm.controller

Class KCUserController

java.lang.Object

org.gcube.service.idm.controller.KCUserController

public class KCUserController
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KCUserController.REPR

Field Summary

Fields

Modifier and Type	Field	Description
static String	MEMBER_ROLE_NAME

Constructor Summary

Constructors

Constructor	Description
KCUserController()

Method Summary

Modifier and Type	Method	Description
static List<org.keycloak.representations.idm.ClientRepresentation>	clients()
static List<org.keycloak.representations.idm.UserRepresentation>	contextUsers(Integer firstResult, Integer maxResults)
static Object	formatList(List<org.keycloak.representations.idm.UserRepresentation> users, KCUserController.REPR format)
static Object	formatRepr(org.keycloak.representations.idm.UserRepresentation user, KCUserController.REPR format)
static org.keycloak.representations.idm.UserRepresentation	getUserByEmail(String email)
static org.keycloak.representations.idm.UserRepresentation	getUserById(String username)
static org.keycloak.representations.idm.UserRepresentation	getUserByUsername(String username)
static Object	getUserParameter(String username, String parameter)
static org.keycloak.admin.client.resource.UserResource	getUserResourceByUsername(String username)
static List<org.keycloak.representations.idm.UserRepresentation>	realmUser(Integer firstResult, Integer maxResults)
static org.keycloak.admin.client.resource.UsersResource	realmUsersResource()
static List<org.keycloak.representations.idm.UserRepresentation>	search(String username, String firstName, String lastName, String email, Boolean emailVerified, String idpAlias, String idpUserId, Integer firstResult, Integer maxResults, Boolean enabled, Boolean briefRepresentation)	Search for users based on the given filters.
static List<org.keycloak.representations.idm.UserRepresentation>	searchUsersByRole(String roleName, Integer firstResult, Integer maxResults)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MEMBER_ROLE_NAME

public static String MEMBER_ROLE_NAME

Constructor Detail

KCUserController

public KCUserController()

Method Detail

realmUsersResource

public static org.keycloak.admin.client.resource.UsersResource realmUsersResource()

realmUser

public static List<org.keycloak.representations.idm.UserRepresentation> realmUser(Integer firstResult,
                                                                                  Integer maxResults)

contextUsers

public static List<org.keycloak.representations.idm.UserRepresentation> contextUsers(Integer firstResult,
                                                                                     Integer maxResults)

formatRepr

public static Object formatRepr(org.keycloak.representations.idm.UserRepresentation user,
                                KCUserController.REPR format)

formatList

public static Object formatList(List<org.keycloak.representations.idm.UserRepresentation> users,
                                KCUserController.REPR format)

search

public static List<org.keycloak.representations.idm.UserRepresentation> search(String username,
                                                                               String firstName,
                                                                               String lastName,
                                                                               String email,
                                                                               Boolean emailVerified,
                                                                               String idpAlias,
                                                                               String idpUserId,
                                                                               Integer firstResult,
                                                                               Integer maxResults,
                                                                               Boolean enabled,
                                                                               Boolean briefRepresentation)

Search for users based on the given filters.

Parameters:

username - a value contained in username

firstName - a value contained in first name

lastName - a value contained in last name

email - a value contained in email

emailVerified - whether the email has been verified

idpAlias - the alias of the Identity Provider

idpUserId - the userId at the Identity Provider

firstResult - the position of the first result to retrieve

maxResults - the maximum number of results to retrieve

enabled - only return enabled or disabled users

briefRepresentation - Only return basic information (only guaranteed to return id, username, created, first and last name, email, enabled state, email verification state, federation link, and access. Note that it means that namely user attributes, required actions, and not before are not returned.)

Returns:

a list of UserRepresentation

getUserByEmail

public static org.keycloak.representations.idm.UserRepresentation getUserByEmail(String email)

getUserById

public static org.keycloak.representations.idm.UserRepresentation getUserById(String username)

getUserByUsername

public static org.keycloak.representations.idm.UserRepresentation getUserByUsername(String username)

getUserResourceByUsername

public static org.keycloak.admin.client.resource.UserResource getUserResourceByUsername(String username)

searchUsersByRole

public static List<org.keycloak.representations.idm.UserRepresentation> searchUsersByRole(String roleName,
                                                                                          Integer firstResult,
                                                                                          Integer maxResults)

clients

public static List<org.keycloak.representations.idm.ClientRepresentation> clients()

getUserParameter

public static Object getUserParameter(String username,
                                      String parameter)