1 of 31

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

APIs for Veza Access Reviews are 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 and Veza base URL as environment variables:

Get all workflows and IDs:

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

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

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

Update a certification result row with a note:

Workflow Parameters Reference

Workflows, certifications, and result details

This page describes common properties for listing workflows, certifications, and certification results:

Workflow Properties

When , all Veza Workflows are returned within a values array. Each has the properties:

Name

Type

Force Update Result

Update a single result with escalated privileges

ForceUpdateAwfResults allows administrators to modify results more than normally allowed, such as changing sign-off status, or changing a row's decision after a certification expires.

Method

syntax

POST

/api/preview/awf/certifications/{certification_id}/results:force_update

The API token used for this request must be created for a user with the admin role.

A forced update request:

Can undo sign-off of a row.
On an expired or completed certification, during the grace period, rows can be modified as normal (Assuming they're no longer signed off).
- The grace period for changes is 7 days after certification completion or expiration

A :

Can't undo sign-off of a row.
On an expired certification, during the grace period, a rejected row can be marked as fixed by admin/operator.

Parameters

Field

Value

Sample Request

Sample Response

A successful response will be empty:

Update Webhook Info

Update status info for custom webhooks

Updates webhook status and details for a certification result.

If you have configured a custom webhook to conduct automated access removal or another form of remediation, you can update Veza with the notification status.

Your application can use this endpoint to send a POST request updating the webhook state, visible to other reviewers from Veza's Certification UI.

Method

syntax

POST

/api/preview/awf/certifications/{certification_id}/results:update_webhook_info

Path parameters

certification_id - id of the certification containing the result to update.

Body

The request body must include the id of the result to update. Valid notification_status are:

PENDING
SUCCEED
FAILED

Webhook_info strings can contain up to 255 bytes.

Response

A successful response will be empty {}

Get Certification Result

Return a single certification result

Returns result details by id, including any special properties, decisions, and notes.

Method

syntax

Parameters

Name

Type

Req.

Description

Manage Reviewer Deny List

Prevent auto assignment for specific users

View or change the deny list for reviewer auto assignment.

Adding a user to the deny list will prevent that user from being auto assigned as a reviewer. That user will also be prevented from appearing in the drop-down menu when manually reassigning a user.

If a user's manager is on the deny list when auto assignment occurs, the certification will be assigned to the that manager's manager. If both the manager and the manager's manger are on the deny list, the result will be assigned to the workflow creator.

Get Deny List

Returns the current denied users.

Quick Filters

Customizing saved filters for certification reviewers.

List, create, and delete saved filters, globally or for a single workflow. Reviewers can pick from available quick filters under Certification Filters > Saved Filters.

Method

Syntax

GET, POST, DELETE

{Veza URL}/api/preview/awf/quick_filters

Requests require a Veza API key for authentication.

Examples

Add a quick filter

Add a quick filter by specifying an optional workflow_id and a single source or destination node property, corresponding to a Review interface column.

Filters can also apply to abstract_permissions or concrete_permissions (see example response).

Valid filter operators are:

co "contains"
eq "equals"
ne "not equals"

With a workflow_id specified, the filter will only apply to certifications on that workflow. Otherwise, reviewers can apply the quick filter to any certification:

A successful response will contain the filter id, for example:

List all quick filters

Including a workflow_id in the query returns quick filters with a matching workflow_id and quick filters with no workflow_id:

Example response:

Remove quick filter by quick filter id

Delegate Reviewers

Configure delegate Veza users who will be assigned as certification reviewers whenever a specified user would have been assigned.

Method

Operation

syntax

List Reviewer Infos

Get all reviewers and details by certification

Method

syntax

GET

/api/preview/awf/certifications/{certification_id}/reviewer_infos

Returns information about all users assigned to a certification and its results. This will include the users' email and ID, along with their progress on the certification (row_stats listing actions counts by type).

Parameters

Name

Type

Description

Req.

Examples

Request

Response

A successful response returns AccessReviewerInfo objects within a values array:

Review UI Customizations

Customize notes behavior and UI elements for reviewers.

By default, when a reviewer approves a row, a "notes" pop-up appears, allowing the user to optionally add a note explaining their decision. When a reviewer rejects a row, the "notes" pop-up appears, and adding a note is required. This API allows you to customize this behavior. For example, you can choose to disable the pop-up when a row is approved and make the notes pop-up optional when a row is rejected.

Additionally, this API can enable the historical "Approve & Signoff" action in the reviewer experience when multiple rows are selected. Note: It is recommended that this feature remains disabled to ensure a more streamlined reviewer experience.

Parameters

accept_notes_behavior can be:

NOTES_BEHAVIOR_UNKNOWN = 0
NO_POP_UP = 1
POP_UP_OPTIONAL = 2
POP_UP_REQUIRED

reject_notes_behavior can be:

NOTES_BEHAVIOR_UNKNOWN = 0
NO_POP_UP = 1
POP_UP_OPTIONAL = 2

approve_and_sign_off_button_behavior can be:

HIDE_OR_SHOW_BEHAVIOR_UNKNOWN = 0
SHOW = 1
HIDE = 2

diff_dropdown_behavior can be:

NORMAL = 1 (Enables all users to see decisions and access changes from previous reviews for the same configuration)
ALWAYS_HIDE_FOR_ACCESS_REVIEWER_ROLE = 2 (Prevents users with the "Access Reviewer" role from accessing this option)

Example

Get Review UI Customizations

Set Review UI Customizations

Review Column Defaults

Configure default columns and visibility for reviewers.

This API configures the default columns which reviewers will see when they open a review, as well as columns that should be hidden from reviewers but visible to administrators. If workflow_id is specified then the configuration will only be applied to reviews related to the particular Review Configuration identified by workflow_id.

The request body includes two main fields:

default_ordered_columns: Array of column names that will be visible to all users (reviewers, administrators, and operators)

Reviewer Export Settings

Control export permissions for reviewers.

Control whether reviewers can view and export access review data. This setting provides granular control over different export formats, allowing administrators to enable or disable CSV and PDF exports independently based on organizational security policies.

When enabled, reviewers can export review data in the allowed formats for offline analysis or reporting. When disabled, the corresponding export options are hidden from the reviewer interface, ensuring review data remains within the Veza platform.

The default setting disables both CSV and PDF exports for security. This setting can be configured globally for all reviews or for specific review configurations using the workflow_id parameter.

Parameters

The request body accepts:

allow_csv_exports (boolean) - Enable or disable CSV export functionality for reviewers
allow_pdf_exports (boolean) - Enable or disable PDF export functionality for reviewers
workflow_id (optional string) - Specific review configuration ID to override global settings

Example

Example request body:

Get Reviewer Export Settings

Retrieve the current reviewer export permission settings. Include the optional workflow_id query parameter to get settings for a specific review configuration.

Global Settings Request:

Configuration-Specific Request:

Example response:

Set Reviewer Export Settings

Update the reviewer export permission settings globally or for a specific review configuration.

Global Settings Request:

Configuration-Specific Request:

Example response:

{ "value": { "result_id": 0, "source": { "aliases": [], "created_at": "2023-05-03T14:25:43Z", "datasource_id": "datasource:google_cloud_workspace", "email_addresses": [ "[email protected]", "[email protected]", "[email protected]" ], "full_admin": false, "google_cloud_organization_name": "organizations/123456789012", "guest": false, "id": "datasource:112655590859538682841", "idp_unique_id": "[email protected]", "is_active": true, "last_login_at": "2023-05-10T15:25:04Z", "location_areas": [], "mfa_enabled": false, "name": "[email protected]", "organization_names": [], "provider_id": "datasource", "suspended": false, "type": "GoogleWorkspaceUser" }, "destination": { "created_at": "2021-11-01T14:23:35Z", "datasource_id": "datasource:google_cloud_iam", "google_cloud_organization_name": "organizations/123456789012", "id": "projects/743979515322", "name": "Dev GCP Project", "parent_id": "organizations/123456789012", "project_id": "striped-graph-330814", "provider_id": "datasource", "type": "GoogleCloudProject", "updated_at": "2022-04-07T22:08:48Z" }, "accumulated_effective_permissions": [], "accumulated_raw_permissions": [ "bigquery.datasets.get", "bigquery.datasets.getIamPolicy", "bigquery.tables.get", "bigquery.tables.getIamPolicy", "bigquery.tables.list", "iam.roles.get", "iam.roles.list", "iam.serviceAccounts.create", "iam.serviceAccounts.list", "resourcemanager.folders.create", "resourcemanager.folders.delete", "resourcemanager.folders.get", "resourcemanager.folders.getIamPolicy", "resourcemanager.folders.list", "resourcemanager.folders.move", "resourcemanager.folders.setIamPolicy", "resourcemanager.folders.undelete", "resourcemanager.organizations.get", "resourcemanager.organizations.getIamPolicy", "resourcemanager.organizations.setIamPolicy", "resourcemanager.projects.create", "resourcemanager.projects.delete", "resourcemanager.projects.get", "resourcemanager.projects.getIamPolicy", "resourcemanager.projects.list", "resourcemanager.projects.move", "resourcemanager.projects.setIamPolicy", "resourcemanager.projects.update", "storage.buckets.create", "storage.buckets.createTagBinding", "storage.buckets.delete", "storage.buckets.deleteTagBinding", "storage.buckets.get", "storage.buckets.getIamPolicy", "storage.buckets.list", "storage.buckets.listTagBindings", "storage.buckets.setIamPolicy", "storage.buckets.update" ], "updated_at": null, "updated_by": null, "signed_off_at": null, "signed_off_by": null, "notification_response_infos": [], "notification_status": "UNKNOWN", "waypoint": { "id": "organizations/123456789012_policy_role_binding0", "name": "CookieAIDevServicePrincipalRole", "type": "GoogleCloudIamRoleBinding" }, "action_log_entries": [], "decision": "NONE", "notes": "", "reviewers": [ { "user_type": "localCookieUser", "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8", "email": "[email protected]", "name": "External User" } ], "signed_off_state": "NOT_SIGNED_OFF", "reviewer_assignment": null } }

{
    "values": [
        {
            "workflow_id": "b9dc2586-5f30-4462-b6be-53f62debc40f",
            "name": "demo",
            "description": "demo",
            "owner": {
                "user_type": "localCookieUser",
                "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8",
                "email": "[email protected]",
                "name": "earlypreview-auth0"
            },
            "notes": "",
            "query": {
                "raw_permissions": null,
                "effective_permissions": null,
                "source_node_types": {
                    "nodes": [
                        {
                            "node_type": "GoogleWorkspaceUser",
                            "tags": [],
                            "conditions": [],
                            "condition_expression": null,
                            "node_id": "",
                            "excluded_tags": [],
                            "count_conditions": [],
                            "direct_relationship_only": false,
                            "node_type_grouping_constraint": null
                        }
                    ],
                    "nodes_operator": "AND"
                },
                "required_intermediate_node_types": {
                    "nodes": [],
                    "nodes_operator": "AND"
                },
                "avoided_intermediate_node_types": {
                    "nodes": [],
                    "nodes_operator": "AND"
                },
                "destination_node_types": {
                    "nodes": [
                        {
                            "node_type": "GoogleCloudProject",
                            "tags": [],
                            "conditions": [],
                            "condition_expression": null,
                            "node_id": "",
                            "excluded_tags": [],
                            "count_conditions": [],
                            "direct_relationship_only": false,
                            "node_type_grouping_constraint": null
                        }
                    ],
                    "nodes_operator": "AND"
                },
                "no_relation": false,
                "snapshot_id": "1690354800",
                "waypoint_node_types": {
                    "nodes": [
                        {
                            "node_type": "GoogleCloudIamRoleBinding",
                            "tags": [],
                            "conditions": [],
                            "condition_expression": null,
                            "node_id": "",
                            "excluded_tags": [],
                            "count_conditions": [],
                            "direct_relationship_only": false,
                            "node_type_grouping_constraint": null
                        }
                    ],
                    "nodes_operator": "AND"
                },
                "path_summary_node_types": null,
                "node_relationship_type": "CONFIGURED",
                "include_all_source_tags_in_results": true,
                "include_all_destination_tags_in_results": false,
                "page_size": "0",
                "page_token": ""
            },
            "creator": {
                "user_type": "localCookieUser",
                "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8",
                "email": "[email protected]",
                "name": "earlypreview-auth0"
            },
            "created_at": "2023-07-27T03:34:56.166550127Z"
        },
        {
            "workflow_id": "baecbd47-bd3d-4d52-acb8-34840a8973b2",
            "name": "Azure PS",
            "description": "",
            "owner": {
                "user_type": "localCookieUser",
                "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8",
                "email": "[email protected]",
                "name": "earlypreview-auth0"
            },
            "notes": "",
            "query": {
                "raw_permissions": null,
                "effective_permissions": null,
                "source_node_types": {
                    "nodes": [
                        {
                            "node_type": "Principal",
                            "tags": [],
                            "conditions": [],
                            "condition_expression": null,
                            "node_id": "",
                            "excluded_tags": [],
                            "count_conditions": [],
                            "direct_relationship_only": false,
                            "node_type_grouping_constraint": null
                        }
                    ],
                    "nodes_operator": "AND"
                },
                "required_intermediate_node_types": {
                    "nodes": [],
                    "nodes_operator": "AND"
                },
                "avoided_intermediate_node_types": {
                    "nodes": [],
                    "nodes_operator": "AND"
                },
                "destination_node_types": {
                    "nodes": [
                        {
                            "node_type": "AzureDataLakeFilesystem",
                            "tags": [],
                            "conditions": [],
                            "condition_expression": null,
                            "node_id": "",
                            "excluded_tags": [],
                            "count_conditions": [],
                            "direct_relationship_only": false,
                            "node_type_grouping_constraint": null
                        }
                    ],
                    "nodes_operator": "AND"
                },
                "no_relation": false,
                "snapshot_id": "1675900800",
                "waypoint_node_types": null,
                "path_summary_node_types": {
                    "nodes": [
                        {
                            "node_type": "AzureADGroup",
                            "tags": [],
                            "conditions": [],
                            "condition_expression": null,
                            "node_id": "",
                            "excluded_tags": [],
                            "count_conditions": [],
                            "direct_relationship_only": false,
                            "node_type_grouping_constraint": null
                        },
                        {
                            "node_type": "ActiveDirectoryGroup",
                            "tags": [],
                            "conditions": [],
                            "condition_expression": null,
                            "node_id": "",
                            "excluded_tags": [],
                            "count_conditions": [],
                            "direct_relationship_only": false,
                            "node_type_grouping_constraint": null
                        },
                        {
                            "node_type": "AzureRoleAssignment",
                            "tags": [],
                            "conditions": [],
                            "condition_expression": null,
                            "node_id": "",
                            "excluded_tags": [],
                            "count_conditions": [],
                            "direct_relationship_only": false,
                            "node_type_grouping_constraint": null
                        },
                        {
                            "node_type": "AzureAssignmentPermissions",
                            "tags": [],
                            "conditions": [],
                            "condition_expression": null,
                            "node_id": "",
                            "excluded_tags": [],
                            "count_conditions": [],
                            "direct_relationship_only": false,
                            "node_type_grouping_constraint": null
                        }
                    ],
                    "nodes_operator": "AND"
                },
                "node_relationship_type": "CONFIGURED",
                "include_all_source_tags_in_results": false,
                "include_all_destination_tags_in_results": false,
                "page_size": "0",
                "page_token": ""
            },
            "creator": {
                "user_type": "localCookieUser",
                "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8",
                "email": "[email protected]",
                "name": "earlypreview-auth0"
            },
            "created_at": "2023-02-09T03:07:24.458473708Z"
        }
    ]
}

Help Page Templates

Manage custom help pages for Veza Access Reviews.

Use these operations to add and manage help pages for access reviewers, and customize pop-up messages when a review starts, or when rows are signed off.

Operation

Method

Syntax

POST

{veza_url}/api/preview/awf/help_page_templates

GET

{veza_url}/api/preview/awf/help_page_templates

Create help page

Add custom help messages for reviewers by providing the plain text template_body, name, and an existing workflow_id and usage where the template will apply. All reviews (certifications) for the configuration (workflow) will use the new template.

Template usage

The usage field determines how and when the help page will be visible to users. It must be one of the following values:

HELP_PAGE: Reviewers can access help pages from reviewer's interface by clicking the User Guide icon. The help page will also appear when viewing the review for the first time.
REVIEW_START: Opens when reviewers start a review.
SIGN_OFF: Opens whenever a row or multiple rows are signed off by a reviewer.

Only one help page can exist at a time for a given workflow and usage. You can manage global help pages by using 00000000-0000-0000-0000-000000000000 as the workflow_id. Global help pages for each usage will apply to all reviews for all configurations.

Template formatting

The template can use markdown and placeholders, for example:

See for more information about placeholders.

Example request:

List help pages

Get all configured help page templates.

Example response:

Get help page

Returns the current help page template for an existing workflow_id and usage.

The usage parameter must be specified. For the existing help page template, the usage value should be HELP_PAGE.
To retrieve the tenant-wide default template (if it was set), use an all-zero UUID (00000000-0000-0000-0000-000000000000) for the workflow_id.

Example request:

Get review help page

Returns the current template for a given certification id.

Example request:

Example response:

Delete help page

Permanently remove the help page template for a workflow_id and usage. It will no longer apply to reviews for using the configuration, specified by workflow_id.

The usage parameter must be specified. For the existing help page template, the usage value should be HELP_PAGE.
To clear the tenant-wide default template, use an all-zero UUID for the workflow_id: 00000000-0000-0000-0000-000000000000.

Example request:

Update help page

PUT {{veza_url}}/api/preview/awf/help_page_templates

Update the help page for the specified workflow_id and usage:

To add a tenant-wide default template, use an all-zero UUID for the workflow_id: 00000000-0000-0000-0000-000000000000.
Updating a template now uses a plain text template_body, instead of a base64-encoded string.

Example request:

{ "values": [ { "certification_id": "b2562ef3-a4b3-4b30-8a45-1ba36f945d10", "workflow_id": "b9dc2586-5f30-4462-b6be-53f62debc40f", "query_used": { "raw_permissions": null, "effective_permissions": null, "source_node_types": { "nodes": [ { "node_type": "GoogleWorkspaceUser", "tags": [], "conditions": [], "condition_expression": null, "node_id": "", "excluded_tags": [], "count_conditions": [], "direct_relationship_only": false, "node_type_grouping_constraint": null } ], "nodes_operator": "AND" }, "required_intermediate_node_types": { "nodes": [], "nodes_operator": "AND" }, "avoided_intermediate_node_types": { "nodes": [], "nodes_operator": "AND" }, "destination_node_types": { "nodes": [ { "node_type": "GoogleCloudProject", "tags": [], "conditions": [], "condition_expression": null, "node_id": "", "excluded_tags": [], "count_conditions": [], "direct_relationship_only": false, "node_type_grouping_constraint": null } ], "nodes_operator": "AND" }, "no_relation": false, "snapshot_id": "1690354800", "waypoint_node_types": { "nodes": [ { "node_type": "GoogleCloudIamRoleBinding", "tags": [], "conditions": [], "condition_expression": null, "node_id": "", "excluded_tags": [], "count_conditions": [], "direct_relationship_only": false, "node_type_grouping_constraint": null } ], "nodes_operator": "AND" }, "path_summary_node_types": null, "node_relationship_type": "CONFIGURED", "include_all_source_tags_in_results": true, "include_all_destination_tags_in_results": false, "page_size": "0", "page_token": "" }, "name": "demo", "notes": "", "due_date": "2023-07-30T03:44:00Z", "reviewers": [], "state": "IN_PROGRESS", "snapshot_time": "2023-07-26T07:00:00Z", "started_at": "2023-07-27T03:44:27.260812616Z", "query_completed_at": "2023-07-27T03:44:31.410373279Z", "completed_at": null, "created_by": { "user_type": "localCookieUser", "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8", "email": "[email protected]", "name": "earlypreview-auth0" }, "completed_by": null, "results_updated_at": "2023-07-27T03:44:31.410373665Z", "results_updated_by": { "user_type": "localCookieUser", "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8", "email": "[email protected]", "name": "earlypreview-auth0" }, "updated_at": "2023-07-27T03:44:31.410413829Z", "updated_by": { "user_type": "localCookieUser", "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8", "email": "[email protected]", "name": "earlypreview-auth0" }, "error_reason": "", "expired_at": null, "version": 1, "total_result_count": 2433, "total_complete_count": 0, "total_rejected_count": 0, "total_accepted_count": 0, "total_fixed_count": 0 } ] }

{ "values": [ { "id": "text", "description": "text", "name": "text", "workflow_id": "text", "filter": "text", "mutable_fields": { "decision": 1, "notes": "text", "updated_at": "2025-12-23T12:22:28.658Z", "updated_by": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "notification_infos": { "values": [ { "notification_type": 1, "webhook_type": 1, "status": 1, "error_message": "text", "updated_at": "2025-12-23T12:22:28.658Z", "snow_info": { "ticket_number": "text", "sys_id": "text" }, "webhook_info": { "info": "text" }, "jira_info": { "keys": [ "text" ] }, "slack_app_info": {} } ] }, "notification_status": 1, "reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "signed_off_state": 1, "signed_off_at": "2025-12-23T12:22:28.658Z", "signed_off_by": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "action_log": { "entries": [ { "action": 1, "user": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "time": "2025-12-23T12:22:28.658Z", "note": "text", "reviewer_detail": { "old_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "new_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ] }, "decision_detail": { "decision": 1, "note": "text" }, "decision_cleared_detail": { "previous_decision": 1, "original_decider": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "reason": 1 }, "approval_level": 1 } ] }, "reviewer_assignment": { "users_manager": true, "resource_managers": true, "reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "fallback_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "reviewers_managers_for_approval_levels": [ 1 ] }, "automation_run_ids": [ "text" ], "decision_by": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "decision_at": "2025-12-23T12:22:28.658Z", "revoke_request_infos": [ { "id": "text", "state": 1, "error_message": "text" } ], "old_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "predefined_question_response": [ { "question_id": "text", "answer_id": "text", "answer_text": "text", "respondent_user": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "responded_at": "2025-12-23T12:22:28.658Z" } ], "is_assigned_to_current_user": true }, "mutable_filter": "text", "apply_to_all_rows": true } ] }

POST /api/preview/awf/smart_action_definitions HTTP/1.1 Host: your-tenant.cookiecloud.ai Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 2335 { "name": "text", "description": "text", "workflow_id": "text", "filter": "text", "mutable_fields": { "decision": 1, "notes": "text", "updated_at": "2025-12-23T12:22:28.658Z", "updated_by": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "notification_infos": { "values": [ { "notification_type": 1, "webhook_type": 1, "status": 1, "error_message": "text", "updated_at": "2025-12-23T12:22:28.658Z", "snow_info": { "ticket_number": "text", "sys_id": "text" }, "webhook_info": { "info": "text" }, "jira_info": { "keys": [ "text" ] }, "slack_app_info": {} } ] }, "notification_status": 1, "reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "signed_off_state": 1, "signed_off_at": "2025-12-23T12:22:28.658Z", "signed_off_by": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "action_log": { "entries": [ { "action": 1, "user": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "time": "2025-12-23T12:22:28.658Z", "note": "text", "reviewer_detail": { "old_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "new_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ] }, "decision_detail": { "decision": 1, "note": "text" }, "decision_cleared_detail": { "previous_decision": 1, "original_decider": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "reason": 1 }, "approval_level": 1 } ] }, "reviewer_assignment": { "users_manager": true, "resource_managers": true, "reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "fallback_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "reviewers_managers_for_approval_levels": [ 1 ] }, "automation_run_ids": [ "text" ], "decision_by": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "decision_at": "2025-12-23T12:22:28.658Z", "revoke_request_infos": [ { "id": "text", "state": 1, "error_message": "text" } ], "old_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "predefined_question_response": [ { "question_id": "text", "answer_id": "text", "answer_text": "text" } ], "is_assigned_to_current_user": true }, "mutable_filter": "text", "apply_to_all_rows": true }

PUT /api/preview/awf/smart_action_definitions HTTP/1.1 Host: your-tenant.cookiecloud.ai Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 2357 { "value": { "id": "text", "description": "text", "name": "text", "workflow_id": "text", "filter": "text", "mutable_fields": { "decision": 1, "notes": "text", "updated_at": "2025-12-23T12:22:28.658Z", "updated_by": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "notification_infos": { "values": [ { "notification_type": 1, "webhook_type": 1, "status": 1, "error_message": "text", "updated_at": "2025-12-23T12:22:28.658Z", "snow_info": { "ticket_number": "text", "sys_id": "text" }, "webhook_info": { "info": "text" }, "jira_info": { "keys": [ "text" ] }, "slack_app_info": {} } ] }, "notification_status": 1, "reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "signed_off_state": 1, "signed_off_at": "2025-12-23T12:22:28.658Z", "signed_off_by": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "action_log": { "entries": [ { "action": 1, "user": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "time": "2025-12-23T12:22:28.658Z", "note": "text", "reviewer_detail": { "old_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "new_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ] }, "decision_detail": { "decision": 1, "note": "text" }, "decision_cleared_detail": { "previous_decision": 1, "original_decider": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "reason": 1 }, "approval_level": 1 } ] }, "reviewer_assignment": { "users_manager": true, "resource_managers": true, "reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "fallback_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "reviewers_managers_for_approval_levels": [ 1 ] }, "automation_run_ids": [ "text" ], "decision_by": { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" }, "decision_at": "2025-12-23T12:22:28.658Z", "revoke_request_infos": [ { "id": "text", "state": 1, "error_message": "text" } ], "old_reviewers": [ { "user_type": "text", "id": "text", "email": "text", "name": "text", "alternate_email": "text" } ], "predefined_question_response": [ { "question_id": "text", "answer_id": "text", "answer_text": "text" } ], "is_assigned_to_current_user": true }, "mutable_filter": "text", "apply_to_all_rows": true } }

