Package org.keycloak.admin.client.resource

Interface UsersResource

  • public interface UsersResource

    • Method Detail

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

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

      • searchByUsername

        @GET
@Produces("application/json")
List<UserRepresentation> searchByUsername​(@QueryParam("username")
                                          String username,
                                          @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 retreive
        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 retreive
        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

      • create

        @POST
@Consumes("application/json")
javax.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)
        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

      • delete

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