Access Review Settings

API operations for customizing the behavior and functionality of Veza Access Reviews.

These endpoints can be called by providing a Veza admin user API key. See Authentication to generate a bearer token for use in requests. Note that API operations in the private namespace are subject to change as features are added or modified.

Use these APIs to configure Access Reviews Settings for Veza Access Reviews.

The settings that can be configured by a Veza administrator are:

• Review Auto-Complete Settings: Automatically complete reviews once all rows have a signed-off decision, or a non-rejected signed-off decision.

• Review Completion Settings: Enable review completion at any time, or only when all rows are signed off with a non-rejected decision.

• Data Source Acknowledgement: Require review creators to view and acknowledge the data source status shown at review creation.

• Expire Overdue Reviews: Enable or disable expiration of overdue reviews.

• Review Expiration Behavior: Reject and sign off incomplete rows when a review expires.

• Self Review Prevention: Prevent users from being assigned as reviewers for rows that relate to their own access and permissions.

• Review Column Defaults: Configure default columns which reviewers will see when they open a review.

• Review UI Customizations: Set whether notes are required when approving or rejecting access.

• Review Sort Order: Set the default sort order and sorting column when opening a review.

• Predefined Decision Notes: Add suggested notes as menu options when reviewers approve or reject rows.

• Review Row Grouping: Configure default grouping behavior for review rows to organize data by column values.

• Reviewer Export Settings: Control whether reviewers can export review data to CSV or PDF formats.

For each endpoint, a GET request returns the current setting, and a PUT request updates the setting. Use your unique Veza URL and API key (see Authentication) in your request, for example:

curl -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/cert_completion_settings' \
-H 'authorization: Bearer mZ1eqKMACtP...' \
-d '{"value": "AUTO_COMPLETE_DISABLED"}'

Postman Collection

Use the Postman collection as an alternative to cURL commands for testing and configuring Veza Access Reviews global settings:

53KB

access-reviews-global-settings.postman_collection.json

Import Instructions

To import the collection into Postman:

Import Button

1. Open Postman and click Import in the sidebar

2. In the Import modal, click Choose Files

3. Select the access-reviews-global-settings.postman_collection.json file

4. Click Import to complete the process

5. The collection appears in your Collections tab

Drag & Drop

1. Download the collection file to your computer

2. Drag and drop the .json file directly into the Postman interface

3. The collection is automatically imported and appears in your Collections tab

Configure Variables

Before using the collection, configure these required variables on the Variables tab:

Variable	Description	Example
baseUrl	Your Veza instance URL	https://your-organization.vezacloud.com
apiToken	Veza admin user API key	mZ1eqKMACtP...
Workflow ID	Specific review configuration ID (optional)	8ae1c414-3a76-46cb-950a-925316b3f264

The collection uses Bearer token authentication. Your apiToken variable automatically populates the Authorization header for all requests.

Important: Use HTTPS (not HTTP) for your baseUrl to avoid redirect issues that can drop request bodies in PUT/POST operations.