{ "nodes": [ { "properties": { "id": "arn:aws:iam::973979857296:role/FederatedS3", "name": "FederatedS3", "type": "AwsIamRole" }, "out_edges": [ { "destination_node_id": "arn:aws:iam::973979857296:role/FederatedS3::eperm::877042069677/S3Bucket/2ce2cbf45bcc5d748c800358d9932a251d670509" } ] }, { "properties": { "id": "0bba9374-d4f5-4c77-93d2-7dfde581fa8a", "name": "Abel_Maclead", "type": "AzureADUser" }, "out_edges": [ { "destination_node_id": "arn:aws:iam::973979857296:role/FederatedS3" } ] }, { "properties": { "id": "arn:aws:iam::973979857296:role/FederatedS3::eperm::877042069677/S3Bucket/2ce2cbf45bcc5d748c800358d9932a251d670509", "name": "Read", "type": "AwsIamEffectivePermission" }, "out_edges": [ { "destination_node_id": "arn:aws:s3:::cct-cct02-finance" } ] }, { "properties": { "id": "arn:aws:s3:::cct-cct02-finance", "name": "cct-cct02-finance", "type": "S3Bucket" }, "out_edges": [] } ], "accumulated_effective_permissions": [ "Read" ], "accumulated_raw_permissions": [ "s3:GetObject" ], "datasource_infos": [ { "datasource_id": "160e97cf-4b8a-4841-800b-49f8d6fa17ef", "external_id": "160e97cf-4b8a-4841-800b-49f8d6fa17ef", "name": "", "last_sync_time": "2022-09-12T22:15:34.874682421Z", "agent_type": "", "has_error": false, "is_deleted": false, "reason": "", "last_error_message": "", "has_warning": false }, { "datasource_id": "", "external_id": "", "name": "", "last_sync_time": "2022-09-12T22:09:47.245436023Z", "agent_type": "", "has_error": false, "is_deleted": false, "reason": "", "last_error_message": "", "has_warning": false } ] }

