List Workflows

GET 
https://sailpoint.api.identitynow.com/v2024/workflows

List all workflows in the tenant.

Responses

200

List of workflows

application/json

Schema

Schema

Array [
idstring
Workflow ID. This is a UUID generated upon creation.
Example: d201c5e9-d37b-4aff-af14-66414f39d569
executionCountint32
The number of times this workflow has been executed.
Example: 2
failureCountint32
The number of times this workflow has failed during execution.
Example: 0
createddate-time
The date and time the workflow was created.
Example: 2022-01-10T16:06:16.636381447Z
modifieddate-time
The date and time the workflow was modified.
Example: 2023-12-05T15:18:27.699Z
modifiedBy object
typestring
Possible values: [IDENTITY]
Example: IDENTITY
idstring
Identity ID
Example: 2c9180a46faadee4016fb4e018c20639
namestring
Human-readable display name of identity.
Example: Thomas Edison
creator object
Workflow creator's identity.
typestring
Workflow creator's DTO type.
Possible values: [IDENTITY]
Example: IDENTITY
idstring
Workflow creator's identity ID.
Example: 2c7180a46faadee4016fb4e018c20642
namestring
Workflow creator's display name.
Example: Michael Michaels
namestring
The name of the workflow
Example: Send Email
owner object
The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.
typestring
The type of object that is referenced
Possible values: [IDENTITY]
Example: IDENTITY
idstring
The unique ID of the object
Example: 2c91808568c529c60168cca6f90c1313
namestring
The name of the object
Example: William Wilson
descriptionstring
Description of what the workflow accomplishes
Example: Send an email to the identity who's attributes changed.
definition object
The map of steps that the workflow will execute.
startstring
The name of the starting step.
Example: Send Email Test
steps object
One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.
property name*any
One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.
Example: {"Send Email":{"actionId":"sp:send-email","attributes":{"body":"This is a test","from":"sailpoint@sailpoint.com","recipientId.$":"$.identity.id","subject":"test"},"nextStep":"success","selectResult":null,"type":"ACTION"},"success":{"type":"success"}}
enabledboolean
Enable or disable the workflow. Workflows cannot be created in an enabled state.
Default value: false
Example: false
trigger object
The trigger that starts the workflow
typestringrequired
The trigger type
Possible values: [EVENT, EXTERNAL, SCHEDULED, ``]
Example: EVENT
displayNamestringnullable
attributes objectnullablerequired
Workflow Trigger Attributes.
anyOf
Event Trigger Attributes
idstringnullablerequired
The unique ID of the trigger
Example: idn:identity-attributes-changed
filter.$stringnullable
JSON path expression that will limit which events the trigger will fire on
Example: $.changes[?(@.attribute == 'manager')]
descriptionstringnullable
Description of the event trigger
Example: Triggered when an identity's manager attribute changes
attributeToFilterstringnullable
The attribute to filter on
Example: LifecycleState
formDefinitionIdstringnullable
Form definition's unique identifier.
Example: Admin_Access_Request_Form
External Trigger Attributes
namestringnullable
A unique name for the external trigger
Example: search-and-notify
descriptionstringnullable
Additional context about the external trigger
Example: Run a search and notify the results
clientIdstringnullable
OAuth Client ID to authenticate with this trigger
Example: 87e239b2-b85b-4bde-b9a7-55bf304ddcdc
urlstringnullable
URL to invoke this workflow
Example: https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d
Scheduled Trigger Attributes
frequencystringnullablerequired
Frequency of execution
Possible values: [daily, weekly, monthly, yearly, cronSchedule, null]
Example: daily
timeZonestringnullable
Time zone identifier
Example: America/Chicago
cronStringstringnullable
A valid CRON expression
Example: 0 9 * * 1
weeklyDaysstring[]nullable
Scheduled days of the week for execution
Example: Monday
weeklyTimesstring[]nullable
Scheduled execution times
Example: Monday
yearlyTimesstring[]nullable
Scheduled execution times
Example: 1969-12-31T09:00:00.000Z
]

Example (auto)

[
  {
    "id": "d201c5e9-d37b-4aff-af14-66414f39d569",
    "executionCount": 2,
    "failureCount": 0,
    "created": "2022-01-10T16:06:16.636381447Z",
    "modified": "2023-12-05T15:18:27.699Z",
    "modifiedBy": {
      "type": "IDENTITY",
      "id": "2c9180a46faadee4016fb4e018c20639",
      "name": "Thomas Edison"
    },
    "creator": {
      "type": "IDENTITY",
      "id": "2c7180a46faadee4016fb4e018c20642",
      "name": "Michael Michaels"
    },
    "name": "Send Email",
    "owner": {
      "type": "IDENTITY",
      "id": "2c91808568c529c60168cca6f90c1313",
      "name": "William Wilson"
    },
    "description": "Send an email to the identity who's attributes changed.",
    "definition": {
      "start": "Send Email Test",
      "steps": {
        "Send Email": {
          "actionId": "sp:send-email",
          "attributes": {
            "body": "This is a test",
            "from": "sailpoint@sailpoint.com",
            "recipientId.$": "$.identity.id",
            "subject": "test"
          },
          "nextStep": "success",
          "selectResult": null,
          "type": "ACTION"
        },
        "success": {
          "type": "success"
        }
      }
    },
    "enabled": false,
    "trigger": {
      "type": "EVENT",
      "displayName": "string",
      "attributes": {
        "id": "idn:identity-attributes-changed",
        "filter.$": "$.changes[?(@.attribute == 'manager')]",
        "description": "Triggered when an identity's manager attribute changes",
        "attributeToFilter": "LifecycleState",
        "formDefinitionId": "Admin_Access_Request_Form"
      }
    }
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error
A message describing the error
Example: JWT validation failed: JWT is expired

Example (auto)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message
A message describing the error
Example: Rate Limit Exceeded

Example (auto)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Authorization: oauth2

type: Personal Access Token
scopes: sp:workflow:read

• go
• powershell
  SailPoint SDK
• python
  SailPoint SDK
• csharp
• curl
• dart
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• r
• ruby
• rust
• shell
• swift

• NATIVE

Request Collapse all

Base URL

https://sailpoint.api.identitynow.com/v2024

Auth

Bearer Token

ResponseClear

Click the Send API Request button above and see the response here!