Triggered Workflows

List, inspect, export, unblock, and restart triggered workflow tasks for lifecycle management policies

Triggered workflow tasks are the core execution unit of Veza Lifecycle Management. Each task represents a single workflow execution for an identity, created when a policy's source of identity detects a change (new hire, attribute change, termination, etc.).

These APIs correspond to the Triggered Workflows tab on the Activity Log page in the Veza UI.

Triggered Workflow APIs help you:

Monitor real-time and historical workflow execution across all policies
Investigate errored or blocked tasks with full state and message details
Unblock tasks that are held by safety limit thresholds
Restart previously failed tasks for reprocessing
Export workflow task data for compliance reporting and auditing

Endpoints

Method

Endpoint

Description

GET

List Workflow Tasks

Retrieve a paginated list of triggered workflow tasks

GET

Get Workflow Task

Retrieve a single workflow task by ID

GET

List Workflow Tasks by Policy

List workflow tasks scoped to a specific policy

POST

Export Workflow Tasks

Export workflow tasks to a downloadable file

POST

Unblock Workflow Tasks

Run or abandon blocked workflow tasks

POST

Restart Workflow Task

Restart a previously errored or completed task

Key Concepts

Task States

Each workflow task progresses through the following states:

State

Description

INITIAL

Task created but not yet started

RUNNING

Task is currently executing actions

COMPLETED

Task completed successfully

ERRORED

Task failed (check messages for details)

SKIPPED

Task was skipped (conditions not met)

SCHEDULED

Task is scheduled for future execution

PENDING

Task is waiting for a prerequisite

BLOCKED

Task is blocked by a safety limit threshold

ABANDONED

Task was manually abandoned

Identity Status (Trigger Reason)

The identity_status field indicates what change triggered the workflow:

Value

Description

NONE

No specific identity change (e.g., manual trigger)

NEW

New identity discovered in the source of identity

DELETED

Identity removed from the source of identity

CHANGED

One or more identity attributes changed

UNCHANGED_RESYNC

Identity unchanged but re-synced

Priority Levels

Value

Description

UNSET

Default behavior

LOW

Processed after all higher-priority tasks

NORMAL

Standard priority

MEDIUM

Elevated priority

HIGH

Processed before normal and low

CRITICAL

Processed immediately

List Workflow Tasks

Endpoint

GET /api/private/lifecycle_management/workflow_tasks

Description

Retrieve a paginated list of triggered workflow tasks across all policies. Supports SCIM-style filtering, ordering, and pagination.

Filterable Fields

Field

Operators

Description

id

Workflow task ID

policy_id

Policy that owns the task

state

Current execution state

workflow

eq, ne, co

Workflow name (case-insensitive)

identity_id

eq, co, sw, ew

Identity ID

identity_name

eq, co, sw, ew

Identity display name (case-insensitive)

identity_status

eq, ne

Change type that triggered the task

priority

eq, ne, gt, ge, lt, le

Execution priority

started_at

gt, lt, ge, le

Task start time

completed_at

gt, lt, ge, le

Task completion time

manually_triggered

Whether task was manually triggered

dry_run

Whether task was a dry run

runtime_change_limit_reached

Whether blocked by safety limit

API Reference

List Triggered Workflow Tasks

get

Retrieve a paginated list of triggered workflow tasks across all policies. Each task represents a single workflow execution for an identity, created when a policy's source of identity detects a change. Use the filter parameter with SCIM-style expressions to narrow results by state, policy, identity, or time range. Corresponds to the "Triggered Workflows" tab in the Activity Log UI.

Authorizations

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Query parameters

filterstringOptional

SCIM-style filter expression. Filterable fields: id (eq), policy_id (eq), policy_version_number (eq, gt, lt, ge, le), entity_type (eq), entity_id (eq), state (eq), dry_run (eq), workflow (eq, ne, co — case-insensitive), scheduled_at (gt, lt, ge, le), extraction_event (eq), previous_task_id (eq, co, sw, ew), identity_id (eq, co, sw, ew), identity_name (eq, co, sw, ew — case-insensitive), started_at (gt, lt, ge, le), completed_at (gt, lt, ge, le), any_changes (eq), high_priority (eq), manually_triggered (eq), manually_triggered_by (eq, ne), manually_override_workflows (eq), identity_status (eq, ne), priority (eq, ne, gt, ge, lt, le), reason (eq, ne), t_created_at (gt, lt, ge, le), t_updated_at (gt, lt, ge, le), runtime_change_limit_reached (eq), disregard_change_limit (eq). Example: state eq "ERRORED" and policy_id eq "abc-123".