Automations API

Get, create, update, delete, and attach Intelligent Automations.

Use these operations to manage Access Review Automations and associate them with individual workflows.

Automations apply changes (such as approve, sign-off, add a note, or apply visual indicators) to Certification rows based on historical certification data, or a filter on the current results. They can run by default or on an opt-in basis when a certification is created.

Example Automations

For more information about this feature see Intelligent Automations.

You will need an API token with root team or administrator permissions to manage Automations.

Error handling and conflicts

The following rules apply when an Automation run encounters an issue:

If Automation processing fails for any result, the Automation run stops and no further Automations are applied.
When Automations fail, the Certification is still considered complete and non-errored. The Automation run will have an error status and message.

Results are considered the same when the entities and relationships are exactly equal (including data source IDs). If a conflict occurs with Automations trying to change the same mutable field:

Each change must update the field to the same value. The action log entry will contain notes (if supplied) for each action.
Automations changing a field to differing values are unresolvable conflicts and skipped, but will not interrupt the Automation run.

Automation Object Schema

An Automation consists of attachment_behavior rules, filter criteria, and an action to apply:

Each Automation object has the fields:

id (String): Unique identifier for the Automation.
name (String): Name of the Automation.
description (String): A brief description of the Automation.

`attachment_behavior` (Object)

