🌐Veza APIs
Overview of Veza APIs and developer resources
Last updated
Was this helpful?
Overview of Veza APIs and developer resources
Last updated
Was this helpful?
Was this helpful?
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.
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.
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.
You will need an API key from your Veza administrator to make requests. API keys inherit the same permissions as your user account.
Go to Veza Administration > API Keys
Create a new Personal API Key
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"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.
oaaclient SDKIf 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:
Run and save searches constructed with the Query Builder:
Push entity and authorization metadata to the Veza data catalog, to integrate data sources that aren't natively supported:
Custom Application template
Custom Identity Provider template
Add, change, and monitor configurations for Veza integrations:
Individual datasource status endpoints: Get Sync Status and Get Parse Status
Create, apply, and remove Veza Tags:
/preview APIsThe 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.
Get platform events and activity logs:
Customize templates for Email Notifications and Reminders emails:
Get results and make decisions on certifications, and customize settings and templates: