Class ComponentResource
java.lang.Object
org.keycloak.services.resources.admin.ComponentResource
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Field Summary
Modifier and TypeFieldDescriptionprotected final ClientConnection
protected final jakarta.ws.rs.core.HttpHeaders
protected static final org.jboss.logging.Logger
protected final RealmModel
protected final KeycloakSession
-
Constructor Summary
ConstructorDescriptionComponentResource
(KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) -
Method Summary
Modifier and TypeMethodDescriptionjakarta.ws.rs.core.Response
getComponent
(String id) getComponents
(String parent, String type, String name) getSubcomponentConfig
(String parentId, String subtype) List of subcomponent types that are available to configure for a particular parent component.void
jakarta.ws.rs.core.Response
updateComponent
(String id, ComponentRepresentation rep)
-
Field Details
-
logger
protected static final org.jboss.logging.Logger logger -
realm
-
clientConnection
-
session
-
headers
protected final jakarta.ws.rs.core.HttpHeaders headers
-
-
Constructor Details
-
ComponentResource
public ComponentResource(KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
-
-
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
-
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:
-