Access Reviews APIs

Methods for interacting with workflows and certifications

These endpoints enable listing workflows, listing certifications, getting certification results, and updating certifications. They can be used to programmatically retrieve workflow and certification details, and update certification rows with a decision or note, such as ticket number.

These endpoints also provide utility functionality, such as managing the reviewer deny list, populating results with webhook response info, and customizing quick filters, smart actions, and help pages.

• List Workflows

• List Certifications

• List Certification Results

• Update Certification Result

• Force Update Result

• Update Webhook Info

• Get Certification Result

• Manage Reviewer Deny List

• Workflow Parameters

• Quick Filters

• Help Page Templates

• Smart Action Definitions

• Delegate Reviewers

• List Reviewer Infos

Workflow APIs are experimental and subject to change, and as such are provided with the /preview API collection. Use the appropriate prefix when calling the API, for example, your-org.vezacloud.com/api/preview/.

Quick start

First, save your API key and Veza base URL as environment variables:

export VEZA_TOKEN=APIKEY
export VEZA_URL=https://preview.vezacloud.com

List Workflows

Get all workflows and IDs:

curl "$BASE_URL/api/preview/awf/workflows" \
  -H "authorization: Bearer $VEZA_TOKEN"

List Certifications

Use a workflow id to get active and pending certifications for that workflow:

curl "$BASE_URL/api/preview/awf/certifications?workflow_id=b9dc2586-5f30-4462-b6be-53f62debc40f" \
  -H "authorization: Bearer $VEZA_TOKEN"

The response will include certification details, including the certification ids.

List Certification Results

Using a certification id, you can get results for the certification, including entity attributes:

curl "$BASE_URL/api/preview/awf/certifications/b2562ef3-a4b3-4b30-8a45-1ba36f945d10/results?offset=0&size=30" \
  -H "authorization: Bearer $VEZA_TOKEN"

Update Certification Result

Update a certification result row with a note:

curl -X PUT "$BASE_URL/api/preview/awf/certifications/b2562ef3-a4b3-4b30-8a45-1ba36f945d10/results" \
  -H "authorization: Bearer $VEZA_TOKEN" \
  -d '{"value": {"result_id": 0,"decisions": "REJECTED", "notes": "Over-privileged"}}'