Skip to content

workflows.md

Latest commit

 

History

History
298 lines (199 loc) · 6.51 KB

workflows.md

File metadata and controls

298 lines (199 loc) · 6.51 KB
Raw

Workflows

8 operation(s). Part of the API index.

Call these as client.<service>.<method>(...). <service> is the client field for this group — the README lists the field name for every service. These pages group operations the way the OpenAPI specification tags them, which is not always one field per page.

addWorkflow

POST /v2/manage/workflows

Add workflow

Adds a new workflow configuration to the Tenant.

Example

public static void callAddWorkflow(LoginRadiusClient client) {
  AddWorkflowConfig addWorkflowConfig = new AddWorkflowConfig().name("<name>").data("<data>"); //Required

  try {
    var response = client.workflows.addWorkflow(addWorkflowConfig);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Request body

AddWorkflowConfig as application/json.

Returns

WorkflowConfig

deleteWorkflow

DELETE /v2/manage/workflows/{workflowId}

Delete Workflow

Deletes an existing Workflow from the system.

Example

public static void callDeleteWorkflow(LoginRadiusClient client) {
  String workflowId = "<workflowId>"; //Required

  try {
    var response = client.workflows.deleteWorkflow(workflowId);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
workflowId path string yes The ID of the workflow.

Returns

DeleteResponse

deleteWorkflowVersion

DELETE /v2/manage/workflows/{workflowId}/versions/{version}

Delete Workflow Version

Deletes a specific version of a Workflow from the system.

Example

public static void callDeleteWorkflowVersion(LoginRadiusClient client) {
  String workflowId = "<workflowId>"; //Required
  String version = "<version>"; //Required

  try {
    var response = client.workflows.deleteWorkflowVersion(workflowId, version);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
workflowId path string yes The ID of the workflow.
version path string yes The version identifier to delete.

Returns

IsDeleted

getAllWorkflows

GET /v2/manage/workflows

List workflows

Retrieves a list of all workflows configured for the Tenant.

Example

public static void callGetAllWorkflows(LoginRadiusClient client) {
  try {
    var response = client.workflows.getAllWorkflows();
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Returns

object

getAllWorkflowVersionList

GET /v2/manage/workflows/{workflowId}/versions

List Workflow Versions

Returns a list of all available versions for a specified Workflow.

Example

public static void callGetAllWorkflowVersionList(LoginRadiusClient client) {
  String workflowId = "<workflowId>"; //Required

  try {
    var response = client.workflows.getAllWorkflowVersionList(workflowId);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
workflowId path string yes The ID of the workflow.

Returns

VersionListResponse

getWorkflowById

GET /v2/manage/workflows/{workflowId}

Retrieve Workflow

Retrieves details of a specific Workflow using its unique identifier.

Example

public static void callGetWorkflowById(LoginRadiusClient client) {
  String workflowId = "<workflowId>"; //Required

  try {
    var response = client.workflows.getWorkflowById(workflowId);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
workflowId path string yes The ID of the workflow.

Returns

WorkflowConfig

restoreWorkflowVersion

PUT /v2/manage/workflows/{workflowId}/versions/{version}

Restore Workflow Version

Restores a specific version of a Workflow to its active state.

Example

public static void callRestoreWorkflowVersion(LoginRadiusClient client) {
  String workflowId = "<workflowId>"; //Required
  String version = "<version>"; //Required

  try {
    var response = client.workflows.restoreWorkflowVersion(workflowId, version);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
workflowId path string yes The ID of the workflow.
version path string yes The version identifier to delete.

Returns

object

updateWorkflow

PUT /v2/manage/workflows/{workflowId}

Update Workflow

Updates the configuration of an existing Workflow.

Example

public static void callUpdateWorkflow(LoginRadiusClient client) {
  String workflowId = "<workflowId>"; //Required
  UpdateWorkflowConfig updateWorkflowConfig = new UpdateWorkflowConfig().name("<name>").themeName("<themeName>").description("<description>"); //Required

  try {
    var response = client.workflows.updateWorkflow(workflowId, updateWorkflowConfig);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
workflowId path string yes The ID of the workflow.

Request body

UpdateWorkflowConfig as application/json.

Returns

WorkflowConfig