IDM 7.2.2

Test workflow integration

IDM reads workflow definitions from the /path/to/openidm/workflow directory.

The /path/to/openidm/samples/provisioning-with-workflow/ sample provides a workflow definition ( that you can use to test the workflow integration.

  1. Create a workflow directory in your project directory and copy the sample workflow to that directory:

    cd project-dir
    mkdir workflow
    cp samples/provisioning-with-workflow/workflow/ workflow/
  2. Verify the workflow integration by using the REST API. The following REST call lists the defined workflows:

    curl \
    --header "X-OpenIDM-Username: openidm-admin" \
    --header "X-OpenIDM-Password: openidm-admin" \
    --header "Accept-API-Version: resource=1.0" \
    --request GET \

    The result is similar to:

      "result": [
          "_id": "contractorOnboarding:1:5",
          "_rev": "1",
          "candidateStarterGroupIdExpressions": [],
          "candidateStarterUserIdExpressions": [],
          "category": "Examples",
          "deploymentId": "1",
          "description": null,
          "eventSupport": {},
          "executionListeners": {},
          "graphicalNotationDefined": false,
          "hasStartFormKey": true,
          "historyLevel": null,
          "ioSpecification": null,
          "key": "contractorOnboarding",
          "laneSets": [],
          "name": "Contractor onboarding process",
          "participantProcess": null,
          "processDiagramResourceName": "contractorOnboarding.contractorOnboarding.png",
          "properties": {},
          "resourceName": "contractorOnboarding.bpmn20.xml",
          "revisionNext": 2,
          "startFormHandler": null,
          "suspended": false,
          "suspensionState": 1,
          "taskDefinitions": null,
          "tenantId": "",
          "variables": null,
          "version": 1
      "resultCount": 1,
      "pagedResultsCookie": null,
      "totalPagedResultsPolicy": "NONE",
      "totalPagedResults": -1,
      "remainingPagedResults": -1

For more information about the above workflow, see Provision users with workflow.

For more information about managing workflows over REST, see Workflows.

Copyright © 2010-2023 ForgeRock, all rights reserved.