List provisioning workflows

This endpoint enables you to query the entire list of provisioning workflows configured on your account.

Prerequisites

Querying the developer APIs involves sending an access_token as part of the Authorization header. For instructions on how to generate an access token, see Authorization.

Endpoint

GET https://public-api.productiv.com/pull/v1/provisioning-workflows
Required Scope https://api.productiv.com/elm.policy.read

Request headers

Parameter Value
Content-Type application/json
Authorization Bearer access_token

Query params

Parameter Description
pageToken Pagination cursor for the next page of workflows

Response

If the request is successful, a JSON object containing the following attributes is returned:

Parameter Datatype Description
Workflows array List of Workflow objects (see definition below)
ResponseTimeMs number Time taken by the server to process the request in milliseconds
nextPageToken string Pagination cursor for the next page of workflows, to be used in a subsequent API call. Only returned if there are more results to be returned

Example response

{
  "Workflows": [
    {
      "ApplicationId": "productiv",
      "ApplicationInstanceId": "productiv-2",
      "WorkflowId": "POL_8932892hdn9u23nd9238e23",
      "WorkflowStatus": "active",
      "CreationTime": 10000000000,
      "Rules": [
        {
          "RuleId": "98123jeoidusqanoqwk",
          "RuleStatus": "active",
          "Description": "Downgrade - Pro license tier; Only used basic features (60-day engagement)"
        },
        {
          "RuleId": "329e8jd20w9je012912",
          "RuleStatus": "active",
          "Description": "Deprovision - Any license tier; Inactive (60-day engagement)"
        }
      ],
      "History": [
        {
          "WorkflowId": "POL_8932892hdn9u23nd9238e23",
          "WorkflowStatus": "inactive",
          "CreationTime": 0,
          "Rules": [
            {
              "RuleId": "329e8jd20w9je012912",
              "RuleStatus": "active",
              "Description": "Deprovision - Any license tier; Inactive (60-day engagement)"
            }
          ]
        }
      ]
    }
  ],
  "ResponseTimeMs": 2000
}

Objects

This section lists the objects that can be returned in a successful query, and describes their properties.

Workflow

Parameter Datatype Description
ApplicationId string Unique identifier for the application
ApplicationInstanceId string Unique identifier for the application instance
ExternalSSOAppId string Identifier of the app instance in the external SSO platform (if this instance is discovered through an SSO platform; currently only supported in context of Okta)
WorkflowId string Unique identifier for the workflow
WorkflowStatus string Status of the workflow. See WorkflowStatus enum below
CreationTime number The Unix timestamp in milliseconds for the workflow's creation
Rules array List of Rule objects (defined below)
History array List of Workflow objects. ApplicationId, ApplicationInstanceId and History parameters are not defined for Workflow objects under History.

Rule

Parameter Datatype Description
RuleId string Unique identifier for the rule
RuleStatus string Status of the rule. See RuleStatus enum below
Description string Describes the rule's matching criteria and outcome

Enums

WorkflowStatus

Value Description
scheduled The workflow is set to automatically run on a schedule
active The workflow has been configured but not scheduled
inactive The workflow that has been deleted. Note that editing a workflow will cause the previous workflow definition to be marked as "inactive"

RuleStatus

Value Description
active The rule is enabled
inactive The rule has been disabled