Package org.keycloak.admin.client.resource

Interface WorkflowsResource

public interface WorkflowsResource

Since:

Keycloak server 26.4.0. All the child endpoints are also available since that version

This endpoint including all the child endpoints require feature Profile.Feature.WORKFLOWS to be enabled. Note that feature is preview in 26.5.0 and there might be backwards incompatible changes in the future versions of admin-client and Keycloak server

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(WorkflowRepresentation representation)
List<WorkflowRepresentation>	getScheduledWorkflows(String resourceId)
List<WorkflowRepresentation>	list()
List<WorkflowRepresentation>	list(String search, Boolean exact, Integer firstResult, Integer maxResults)
jakarta.ws.rs.core.Response	migrate(String stepFrom, String stepTo)	Migrate scheduled resources from one step to another
WorkflowResource	workflow(String id)

Method Details

create

@POST
@Consumes({"application/json","application/yaml"})
jakarta.ws.rs.core.Response create(WorkflowRepresentation representation)

list

@GET
@Produces("application/json")
List<WorkflowRepresentation> list()

list

@GET
@Produces("application/json")
List<WorkflowRepresentation> list(@QueryParam("search")
 String search,
 @QueryParam("exact")
 Boolean exact,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults)

getScheduledWorkflows

@Path("scheduled/{resource-id}")
@GET
@Produces("application/json")
List<WorkflowRepresentation> getScheduledWorkflows(@PathParam("resource-id")
 String resourceId)

workflow

@Path("{id}")
WorkflowResource workflow(@PathParam("id")
 String id)

migrate

@POST
@Path("migrate")
jakarta.ws.rs.core.Response migrate(@QueryParam("from")
 String stepFrom,
 @QueryParam("to")
 String stepTo)

Migrate scheduled resources from one step to another

Parameters:

stepFrom - A String representing the id of the step to migrate from

stepTo - A String representing the id of the step to migrate to

Returns:

No content response (status 204) if everything is OK. Error response (status 400) otherwise

Since:

Keycloak server 26.6.0