org.keycloak.admin.client.resource

Interface UsersResource

public interface UsersResource

Method Summary

Modifier and Type	Method and Description
Integer	count()
javax.ws.rs.core.Response	create(UserRepresentation userRepresentation)
javax.ws.rs.core.Response	delete(String id)
UserResource	get(String id)
List<UserRepresentation>	list()
List<UserRepresentation>	list(Integer firstResult, Integer maxResults)
List<UserRepresentation>	search(String username)
List<UserRepresentation>	search(String search, Integer firstResult, Integer maxResults) Search for users whose username or email matches the value provided by search.
List<UserRepresentation>	search(String username, String firstName, String lastName, String email, Integer firstResult, Integer maxResults)

Method Detail

search

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

search

@GET
 @Produces(value="application/json")
List<UserRepresentation> search(@QueryParam(value="username")
                                                                          String username)

search

@GET
 @Produces(value="application/json")
List<UserRepresentation> search(@QueryParam(value="search")
                                                                          String search,
                                                                          @QueryParam(value="first")
                                                                          Integer firstResult,
                                                                          @QueryParam(value="max")
                                                                          Integer maxResults)

Search for users whose username or email matches the value provided by search. The search argument also allows finding users by specific attributes as follows:

• id: - Find users by identifier. For instance, id:aa497859-bbf5-44ac-bf1a-74dbffcaf197

Parameters:

search - the value to search. It can be the username, email or any of the supported options to query based on user attributes

firstResult - the position of the first result to retrieve

maxResults - the maximum number of results to retreive

Returns:

a list of UserRepresentation

list

@GET
 @Produces(value="application/json")
List<UserRepresentation> list(@QueryParam(value="first")
                                                                        Integer firstResult,
                                                                        @QueryParam(value="max")
                                                                        Integer maxResults)

list

@GET
 @Produces(value="application/json")
List<UserRepresentation> list()

create

@POST
 @Consumes(value="application/json")
javax.ws.rs.core.Response create(UserRepresentation userRepresentation)

count

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

get

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

delete

@Path(value="{id}")
 @DELETE
javax.ws.rs.core.Response delete(@PathParam(value="id")
                                                              String id)