public interface UsersResource
| Modifier and Type | Method and Description |
|---|---|
Integer |
count()
Returns the number of users that can be viewed.
|
Integer |
count(String search)
Returns the number of users that can be viewed and match the given search criteria.
|
Integer |
count(String last,
String first,
String email,
Boolean emailVerified,
String username)
Returns the number of users that can be viewed and match the given filters.
|
Integer |
count(String last,
String first,
String email,
String username)
Returns the number of users that can be viewed and match the given filters.
|
Integer |
countEmailVerified(Boolean emailVerified)
Returns the number of users with the given status for emailVerified.
|
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(Boolean emailVerified,
Integer firstResult,
Integer maxResults,
Boolean enabled,
Boolean briefRepresentation) |
List<UserRepresentation> |
search(String username) |
List<UserRepresentation> |
search(String username,
Boolean exact) |
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 search,
Integer firstResult,
Integer maxResults,
Boolean briefRepresentation)
Search for users whose username or email matches the value provided by
search. |
List<UserRepresentation> |
search(String username,
String firstName,
String lastName,
String email,
Boolean emailVerified,
Integer firstResult,
Integer maxResults,
Boolean enabled,
Boolean briefRepresentation) |
List<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.
|
List<UserRepresentation> |
search(String username,
String firstName,
String lastName,
String email,
Integer firstResult,
Integer maxResults) |
List<UserRepresentation> |
search(String username,
String firstName,
String lastName,
String email,
Integer firstResult,
Integer maxResults,
Boolean enabled,
Boolean briefRepresentation) |
UserProfileResource |
userProfile() |
@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)
@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, @QueryParam(value="enabled") Boolean enabled, @QueryParam(value="briefRepresentation") Boolean briefRepresentation)
@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="emailVerified") Boolean emailVerified, @QueryParam(value="idpAlias") String idpAlias, @QueryParam(value="idpUserId") String idpUserId, @QueryParam(value="first") Integer firstResult, @QueryParam(value="max") Integer maxResults, @QueryParam(value="enabled") Boolean enabled, @QueryParam(value="briefRepresentation") Boolean briefRepresentation)
username - a value contained in usernamefirstName - a value contained in first namelastName - a value contained in last nameemail - a value contained in emailemailVerified - whether the email has been verifiedidpAlias - the alias of the Identity ProvideridpUserId - the userId at the Identity ProviderfirstResult - the position of the first result to retrievemaxResults - the maximum number of results to retrieveenabled - only return enabled or disabled usersbriefRepresentation - 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.)UserRepresentation@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="emailVerified") Boolean emailVerified, @QueryParam(value="first") Integer firstResult, @QueryParam(value="max") Integer maxResults, @QueryParam(value="enabled") Boolean enabled, @QueryParam(value="briefRepresentation") Boolean briefRepresentation)
@GET @Produces(value="application/json") List<UserRepresentation> search(@QueryParam(value="emailVerified") Boolean emailVerified, @QueryParam(value="first") Integer firstResult, @QueryParam(value="max") Integer maxResults, @QueryParam(value="enabled") Boolean enabled, @QueryParam(value="briefRepresentation") Boolean briefRepresentation)
@GET @Produces(value="application/json") List<UserRepresentation> search(@QueryParam(value="username") String username)
@GET @Produces(value="application/json") List<UserRepresentation> search(@QueryParam(value="username") String username, @QueryParam(value="exact") Boolean exact)
@GET @Produces(value="application/json") List<UserRepresentation> search(@QueryParam(value="search") String search, @QueryParam(value="first") Integer firstResult, @QueryParam(value="max") Integer maxResults)
search. The search
argument also allows finding users by specific attributes as follows:
search - the value to search. It can be the username, email or any of the supported options to query based on user attributesfirstResult - the position of the first result to retrievemaxResults - the maximum number of results to retreiveUserRepresentation@GET @Produces(value="application/json") List<UserRepresentation> search(@QueryParam(value="search") String search, @QueryParam(value="first") Integer firstResult, @QueryParam(value="max") Integer maxResults, @QueryParam(value="briefRepresentation") Boolean briefRepresentation)
search. The search
argument also allows finding users by specific attributes as follows:
search - the value to search. It can be the username, email or any of the supported options to query based on user attributesfirstResult - the position of the first result to retrievemaxResults - the maximum number of results to retreivebriefRepresentation - 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.)UserRepresentation@GET @Produces(value="application/json") List<UserRepresentation> list(@QueryParam(value="first") Integer firstResult, @QueryParam(value="max") Integer maxResults)
@GET @Produces(value="application/json") List<UserRepresentation> list()
@POST @Consumes(value="application/json") javax.ws.rs.core.Response create(UserRepresentation userRepresentation)
@Path(value="count") @GET @Produces(value="application/json") Integer count()
@Path(value="count") @GET @Produces(value="application/json") Integer count(@QueryParam(value="search") String search)
count()}.search - criteria to search for@Path(value="count") @GET @Produces(value="application/json") Integer count(@QueryParam(value="lastName") String last, @QueryParam(value="firstName") String first, @QueryParam(value="email") String email, @QueryParam(value="username") String username)
count()}.last - last name field of a userfirst - first name field of a useremail - email field of a userusername - username field of a user@Path(value="count") @GET @Produces(value="application/json") Integer count(@QueryParam(value="lastName") String last, @QueryParam(value="firstName") String first, @QueryParam(value="email") String email, @QueryParam(value="emailVerified") Boolean emailVerified, @QueryParam(value="username") String username)
count()}.last - last name field of a userfirst - first name field of a useremail - email field of a useremailVerified - emailVerified field of a userusername - username field of a user@Path(value="count") @GET @Produces(value="application/json") Integer countEmailVerified(@QueryParam(value="emailVerified") Boolean emailVerified)
count()}.emailVerified - emailVerified field of a user@Path(value="{id}")
UserResource get(@PathParam(value="id")
String id)
@Path(value="{id}")
@DELETE
javax.ws.rs.core.Response delete(@PathParam(value="id")
String id)
@Path(value="profile") UserProfileResource userProfile()
Copyright © 2021 JBoss by Red Hat. All rights reserved.