Lifecycle Events

List, inspect, and export granular lifecycle management events recording changes to identities and entities

Lifecycle management events are the granular outcome records produced by workflow actions. Each event records a single change (or attempted change) to an entity in a target system—such as creating an identity, adding a group membership, resetting a password, or disabling an account.

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

Event APIs help you:

• Audit every individual change made by lifecycle management

• Track success and failure of entity-level operations

• Filter events by type, identity, datasource, or time range

• Export event history for compliance reporting

Endpoints

Method	Endpoint	Description
GET	List Events	Retrieve a paginated list of lifecycle management events
GET	Get Event	Retrieve a single event by ID
POST	Export Events	Export events to a downloadable file

Key Concepts

Event Types

The event_type field classifies what happened:

Value	Description
NONE	No event type specified
CREATE_IDENTITY	New identity created in target system
SYNC_IDENTITY	Existing identity attributes synchronized
ADD_RELATIONSHIP	Group/role membership added
REMOVE_RELATIONSHIP	Group/role membership removed
CREATE_EMAIL	Email address created for identity
CHANGE_PASSWORD	Identity password changed
DELETE_IDENTITY	Identity deleted from target system
DISABLE_IDENTITY	Identity disabled in target system
WRITE_BACK_EMAIL	Email written back to HRIS system
ACCESS_REQUEST_COMPLETE	Access request completed
CUSTOM_ACTION	Custom action executed
ACTION_FAILED	Action failed during execution
WORKFLOW_TASK_FAILED	Workflow task failed
EXTRACTION_EVENT_FAILED	Extraction event failed
CREATE_ENTITLEMENT	Entitlement (role/group) created
CREATE_GUEST_ACCOUNT	Guest account created
RENAME_ENTITLEMENT	Entitlement renamed
CREATE_ACCESS_REVIEW	Access review campaign created
RESET_PASSWORD	Identity password reset
CREATE_ACCESS_REVIEW_QUEUED	Access review creation queued
SAFETY_LIMIT_REACHED	Safety limit threshold reached
SYNC_ENTITLEMENT	Entitlement synchronized
INVALID_IDENTITIES_DETECTED	Invalid identities detected in source
INVALID_IDENTITY	Single invalid identity detected
IDENTITY_METADATA_EDIT	Identity metadata manually edited

Lifecycle Event Source

Value	Description
POLICY	Event produced by an LCM Policy workflow
ACCESS_PLAN	Event produced by an Access Plan

List Events

Endpoint

GET /api/private/lifecycle_management/events

Description

Retrieve a paginated list of lifecycle management events. Supports SCIM-style filtering, ordering, and pagination. Events are ordered by timestamp descending by default.

Filterable Fields

Field	Operators	Description
timestamp	gt, ge, lt, le	Event timestamp
event_type	eq	Type of event
success	eq	Whether the event succeeded
identity_entity_type	eq, co	Identity entity type (case-insensitive)
identity_entity_id	eq, co	Identity entity ID (case-insensitive)
identity_entity_name	eq, co	Identity entity name (case-insensitive)
identity_id	eq	Identity ID
data_source_id	eq	Target datasource ID
provider_id	eq	Provider ID
entity_type	eq, co	Target entity type (case-insensitive)
entity_id	eq, co	Target entity ID (case-insensitive)
entity_name	eq, co	Target entity name (case-insensitive)
policy_task	eq	Parent workflow task ID
extraction_event	eq	Extraction event ID
job_id	eq	Parent job ID
event_source	eq	Source (POLICY or ACCESS_PLAN)
event_source_id	eq	Source ID
workflow_name	eq, co	Workflow name
policy_name	eq	Policy name
datasource_name	eq	Datasource name
relationship_entity_type	eq, co	Relationship entity type (case-insensitive)
relationship_entity_id	eq, co	Relationship entity ID (case-insensitive)
relationship_entity_name	eq, co	Relationship entity name (case-insensitive)
relationship_assigned_to_entity_type	eq, co	Assigned-to relationship entity type (case-insensitive)
relationship_assigned_to_entity_id	eq, co	Assigned-to relationship entity ID (case-insensitive)
relationship_assigned_to_entity_name	eq, co	Assigned-to relationship entity name (case-insensitive)
id	eq	Event ID

API Reference

List Lifecycle Management Events

get

Retrieve a paginated list of lifecycle management events. Events are the granular outcome records produced by workflow actions—each represents a single change (or attempted change) to an entity in a target system, such as creating an identity, adding a group membership, or disabling an account. Corresponds to the "Events" tab in the Activity Log UI.

Authorizations

bearerAuth

AuthorizationstringRequired

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

Query parameters

filterstringOptional

