Class ClientsResource

java.lang.Object
org.keycloak.services.resources.admin.ClientsResource

public class ClientsResource extends Object
Base resource class for managing a realm's clients.
Version:
$Revision: 1 $
Author:
Bill Burke
  • Field Details

    • logger

      protected static final org.jboss.logging.Logger logger
    • realm

      protected final RealmModel realm
    • session

      protected final KeycloakSession session
  • Constructor Details

  • Method Details

    • getClients

      @GET @Produces("application/json") public Stream<ClientRepresentation> getClients(@QueryParam("clientId") String clientId, @QueryParam("viewableOnly") @DefaultValue("false") boolean viewableOnly, @QueryParam("search") @DefaultValue("false") boolean search, @QueryParam("q") String searchQuery, @QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults)
      Get clients belonging to the realm. If a client can't be retrieved from the storage due to a problem with the underlying storage, it is silently removed from the returned list. This ensures that concurrent modifications to the list don't prevent callers from retrieving this list.
      Parameters:
      clientId - filter by clientId
      viewableOnly - filter clients that cannot be viewed in full by admin
      search - whether this is a search query or a getClientById query
      firstResult - the first result
      maxResults - the max results to return
    • createClient

      @POST @Consumes("application/json") public jakarta.ws.rs.core.Response createClient(ClientRepresentation rep)
      Create a new client Client's client_id must be unique!
      Parameters:
      rep -
      Returns:
    • getClient

      @Path("{client-uuid}") public ClientResource getClient(@PathParam("client-uuid") String id)
      Base path for managing a specific client.
      Parameters:
      id - id of client (not client-id)
      Returns: