org.keycloak.services.resources.admin

Class UsersResource

java.lang.Object

org.keycloak.services.resources.admin.UsersResource

public class UsersResource
extends Object

Base resource for managing users

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected org.keycloak.common.ClientConnection	clientConnection
protected javax.ws.rs.core.HttpHeaders	headers
protected RealmModel	realm
protected KeycloakSession	session
protected javax.ws.rs.core.UriInfo	uriInfo

Constructor Summary

Constructors

Constructor and Description
UsersResource(RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createUser(javax.ws.rs.core.UriInfo uriInfo, UserRepresentation rep) Create a new user Username must be unique.
List<UserRepresentation>	getUsers(String search, String last, String first, String email, String username, Integer firstResult, Integer maxResults) Get users Returns a list of users, filtered according to query parameters
Integer	getUsersCount()
UserResource	user(String id) Get representation of the user

Methods inherited from class java.lang.Object

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

Field Detail

realm

protected RealmModel realm

clientConnection

@Context
protected org.keycloak.common.ClientConnection clientConnection

uriInfo

@Context
protected javax.ws.rs.core.UriInfo uriInfo

session

@Context
protected KeycloakSession session

headers

@Context
protected javax.ws.rs.core.HttpHeaders headers

Constructor Detail

UsersResource

public UsersResource(RealmModel realm,
                     AdminPermissionEvaluator auth,
                     AdminEventBuilder adminEvent)

Method Detail

createUser

@POST
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createUser(@Context
                                                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                                                       UserRepresentation rep)

Create a new user Username must be unique.

Parameters:

uriInfo -

rep -

Returns:

user

@Path(value="{id}")
public UserResource user(@PathParam(value="id")
                                             String id)

Get representation of the user

Parameters:

id - User id

Returns:

getUsers

@GET
 @Produces(value="application/json")
public List<UserRepresentation> getUsers(@QueryParam(value="search")
                                                                                   String search,
                                                                                   @QueryParam(value="lastName")
                                                                                   String last,
                                                                                   @QueryParam(value="firstName")
                                                                                   String first,
                                                                                   @QueryParam(value="email")
                                                                                   String email,
                                                                                   @QueryParam(value="username")
                                                                                   String username,
                                                                                   @QueryParam(value="first")
                                                                                   Integer firstResult,
                                                                                   @QueryParam(value="max")
                                                                                   Integer maxResults)

Get users Returns a list of users, filtered according to query parameters

Parameters:

search - A String contained in username, first or last name, or email

last -

first -

email -

username -

first - Pagination offset

maxResults - Maximum results size (defaults to 100)

Returns:

getUsersCount

@Path(value="count")
 @GET
 @Produces(value="application/json")
public Integer getUsersCount()