🌐Veza APIs

Overview of Veza APIs and developer resources

Veza's APIs allow you to automate common administrative tasks and integrate Veza with other systems in your environment. They can help streamline operations that would otherwise require manual work through the Veza interface.

Common use cases

For Security and IT teams:

• Automated access reviews: Programmatically manage certification workflows and reviewer assignments

• Custom reporting: Export access data and audit logs for compliance or analysis

• Integration management: Add, configure, or disable data source connections, across multiple integrations at once

For Developers and automation:

• Custom dashboards: Build applications that display Veza data in your preferred format

• Workflow automation: Trigger Veza actions based on events in other systems

• Data integration: Connect unsupported applications using the Open Authorization API (OAA)

This section includes reference documentation and usage examples for each service in the /v1 and /preview collections. See the following list of endpoints for more details.

Getting started

Basic API usage requires some familiarity with command-line tools, but many common tasks can be accomplished with example commands or simple scripts. For complex automation projects, consider collaborating with your IT team or developers.

Authentication and access

You will need an API key from your Veza administrator to make requests. API keys inherit the same permissions as your user account.

1. Go to Veza Administration > API Keys

2. Create a new Personal API Key

3. Follow the environment setup guide to configure your system

Quick test: Verify your setup works by running:

curl -H "Authorization: Bearer $VEZA_TOKEN" "$VEZA_URL/api/v1/providers"

Error messages

The response will indicate when there is an issue with a request. Error details are contained within a field_violations array. See Troubleshooting for possible response codes and a sample error message.

Custom integrations with oaaclient SDK

If you are interested in building your own connector for a data source that Veza does not natively support, you can get started by downloading the official oaaclient and exploring the examples and documentation.

/v1 APIs (Production)

The v1 namespace is intended for production use. These operations are fully supported by Veza, and changes are compatible with earlier versions:

Assessment Queries

Run and save searches constructed with the Query Builder:

• Concepts:

  • Quick Start

  • Query Builder Terminology

  • Query Builder Parameters

  • Query Builder Results

• Operations

  • List saved queries

  • Save a query

  • Get a saved query

  • Update a query

  • Delete a query

  • Get query node destinations

  • Get query nodes

  • Get query result

  • Get query spec node destinations

  • Get query spec nodes

  • Get query spec results

Custom Providers (Open Authorization API)

Push entity and authorization metadata to the Veza data catalog, to integrate data sources that aren't natively supported:

• Open Authorization API

• Core Concepts

• OAA Push API

• OAA Operations

• Custom Application template

• Custom Identity Provider template

Data Source Management

Add, change, and monitor configurations for Veza integrations:

• Cloud Platforms and Data Providers

• Enable/Disable Providers

• Disable AWS Services using Provider Management APIs

• Identity Providers

• Data Sources

• Sync and Parse Status

Entity Tagging

Create, apply, and remove Veza Tags:

• Create, Add, Remove Tag

/preview APIs

The preview namespace is reserved for functionality that is subject to change over time. These endpoints have undergone a review process and are generally consistent with each other and v1 APIs. However, future updates may not be compatible with earlier versions, and documentation and examples may be limited.

Audit Logs and Events

Get platform events and activity logs:

• System Audit Logs

• System Events

Email Notification Templates

Customize templates for Email Notifications and Reminders emails:

• Notification Templates

• Notification Templates API

Workflows

Get results and make decisions on certifications, and customize settings and templates:

• List Workflows

• List Certifications

• List Certification Results

• Get Certification Result

• Update Certification Result

• Get Access Graph

• Manage Reviewer Deny List

• Delegate Reviewers

• Quick Filters

• Help Page Templates

• Workflow Parameters Reference