Defines if the Automation is available for all workflows, and whether it is optional:

attach_to_new_workflows (Boolean): Indicates whether to automatically attach to new and existing workflows.
opt_in (Boolean): If true Operators can pick the automation when creating a Workflow. If false the automation is enabled by default.

`criteria` (Object)

Specifies filters for conditionally updating results:

filter (String): A SCIM filter specifying a source or destination attribute with support for complex expressions using AND, OR, and parentheses for grouping. Examples:
- Simple filter: source.is_active eq false
- Complex filter: (source.name sw "A" OR source.name sw "B") AND destination.is_active eq true

Similarly to Smart Actions, Automations can update results based on a source or destination attribute (such as activity status). Filters use the syntax source.attribute or destination.attribute.

Mutable filters in Automations use the syntax previous.decision, previous.notes and previous.signed_off_state to refer to historical row data. The possible values are:

decision:
- "RESULT_DECISION_UNKNOWN"
- "RESULT_DECISION_NONE"

`action` (Object)

Action the Automation will apply to matching results:

decision (String): Decision code for the action.
signed_off_state (String): Sign off state code.
notes (String): Notes the automation will apply.

Note: When using display_style actions, you cannot set decision, signed_off_state, notes, or reviewer_assignment fields.

Possible decisions and numeric codes are:

