Skip to main content

Update Workflow

Perform a full update of a workflow. The updated workflow object is returned in the response.

Path Parameters
  • id string required

    Id of the Workflow

Request Body required
  • name string

    The name of the workflow

  • owner object
  • type string

    Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY]

    DTO type

  • id string

    ID of the object to which this reference applies

  • name string

    Human-readable display name of the object to which this reference applies

  • 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.

  • enabled boolean

    Default value: false

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

  • trigger object

    The trigger that starts the workflow

  • type required

    Possible values: [EVENT, EXTERNAL, SCHEDULED]

    The trigger type

  • attributes object required

    Workflow Trigger Attributes.

    oneOf

  • id string required

    The unique ID of the trigger

  • filter string

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

Responses

The Workflow object


Schema
  • 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

  • creator object

    The identity that created the workflow.

  • type string

    Possible values: [IDENTITY]

    The type of object that is referenced

  • id string

    ID of the object to which this reference applies

  • name string

    Human-readable display name of the object to which this reference applies

  • 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

    ID of the object to which this reference applies

  • name string

    Human-readable display name of the object to which this reference applies

  • 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.

  • enabled boolean

    Default value: false

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

  • trigger object

    The trigger that starts the workflow

  • type

    Possible values: [EVENT, EXTERNAL, SCHEDULED]

    The trigger type

  • attributes object

    Workflow Trigger Attributes.

    oneOf

  • id string

    The unique ID of the trigger

  • filter string

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

Loading...