Skip to main content

List Workflows

GET 

/workflows

List all workflows in the tenant.

Responses

List of workflows

Schema

  • Array [

  • id string

    Workflow ID. This is a UUID generated upon creation.

    executionCount int32

    The number of times this workflow has been executed.

    failureCount int32

    The number of times this workflow has failed during execution.

    created date-time

    The date and time the workflow was created.

    modified date-time

    The date and time the workflow was modified.

    modifiedBy

    object

    type string

    Possible values: [IDENTITY]

    id string

    Identity ID

    name string

    Human-readable display name of identity.

    creator

    object

    Workflow creator's identity.

    type string

    Possible values: [IDENTITY]

    Workflow creator's DTO type.

    id string

    Workflow creator's identity ID.

    name string

    Workflow creator's display name.

    name string

    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.

    type string

    Possible values: [IDENTITY]

    The type of object that is referenced

    id string

    The unique ID of the object

    name string

    The name of the object

    description string

    Description of what the workflow accomplishes

    definition

    object

    The map of steps that the workflow will execute.

    start string

    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.

    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.

    enabled boolean

    Enable or disable the workflow. Workflows cannot be created in an enabled state.

    trigger

    object

    The trigger that starts the workflow

    type stringrequired

    Possible values: [EVENT, EXTERNAL, SCHEDULED]

    The trigger type

    displayName stringnullable

    attributes

    object

    required

    Workflow Trigger Attributes.

    oneOf

    Attributes related to an IdentityNow ETS event

    id stringrequired

    The unique ID of the trigger

    filter.$ string

    JSON path expression that will limit which events the trigger will fire on

    description string

    Description of the event trigger

  • ]

Loading...