Returns all Workflow resources.

GET 
/Workflows

This endpoint returns all Workflow resources.

Attributes to include in the response can be specified with the 'attributes' query parameter.

Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

The schema related to Workflow is:

• urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow

Request

Query Parameters

filter string

Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.

lookupByName boolean

(OPTIONAL) Set to true if the Workflows name is passed instead of the Workflow id.

sortBy string

Allows sorting the results by a resource's attributes.

sortOrder string

Default value: ascending

Determines what order to sort results in.

startIndex integer

Default value: 1

Determines the starting index of the result set.

count integer

Default value: 1000

Specifies the number of results per page.

attributes string

A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.

excludedAttributes string

A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.

Responses

200

Returned all SCIM resources for this endpoint.

application/json

Schema

Schema

totalResults integer

Number of resources returned for this endpoint.

startIndex integer

The starting index of the resource set list. Can be specified with startIndex query parameter.

schemas string[]

SCIM Schema used for response.

Resources

undefined[]

Array [

id string

Unique identifier of the Workflow.

name stringrequired

Name of the Workflow.

description string

Description of the Workflow.

type string

Possible values: [Batch Provisioning, Scheduled Assignment, Scheduled Role Activation, Managed Attribute, Identity Correlation, Identity Event, Identity Lifecycle, Identity Update, Identity Refresh, LCM Identity, LCM Provisioning, LCM Registration, Policy Violation, Role Modeler, Subprocess, Password Intercept, Alert, Attribute Sync]

Type of the Workflow.

handler string

Handler of the Workflow.

meta

object

created string

DateTime when the Workflow was created.

location string

URL to the Workflow.

lastModified string

DateTime of Workflow last modification.

version string

Workflow version.

resourceType string

Resource type of the metadata subject.

]

Example (from schema)

{
  "totalResults": "1,",
  "startIndex": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "7f00000180281df7818028bf977502f3",
      "name": "Identity Request Approve Identity Changes",
      "description": "\n     The subprocess that drives the Create and Update Identity workflows.\n     This is different then the Identity Request Approve subprocess because this\n     approval process produces a form with the approval so that\n     approvers can update values while approving.\n\n     This subprocess builds the form necessary for the editable approvals\n     and then assimilates that data entered back to the plan, which\n     can be returned from the subprocess.\n",
      "type": "Subprocess",
      "handler": "sailpoint.api.StandardWorkflowHandler",
      "meta": {
        "created": "2022-04-14T10:44:46.453-05:00",
        "location": "http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028bf977502f3",
        "lastModified": "2022-05-05T15:52:30.119-05:00",
        "version": "W\"1649951086453\"",
        "resourceType": "Workflow"
      }
    }
  ]
}

application/scim+json

Schema

Schema

totalResults integer

Number of Workflow resources returned.

startIndex integer

The starting index of the resource set list. Can be specified with startIndex query parameter.

schemas string[]

SCIM Schema used for response.

Resources

undefined[]

The SCIM resources returned for this endpoint.

Array [

id string

Unique identifier of the Workflow.

name stringrequired

Name of the Workflow.

description string

Description of the Workflow.

type string

Possible values: [Batch Provisioning, Scheduled Assignment, Scheduled Role Activation, Managed Attribute, Identity Correlation, Identity Event, Identity Lifecycle, Identity Update, Identity Refresh, LCM Identity, LCM Provisioning, LCM Registration, Policy Violation, Role Modeler, Subprocess, Password Intercept, Alert, Attribute Sync]

Type of the Workflow.

handler string

Handler of the Workflow.

meta

object

created string

DateTime when the Workflow was created.

location string

URL to the Workflow.

lastModified string

DateTime of Workflow last modification.

version string

Workflow version.

resourceType string

Resource type of the metadata subject.

]

Example (from schema)

{
  "totalResults": "1500,",
  "startIndex": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "7f00000180281df7818028bf977502f3",
      "name": "Identity Request Approve Identity Changes",
      "description": "\n     The subprocess that drives the Create and Update Identity workflows.\n     This is different then the Identity Request Approve subprocess because this\n     approval process produces a form with the approval so that\n     approvers can update values while approving.\n\n     This subprocess builds the form necessary for the editable approvals\n     and then assimilates that data entered back to the plan, which\n     can be returned from the subprocess.\n",
      "type": "Subprocess",
      "handler": "sailpoint.api.StandardWorkflowHandler",
      "meta": {
        "created": "2022-04-14T10:44:46.453-05:00",
        "location": "http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028bf977502f3",
        "lastModified": "2022-05-05T15:52:30.119-05:00",
        "version": "W\"1649951086453\"",
        "resourceType": "Workflow"
      }
    }
  ]
}

Loading...