Package org.keycloak.workflow.admin.resource

Class WorkflowStepsResource

java.lang.Object

org.keycloak.workflow.admin.resource.WorkflowStepsResource

public class WorkflowStepsResource
extends Object

Resource for managing steps within a workflow.

Constructor Summary

Constructors

Constructor	Description
WorkflowStepsResource(WorkflowsManager workflowsManager, Workflow workflow)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addStep(WorkflowStepRepresentation stepRep, Integer position)	Add a new step to this workflow.
WorkflowStepRepresentation	getStep(String stepId)	Get a specific step by its ID.
List<WorkflowStepRepresentation>	getSteps()	Get all steps for this workflow.
jakarta.ws.rs.core.Response	removeStep(String stepId)	Remove a step from this workflow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkflowStepsResource

public WorkflowStepsResource(WorkflowsManager workflowsManager,
 Workflow workflow)

Method Details

getSteps

@GET
@Produces("application/json")
public List<WorkflowStepRepresentation> getSteps()

Get all steps for this workflow.

Returns:

list of steps

addStep

@POST
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response addStep(WorkflowStepRepresentation stepRep,
 @QueryParam("position")
 Integer position)

Add a new step to this workflow.

Parameters:

stepRep - step representation

position - optional position to insert the step at (0-based index)

Returns:

the created step

removeStep

@Path("{stepId}")
@DELETE
public jakarta.ws.rs.core.Response removeStep(@PathParam("stepId")
 String stepId)

Remove a step from this workflow.

Parameters:

stepId - ID of the step to remove

Returns:

no content response on success

getStep

@Path("{stepId}")
@GET
@Produces("application/json")
public WorkflowStepRepresentation getStep(@PathParam("stepId")
 String stepId)

Get a specific step by its ID.

Parameters:

stepId - ID of the step to retrieve

Returns:

the step representation