order_bystringOptional

page_sizeinteger · int32Optional

page_tokenstringOptional

Responses

200

application/json

next_page_tokenstringOptional

has_morebooleanOptional

default

Default error response

application/json

get

/api/private/lifecycle_management/workflow_tasks

GET /api/private/lifecycle_management/workflow_tasks HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "values": [
    {
      "id": "text",
      "description": "text",
      "policy_id": "text",
      "entity_type": "text",
      "entity_id": "text",
      "state": 1,
      "dry_run": true,
      "scheduled_at": "2026-02-26T20:42:59.470Z",
      "policy_version_number": 1,
      "workflow": "text",
      "extraction_event": "text",
      "previous_task_id": [
        "text"
      ],
      "identity_id": "text",
      "identity_name": "text",
      "started_at": "2026-02-26T20:42:59.470Z",
      "completed_at": "2026-02-26T20:42:59.470Z",
      "manually_triggered": true,
      "manually_triggered_by": "text",
      "manually_override_workflows": true,
      "identity_status": 1,
      "priority": 1,
      "reason": 1,
      "messages": [
        "text"
      ],
      "error_retry_count": 1,
      "created_at": "2026-02-26T20:42:59.470Z",
      "updated_at": "2026-02-26T20:42:59.470Z",
      "runtime_change_limit_reached": true,
      "disregard_change_limit": true
    }
  ],
  "next_page_token": "text",
  "has_more": true
}

Request Example

curl -X GET "https://your-tenant.vezacloud.com/api/private/lifecycle_management/workflow_tasks?filter=state%20eq%20%22ERRORED%22&page_size=50" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get Workflow Task

Endpoint

GET /api/private/lifecycle_management/workflow_tasks/{id}

API Reference

Get Triggered Workflow Task

get

Retrieve a single triggered workflow task by its unique ID. Returns the full PolicyWorkflowTask object including state, identity details, timing information, priority, and any error messages.

Authorizations

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Path parameters

idstringRequired

Responses

200

application/json

default

Default error response

application/json

get

/api/private/lifecycle_management/workflow_tasks/{id}

GET /api/private/lifecycle_management/workflow_tasks/{id} HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "value": {
    "id": "text",
    "description": "text",
    "policy_id": "text",
    "entity_type": "text",
    "entity_id": "text",
    "state": 1,
    "dry_run": true,
    "scheduled_at": "2026-02-26T20:42:59.470Z",
    "policy_version_number": 1,
    "workflow": "text",
    "extraction_event": "text",
    "previous_task_id": [
      "text"
    ],
    "identity_id": "text",
    "identity_name": "text",
    "started_at": "2026-02-26T20:42:59.470Z",
    "completed_at": "2026-02-26T20:42:59.470Z",
    "manually_triggered": true,
    "manually_triggered_by": "text",
    "manually_override_workflows": true,
    "identity_status": 1,
    "priority": 1,
    "reason": 1,
    "messages": [
      "text"
    ],
    "error_retry_count": 1,
    "created_at": "2026-02-26T20:42:59.470Z",
    "updated_at": "2026-02-26T20:42:59.470Z",
    "runtime_change_limit_reached": true,
    "disregard_change_limit": true
  }
}

Request Example

curl -X GET "https://your-tenant.vezacloud.com/api/private/lifecycle_management/workflow_tasks/abc-123-def" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

List Workflow Tasks by Policy

Endpoint

GET /api/private/lifecycle_management/policies/{policy_id}/workflow_tasks

Description

Same parameters and response shape as the global List Workflow Tasks endpoint, but automatically scoped to the given policy_id.

API Reference

List Workflow Tasks by Policy

get

Retrieve a paginated list of triggered workflow tasks scoped to a specific policy. Accepts the same filter, ordering, and pagination parameters as the global List Workflow Tasks endpoint but automatically restricts results to the given policy_id.

Authorizations

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Path parameters

policy_idstringRequired

Query parameters

filterstringOptional

SCIM-style filter expression. Same filterable fields as the global List Workflow Tasks endpoint. See that endpoint for the complete field reference.

order_bystringOptional

page_sizeinteger · int32Optional

page_tokenstringOptional

Responses

200

application/json

next_page_tokenstringOptional

has_morebooleanOptional

default

Default error response

application/json

get

/api/private/lifecycle_management/policies/{policy_id}/workflow_tasks

GET /api/private/lifecycle_management/policies/{policy_id}/workflow_tasks HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "values": [
    {
      "id": "text",
      "description": "text",
      "policy_id": "text",
      "entity_type": "text",
      "entity_id": "text",
      "state": 1,
      "dry_run": true,
      "scheduled_at": "2026-02-26T20:42:59.470Z",
      "policy_version_number": 1,
      "workflow": "text",
      "extraction_event": "text",
      "previous_task_id": [
        "text"
      ],
      "identity_id": "text",
      "identity_name": "text",
      "started_at": "2026-02-26T20:42:59.470Z",
      "completed_at": "2026-02-26T20:42:59.470Z",
      "manually_triggered": true,
      "manually_triggered_by": "text",
      "manually_override_workflows": true,
      "identity_status": 1,
      "priority": 1,
      "reason": 1,
      "messages": [
        "text"
      ],
      "error_retry_count": 1,
      "created_at": "2026-02-26T20:42:59.470Z",
      "updated_at": "2026-02-26T20:42:59.470Z",
      "runtime_change_limit_reached": true,
      "disregard_change_limit": true
    }
  ],
  "next_page_token": "text",
  "has_more": true
}

Export Workflow Tasks

Endpoint

POST /api/private/lifecycle_management/workflow_tasks:export

Description

Export triggered workflow tasks matching a filter to a downloadable CSV file. The request body wraps the same filter and ordering parameters used by the List endpoint.

API Reference

Export Triggered Workflow Tasks

post

Export triggered workflow tasks to a downloadable file. Accepts the same filter and ordering parameters as the List endpoint. Returns an export job reference that can be polled for completion. Supported formats include CSV.

Authorizations

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Query parameters

formatinteger · enumOptional

Body

filterstringOptional

order_bystringOptional

page_sizeinteger · int32Optional

page_tokenstringOptional

Responses

200

application/json

idstringOptional

default

Default error response

application/json

post

/api/private/lifecycle_management/workflow_tasks:export

POST /api/private/lifecycle_management/workflow_tasks:export HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "filter": "text",
  "order_by": "text",
  "page_size": 1,
  "page_token": "text"
}

{
  "id": "text"
}

Request Example

curl -X POST "https://your-tenant.vezacloud.com/api/private/lifecycle_management/workflow_tasks:export" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "body": {
      "filter": "state eq \"ERRORED\"",
      "order_by": "completed_at desc"
    },
    "format": "CSV"
  }'

Unblock Workflow Tasks

Endpoint

POST /api/private/lifecycle_management/workflow_tasks:unblock

Description

Unblock workflow tasks that are in BLOCKED state because a safety limit threshold was reached. You can target tasks by a specific id or by a SCIM filter expression. Choose whether to RUN (resume processing) or ABANDON (skip without executing) the blocked tasks.

Requires admin or operator role. Unblocking tasks that exceeded safety limits may result in large-scale changes. Review the blocked tasks carefully before proceeding.

API Reference

Unblock Triggered Workflow Tasks

post

Unblock workflow tasks that are in BLOCKED state due to safety limit thresholds being reached. Tasks can be targeted by a specific ID or by a SCIM filter expression. Choose to either RUN the blocked tasks (resume processing) or ABANDON them (skip without executing). Requires admin or operator role.

Authorizations

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Body

Request to unblock workflow tasks that are in BLOCKED state due to safety limit thresholds. Target tasks by ID or filter expression, and choose whether to run or abandon them.

idstringOptional

target worlflow task with specified id

filterstringOptional

target all blocked workflow tasks matching the SCIM filter expression

actioninteger · enumOptional

The action to take on the blocked workflow tasks.

Possible values:

Responses

200

application/json

idstringOptional

filterstringOptional

actioninteger · enumOptional

tasks_unblockedstringOptional

default

Default error response

application/json

post

/api/private/lifecycle_management/workflow_tasks:unblock

POST /api/private/lifecycle_management/workflow_tasks:unblock HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "id": "text",
  "filter": "text",
  "action": 1
}

{
  "id": "text",
  "filter": "text",
  "action": 1,
  "tasks_unblocked": "text"
}

