List Workflows
GET/workflows
List all workflows in the tenant.
Responses
- 200
- 400
- 401
- 403
- 429
- 500
List of workflows
- application/json
- Schema
- Example (from schema)
Schema
Array [
- Event Trigger Attributes
- External Trigger Attributes
- Scheduled Trigger Attributes
]
Workflow ID. This is a UUID generated upon creation.
The number of times this workflow has been executed.
The number of times this workflow has failed during execution.
The date and time the workflow was created.
The date and time the workflow was modified.
modifiedBy
object
Possible values: [IDENTITY
]
Identity ID
Human-readable display name of identity.
creator
object
Workflow creator's identity.
Possible values: [IDENTITY
]
Workflow creator's DTO type.
Workflow creator's identity ID.
Workflow creator's display name.
The name of the workflow
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.
Possible values: [IDENTITY
]
The type of object that is referenced
The unique ID of the object
The name of the object
Description of what the workflow accomplishes
definition
object
The map of steps that the workflow will execute.
The name of the starting step.
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.
One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.
Enable or disable the workflow. Workflows cannot be created in an enabled state.
trigger
object
The trigger that starts the workflow
Possible values: [EVENT
, EXTERNAL
, SCHEDULED
]
The trigger type
attributes
object
required
Workflow Trigger Attributes.
oneOf
Attributes related to an IdentityNow ETS event
The unique ID of the trigger
JSON path expression that will limit which events the trigger will fire on
Description of the event trigger
Attributes related to an external trigger
A unique name for the external trigger
Additonal context about the external trigger
OAuth Client ID to authenticate with this trigger
URL to invoke this workflow
Attributes related to a scheduled trigger
A valid CRON expression
Possible values: [daily
, weekly
, monthly
, yearly
, cronSchedule
]
Frequency of execution
Time zone identifier
Scheduled days of the week for execution
Scheduled execution times
[
{
"id": "d201c5e9-d37b-4aff-af14-66414f39d569",
"executionCount": 2,
"failureCount": 0,
"created": "2022-01-10T16:06:16.636381447Z",
"modified": "2023-12-05T15:18:27.699132301Z",
"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": "[email protected]",
"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": "string"
}
}
}
]
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
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.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "JWT validation failed: JWT is expired"
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (from schema)
- 403
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
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.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
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."
}
]
}
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
- Example (from schema)
Schema
A message describing the error
{
"message": " Rate Limit Exceeded "
}
Internal Server Error - Returned if there is an unexpected error.
- application/json
- Schema
- Example (from schema)
- 500
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
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.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
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."
}
]
}