Prerequisites
Requirements and configuration to get started with Veza Access AuthZ
Before using the Access Request APIs, ensure your Veza environment is properly configured with the following requirements:
Core Requirements
1. Enable Access Requests
Go to Lifecycle Management → Settings, then select the Access Request Settings tab:
Toggle Enable Requests to ON
Toggle Grant without approval to ON (required for API automation)
All API calls will fail until Access Requests are enabled.
2. Admin Permissions
The API token must belong to a user with Admin role. API calls made without admin permissions will fail with authorization errors.
To create an API token:
Navigate to Administration → API Keys
Create a new key for your admin user
See API Authentication for details
3. Enable Lifecycle Management on Integrations
Each integration you want to use with Access AuthZ must have Lifecycle Management enabled.
To enable Lifecycle Management:
Navigate to Integrations in Veza
Locate your target integration in the table
Click the three-dot menu (⋮) in the Actions column
Select Edit from the dropdown menu
On the integration edit page, locate the Lifecycle Management configuration section
Configure and enable the Lifecycle Management settings
Click Save to apply your changes
After enabling Lifecycle Management, the Lifecycle Management column in the integrations table will display the current status:
Enabled - Ready to use with the Access Request APIs
Disabled - Lifecycle Management configured but currently disabled
Not Configured - Lifecycle Management not yet set up
Not Supported - Integration doesn't support Lifecycle Management
When enabled, Veza creates a separate "Lifecycle Manager datasource ID" for this integration that you'll use in API calls.
Without Lifecycle Management enabled, the Access Request APIs cannot perform operations on that target system.
4. Verify Target System Permissions
Veza's service account in each target application must have sufficient permissions for the operations you intend to perform:
Create user
Permission to create user accounts
Update user
Permission to change user attributes
Add to group/role
Permission to alter group/role membership
Remove from group/role
Permission to change group/role membership
Disable user
Permission to disable/deactivate accounts
Refer to integration-specific documentation for detailed permission requirements. See Target Application Support.
Supported Integrations
The Access Request APIs work with any integration that supports Lifecycle Management Actions.
For the list of integrations and supported capabilities, see the Lifecycle Management Integrations table.
Additional integration options:
SCIM integration: If the target application does not have a native Veza integration but supports SCIM v2, use Veza's SCIM integration.
Custom applications: Use the Open Authorization API (OAA) to enable provisioning for custom applications.
Required Features
The following features must be enabled for your tenant, if not enabled by default.
Access Requests - Core capability for programmatic provisioning
Lifecycle Management - Must be enabled tenant-wide and per-integration
If Access Requests are not available in Veza Lifecycle Management > Settings, contact Veza support to enable these capabilities for your tenant.
Last updated
Was this helpful?