Request Example

curl -X POST "https://your-tenant.vezacloud.com/api/private/lifecycle_management/workflow_tasks:unblock" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": "policy_id eq \"abc-123\"",
    "action": "RUN"
  }'

Restart Workflow Task

Endpoint

POST /api/private/lifecycle_management/workflow_tasks/{id}:restart

Description

Restart a previously errored or completed workflow task. Creates a new task execution linked to the original. Requires admin role.

API Reference

Restart Triggered Workflow Task

post

Restart a previously errored or completed workflow task. Creates a new task execution linked to the original task. Requires admin role.

Authorizations

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Path parameters

idstringRequired

Query parameters

somethingstringOptional

Responses

200

application/json

default

Default error response

application/json

post

/api/private/lifecycle_management/workflow_tasks/{id}:restart

POST /api/private/lifecycle_management/workflow_tasks/{id}:restart HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "value": {
    "id": "text",
    "description": "text",
    "policy_id": "text",
    "entity_type": "text",
    "entity_id": "text",
    "state": 1,
    "dry_run": true,
    "scheduled_at": "2026-02-26T20:42:59.470Z",
    "policy_version_number": 1,
    "workflow": "text",
    "extraction_event": "text",
    "previous_task_id": [
      "text"
    ],
    "identity_id": "text",
    "identity_name": "text",
    "started_at": "2026-02-26T20:42:59.470Z",
    "completed_at": "2026-02-26T20:42:59.470Z",
    "manually_triggered": true,
    "manually_triggered_by": "text",
    "manually_override_workflows": true,
    "identity_status": 1,
    "priority": 1,
    "reason": 1,
    "messages": [
      "text"
    ],
    "error_retry_count": 1,
    "created_at": "2026-02-26T20:42:59.470Z",
    "updated_at": "2026-02-26T20:42:59.470Z",
    "runtime_change_limit_reached": true,
    "disregard_change_limit": true
  }
}

Request Example

curl -X POST "https://your-tenant.vezacloud.com/api/private/lifecycle_management/workflow_tasks/abc-123-def:restart" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Authentication

All Triggered Workflow API requests require authentication. See API Authentication for details.

PreviousActivity Log NextWorkflow Actions

Last updated 23 hours ago

Was this helpful?

hashtagEndpoints

hashtagKey Concepts

hashtagTask States

hashtagIdentity Status (Trigger Reason)

hashtagPriority Levels

hashtagList Workflow Tasks

hashtagEndpoint

hashtagDescription

hashtagFilterable Fields

hashtagAPI Reference

hashtagList Triggered Workflow Tasks

hashtagRequest Example

hashtagGet Workflow Task

hashtagEndpoint

hashtagAPI Reference

hashtagGet Triggered Workflow Task

hashtagRequest Example

hashtagList Workflow Tasks by Policy

hashtagEndpoint

hashtagDescription

hashtagAPI Reference

hashtagList Workflow Tasks by Policy

hashtagExport Workflow Tasks

hashtagEndpoint

hashtagDescription

hashtagAPI Reference

hashtagExport Triggered Workflow Tasks

hashtagRequest Example

hashtagUnblock Workflow Tasks

hashtagEndpoint

hashtagDescription

hashtagAPI Reference

hashtagUnblock Triggered Workflow Tasks

hashtagRequest Example

hashtagRestart Workflow Task

hashtagEndpoint

hashtagDescription

hashtagAPI Reference

hashtagRestart Triggered Workflow Task

hashtagRequest Example

hashtagAuthentication

hashtagRelated Documentation

Endpoints

Key Concepts

Task States

Identity Status (Trigger Reason)

Priority Levels

List Workflow Tasks

Endpoint

Description

Filterable Fields

API Reference

List Triggered Workflow Tasks

Request Example

Get Workflow Task

Endpoint

API Reference

Get Triggered Workflow Task

Request Example

List Workflow Tasks by Policy

Endpoint

Description

API Reference

List Workflow Tasks by Policy

Export Workflow Tasks

Endpoint

Description

API Reference

Export Triggered Workflow Tasks

Request Example

Unblock Workflow Tasks

Endpoint

Description

API Reference

Unblock Triggered Workflow Tasks

Request Example

Restart Workflow Task

Endpoint

Description

API Reference

Restart Triggered Workflow Task

Request Example

Authentication

Related Documentation