Lifecycle Management APIs

Programmatic identity lifecycle management for access profiles, policies, and provisioning workflows

Veza's Lifecycle Management APIs enable programmatic management of identity lifecycle processes for your organization. Use these APIs to automate provisioning, access changes, and deprovisioning through Access Profiles and Policy-based workflows.

The Lifecycle Management APIs help you:

• Create and manage Access Profiles that define collections of entitlements

• Build Policy workflows with conditional logic based on identity attributes

• Automate identity synchronization across systems

• Test policy configurations against specific identities

• Manage datasources available for lifecycle operations

See the Lifecycle Management product documentation for information about the basic components of Lifecycle Management, such as Policies, Access Profiles, and available actions for Lifecycle Management Integrations.

Base URL

These endpoints are available under {{VezaURL}}/api/private/ for private APIs and {{VezaURL}}/api/v1/ for stable APIs. You must use the appropriate prefix when calling the API, for example:

curl -X GET 'https://your-org.vezacloud.com/api/private/lifecycle_management/policies'

Authentication

Authentication Required

This endpoint requires a valid Veza API key for authentication.

See Authentication for more about creating and managing API keys.

All requests must include the API key as a Bearer token in the Authorization header.

Example:

curl -X GET "$BASE_URL/api/preview/keys" \
  -H "authorization: Bearer $VEZA_TOKEN"

Available Endpoints

Access Profile Operations

Create Access Profile

Create a new access profile with entitlements and settings

List Access Profiles

Retrieve all access profiles with filtering and pagination

Update Access Profile Labels

Modify labels and metadata for an access profile

Update Access Profile Members

Modify entitlements and permissions within an access profile

List Access Profile Members

View entitlements and permissions in an access profile

Update Access Profile Version

Create new versions and manage access profile lifecycle

Policy Operations

Create Policy

Create a new lifecycle management policy with conditions

List Policies

Retrieve all policies with filtering and pagination

Get Policy

Retrieve details for a specific policy

Update Policy State

Change policy execution state (running, paused, dry run)

Update Policy Configuration

Modify policy workflows, conditions, and actions

Add Condition to Policy

Add conditional logic to policy workflows

Add Action to Policy

Add actions to policy workflows

Administrative & Testing Operations

Run Dry Run on Identity

Test policy execution against specific identities without making changes

List Available Integrations

Discover lifecycle management capabilities by integration type

Create Access Profile Type

Create custom access profile types for organizational needs

List Access Profile Types

Retrieve available access profile types

Datasource Discovery Operations

List Lifecycle Management Datasources

Discover which datasources have lifecycle management enabled and their basic capabilities

Get Lifecycle Management Datasource

Get detailed information about a specific datasource including supported actions, syncable attributes, and grantable entitlements

List by Action Type

Find datasources that support specific action types and entity relationships

Getting Started

To get started with the Lifecycle Management APIs:

1. Discover available datasources - Use the Datasource Discovery Operations to identify which datasources support lifecycle management

2. Configure authentication - Ensure you have the required API authentication configured (a personal API key for a Veza Root Team Administrator)

3. Create access profiles - Review the Access Profile APIs for creating and manage access collections

4. Build policies - Review the Policy APIs for endpoints to build automated provisioning workflows

5. Test configurations - Use the Dry Run capabilities before deploying to production

For conceptual information about Lifecycle Management, see the Lifecycle Management documentation.

Related APIs

For managing datasources that support lifecycle management capabilities:

• Data Sources API - Core datasource management operations

• Lifecycle Management Datasources - Discover lifecycle-enabled datasources

API Status

Development Status: The Veza Lifecycle Management APIs are in active development and subject to change. These APIs are provided under the /private API collection, and specifications may evolve as capabilities are added or modified.