Package org.keycloak.admin.client.resource

Interface ClientsResource

public interface ClientsResource

Author:

rodrigo.sasaki@icarros.com.br

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(org.keycloak.representations.idm.ClientRepresentation clientRepresentation)
jakarta.ws.rs.core.Response	delete(String id)
List<org.keycloak.representations.idm.ClientRepresentation>	findAll()
List<org.keycloak.representations.idm.ClientRepresentation>	findAll(boolean viewableOnly)
List<org.keycloak.representations.idm.ClientRepresentation>	findAll(String clientId, Boolean viewableOnly, Boolean search, Integer firstResult, Integer maxResults)
List<org.keycloak.representations.idm.ClientRepresentation>	findByClientId(String clientId)
ClientResource	get(String id)
List<org.keycloak.representations.idm.ClientRepresentation>	query(String searchQuery)

Method Details

get

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

create

@POST
@Consumes("application/json")
jakarta.ws.rs.core.Response create(org.keycloak.representations.idm.ClientRepresentation clientRepresentation)

findAll

@GET
@Produces("application/json")
List<org.keycloak.representations.idm.ClientRepresentation> findAll()

findAll

@GET
@Produces("application/json")
List<org.keycloak.representations.idm.ClientRepresentation> findAll(@QueryParam("viewableOnly")
 boolean viewableOnly)

findAll

@GET
@Produces("application/json")
List<org.keycloak.representations.idm.ClientRepresentation> findAll(@QueryParam("clientId")
 String clientId,
 @QueryParam("viewableOnly")
 Boolean viewableOnly,
 @QueryParam("search")
 Boolean search,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults)

findByClientId

@GET
@Produces("application/json")
List<org.keycloak.representations.idm.ClientRepresentation> findByClientId(@QueryParam("clientId")
 String clientId)

query

@GET
@Produces("application/json")
List<org.keycloak.representations.idm.ClientRepresentation> query(@QueryParam("q")
 String searchQuery)

delete

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