Class ComponentResource

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

public class ComponentResource extends Object
Version:
$Revision: 1 $
Author:
Bill Burke
  • Field Details

    • logger

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

      protected final RealmModel realm
    • clientConnection

      protected final ClientConnection clientConnection
    • session

      protected final KeycloakSession session
    • headers

      protected final jakarta.ws.rs.core.HttpHeaders headers
  • Constructor Details

  • Method Details

    • getComponents

      @GET @Produces("application/json") public Stream<ComponentRepresentation> getComponents(@QueryParam("parent") String parent, @QueryParam("type") String type, @QueryParam("name") String name)
    • create

      @POST @Consumes("application/json") public jakarta.ws.rs.core.Response create(ComponentRepresentation rep)
    • getComponent

      @GET @Path("{id}") @Produces("application/json") public ComponentRepresentation getComponent(@PathParam("id") String id)
    • updateComponent

      @PUT @Path("{id}") @Consumes("application/json") public jakarta.ws.rs.core.Response updateComponent(@PathParam("id") String id, ComponentRepresentation rep)
    • removeComponent

      @DELETE @Path("{id}") public void removeComponent(@PathParam("id") String id)
    • getSubcomponentConfig

      @GET @Path("{id}/sub-component-types") @Produces("application/json") public Stream<ComponentTypeRepresentation> getSubcomponentConfig(@PathParam("id") String parentId, @QueryParam("type") String subtype)
      List of subcomponent types that are available to configure for a particular parent component.
      Parameters:
      parentId -
      subtype -
      Returns: