Package org.keycloak.admin.client.resource

Interface UsersResource

public interface UsersResource

Method Summary

Modifier and Type	Method	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	count(String search, String last, String first, String email, Boolean emailVerified, String username, Boolean enabled, String searchQuery)	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.
jakarta.ws.rs.core.Response	create(UserRepresentation userRepresentation)
jakarta.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, Boolean enabled, Integer firstResult, Integer maxResults)	Search for users whose username, first or last name or email matches the value provided by search.
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)
List<UserRepresentation>	search(String username, String firstName, String lastName, String email, Integer firstResult, Integer maxResults, Boolean enabled, Boolean briefRepresentation, Boolean exact)	Search for users based on the given filters.
List<UserRepresentation>	searchByAttributes(Integer firstResult, Integer maxResults, Boolean enabled, Boolean briefRepresentation, String searchQuery)
List<UserRepresentation>	searchByAttributes(String searchQuery)
List<UserRepresentation>	searchByEmail(String email, Boolean exact)
List<UserRepresentation>	searchByFirstName(String email, Boolean exact)
List<UserRepresentation>	searchByLastName(String email, Boolean exact)
List<UserRepresentation>	searchByUsername(String username, Boolean exact)
UserProfileResource	userProfile()

Method Details

search

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

search

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

search

@GET
@Produces("application/json")
List<UserRepresentation> search(@QueryParam("username")
 String username,
 @QueryParam("firstName")
 String firstName,
 @QueryParam("lastName")
 String lastName,
 @QueryParam("email")
 String email,
 @QueryParam("emailVerified")
 Boolean emailVerified,
 @QueryParam("idpAlias")
 String idpAlias,
 @QueryParam("idpUserId")
 String idpUserId,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults,
 @QueryParam("enabled")
 Boolean enabled,
 @QueryParam("briefRepresentation")
 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

search

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

search

@GET
@Produces("application/json")
List<UserRepresentation> search(@QueryParam("emailVerified")
 Boolean emailVerified,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults,
 @QueryParam("enabled")
 Boolean enabled,
 @QueryParam("briefRepresentation")
 Boolean briefRepresentation)

search

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

searchByAttributes

@GET
@Produces("application/json")
@Consumes("application/json")
List<UserRepresentation> searchByAttributes(@QueryParam("q")
 String searchQuery)

searchByAttributes

@GET
@Produces("application/json")
@Consumes("application/json")
List<UserRepresentation> searchByAttributes(@QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults,
 @QueryParam("enabled")
 Boolean enabled,
 @QueryParam("briefRepresentation")
 Boolean briefRepresentation,
 @QueryParam("q")
 String searchQuery)

search

@GET
@Produces("application/json")
List<UserRepresentation> search(@QueryParam("username")
 String username,
 @QueryParam("exact")
 Boolean exact)

searchByUsername

@GET
@Produces("application/json")
List<UserRepresentation> searchByUsername(@QueryParam("username")
 String username,
 @QueryParam("exact")
 Boolean exact)

searchByEmail

@GET
@Produces("application/json")
List<UserRepresentation> searchByEmail(@QueryParam("email")
 String email,
 @QueryParam("exact")
 Boolean exact)

searchByFirstName

@GET
@Produces("application/json")
List<UserRepresentation> searchByFirstName(@QueryParam("firstName")
 String email,
 @QueryParam("exact")
 Boolean exact)

searchByLastName

@GET
@Produces("application/json")
List<UserRepresentation> searchByLastName(@QueryParam("lastName")
 String email,
 @QueryParam("exact")
 Boolean exact)

search

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

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

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.)

exact - search with exact matching by filters (username, email, firstName, lastName)

Returns:

a list of UserRepresentation

search

@GET
@Produces("application/json")
List<UserRepresentation> search(@QueryParam("search")
 String search,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("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 retrieve

Returns:

a list of UserRepresentation

search

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

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 retrieve

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

search

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

Search for users whose username, first or last name 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

enabled - if true, only users that are enabled are returned

firstResult - the position of the first result to retrieve

maxResults - the maximum number of results to retrieve

Returns:

a list of UserRepresentation

list

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

list

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

create

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

count

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

Returns the number of users that can be viewed.

Returns:

number of users

count

@Path("count")
@GET
@Produces("application/json")
Integer count(@QueryParam("search")
 String search)

Returns the number of users that can be viewed and match the given search criteria. If none is specified this is equivalent to {count()}.

Parameters:

search - criteria to search for

Returns:

number of users matching the search criteria

count

@Path("count")
@GET
@Produces("application/json")
Integer count(@QueryParam("lastName")
 String last,
 @QueryParam("firstName")
 String first,
 @QueryParam("email")
 String email,
 @QueryParam("username")
 String username)

Returns the number of users that can be viewed and match the given filters. If none of the filters is specified this is equivalent to {count()}.

Parameters:

last - last name field of a user

first - first name field of a user

email - email field of a user

username - username field of a user

Returns:

number of users matching the given filters

count

@Path("count")
@GET
@Produces("application/json")
Integer count(@QueryParam("lastName")
 String last,
 @QueryParam("firstName")
 String first,
 @QueryParam("email")
 String email,
 @QueryParam("emailVerified")
 Boolean emailVerified,
 @QueryParam("username")
 String username)

Returns the number of users that can be viewed and match the given filters. If none of the filters is specified this is equivalent to {count()}.

Parameters:

last - last name field of a user

first - first name field of a user

email - email field of a user

emailVerified - emailVerified field of a user

username - username field of a user

Returns:

number of users matching the given filters

count

@Path("count")
@GET
@Produces("application/json")
Integer count(@QueryParam("search")
 String search,
 @QueryParam("lastName")
 String last,
 @QueryParam("firstName")
 String first,
 @QueryParam("email")
 String email,
 @QueryParam("emailVerified")
 Boolean emailVerified,
 @QueryParam("username")
 String username,
 @QueryParam("enabled")
 Boolean enabled,
 @QueryParam("q")
 String searchQuery)

Returns the number of users that can be viewed and match the given filters. If none of the filters is specified this is equivalent to {count()}.

Parameters:

search - arbitrary search string for all the fields below

last - last name field of a user

first - first name field of a user

email - email field of a user

emailVerified - emailVerified field of a user

username - username field of a user

enabled - Boolean representing if user is enabled or not

Returns:

number of users matching the given filters

countEmailVerified

@Path("count")
@GET
@Produces("application/json")
Integer countEmailVerified(@QueryParam("emailVerified")
 Boolean emailVerified)

Returns the number of users with the given status for emailVerified. If none of the filters is specified this is equivalent to {count()}.

Parameters:

emailVerified - emailVerified field of a user

Returns:

number of users matching the given filters

get

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

delete

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

userProfile

@Path("profile")
UserProfileResource userProfile()