UNKNOWN (0)
NONE (1)
ACCEPTED (2

Signed Off State can be:

UNKNOWN_SIGNED_OFF = 0;
NOT_SIGNED_OFF = 1;
SIGNED_OFF = 2;

`reviewer_assignment` (Object)

The preview API does not currently support Reviewer assignment.

Preview API Documentation

Use the endpoints documented below to create and manage automations:

List Automations

Endpoint: /api/preview/awf/automations
Method: GET
Description: Returns all Automations and configuration details.

Returns all in a values array.

Update Automation

Endpoint: /api/preview/awf/automations
Method: PUT
Description: Updates an existing Automation. The full Automation object is required.

Create Automation

Endpoint: /api/preview/awf/automations
Method: POST
Description: Creates a new Automation.

Get Automation

Endpoint: /api/preview/awf/automations/{id}
Method: GET
Description: Get details for a single Automation by ID.

Delete Automation

Endpoint: /api/preview/awf/automations/{id}
Method: DELETE
Description: Deletes a specific Automation by its ID.

Attach Automations

Endpoint: /api/preview/awf/automations:attach
Method: POST
Description: Enable an Automation for a specific workflow, or all workflows.

Attach one or all Automations to a single workflow by specifying the:

id (String): Single Automation ID.
workflow_id (String): ID of the workflow to associate Automations with.
all (boolean): If True, attaches all existing Automations to the Workflow.

List attached Workflow Automations

Endpoint: /api/preview/awf/automations:attached/{workflow_id}
Method: GET
Description: Returns all Automations eligible to run on Certifications for a given Workflow id.

Detach Automations

Endpoint: /api/preview/awf/automations:detach
Method: POST
Description: Detach one or all Automations from an Access Review Workflow.

{
    "values": [
        {
            "result_id": 0,
            "source": {
                "aliases": [],
                "created_at": "2023-05-03T14:25:43Z",
                "datasource_id": "datasource:google_cloud_workspace",
                "email_addresses": [
                    "[email protected]",
                    "[email protected]",
                    "[email protected]"
                ],
                "full_admin": false,
                "google_cloud_organization_name": "organizations/123456789012",
                "guest": false,
                "id": "datasource:112655590859538682841",
                "idp_unique_id": "[email protected]",
                "is_active": true,
                "last_login_at": "2023-05-10T15:25:04Z",
                "location_areas": [],
                "mfa_enabled": false,
                "name": "[email protected]",
                "organization_names": [],
                "provider_id": "datasource",
                "suspended": false,
                "type": "GoogleWorkspaceUser"
            },
            "destination": {
                "created_at": "2021-11-01T14:23:35Z",
                "datasource_id": "datasource:google_cloud_iam",
                "google_cloud_organization_name": "organizations/123456789012",
                "id": "projects/743979515322",
                "name": "Dev GCP Project",
                "parent_id": "organizations/123456789012",
                "project_id": "striped-graph-330814",
                "provider_id": "datasource",
                "type": "GoogleCloudProject",
                "updated_at": "2022-04-07T22:08:48Z"
            },
            "accumulated_effective_permissions": [],
            "accumulated_raw_permissions": [
                "bigquery.datasets.get",
                "bigquery.datasets.getIamPolicy",
                "bigquery.tables.get",
                "bigquery.tables.getIamPolicy",
                "bigquery.tables.list",
                "iam.roles.get",
                "iam.roles.list",
                "iam.serviceAccounts.create",
                "iam.serviceAccounts.list",
                "resourcemanager.folders.create",
                "resourcemanager.folders.delete",
                "resourcemanager.folders.get",
                "resourcemanager.folders.getIamPolicy",
                "resourcemanager.folders.list",
                "resourcemanager.folders.move",
                "resourcemanager.folders.setIamPolicy",
                "resourcemanager.folders.undelete",
                "resourcemanager.organizations.get",
                "resourcemanager.organizations.getIamPolicy",
                "resourcemanager.organizations.setIamPolicy",
                "resourcemanager.projects.create",
                "resourcemanager.projects.delete",
                "resourcemanager.projects.get",
                "resourcemanager.projects.getIamPolicy",
                "resourcemanager.projects.list",
                "resourcemanager.projects.move",
                "resourcemanager.projects.setIamPolicy",
                "resourcemanager.projects.update",
                "storage.buckets.create",
                "storage.buckets.createTagBinding",
                "storage.buckets.delete",
                "storage.buckets.deleteTagBinding",
                "storage.buckets.get",
                "storage.buckets.getIamPolicy",
                "storage.buckets.list",
                "storage.buckets.listTagBindings",
                "storage.buckets.setIamPolicy",
                "storage.buckets.update"
            ],
            "updated_at": null,
            "updated_by": null,
            "signed_off_at": null,
            "signed_off_by": null,
            "notification_response_infos": [],
            "notification_status": "UNKNOWN",
            "waypoint": {
                "id": "organizations/123456789012_policy_role_binding0",
                "name": "CookieAIDevServicePrincipalRole",
                "type": "GoogleCloudIamRoleBinding"
            },
            "action_log_entries": [],
            "decision": "NONE",
            "notes": "",
            "reviewers": [
                {
                    "user_type": "localCookieUser",
                    "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8",
                    "email": "[email protected]",
                    "name": "External User"
                }
            ],
            "signed_off_state": "NOT_SIGNED_OFF",
            "reviewer_assignment": null
        },
        {
            "result_id": 1,
            "source": {
                "aliases": [],
                "created_at": "2023-05-03T14:25:43Z",
                "datasource_id": "datasource:google_cloud_workspace",
                "email_addresses": [
                    "[email protected]",
                    "[email protected]",
                    "[email protected]"
                ],
                "full_admin": false,
                "google_cloud_organization_name": "organizations/123456789012",
                "guest": false,
                "id": "datasource:112655590859538682841",
                "idp_unique_id": "[email protected]",
                "is_active": true,
                "last_login_at": "2023-05-10T15:25:04Z",
                "location_areas": [],
                "mfa_enabled": false,
                "name": "[email protected]",
                "organization_names": [],
                "provider_id": "datasource",
                "suspended": false,
                "type": "GoogleWorkspaceUser"
            },
            "destination": {
                "created_at": "2021-11-01T14:23:35Z",
                "datasource_id": "datasource:google_cloud_iam",
                "google_cloud_organization_name": "organizations/123456789012",
                "id": "projects/743979515322",
                "name": "Dev GCP Project",
                "parent_id": "organizations/123456789012",
                "project_id": "striped-graph-330814",
                "provider_id": "datasource",
                "type": "GoogleCloudProject",
                "updated_at": "2022-04-07T22:08:48Z"
            },
            "accumulated_effective_permissions": [],
            "accumulated_raw_permissions": [
                "cloudkms.cryptoKeyVersions.create",
                "cloudkms.cryptoKeyVersions.destroy",
                "cloudkms.cryptoKeyVersions.get",
                "cloudkms.cryptoKeyVersions.list",
                "cloudkms.cryptoKeyVersions.restore",
                "cloudkms.cryptoKeyVersions.update",
                "cloudkms.cryptoKeyVersions.useToDecryptViaDelegation",
                "cloudkms.cryptoKeyVersions.useToEncryptViaDelegation",
                "cloudkms.cryptoKeys.create",
                "cloudkms.cryptoKeys.get",
                "cloudkms.cryptoKeys.getIamPolicy",
                "cloudkms.cryptoKeys.list",
                "cloudkms.cryptoKeys.setIamPolicy",
                "cloudkms.cryptoKeys.update",
                "cloudkms.keyRings.create",
                "cloudkms.keyRings.createTagBinding",
                "cloudkms.keyRings.deleteTagBinding",
                "cloudkms.keyRings.get",
                "cloudkms.keyRings.getIamPolicy",
                "cloudkms.keyRings.list",
                "cloudkms.keyRings.listTagBindings",
                "cloudkms.keyRings.setIamPolicy",
                "cloudkms.locations.get",
                "cloudkms.locations.list",
                "resourcemanager.projects.get"
            ],
            "updated_at": null,
            "updated_by": null,
            "signed_off_at": null,
            "signed_off_by": null,
            "notification_response_infos": [],
            "notification_status": "UNKNOWN",
            "waypoint": {
                "id": "organizations/123456789012_policy_role_binding11",
                "name": "cloudkms.admin",
                "type": "GoogleCloudIamRoleBinding"
            },
            "action_log_entries": [],
            "decision": "NONE",
            "notes": "",
            "reviewers": [
                {
                    "user_type": "localCookieUser",
                    "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8",
                    "email": "[email protected]",
                    "name": "External User"
                }
            ],
            "signed_off_state": "NOT_SIGNED_OFF",
            "reviewer_assignment": null
        }
    ],
    "next_page_token": "EAI=",
    "has_more": true,
    "has_previous": false
}

Outlier Detection

Configure outlier detection settings to identify anomalous access patterns in Access Reviews.

Early Access Feature: Outlier Detection is currently in Early Access and available via API only. The feature and API are subject to change. Contact your Veza Customer Success Manager to enable this feature for your tenant.

Configure outlier detection to automatically identify and flag anomalous access patterns during Access Reviews. The Manager-Centric algorithm compares each user's access to their peer group and detects access held by fewer than a specified threshold percentage of peers, helping reviewers focus on unusual or potentially risky permissions.

How Outlier Detection Works

The Manager-Centric outlier detection algorithm uses statistical analysis to identify rare access patterns:

Peer Grouping: Users are grouped based on configurable properties (default: users sharing the same manager)
Statistical Analysis: For each destination (resource/permission) in the review, Veza calculates what percentage of the peer group has access using the Wilson score confidence interval method at 95% confidence
Threshold Comparison: Access paths where the statistical lower bound is at or below the configured threshold are flagged as outliers
Reviewer Visibility

Default Behavior

By default, outlier detection uses:

Grouping: Users with the same manager (manager_idp_unique_id property)
Threshold: 15% (access held by ≤15% of peers is flagged as an outlier)

Example Scenario

Consider an Access Review for Okta groups:

100 users report to Manager A
95 of them have access to the "Engineering-All-Hands" group
5 users have access to the "Admin-Production-Access" group

Given a 15% threshold:

"Engineering-All-Hands" access (95% of peers) is not flagged, as this is normal access
"Admin-Production-Access" (5% of peers) is flagged as an outlier, as this is rare access

The reviewer sees a warning on those 5 rows that this access is anomalous within the peer group — no more than 15% of peers with shared characteristics have it.

API Endpoints

Administrators can customize outlier detection using APIs:

Get Outlier Detection Configuration

GET /api/private/workflows/access/global_settings/manager_centric_config

Retrieve the current outlier detection configuration, either globally or for a specific review configuration.

Parameters

Name

Type

Required

Description

Example: Get Global Configuration

Example: Get Configuration for Specific Review

Response

Set Outlier Detection Configuration

PUT /api/private/workflows/access/global_settings/manager_centric_config

Update the outlier detection configuration globally or for a specific review configuration.

Parameters

Name

Type

Required

Description

Example: Set Global Configuration

Example: Set Configuration for Specific Review

Response

Grouping Properties

Grouping properties define how users are organized into peer groups for outlier analysis. You can specify properties from:

Source nodes (the users/identities in the review)
Destination nodes (the resources/permissions being reviewed)
Enriched/joined nodes (additional data joined to the query, such as manager information from an IdP)

Property Reference Schema

Each property reference has these fields:

Field

Type

Required

Description

Target Node Types

SOURCE Node Properties

Properties from the source entities in the review (typically users/identities).

Common source properties:

department - User's department
location - User's location
manager_idp_unique_id - User's manager identifier (default)

Example:

DESTINATION Node Properties

Properties from the destination entities (resources/permissions being reviewed).

Common destination properties:

classification - Resource classification level
data_sensitivity - Data sensitivity level
owner - Resource owner

Example:

JOINED Node Properties (Enrichment)

Properties from enriched/joined metadata from another data source. These require the review query to include a JoinNodeSpec that joins additional data (such as manager information from an IdP).

Example:

This groups all users by their manager's department, requiring the review query to join the manager data with the alias "manager".

Configuration Examples

Example 1: Default Manager-Based Grouping

Groups users by manager with a 15% threshold (default configuration):

Use case: Identify access that's unusual compared to direct peers reporting to the same manager.

Example 2: Department and Location Grouping

Groups users by both department and location with a 10% threshold:

Use case: Identify access that's rare among users in the same department and office location.

Example 3: No Grouping (Population-Wide)

Compares each user to the entire population with 5% threshold:

Use case: Flag extremely rare access across the entire organization, regardless of role or department.

Example 4: Resource Classification Grouping

Groups by destination resource classification with a 20% threshold:

Use case: Identify unusual access patterns within resources of the same classification level.

Example 5: Manager's Department (Enrichment)

Groups by the manager's department (requires query enrichment) with a 15% threshold:

Use case: Identify access that's unusual among users whose managers are in the same department, useful in matrix organizations.

Use Cases

Finance Audit Compliance

Scenario: Reviewing access to financial systems where SOX compliance requires attention to outlier access.

Configuration:

Users with access held by ≤5% of their department peers are flagged for additional scrutiny.

Engineering Production Access

Scenario: Reviewing production system access where most engineers shouldn't have admin rights.

Configuration:

Identifies engineers with production access that is unusual within their team, considering the environment.

Role-Based Access Review

Scenario: Reviewing access where job role should predict permissions.

Configuration:

Flags access held by ≤15% of users with the same job role, indicating potential role creep or over-provisioning.

Cross-Department Anomaly Detection

Scenario: Detecting access patterns that are unusual for an entire department.

Configuration:

Identifies access held by ≤8% of users in the same department and location, flagging potentially inappropriate cross-functional access.

Important Considerations

Configuration Scope: Settings can be applied globally (affecting all new reviews by default) or per-review configuration. Review-specific settings override global settings for reviews created from that configuration.

Property Availability: Grouping properties must exist in your access review query results. If a specified property doesn't exist for source/destination/joined nodes, outlier detection may not function as expected. Verify property names match your data schema.

Statistical Confidence: The algorithm uses the Wilson score confidence interval at 95% confidence level to ensure statistically sound outlier detection even with small peer groups. Peer groups with fewer than 3 members are excluded from outlier analysis to maintain statistical validity.

Threshold Tuning: Start with the default 15% threshold and adjust based on your organization's risk tolerance:

Lower thresholds (5-10%): More sensitive, flags only the rarest access
Higher thresholds (20-25%): Less sensitive, flags more broadly uncommon access

Enrichment Requirements: When using TARGET_NODE_JOINED properties, ensure your Access Review query includes the corresponding JoinNodeSpec with the matching alias. See for enrichment configuration.

- Overview of all Access Reviews settings
- Complete Access Reviews documentation

Access Reviews APIs

Quick start

Workflow Parameters Reference

Workflow Properties

Force Update Result

Parameters

Sample Request

Sample Response

Update Webhook Info

Get Certification Result

Manage Reviewer Deny List

Get Deny List

Quick Filters

Examples

Add a quick filter

List all quick filters

Remove quick filter by quick filter id

Delegate Reviewers

List Reviewer Infos

Parameters

Examples

Request

Response

Review UI Customizations

Parameters

Example

Get Review UI Customizations

Set Review UI Customizations

Review Column Defaults

Reviewer Export Settings

Parameters

Example

Get Reviewer Export Settings

Set Reviewer Export Settings

Access Reviews APIs

Quick start

Update Webhook Info

Force Update Result

Parameters

Sample Request

Sample Response

Quick Filters

Examples

Add a quick filter

List all quick filters

Remove quick filter by quick filter id

List Reviewer Infos

Parameters

Examples

Request

Response

Review UI Customizations

Parameters

Example

Get Review UI Customizations

Set Review UI Customizations

Workflow Parameters Reference

Workflow Properties

Certification Properties

Result Properties

ResultNode

WorkflowUser

ActionLog

ReviewerAssignmentInstructions

Reviewer Export Settings

Parameters

Example

Get Reviewer Export Settings

Set Reviewer Export Settings

Get Certification Result

Delegate Reviewers

Manage Reviewer Deny List

Get Deny List

Review Column Defaults

Examples

Examples

Add user delegations

List user delegations

Remove user delegations

Add User

Re-assigning `reviewers`