SCIM-style filter expression. Filterable fields: timestamp (gt, ge, lt, le), identity_entity_type (eq, co — case-insensitive), identity_entity_id (eq, co — case-insensitive), identity_entity_name (eq, co — case-insensitive), data_source_id (eq), provider_id (eq), entity_type (eq, co — case-insensitive), entity_id (eq, co — case-insensitive), entity_name (eq, co — case-insensitive), event_type (eq), success (eq), extraction_event (eq), policy_task (eq), relationship_entity_type (eq, co — case-insensitive), relationship_entity_id (eq, co — case-insensitive), relationship_entity_name (eq, co — case-insensitive), job_id (eq), event_source (eq), event_source_id (eq), relationship_assigned_to_entity_type (eq, co — case-insensitive), relationship_assigned_to_entity_id (eq, co — case-insensitive), relationship_assigned_to_entity_name (eq, co — case-insensitive), id (eq), identity_id (eq), workflow_name (eq, co), policy_name (eq), datasource_name (eq). Example: event_type eq "CREATE_IDENTITY" and success eq true.

order_bystringOptional

page_sizeinteger · int32Optional

page_tokenstringOptional

Responses

200

OK

application/json

next_page_tokenstringOptional

default

Default error response

application/json

get

/api/private/lifecycle_management/events

HTTPcURLJavaScriptPython

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

{
  "next_page_token": "text",
  "events": [
    {
      "id": "text",
      "timestamp": "2026-02-26T23:08:40.363Z",
      "category": 1,
      "severity": 1,
      "name": "text",
      "message": "text",
      "entity": 1,
      "entity_id": "text",
      "error": {
        "reason": 1,
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "message": "text",
        "resolution": "text",
        "request_id": "text"
      },
      "entity_name": "text",
      "event_type": "text",
      "provider_id": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Request Examples

List failed events since a specific date:

# Replace the timestamp value with your desired start date
curl -X GET "https://your-tenant.vezacloud.com/api/private/lifecycle_management/events?filter=success%20eq%20false%20and%20timestamp%20gt%20%222024-07-14T00:00:00Z%22&page_size=100" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

List identity creation events:

curl -X GET "https://your-tenant.vezacloud.com/api/private/lifecycle_management/events?filter=event_type%20eq%20%22CREATE_IDENTITY%22" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get Event

Endpoint

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

Description

Retrieve a single lifecycle management event by its unique ID. Returns the full event record including entity details, relationship information, and success/failure status.

API Reference

Get Lifecycle Management Event

get

Retrieve a single lifecycle management event by its unique ID. Returns the full Event object including the event type, success status, identity and entity details, relationship information, and source metadata.

Authorizations

bearerAuth

AuthorizationstringRequired

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

Path parameters

idstringRequired

Responses

200

OK

application/json

default

Default error response

application/json

get

/api/private/lifecycle_management/events/{id}

HTTPcURLJavaScriptPython

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

{
  "value": {
    "timestamp": "2026-02-26T23:08:40.363Z",
    "data_source_id": "text",
    "provider_id": "text",
    "entity_type": "text",
    "entity_id": "text",
    "entity_name": "text",
    "event_type": 1,
    "success": true,
    "message": "text",
    "extraction_event": "text",
    "identity_entity_type": "text",
    "identity_entity_id": "text",
    "identity_entity_name": "text",
    "policy_task": "text",
    "job_id": "text",
    "relationship_entity_type": "text",
    "relationship_entity_id": "text",
    "relationship_entity_name": "text",
    "event_source": 1,
    "event_source_id": "text",
    "relationship_assigned_to_entity_type": "text",
    "relationship_assigned_to_entity_id": "text",
    "relationship_assigned_to_entity_name": "text",
    "id": "text",
    "identity_id": "text",
    "workflow_name": "text",
    "policy_name": "text",
    "datasource_name": "text",
    "event_entity": {
      "entity_type": "text",
      "entity_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "assigned_to_entity_type": "text",
      "assigned_to_entity_id": "text",
      "entity_name": "text",
      "error_message": "text",
      "unique_identifiers": [
        "text"
      ],
      "datasource_id": "text"
    }
  }
}

Request Example

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

Export Events

Endpoint

POST /api/private/lifecycle_management/events:export

Description

Export lifecycle management events 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 Lifecycle Management Events

post

Export lifecycle management events to a downloadable file. Accepts the same filter and ordering parameters as the List Events endpoint. Returns an export job reference that can be polled for completion.

Authorizations

bearerAuth

AuthorizationstringRequired

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

Query parameters

formatinteger · enumOptional

Body

application/json

filterstringOptional

page_sizeinteger · int32Optional

page_tokenstringOptional

Responses

200

OK

application/json

idstringOptional

default

Default error response

application/json

post

/api/private/lifecycle_management/events:export

HTTPcURLJavaScriptPython

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

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

{
  "id": "text"
}

Request Example

curl -X POST "https://your-tenant.vezacloud.com/api/private/lifecycle_management/events:export" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "body": {
      "filter": "event_type eq \"CREATE_IDENTITY\" and success eq true",
      "order_by": "timestamp desc"
    },
    "format": "CSV"
  }'

Authentication

All Event API requests require authentication. See API Authentication for details.

Related Documentation

• Activity Log

• Policies and Workflows

• Triggered Workflows

• Workflow Actions

• Integration Jobs