All pages
Powered by GitBook
1 of 43

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Update Review Configuration

Update the configuration of an existing access review workflow.

Update the configuration of an existing access review workflow. Use this endpoint to modify the workflow name, description, query settings, webhook actions, notification policies, and access revocation behavior.

Method
Endpoint

PUT

/api/preview/awf/workflows/{workflow_id}

Path parameters

Name
Type
Description

All fields are optional. Include only the fields you want to change — omitted fields retain their current values.

Field
Type
Description

A successful response returns an empty JSON object:

  • Partial updates: Only fields included in the request body are updated. Omitted fields retain their current values.

  • Permissions: Requires the modify_workflow permission and the admin, access_reviews_admin, or operator role.

  • Workflow ID: Use the

endpoint to retrieve workflow IDs.
  • Webhook IDs: Use the Veza UI (Administration > Veza Actions) or the API to get webhook IDs before setting them on a workflow.

  • workflow_id

    string

    ID of the workflow to update.

    name

    string

    Display name for the workflow.

    description

    string

    Description of the workflow's purpose.

    owner

    object

    Updated owner. The email must match an existing user.

    curl -X PUT "$VEZA_URL/api/preview/awf/workflows/58e6ff05-0918-4060-9edd-5e1017f26bac" \
      -H "authorization: Bearer $VEZA_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
        "name": "Quarterly Snowflake Role Review",
        "description": "Certify access from top-level principals to Snowflake roles via Okta app membership.",
        "query": {
          "source_node_types": {
            "nodes": [
              {
                "node_type": "PrincipalTopLevel",
                "tags": [],
                "conditions": [],
                "direct_relationship_only": false
              }
            ]
          },
          "destination_node_types": {
            "nodes": [
              {
                "node_type": "SnowflakeRole",
                "tags": [],
                "conditions": [],
                "direct_relationship_only": false
              }
            ]
          },
          "path_summary_node_types": {
            "nodes": [
              {
                "node_type": "OktaAppUser"
              }
            ]
          },
          "node_relationship_type": "EFFECTIVE_ACCESS",
          "include_dynamic_node_types": true
        },
        "webhooks": {
          "action_webhooks": [
            {
              "action_name": "SIGN_OFF_REJECTED",
              "webhook_id": "a1b2c3d4-0000-0000-0000-000000000000",
              "type": "WEBHOOK"
            }
          ]
        },
        "revoke_access_on_rejected_rows": "DO_REVOKE"
      }'
    {}

    Request body

    Example request

    Response

    Notes

    List Workflows

    notes

    string

    Internal notes about the workflow.

    digest_summary

    string

    Short label shown when this workflow appears in digest notifications. Maximum 64 characters.

    query

    object

    Access query configuration (source nodes, destination nodes, path summary nodes).

    webhooks

    object

    Webhook action mappings. Each entry maps a certification action (e.g. CHANGE_REVIEWER, SIGN_OFF_APPROVED, SIGN_OFF_REJECTED, COMPLETE) to a webhook ID and type.

    notifications

    object

    Event and reminder notification policies.

    revoke_access_on_rejected_rows

    string

    Controls whether rejected rows trigger access revocation. Valid values: UNKNOWN, DO_REVOKE, DO_NOT_REVOKE.

    labels

    object

    Labels applied to this workflow, used to organize and filter access reviews. values is a list of labels, each identified by id.

    applications

    object

    Applications associated with this workflow. values is a list of applications, each identified by id.

    Update Certification Result

    Add decisions and notes to a certification result

    Apply a decision, note, sign-off, or reviewer change to a numbered certification result.

    Each row of the certification results can be annotated, marked as ACCEPTED, or REJECTED, signed-off, or assigned to a different reviewer.

    Method
    syntax

    PUT

    {{base_url}}/api/preview/awf/certifications/{certification_id}/results

    Parameters

    Name
    Type
    In
    Description

    value must include the result_id and any mutable fields to update:

    Name
    Type
    Req.
    Description

    Valid decisions are:

    • NONE // No decision has been made

    • ACCEPTED // The access described in the result row is acceptable

    • REJECTED // The access described in the result row isn't correct

    Adding a note overwrites the previous value. Historical notes are included in the action log when . When viewing the row in the UI, only the most recent note is shown.

    After a certification completes or expires, the Administrator, Access Reviews Admin, and Operator roles can mark rejected rows as fixed, set fixed rows back to rejected, and update row notes. These changes have no time limit. On an expired or completed certification, this endpoint can't change sign-off status or set any other decision. For a comparison of standard and forced updates, see .

    To apply the same change to up to 100 rows per call, use .

    A result’s reviewer can be reassigned by updating the reviewers field with a list of one or more Access Workflow User objects:

    Name
    Type
    Req.
    Description

    Note that all fields are required when assigning a reviewer. As of the current release, there is no customer-facing API to get local user ids. For this reason, API-based reviewer reassignment is recommended only when a graph IdP is configured as the , and you can programmatically retrieve required identifiers such as user "name," "id," and "email."

    A successful response will be empty: {}.

    FIXED // The access was rejected but has been fixed

    cert_id

    string

    path

    id of the certification to update

    value

    object

    body

    Mutable fields to update

    result_id

    int

    Y

    certification result number to update

    decision

    enum

    N

    The decision to apply to the result

    user_type

    string

    Y

    Must be the same user_type as configured for the . Typical values are OktaUser, CustomIDPUser, or AzureADUser.

    id

    string

    Y

    The user_identity_property set when configuring the workflows IdP is used to validate a Workflow Reviewer's identity. For an Okta user, this would be an id such as 00upa6s0hSGtl1eGL5d5. For a Custom IdP user, this will typically be the IdP users set within the OAA payload.

    curl -X PUT '{{baseurl}}/api/preview/awf/certifications/{{cert_id}}/results' \
    -H 'authorization: Bearer ' $TOKEN \
     --data-raw '{"value": {"result_id": 0,"reviewers": [{"user_type": "CustomIDPUser", "id": "125", "email": "cookiedemo@cookie.ai", "name": "Valid Reviewer"}]}}'
    curl -X PUT '{{baseurl}}/api/preview/awf/certifications/f9123002-f056-491f-978f-f203bc9885ed/results' \
      -H 'authorization: Bearer '$token \
      --data-raw '{
      "value": {
        "result_id": 0,
        "decision": "REJECTED",
        "notes": "Over-privileged"
      }
    }'
    curl -X PUT '{{baseurl}}/api/preview/awf/certifications/{{cert_id}}/results' \
    -H 'authorization: Bearer ' $TOKEN \
     --data-raw '{"value": {"result_id": 0,"reviewers": [{"user_type": "CustomIDPUser", "id": "125", "email": "cookiedemo@cookie.ai", "name": "Valid Reviewer"}]}}'
    curl -X PUT '{{baseurl}}/api/preview/awf/certifications/{{cert_id}}/results' \
    -H 'authorization: Bearer ' $TOKEN \
    --data-raw '{"value": {"result_id": 0,"reviewers": [{"user_type": "localCookieUser", "id": "0ffcfbc7-6339-4aed-afa4-ff3bea505485", "email": "cookie@cookie.ai", "name": "demo-auth0"}]}}'

    Re-assigning reviewers

    Examples

    Reject with note

    Change the reviewer to a Custom IdP user

    Assign a local user as a reviewer

    Response

    Listing Certification Results
    Force Update Result
    Update Multiple Certification Results
    Global Workflows IdP

    notes

    string

    N

    Send an empty string " " to clear the current note

    signed_off_state

    string

    N

    Can be: NOT_SIGNED_OFF, SIGNED_OFF

    reviewers

    array

    N

    Contains Workflow User details for assigned reviewers

    email

    string

    Y

    Must match the email property on the local user or graph node.

    name

    string

    Y

    Must match the name property on the local user or graph node.

    primary workflows Identity Provider
    identity
    Reviewers

    List Workflows

    Get all workflows and certification status

    Returns a list of all workflows, including query details and creator information.

    Method
    syntax

    A successful response will include the Workflow details.

    See for additional details on the complete workflow object.

    GET

    {{base_url}}/api/preview/awf/workflows

    curl '{{VEZA_URL}}/api/preview/awf/workflows' \
      -H 'authorization: Bearer '$token

    Examples

    Request

    Response

    Workflow Parameters
    {
        "values": [
            {
                "workflow_id": "b9dc2586-5f30-4462-b6be-53f62debc40f",
                "name": "demo",
                "description": "demo",
                "owner": {
                    "user_type": "localCookieUser",
                    "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8",
                    "email": "cookie@cookie.ai",
                    "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": "cookie@cookie.ai",
                    "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": "cookie@cookie.ai",
                    "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": "cookie@cookie.ai",
                    "name": "earlypreview-auth0"
                },
                "created_at": "2023-02-09T03:07:24.458473708Z"
            }
        ]
    }

    Review Sort Order

    Set default sort order for review rows.

    Configure the default order in which review rows are displayed. Note: Users can later sort the rows as they prefer.

    The order is specified using a SCIM "order by" expression. The default value is source.type asc.

    Valid Values

    Valid values include:

    • source.ATTR

    • destination.ATTR

    • waypoint.ATTR

    • idp.ATTR

    Where ATTR is an attribute name such as "id" or "name".

    {
        "value": {
            "order_by": "destination.name desc"
        }
    }

    Example

    Get Review Sort Order

    Set Review Sort Order

    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 = 3

    reject_notes_behavior can be:

    • NOTES_BEHAVIOR_UNKNOWN = 0

    • NO_POP_UP = 1

    • POP_UP_OPTIONAL = 2

    • POP_UP_REQUIRED

    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)

    = 3
    {
        "value": {
            "diff_dropdown_behavior": "ALWAYS_HIDE_FOR_ACCESS_REVIEWER_ROLE",
            "accept_notes_behavior": "NO_POP_UP",
            "reject_notes_behavior": "POP_UP_REQUIRED",
            "approve_and_sign_off_button_behavior": "SHOW"
        }
    }

    Example

    Get Review UI Customizations

    Set Review UI Customizations

    Default Review Page Size

    Set the default number of rows shown per page in the reviewer interface.

    Configure the default page size for the Access Reviews reviewer interface — the number of ungrouped rows shown per page when a reviewer first opens a review. When this setting is unset, reviews open at the standard default page size.

    The configured value applies to the ungrouped results view the first time a reviewer opens a review. Reviewers can still change the number of rows shown per page for the review they are working in at any time.

    The value is an integer from 10 to 500, specifying the number of rows shown per page.

    {
        "value": 100
    }

    Parameters

    Example

    Get Default Review Page Size

    Set Default Review Page Size

    Clone Review Configuration

    Duplicate an existing access review configuration under a new name, carrying over notifications, Veza Actions, and per-configuration settings.

    Overview

    Duplicates an existing access review configuration and assigns it a new name. Note that the API path uses the older term workflow. In the Veza UI, these are called configurations — as shown on the Access Reviews > Configurations page.

    The clone inherits the source configuration's:

    • Query and scope

    • Notifications and Veza Actions

    • Reviewer experience options — column selection and overrides, default sort order, row grouping, UI customizations, and reviewer export and bulk-action settings

    • Review behavior — completion and expiration behavior, self-review prevention, mandatory due-date settings, and auto-complete rules

    • Automation and alerting — digest notifications, review alerts, and any attached automations

    • Limit Access list, when the (Early Access) feature is enabled on the tenant

    In short, any setting you can configure on a configuration in the builder is carried over to the clone.

    Any reviews already created from the source configuration are not cloned. The new configuration starts with no reviews. The user calling the endpoint becomes the owner of the new configuration.

    Available to users with the Administrator, Access Reviews Admin, or Operator role on the root team.

    Use the returned workflow_id to fetch the new configuration with GET /api/private/workflows/access/{workflow_id}, or to update it with subsequent API calls.

    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.

  • 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/.

    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:

    Core Workflow Operations

    List Workflows
    Update Review Configuration
    curl -X POST "https://your-organization.vezacloud.com/api/private/workflows/access/{workflow_id}:clone" \
      -H "authorization: Bearer YOUR_API_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{"name": "Q3 Finance Review (copy)"}'
    {
      "workflow_id": "019ed153-9f4c-7d3c-85c9-f9d516be99c0"
    }

    Permissions

    API reference

    Example request

    Example response

    Permission Sets for Configurations and Integrations

    Quick start

    Create a certification
    List Certifications
    List Certification Results
    Update Certification Result
    Update Multiple Certification Results
    Force Update Result
    Get Certification Result
    Access Review Exports
    Update Webhook Info
    Manage Reviewer Deny List
    Workflow Parameters
    Quick Filters
    Help Page Templates
    Smart Action Definitions
    Delegate Reviewers
    List Reviewer Infos
    API key
    List Workflows
    List Certifications
    List Certification Results
    Update Certification Result
    export VEZA_TOKEN=APIKEY
    export VEZA_URL=https://your-org.vezacloud.com
    curl "$VEZA_URL/api/preview/awf/workflows" \
      -H "authorization: Bearer $VEZA_TOKEN"
    curl "$VEZA_URL/api/preview/awf/certifications?workflow_id=b9dc2586-5f30-4462-b6be-53f62debc40f" \
      -H "authorization: Bearer $VEZA_TOKEN"
    curl "$VEZA_URL/api/preview/awf/certifications/b2562ef3-a4b3-4b30-8a45-1ba36f945d10/results?offset=0&size=30" \
      -H "authorization: Bearer $VEZA_TOKEN"
    curl -X PUT "$VEZA_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"}}'
    

    Review Completion Settings

    Customize the requirements for completing a review.

    An Admin or Operator user can complete a review by clicking the "Complete Review" button.

    Once a review is marked as "completed," it becomes read-only and is no longer visible to reviewers. By default, a review can be completed when all rows have a signed-off decision.

    This API allows you to modify this behavior, enabling a review to be completed at any time, or only when all rows are signed off with a non-rejected decision. The latter option is useful if your organization prefers to complete reviews only after all rejected access has been remediated.

    Parameters

    Possible values are:

    • COMPLETION_ALLOWED_UNKNOWN = 0

    • COMPLETION_ALLOWED_ALL_ROWS_HAVE_DECISION = 1 (Review can be completed only when all result rows have a decision)

    • COMPLETION_ALLOWED_ANYTIME = 2 (Review can be completed any time)

    List Reviewer Infos

    Get all reviewers and details by certification

    Method
    syntax

    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).

    Get Review Sort Settings

    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    objectOptional
    get/api/private/workflows/access/global_settings/view_sort_settings
    GET /api/private/workflows/access/global_settings/view_sort_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    200

    OK

    {
      "value": {
        "order_by": "source.type asc"
      }
    }

    Set Review Sort Settings

    put
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    Content-TypestringOptionalExample: application/json
    AcceptstringOptionalExample: application/json
    Body
    objectOptionalExample: {"value":{"order_by":"<string>"}}
    Responses
    200

    OK

    application/json
    objectOptional
    put/api/private/workflows/access/global_settings/view_sort_settings
    PUT /api/private/workflows/access/global_settings/view_sort_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 33
    
    {
      "value": {
        "order_by": "<string>"
      }
    }
    200

    OK

    {
      "value": {
        "order_by": "source.type asc"
      }
    }

    Get Review Customization Settings

    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    objectOptional
    get/api/private/workflows/access/global_settings/ui_customization_settings
    GET /api/private/workflows/access/global_settings/ui_customization_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    200

    OK

    {
      "value": {
        "diff_dropdown_behavior": "ALWAYS_HIDE_FOR_ACCESS_REVIEWER_ROLE",
        "accept_notes_behavior": "NO_POP_UP",
        "reject_notes_behavior": "POP_UP_REQUIRED",
        "approve_and_sign_off_button_behavior": "SHOW"
      }
    }

    Set Review Customization Settings

    put
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    Content-TypestringOptionalExample: application/json
    AcceptstringOptionalExample: application/json
    Body
    objectOptionalExample: {"value":{"diff_dropdown_behavior":"<integer>","accept_notes_behavior":"<integer>","reject_notes_behavior":"<integer>","approve_and_sign_off_button_behavior":"<integer>"}}
    Responses
    200

    OK

    application/json
    objectOptional
    put/api/private/workflows/access/global_settings/ui_customization_settings
    PUT /api/private/workflows/access/global_settings/ui_customization_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 171
    
    {
      "value": {
        "diff_dropdown_behavior": "<integer>",
        "accept_notes_behavior": "<integer>",
        "reject_notes_behavior": "<integer>",
        "approve_and_sign_off_button_behavior": "<integer>"
      }
    }
    200

    OK

    {
      "value": {
        "diff_dropdown_behavior": "ALWAYS_HIDE_FOR_ACCESS_REVIEWER_ROLE",
        "accept_notes_behavior": "NO_POP_UP",
        "reject_notes_behavior": "POP_UP_REQUIRED",
        "approve_and_sign_off_button_behavior": "SHOW"
      }
    }

    Get Default Review Page Size Setting

    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    objectOptional
    get/api/private/workflows/access/global_settings/reviews:default_page_size
    GET /api/private/workflows/access/global_settings/reviews:default_page_size HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    200

    OK

    {
      "value": 100
    }

    Set Default Review Page Size Setting

    put
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    Content-TypestringOptionalExample: application/json
    AcceptstringOptionalExample: application/json
    Body
    objectOptional
    Responses
    200

    OK

    application/json
    objectOptional
    put/api/private/workflows/access/global_settings/reviews:default_page_size
    PUT /api/private/workflows/access/global_settings/reviews:default_page_size HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 13
    
    {
      "value": 100
    }
    200

    OK

    {}
    Name
    Type
    Description
    Req.

    certification_id

    string

    ID of a workflow certification

    Y

    A successful response returns AccessReviewerInfo objects within a values array:

    GET

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

    Parameters

    Examples

    Request

    Response

    curl 'https://{{VezaURL}}/api/preview/awf/certifications/abe5c346-84ad-49b0-bafc-614a8365c883/reviewer_infos' \
    -H 'authorization: Bearer '$TOKEN
    {
      "values": [
        {
          "reviewer": {
            "user_type": "localCookieUser",
            "id": "dcadfc95-29f5-4130-b715-5476d40a5811",
            "email": "reviewer@veza.com",
            "name": "Access Reviewer"
          },
          "row_stats": {
            "total": "1",
            "no_decision": "0",
            "accepted": "1",
            "rejected": "0",
            "fixed": "0",
            "signed_off": "1"
          }
        }
      ]
    }
    {
        "value": "COMPLETION_ALLOWED_ALL_ROWS_HAVE_DECISION"
    }
    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    objectOptional
    get/api/private/workflows/access/global_settings/cert_completion_settings
    GET /api/private/workflows/access/global_settings/cert_completion_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    200

    OK

    {
      "value": "COMPLETION_ALLOWED_ALL_ROWS_HAVE_DECISION"
    }
    put
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    Content-TypestringOptionalExample: application/json
    AcceptstringOptionalExample: application/json
    Body
    objectOptionalExample: {"value":"<integer>"}
    Responses
    200

    OK

    application/json
    objectOptional
    put/api/private/workflows/access/global_settings/cert_completion_settings
    PUT /api/private/workflows/access/global_settings/cert_completion_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 21
    
    {
      "value": "<integer>"
    }
    200

    OK

    {
      "value": "COMPLETION_ALLOWED_ALL_ROWS_HAVE_DECISION"
    }

    Example

    Get Review Completion Settings

    Set Review Completion Settings

    Column Name Overrides

    Customize column display names in the access review interface.

    Use column name overrides to customize the display names of columns in the reviewer interface. For example, you can rename source.department to "Business Unit" or destination.name to "Application" to better match your organization's terminology.

    Overrides can be configured globally (applying to all reviews) or scoped to a specific review configuration by providing a workflow_id. Workflow-specific overrides take precedence over global overrides.

    Allowed roles: admin, access_reviews_admin, operator

    Parameters

    Name
    Type
    Required
    In
    Description

    GET /api/private/workflows/access/global_settings/column_name_overrides

    PATCH /api/private/workflows/access/global_settings/column_name_overrides

    DELETE /api/private/workflows/access/global_settings/column_name_overrides

    Remove column name overrides. Optionally specify field_names to clear specific overrides, or omit to clear all overrides for the given scope.

    Mandatory Due Date Settings

    Configure whether due dates are required when creating or editing access reviews.

    Configure whether due dates are required when creating or editing access reviews. When enabled, review creators must specify a due date before creating a review.

    This setting can be configured globally or per-workflow. When a workflow-specific setting is applied, it overrides the global setting for reviews created from that Review Configuration.

    Parameters

    The setting accepts an object with boolean fields for each review level:

    Field
    Type
    Description

    mandatory_for_first_level

    boolean

    Enable mandatory due dates for first-level reviews only:

    Enable mandatory due dates for both review levels:

    Example cURL request (global setting):

    Example cURL request (workflow-specific setting):

    Review Auto-Complete Settings

    Enable or disable automatic review completion once all rows have decisions.

    Enable or disable the "auto-complete" feature. When auto-complete is enabled, a review will automatically be completed once all rows have a signed-off decision, or a non-rejected signed-off decision, depending on the "Completion Allowed Settings."

    Parameters

    Possible values are:

    • AUTO_COMPLETE_UNKNOWN

    • AUTO_COMPLETE_ENABLED

    • AUTO_COMPLETE_DISABLED

    Get Completion Allowed Settings

    Set Certification Completion Allowed Settings

    workflow_id

    string

    No

    body/query

    The review configuration ID to scope the overrides to. If omitted, overrides apply globally.

    column_name_overrides

    object

    Yes

    body

    A map of field_name to display_name pairs. Each key is a column field name and each value is the custom display name to show in the reviewer interface.

    Get Column Name Overrides

    Get Global Overrides

    Get Workflow-Scoped Overrides

    Example Response

    Set Column Name Overrides

    Example: Set Global Overrides

    Example: Set Workflow-Scoped Overrides

    Response

    Clear Column Name Overrides

    Clear All Global Overrides

    Clear Specific Overrides

    Response

    Column name overrides affect the display names shown in the reviewer interface. The underlying field names used in API requests, filters, and column configuration remain unchanged. When configured for a specific review configuration (using workflow_id), those overrides take precedence over any global overrides for reviews created from that configuration.

    curl 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/column_name_overrides' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer YOUR_BEARER_TOKEN'
    curl 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/column_name_overrides?workflow_id=8ae1c414-3a76-46cb-950a-925316b3f264' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer YOUR_BEARER_TOKEN'
    {
      "column_name_overrides": {
        "source.department": "Business Unit",
        "destination.name": "Application",
        "concrete_permissions": "Access Level"
      }
    }
    curl -X PATCH 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/column_name_overrides' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
        -d '{
          "column_name_overrides": {
            "source.department": "Business Unit",
            "destination.name": "Application",
            "concrete_permissions": "Access Level"
          }
        }'
    curl -X PATCH 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/column_name_overrides' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
        -d '{
          "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264",
          "column_name_overrides": {
            "source.department": "Business Unit",
            "destination.name": "Application"
          }
        }'
    {}
    curl -X DELETE 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/column_name_overrides' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer YOUR_BEARER_TOKEN'
    curl -X DELETE 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/column_name_overrides?workflow_id=8ae1c414-3a76-46cb-950a-925316b3f264&field_names=source.department&field_names=destination.name' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer YOUR_BEARER_TOKEN'
    {}

    Require due date for first-level (primary) reviews

    mandatory_for_second_level

    boolean

    Require due date for second-level reviews

    {
        "value": {
            "mandatory_for_first_level": true,
            "mandatory_for_second_level": false
        }
    }
    {
        "value": {
            "mandatory_for_first_level": true,
            "mandatory_for_second_level": true
        }
    }
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/mandatory_due_date_for_review_settings' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN' \
      -H 'Content-Type: application/json' \
      -d '{
        "value": {
            "mandatory_for_first_level": true,
            "mandatory_for_second_level": false
        }
      }'
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/mandatory_due_date_for_review_settings' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN' \
      -H 'Content-Type: application/json' \
      -d '{
        "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264",
        "value": {
            "mandatory_for_first_level": true,
            "mandatory_for_second_level": true
        }
      }'
    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Query parameters
    workflow_idstringOptional

    Optional workflow ID to get workflow-specific settings

    Example: 8ae1c414-3a76-46cb-950a-925316b3f264
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    mandatory_for_first_levelbooleanOptional

    Require due date for first-level reviews

    mandatory_for_second_levelbooleanOptional

    Require due date for second-level reviews

    get/api/private/workflows/access/global_settings/mandatory_due_date_for_review_settings
    GET /api/private/workflows/access/global_settings/mandatory_due_date_for_review_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    200

    OK

    {
      "value": {
        "mandatory_for_first_level": false,
        "mandatory_for_second_level": false
      }
    }
    put
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    Content-TypestringOptionalExample: application/json
    AcceptstringOptionalExample: application/json
    Body
    workflow_idstringOptional

    Optional workflow ID for workflow-specific settings

    mandatory_for_first_levelbooleanRequired

    Require due date for first-level reviews

    mandatory_for_second_levelbooleanOptional

    Require due date for second-level reviews

    Responses
    200

    OK

    application/json
    objectOptional
    put/api/private/workflows/access/global_settings/mandatory_due_date_for_review_settings
    PUT /api/private/workflows/access/global_settings/mandatory_due_date_for_review_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 132
    
    {
      "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264",
      "value": {
        "mandatory_for_first_level": true,
        "mandatory_for_second_level": false
      }
    }
    200

    OK

    {}

    Examples

    Get Mandatory Due Date Settings

    Set Mandatory Due Date Settings

    {
        "value": "AUTO_COMPLETE_DISABLED"
    }
    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    objectOptional
    get/api/private/workflows/access/global_settings/cert_auto_complete_settings
    GET /api/private/workflows/access/global_settings/cert_auto_complete_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    200

    OK

    {
      "value": "AUTO_COMPLETE_DISABLED"
    }
    put
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    Content-TypestringOptionalExample: application/json
    AcceptstringOptionalExample: application/json
    Body
    objectOptionalExample: {"value":"<integer>"}
    Responses
    200

    OK

    application/json
    objectOptional
    put/api/private/workflows/access/global_settings/cert_auto_complete_settings
    PUT /api/private/workflows/access/global_settings/cert_auto_complete_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 21
    
    {
      "value": "<integer>"
    }
    200

    OK

    {
      "value": "AUTO_COMPLETE_DISABLED"
    }

    Example

    Get Review Auto-Complete Settings

    Set Review Auto-Complete Settings

    Reviewer Bulk Actions Settings

    Control which bulk actions are available to reviewers.

    This setting provides granular control over bulk operations in Access Reviews. With it, administrators can selectively disable specific actions, based on organizational security policies and compliance requirements.

    When a bulk action is enabled (all actions are enabled by default), reviewers choose the action to multiple rows at once using row selection, "Select All", or filter-based operations. When disabled, the specified action is hidden from the reviewer interface, for any operations affecting two or more rows.

    Bulk action restrictions apply only to users with the reviewer role. Administrators and operators are not affected by these settings. Single-row operations (acting on one row at a time) are never restricted.

    All fields default to true (all bulk actions allowed). This setting can be configured globally for all reviews, or for specific review configurations by workflow_id parameter.

    The fallback precedence is:

    • configuration-specific setting → global setting → default (all enabled).

    When a bulk action is disabled, any that use the disabled action type are also hidden from reviewers. For example, if bulk approve is disabled, a Smart Action that includes an approve step will not be shown to reviewers.

    Parameters

    The request body accepts:

    • allow_bulk_approve (boolean) - Enable or disable bulk approve for reviewers

    • allow_bulk_reject (boolean) - Enable or disable bulk reject for reviewers

    • allow_bulk_signoff (boolean) - Enable or disable bulk sign-off for reviewers

    Example request body to disable bulk approve and reject globally while keeping other bulk actions enabled:

    Example request body to disable all bulk actions for a specific review configuration:

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

    Global Settings Request:

    Configuration-Specific Request:

    Example response:

    Update the reviewer bulk actions settings globally or for a specific review configuration.

    Global Settings Request:

    Configuration-Specific Request:

    Example response:

    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.

    • Can modify rows of an expired or completed certification as if it were still open, provided the rows aren't signed off. These changes have no time limit.

    • Updates one row per call.

    A :

    • Can't undo sign-off of a row.

    • On an expired or completed certification, allows the Administrator, Access Reviews Admin, and Operator roles the following updates, with no time limit:

      • Mark a rejected row as Fixed, or set a fixed row back to Rejected

      • Update row notes

    Field
    In
    Value

    A successful response will be empty:

    Review Expiration Behavior

    Configure what happens when reviews expire.

    This setting is configurable on the Access Reviews > Settings page. Enable Reject incomplete rows to reject and sign off on undecided rows when a review expires.

    This API allows you to change the behavior when a review expires (which can be enabled in Review Auto-Complete Settings). Depending on the behavior, incomplete rows can be auto-rejected when the review deadline passes.

    Review expiration behavior can be configured globally, or for all reviews for a single Review Configuration, specified by workflow_id in the request.

    Request Structure

    The request body must include a setting object with the following structure:

    {
      "workflow_id": "string",
      "setting": {
        "behavior": 0,
        "note_to_add": "string"
      }
    }

    Parameters

    Where:

    • workflow_id (string, optional): Specific review configuration ID. If omitted, applies globally to all reviews.

    • setting.behavior (integer): The expiration behavior mode:

      • 0 = DO_NOTHING: No action is made on incomplete rows (default)

      • 1 = AUTO_REJECT_INCOMPLETE_RESULTS: Reject and sign-off any results that are incomplete when the review expires

    • setting.note_to_add (string, optional): Note to be added when auto-rejecting or auto-approving incomplete results

    Example request:

    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 request body:

    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:

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

    Global Settings Request:

    Configuration-Specific Request:

    Example response:

    Self Review Prevention

    Prevent users from being assigned as reviewers for rows that relate to their own access and permissions.

    Enable or disable self-review prevention. When self-review prevention is enabled, users are prevented from being assigned as reviewers for rows that relate to their own access and permissions.

    Parameters

    The value can be either an integer or string:

    • SELF_REVIEWER_CHECKING_DISABLED = 1 (or "SELF_REVIEWER_CHECKING_DISABLED" as string)

    • SELF_REVIEWER_CHECKING_ENABLED = 2 (or "SELF_REVIEWER_CHECKING_ENABLED" as string)

    An optional workflow_id parameter allows configuring self-review prevention per review configuration, overriding the global setting for that configuration. When workflow_id is omitted, the request reads or writes the global setting.

    Example using string value (global):

    Example using integer value (global):

    Example enabling self-review prevention for a specific review configuration:

    When a workflow_id is provided on a GET request, Veza returns the configuration-specific setting if one exists, or falls back to the global setting.

    Example GET request (per review configuration):

    Example cURL request (global):

    Example cURL request (per review configuration):

    Expire Overdue Reviews

    Auto-expire overdue reviews.

    This setting is configurable on the Access Reviews > Settings page. Enable Auto-Expire overdue reviews to automatically expire reviews that aren't completed by the due date.

    Enables or disable expiration of overdue reviews. By default, overdue reviews are not expired and remain available to reviewers. When expiration is enabled, the review will be "expired" when it becomes overdue. An expired review is read-only and is not shown to reviewers.

    Parameters

    The value can be True or False.

    Get Expire Overdue Reviews Setting

    Set Expire Overdue Reviews Setting

    Data Source Acknowledgment

    Require data source status acknowledgement during review creation.

    By default, when a review is created, a user can optionally view the status of the data sources involved in the review. This API allows the behavior to change, requiring that the data source status is shown to the user and acknowledged during review creation.

    Possible values are:

    • DATASOURCE_ACKNOWLEDGEMENT_UNKNOWN = 0

    • DATASOURCE_ACKNOWLEDGEMENT_NOT_SHOWN = 1

    Get Mandatory Due Date Settings

    Set Mandatory Due Date Settings

    Get Auto-Complete Settings

    Set Auto-Complete Settings

    Get Expire Overdue Certifications Setting

    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    objectOptional
    get/api/private/workflows/access/global_settings/expire_overdue_certifications
    GET /api/private/workflows/access/global_settings/expire_overdue_certifications HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    200

    OK

    {
      "value": false
    }

    Set Expire Overdue Certifications Setting

    put
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    Content-TypestringOptionalExample: application/json
    AcceptstringOptionalExample: application/json
    Body
    objectOptionalExample: {"value":"<boolean>"}
    Responses
    200

    OK

    application/json
    objectOptional
    put/api/private/workflows/access/global_settings/expire_overdue_certifications
    PUT /api/private/workflows/access/global_settings/expire_overdue_certifications HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 21
    
    {
      "value": "<boolean>"
    }
    200

    OK

    {
      "value": false
    }
    allow_bulk_clear_decisions (boolean) - Enable or disable bulk clear decisions for reviewers
  • allow_bulk_add_note (boolean) - Enable or disable bulk add note for reviewers

  • allow_bulk_reassign (boolean) - Enable or disable bulk reassign for reviewers

  • workflow_id (optional string) - Specific review configuration ID to override global settings

  • {
      "value": {
        "allow_bulk_approve": false,
        "allow_bulk_reject": false,
        "allow_bulk_signoff": true,
        "allow_bulk_clear_decisions": true,
        "allow_bulk_add_note": true,
        "allow_bulk_reassign": true
      }
    }
    {
      "value": {
        "allow_bulk_approve": false,
        "allow_bulk_reject": false,
        "allow_bulk_signoff": false,
        "allow_bulk_clear_decisions": false,
        "allow_bulk_add_note": false,
        "allow_bulk_reassign": false
      },
      "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264"
    }
    curl -L 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/reviewer_bulk_actions' \
    -H 'Authorization: Bearer YOUR_API_KEY'
    curl -L 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/reviewer_bulk_actions?workflow_id=8ae1c414-3a76-46cb-950a-925316b3f264' \
    -H 'Authorization: Bearer YOUR_API_KEY'
    {
      "value": {
        "allow_bulk_approve": true,
        "allow_bulk_reject": true,
        "allow_bulk_signoff": true,
        "allow_bulk_clear_decisions": true,
        "allow_bulk_add_note": true,
        "allow_bulk_reassign": true
      }
    }
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/reviewer_bulk_actions' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "value": {
        "allow_bulk_approve": false,
        "allow_bulk_reject": false,
        "allow_bulk_signoff": true,
        "allow_bulk_clear_decisions": true,
        "allow_bulk_add_note": true,
        "allow_bulk_reassign": true
      }
    }'
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/reviewer_bulk_actions' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "value": {
        "allow_bulk_approve": false,
        "allow_bulk_reject": false,
        "allow_bulk_signoff": false,
        "allow_bulk_clear_decisions": false,
        "allow_bulk_add_note": false,
        "allow_bulk_reassign": false
      },
      "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264"
    }'
    {}

    Examples

    Get Reviewer Bulk Actions Settings

    Set Reviewer Bulk Actions Settings

    Smart Actions

    Update webhook notification status and details (see Update Webhook Info)

  • Can update up to 100 rows per call, through Update Multiple Certification Results.

  • body

    Result decision(NONE, REJECTED, ACCEPTED, FIXED)

    notes

    body

    string of most recent row

    reviewers

    body

    object

    signed_off_state

    body

    Sign-off status (NOT_SIGNED_OFF, SIGNED_OFF)

    notification_status

    body

    Integration status (UNKNOWN, PENDING, SUCCEED, FAILED)

    certification_id

    path

    ID of the certification containing the result to alter

    value

    body

    Contains a single certification result and keys to update

    result_id

    body

    Numeric result id to update (min 0)

    curl '{{VEZA_URL}}/api/preview/awf/certifications/f9123002-978f-f203bc9885ed/results:force_update' \
      -H 'authorization: Bearer '$token \
      -D '{"value": {"result_id": 0,"signed_off_state":"NOT_SIGNED_OFF"}}'
    {}

    Parameters

    Sample Request

    Sample Response

    standard update request

    decision

  • 2 = AUTO_APPROVE_INCOMPLETE_RESULTS: Approve and sign off any results that are incomplete when the review expires

  • {
      "workflow_id": "string",
      "setting": {
        "behavior": 1,
        "note_to_add": "Rejected incomplete result due to review expiration."
      }
    }
    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Query parameters
    workflow_idstringOptionalExample: <string>
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    objectOptional
    get/api/private/workflows/access/global_settings/review_expiration_behavior
    GET /api/private/workflows/access/global_settings/review_expiration_behavior HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    200

    OK

    {
      "value": "AUTO_REJECT_INCOMPLETE_RESULTS",
      "setting": {
        "behavior": 0,
        "note_to_add": "Rejected incomplete result due to review expiration."
      }
    }
    put
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    Content-TypestringOptionalExample: application/json
    AcceptstringOptionalExample: application/json
    Body
    workflow_idstringOptional

    Optional workflow ID for configuration-specific settings

    behaviorintegerRequired

    Expiration behavior: 0 = DO_NOTHING, 1 = AUTO_REJECT_INCOMPLETE_RESULTS

    note_to_addstringOptional

    Note to add when auto-rejecting incomplete results

    Responses
    200

    OK

    application/json
    objectOptional
    put/api/private/workflows/access/global_settings/review_expiration_behavior
    PUT /api/private/workflows/access/global_settings/review_expiration_behavior HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 118
    
    {
      "workflow_id": "string",
      "setting": {
        "behavior": 1,
        "note_to_add": "Rejected incomplete result due to review expiration."
      }
    }
    200

    OK

    {
      "value": "AUTO_REJECT_INCOMPLETE_RESULTS",
      "setting": {
        "behavior": 1,
        "note_to_add": "Rejected incomplete result due to review expiration."
      }
    }

    Example

    Get Review Expiration Behavior

    Set Review Expiration Behavior

    DATASOURCE_ACKNOWLEDGEMENT_REQUIRED = 2

    Acknowledgement settings apply only to manually created reviews in the Veza console and do not apply to on-demand, scheduled, or API-created reviews.

    Parameters

    Get Data Source Acknowledgement Setting

    Set Data Source Acknowledgement Setting

    {
      "value": {
        "allow_csv_exports": true,
        "allow_pdf_exports": false
      },
      "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264"  // Optional
    }
    curl -L 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/allow_reviewer_exports' \
    -H 'Authorization: Bearer YOUR_API_KEY'
    curl -L 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/allow_reviewer_exports?workflow_id=8ae1c414-3a76-46cb-950a-925316b3f264' \
    -H 'Authorization: Bearer YOUR_API_KEY'
    {
      "value": {
        "allow_csv_exports": false,
        "allow_pdf_exports": false
      }
    }
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/allow_reviewer_exports' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "value": {
        "allow_csv_exports": true,
        "allow_pdf_exports": false
      }
    }'
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/allow_reviewer_exports' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "value": {
        "allow_csv_exports": true,
        "allow_pdf_exports": false
      },
      "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264"
    }'
    {}

    Example

    Get Reviewer Export Settings

    Set Reviewer Export Settings

    {
        "value": "SELF_REVIEWER_CHECKING_DISABLED"
    }
    {
        "value": 1
    }
    {
        "value": "SELF_REVIEWER_CHECKING_ENABLED",
        "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264"
    }
    curl -L -X GET 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/self_reviewer_settings?workflow_id=8ae1c414-3a76-46cb-950a-925316b3f264' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN'
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/self_reviewer_settings' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN' \
      -H 'Content-Type: application/json' \
      -d '{
        "value": 1
      }'
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/self_reviewer_settings' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN' \
      -H 'Content-Type: application/json' \
      -d '{
        "value": 2,
        "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264"
      }'
    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Query parameters
    workflow_idstringOptional

    Optional. If provided, returns the setting for this specific review configuration. If not provided or no configuration-specific setting exists, returns the global setting.

    Example: 8ae1c414-3a76-46cb-950a-925316b3f264
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    objectOptional
    get/api/private/workflows/access/global_settings/self_reviewer_settings
    GET /api/private/workflows/access/global_settings/self_reviewer_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    200

    OK

    {
      "value": "SELF_REVIEWER_CHECKING_DISABLED"
    }
    put
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    Content-TypestringOptionalExample: application/json
    AcceptstringOptionalExample: application/json
    Body
    valueone ofOptional
    integer · enumOptional

    1 = SELF_REVIEWER_CHECKING_DISABLED, 2 = SELF_REVIEWER_CHECKING_ENABLED

    Possible values:
    or
    string · enumOptional

    String values for self-review prevention settings

    Possible values:
    workflow_idstringOptional

    Optional. If provided, sets the setting for this specific review configuration only. If omitted, sets the global setting.

    Responses
    200

    OK

    application/json
    objectOptional
    put/api/private/workflows/access/global_settings/self_reviewer_settings
    PUT /api/private/workflows/access/global_settings/self_reviewer_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 64
    
    {
      "value": 2,
      "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264"
    }
    200

    OK

    {
      "value": "SELF_REVIEWER_CHECKING_DISABLED"
    }

    Examples

    Get Self Review Settings

    Set Self Review Settings

    List Certification Results

    Get results for workflow certifications

    Returns the results of the certification query, including any special properties, decisions, and notes.

    Method
    syntax

    GET

    {{base_url}}/api/preview/awf/certifications/{certification_id}/results

    Parameters

    Name
    Type
    Req.
    Description

    Request

    Provide the UUID of the certification to get results. You can page through responses by providing a starting result number, and setting the maximum results to return.

    Response

    Each row in a certification describes an identity and resource entity pair, connected by a set of concrete and abstract permissions. Responses can be partial, depending on the page_size. You can get the next set of results by requesting a valid next_page_token as the page_token.

    See for more details on the Certification Result object.

    Result objects include two enrichment fields when available:

    tags — An array of Veza tags on the source entity, returned as a property inside the source object. Each entry includes:

    Field
    Type
    Description

    joined_nodes — An object containing enriched attributes from connected systems, keyed by the alias configured in the workflow's join specification. Fields vary by node type and may include canonical_name, department, email, manager_email, identity_type, and custom properties prefixed with customprop_. This field is present when enrichment data is configured for the integration.

    Get Certification Result

    Return a single certification result

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

    Method
    syntax

    GET

    /api/preview/awf/certifications/{certification_id}/results/{result_id}

    Parameters

    Name
    Type
    Req.
    Description

    Request

    Response

    For more information about the Result object see .

    See for a description of the tags and joined_nodes enrichment fields.

    Predefined Decision Notes

    Add suggested notes for reviewer decisions.

    Configure predefined notes as menu options when reviewers approve or reject rows. This feature can be configured globally for all reviews or specifically for individual review configurations. When configured for a specific review configuration (using workflow_id), those settings override any global predefined notes.

    The predefined notes appear as selectable options in the notes dialog when making decisions, suggesting standardized responses alongside free-form text entry.

    Parameters

    The request body accepts:

    • reject_notes: Array of predefined note options shown when rejecting rows

    • accept_notes: Array of predefined note options shown when approving rows

    • workflow_id: (Optional) Specific review configuration ID to override global settings

    Example request body:

    Retrieve the current predefined notes settings. Include the optional workflow_id query parameter to get settings for a specific review configuration.

    Global Settings Request:

    Configuration-Specific Request:

    Example response:

    Update the predefined notes settings globally or for a specific review configuration.

    Configuration-Specific Request:

    Review Row Grouping

    Configure default grouping behavior for review rows to organize data by column values.

    Configure default grouping behavior for access review rows. When enabled, review rows are automatically organized by the specified column values, making it easier for reviewers to process large datasets by grouping related items together.

    The setting allows admins to configure a default group by column and collapsed/expanded behavior, either globally or per-workflow.

    Name
    Type
    Required
    In
    Description

    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.

    The endpoint also accepts calls after a certification completes or expires, with no time limit. Those calls require the Administrator, Access Reviews Admin, or Operator role.

    Method
    syntax

    Get Review Expiration Settings

    Set Review Expiration Settings

    Get Self-Reviewer Settings

    Set Self-Reviewer Settings

    notes
    WorkflowUser

    Get Data Source Acknowledgement Settings

    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    objectOptional
    get/api/private/workflows/access/global_settings/datasource_acknowledgement
    GET /api/private/workflows/access/global_settings/datasource_acknowledgement HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    200

    OK

    {
      "value": "DATASOURCE_ACKNOWLEDGEMENT_REQUIRED"
    }

    Set Data Source Acknowledgement Settings

    put
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    Content-TypestringOptionalExample: application/json
    AcceptstringOptionalExample: application/json
    Body
    objectOptionalExample: {"value":"<integer>"}
    Responses
    200

    OK

    application/json
    objectOptional
    put/api/private/workflows/access/global_settings/datasource_acknowledgement
    PUT /api/private/workflows/access/global_settings/datasource_acknowledgement HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 21
    
    {
      "value": "<integer>"
    }
    200

    OK

    {
      "value": "DATASOURCE_ACKNOWLEDGEMENT_REQUIRED"
    }
    post
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Path parameters
    workflow_idstringRequired
    Body
    workflow_idstringOptional
    namestringOptional
    Responses
    200

    OK

    application/json
    workflow_idstringOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    post/api/private/workflows/access/{workflow_id}:clone
    POST /api/private/workflows/access/{workflow_id}:clone HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 36
    
    {
      "workflow_id": "text",
      "name": "text"
    }
    {
      "workflow_id": "text"
    }
    get
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Query parameters
    workflow_idstringOptional

    Optional. If empty, returns the global tenant setting. If provided, returns the workflow-specific setting.

    Responses
    200

    OK

    application/json
    allow_bulk_approvebooleanOptional
    allow_bulk_rejectbooleanOptional
    allow_bulk_signoffbooleanOptional
    allow_bulk_clear_decisionsbooleanOptional
    allow_bulk_add_notebooleanOptional
    allow_bulk_reassignbooleanOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    get/api/private/workflows/access/global_settings/reviewer_bulk_actions
    GET /api/private/workflows/access/global_settings/reviewer_bulk_actions HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    {
      "value": {
        "allow_bulk_approve": true,
        "allow_bulk_reject": true,
        "allow_bulk_signoff": true,
        "allow_bulk_clear_decisions": true,
        "allow_bulk_add_note": true,
        "allow_bulk_reassign": true
      }
    }
    put
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Body
    allow_bulk_approvebooleanOptional
    allow_bulk_rejectbooleanOptional
    allow_bulk_signoffbooleanOptional
    allow_bulk_clear_decisionsbooleanOptional
    allow_bulk_add_notebooleanOptional
    allow_bulk_reassignbooleanOptional
    workflow_idstringOptional

    Optional. If empty, sets the global tenant setting. If provided, sets the workflow-specific setting.

    Responses
    200

    OK

    application/json
    object · SetReviewerBulkActionsSettingsResponseOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    put/api/private/workflows/access/global_settings/reviewer_bulk_actions
    PUT /api/private/workflows/access/global_settings/reviewer_bulk_actions HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 197
    
    {
      "value": {
        "allow_bulk_approve": true,
        "allow_bulk_reject": true,
        "allow_bulk_signoff": true,
        "allow_bulk_clear_decisions": true,
        "allow_bulk_add_note": true,
        "allow_bulk_reassign": true
      },
      "workflow_id": "text"
    }
    {}
    get
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Query parameters
    workflow_idstringOptional
    Responses
    200

    OK

    application/json
    allow_csv_exportsbooleanOptional
    allow_pdf_exportsbooleanOptional
    allow_xlsx_exportsbooleanOptional
    workflow_idstringOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    get/api/private/workflows/access/global_settings/allow_reviewer_exports
    GET /api/private/workflows/access/global_settings/allow_reviewer_exports HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    {
      "value": {
        "allow_csv_exports": true,
        "allow_pdf_exports": true,
        "allow_xlsx_exports": true
      },
      "workflow_id": "text"
    }
    put
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Body
    allow_csv_exportsbooleanOptional
    allow_pdf_exportsbooleanOptional
    allow_xlsx_exportsbooleanOptional
    workflow_idstringOptional
    Responses
    200

    OK

    application/json
    object · SetAccessWorkflowSettingAllowReviewerViewExportsResponseOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    put/api/private/workflows/access/global_settings/allow_reviewer_exports
    PUT /api/private/workflows/access/global_settings/allow_reviewer_exports HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 108
    
    {
      "value": {
        "allow_csv_exports": true,
        "allow_pdf_exports": true,
        "allow_xlsx_exports": true
      },
      "workflow_id": "text"
    }
    {}

    certification_id

    string

    Y

    Certification id

    page_token

    int

    N

    next_page_token to list results from

    page_size

    int

    N

    Max results to return per page (default 100, minimum 1, maximum 2,000)

    paginate_direction_backwards

    boolean

    N

    When true, use reverse order from the last page of results

    key

    string

    Tag name

    type

    string

    Tag source. VEZA for platform-managed tags.

    value

    string

    Tag value, or empty string for boolean tags.

    Examples

    Enrichment fields

    Workflow Parameters

    certification_id

    string

    Y

    Certification id

    result_id

    string

    Y

    Result number to retrieve

    Examples

    Workflows Parameters
    List Certification Results

    Example

    Get Predefined Notes Settings

    Set Predefined Notes Settings

    string

    No

    body

    The workflow ID to apply the setting to

    value.group_by_column

    string

    Yes

    body

    The column to group rows by (e.g. destination.veza_unique_name, source.veza_unique_name, status, risk_level). Must be a valid column name (same as in CreateAccessResultsGroupCollection). If empty or unset, grouping is disabled.

    value.expand_groups_by_default

    bool

    Yes

    body

    When set to true, row groups will be expanded by default when the review loads; if false, they'll be collapsed. This flag is ignored when group_by_column is empty.

    GET /api/private/workflows/access/global_settings/rows_group_by_setting

    PUT /api/private/workflows/access/global_settings/rows_group_by_setting

    • destination.veza_unique_name - Group by resource name

    • source.veza_unique_name - Group by identity name

    • status - Group by review status

    • risk_level - Group by risk level

    • destination.type - Group by resource type

    • decision - Group by decision status

    Parameters

    workflow_id

    Get Row Grouping Settings

    Get Global Setting

    Get Workflow-Scoped Setting

    Example Response

    Set Row Grouping Settings

    Example: Set Global Setting

    Example: Set Workflow-Scoped Setting

    Response

    Common Column Examples

    Row grouping settings apply when reviewers first load a review. Users can manually change grouping options in the review interface regardless of these default settings. When configured for a specific review configuration (using workflow_id), those settings override any global grouping settings for reviews created from that configuration.

    Grouping helps organize large reviews by collecting related rows together, making it easier to identify patterns and make decisions efficiently. Common grouping strategies include grouping by department, resource type, permission level, or risk assessment.

    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 {}

    POST

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

    {
      "result_id": "0",
      "notification_status": "FAILED",
      "webhook_info": "Ticket could not be created"
    }
    curl '{{VEZA_URL}}/api/preview/awf/certifications/f9123002-f056-491f-978f-f203bc9885ed/results?page_token=0&page_size=1' \
      -H 'authorization: Bearer '$token
    {
        "values": [
            {
                "result_id": 0,
                "source": {
                    "aliases": [],
                    "created_at": "2023-05-03T14:25:43Z",
                    "datasource_id": "datasource:google_cloud_workspace",
                    "email_addresses": [
                        "jdoe@cookiebeta.ai",
                        "jdoe@cookiebeta.ai.test-google-a.com",
                        "jdoe@veza.com"
                    ],
                    "full_admin": false,
                    "google_cloud_organization_name": "organizations/123456789012",
                    "guest": false,
                    "id": "datasource:112655590859538682841",
                    "idp_unique_id": "jdoe@cookiebeta.ai",
                    "is_active": true,
                    "last_login_at": "2023-05-10T15:25:04Z",
                    "location_areas": [],
                    "mfa_enabled": false,
                    "name": "jdoe@cookiebeta.ai",
                    "organization_names": [],
                    "provider_id": "datasource",
                    "suspended": false,
                    "type": "GoogleWorkspaceUser",
                    "tags": [
                        {
                            "key": "department",
                            "type": "VEZA",
                            "value": "engineering"
                        }
                    ]
                },
                "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": "cookie@cookie.ai",
                        "name": "External User"
                    }
                ],
                "signed_off_state": "NOT_SIGNED_OFF",
                "reviewer_assignment": null,
                "joined_nodes": {
                    "idp": {
                        "canonical_name": "Jane Doe",
                        "department": "Engineering",
                        "email": "jdoe@cookiebeta.ai",
                        "identity_type": "HUMAN",
                        "is_active": true,
                        "manager_email": "manager@cookiebeta.ai",
                        "name": "jdoe",
                        "type": "OAA.custom_idp.IDPUser"
                    }
                }
            },
            {
                "result_id": 1,
                "source": {
                    "aliases": [],
                    "created_at": "2023-05-03T14:25:43Z",
                    "datasource_id": "datasource:google_cloud_workspace",
                    "email_addresses": [
                        "jdoe@cookiebeta.ai",
                        "jdoe@cookiebeta.ai.test-google-a.com",
                        "jdoe@veza.com"
                    ],
                    "full_admin": false,
                    "google_cloud_organization_name": "organizations/123456789012",
                    "guest": false,
                    "id": "datasource:112655590859538682841",
                    "idp_unique_id": "jdoe@cookiebeta.ai",
                    "is_active": true,
                    "last_login_at": "2023-05-10T15:25:04Z",
                    "location_areas": [],
                    "mfa_enabled": false,
                    "name": "jdoe@cookiebeta.ai",
                    "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": "cookie@cookie.ai",
                        "name": "External User"
                    }
                ],
                "signed_off_state": "NOT_SIGNED_OFF",
                "reviewer_assignment": null
            }
        ],
        "next_page_token": "EAI=",
        "has_more": true,
        "has_previous": false
    }
    curl '{{VEZA_URL}}/api/preview/awf/certifications/f9123002-978f-f203bc9885ed/results/0' \
      -H 'authorization: Bearer '$token
    {
        "value": {
            "result_id": 0,
            "source": {
                "aliases": [],
                "created_at": "2023-05-03T14:25:43Z",
                "datasource_id": "datasource:google_cloud_workspace",
                "email_addresses": [
                    "jdoe@cookiebeta.ai",
                    "jdoe@cookiebeta.ai.test-google-a.com",
                    "jdoe@veza.com"
                ],
                "full_admin": false,
                "google_cloud_organization_name": "organizations/123456789012",
                "guest": false,
                "id": "datasource:112655590859538682841",
                "idp_unique_id": "jdoe@cookiebeta.ai",
                "is_active": true,
                "last_login_at": "2023-05-10T15:25:04Z",
                "location_areas": [],
                "mfa_enabled": false,
                "name": "jdoe@cookiebeta.ai",
                "organization_names": [],
                "provider_id": "datasource",
                "suspended": false,
                "type": "GoogleWorkspaceUser",
                "tags": [
                    {
                        "key": "department",
                        "type": "VEZA",
                        "value": "engineering"
                    }
                ]
            },
            "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": "cookie@cookie.ai",
                    "name": "External User"
                }
            ],
            "signed_off_state": "NOT_SIGNED_OFF",
            "reviewer_assignment": null,
            "joined_nodes": {
                "idp": {
                    "canonical_name": "Jane Doe",
                    "department": "Engineering",
                    "email": "jdoe@cookiebeta.ai",
                    "identity_type": "HUMAN",
                    "is_active": true,
                    "manager_email": "manager@cookiebeta.ai",
                    "name": "jdoe",
                    "type": "OAA.custom_idp.IDPUser"
                }
            }
        }
    }
    {
        "value": {
            "reject_notes": [
                "Rotate now",
                "Delete secret"
            ],
            "accept_notes": []
        },
        "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264"  // Optional
    }
    curl -L 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/predefined_decision_notes' \
    -H 'Authorization: Bearer YOUR_API_KEY'
    curl -L 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/predefined_decision_notes?workflow_id=8ae1c414-3a76-46cb-950a-925316b3f264' \
    -H 'Authorization: Bearer YOUR_API_KEY'
    {
        "value": {
            "reject_notes": [
                "Rotate now",
                "Delete secret"
            ],
            "accept_notes": []
        }
    }
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/predefined_decision_notes' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
        "value": {
            "reject_notes": [
                "Rotate now",
                "Delete secret"
            ],
            "accept_notes": []
        },
        "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264"
    }'
    curl 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/rows_group_by_setting' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer YOUR_BEARER_TOKEN'
    curl 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/rows_group_by_setting?workflow_id=01983256-911c-7906-9d75-d69871c877fd' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer YOUR_BEARER_TOKEN'
    {
      "value": {
        "group_by_column": "status",
        "expand_groups_by_default": true
      }
    }
    curl -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/rows_group_by_setting' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
        -d '{
          "value": {
            "group_by_column": "destination.veza_unique_name",
            "expand_groups_by_default": false
          }
        }'
    curl -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/rows_group_by_setting' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
        -d '{
          "workflow_id": "01983256-911c-7906-9d75-d69871c877fd",
          "value": {
            "group_by_column": "destination.veza_unique_name",
            "expand_groups_by_default": false
          }
        }'
    {}  // Empty on success

    Get Access Graph

    Detailed graph relationships for certification results

    Method
    syntax

    GET

    /api/preview/awf/access_graph

    Returns Access Graph relationships for a certification result, including intermediate role details and accumulated permissions.

    Parameters

    Name
    Type
    Description
    Req.

    Omit snapshot_id to get the most recent access graph. Specify the snapshot_id of the original certification to show relationships at the time of certification.

    Request

    Response

    The out_edges of each node will contain the IDs of other directly connected nodes. For example, if "OktaUser" is connected to two "OktaGroup" nodes G1 and G2, the user's out-edges will be [{G1}, {G2}]. The node id for each connected node will be included in the response, as well as the status of the relevant data sources, for example:

    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.

    Method
    syntax

    get

    Example response:

    Add a user, either a or an identity from a .

    Note: To get the user_type for a Veza system user, as well as the user_id, email, and name, view network traffic in the browser while while searching for the user in a reviewer selection drop-down.

    Method
    syntax

    Example body:

    Delete an entry on the deny list.

    Method
    syntax

    Example body:

    Action Allow List

    Restrict which users can delete, complete, or change the due dates of access reviews, independent of their assigned Veza role.

    API reference for the Action Allow List feature. For configuration guidance and how it works, see .

    Operation
    Required Role

    Access Review Settings

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

    Use these APIs to configure for Veza Access Reviews, or to operate on a specific Review Configuration.

    • : Duplicate an existing access review configuration under a new name, carrying over notifications, Veza Actions, and per-configuration settings.

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

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

    Reviewer Reassignment Setting

    Control whether assigned reviewers can reassign rows to other reviewers.

    Controls whether users acting as assigned reviewers can reassign rows to other reviewers.

    • When enabled (the default), any user assigned as a reviewer on specific rows can reassign those rows.

    • When disabled, assigned reviewers cannot reassign rows.

    • Administrators, Operators, and Reassigners always retain reassignment privileges, regardless of this setting.

    This setting can be configured globally for all reviews, or for specific review configurations by workflow_id

    Alternate Reviewer Settings

    Configure the fallback reviewer selection methods used when a valid reviewer cannot be assigned.

    Configure the ordered list of fallback selection methods that Veza uses when a valid reviewer cannot be assigned. When all specified reviewers are prevented from assignment (due to self-review prevention, the reviewer deny list, or missing managers/owners), Veza evaluates each selection method in order until an allowed alternate reviewer is found.

    For more information, see .

    The selection_methods array accepts integer or string values representing fallback methods to enable. Enabled methods are evaluated in the specified order.

    Integer
    String Value
    Description

    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)

    certification_id

    string

    ID of a workflow certification

    Y

    result_id

    int

    Certification result number to get access for

    Y

    snapshot_id

    string

    Graph snapshot to get results from

    N

    Examples

    /api/preview/workflows/deny_list/users

    post

    /api/preview/workflows/deny_list/users:add

    post

    /api/preview/workflows/deny_list/users:remove

    Add User

    Remove User

    Veza system user
    configured graph Identity Provider

    Both users and groups can be added to the allow list. A user is permitted if their user ID is directly on the list, or if any Veza group they belong to is on the list.

    Each principal is specified as an object with a type and id:

    All IDs must be Veza internal UUIDs. Email addresses and usernames are not supported.

    To look up a user's UUID:

    • Administration console: Go to Administration > Users, click the user's name, and copy the UUID from their profile page.

    • Users API: Use the Users and Teams API to list users and locate the id field in the response.

    To look up a group's UUID:

    • Groups API: Use GET /api/private/groups to list groups and locate the id field for the target group. Use the filter query parameter to narrow by name (e.g., ?filter=name eq 'Your Group Name').

    The allowed_action field controls which restricted operations the principal is permitted to perform. Specify one or more values:

    Value
    Description

    DELETE_IN_PROGRESS_REVIEW

    Delete an In Progress review

    MODIFY_IN_PROGRESS_REVIEW_DUE_DATE

    Modify the due date of an In Progress review

    MANUALLY_COMPLETE_REVIEW

    Manually complete a review (the explicit Complete Review action; automatic completion is not affected)

    DELETE_EXPIRED_COMPLETED_REVIEW

    Delete an expired or completed review (only possible while the allow list is enabled)

    GET /api/private/workflows/access/settings/action_allowlist_enabled

    Returns the current enabled state of the allow list.

    Example:

    Response:


    PUT /api/private/workflows/access/settings/action_allowlist_enabled

    Enable or disable the allow list globally. When disabled, existing RBAC governs access to all review operations.

    Request body:

    Set enabled to true to enable or false to disable.

    Example (enable):

    Example (disable):


    POST /api/private/workflows/access/action_allowlist

    Add one or more users or groups to the allow list. A single request can include multiple principals of mixed types.

    Request body:

    Example (add a user for both actions):

    Example (add a group):


    POST /api/private/workflows/access/action_allowlist:delete

    Remove one or more principals from the allow list. Uses the same request shape as the add endpoint.

    Request body:

    Example:


    GET /api/private/workflows/access/action_allowlist

    Returns all users and groups currently on the allow list. Each entry represents one principal–action pair; a principal with two allowed actions appears as two separate entries.

    Example:

    Response:


    GET /api/private/workflows/access/action_allowlist/{user_id}

    Returns the resolved allowed actions for the specified user, including permissions inherited from group memberships. Pass a user UUID — passing a group UUID will return an empty allowed_actions array rather than an error.

    Example:

    Response:

    Returns an empty array if the user is not on the list and belongs to no permitted groups.

    Enable or disable the allow list

    admin

    Add or remove users from the list

    admin or access_reviews_admin

    Check whether a user is permitted

    admin or access_reviews_admin

    Role Requirements

    Principals

    Action Allow List

    Allowed Actions

    API Reference

    Check Whether the Allow List Is Enabled

    Enable or Disable the Allow List

    Add Principals to the Allow List

    Remove Principals from the Allow List

    List All Permitted Principals

    Check Whether a User Is Permitted

    Review Completion Settings: Enable review completion at any time, or only when all rows are signed off with a non-rejected decision.
  • Data Source Acknowledgment: 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.

  • Default Review Page Size: Set the default number of ungrouped rows shown per page when a reviewer opens 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.

  • Outlier Detection: Configure outlier detection to identify anomalous access patterns by comparing users to peer groups (Early Access, API-only).

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

  • Reviewer Bulk Actions Settings: Control which bulk actions (approve, reject, sign off, clear decisions, add note, reassign) are available to reviewers.

  • Mandatory Due Date Settings: Configure whether due dates are required when creating or editing access reviews.

  • Column Name Overrides: Customize column display names in the reviewer interface to match your organization's terminology.

  • Alternate Reviewer Settings: Configure the fallback reviewer selection methods used when a valid reviewer cannot be assigned (Early Access).

  • Action Allow List: Restrict which users can delete in-progress reviews or modify their due dates, independent of their Veza role.

  • 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:

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

    To import the collection into Postman:

    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

    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

    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.

    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.

    Per-configuration operations

    Global settings

    Access Reviews Settings
    Clone Review Configuration
    Review Auto-Complete Settings

    Postman Collection

    Import Instructions

    Configure Variables

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

    access-reviews-global-settings.postman_collection.json
    53KB
    Open
    parameter.

    The fallback precedence is:

    • configuration-specific setting → global setting → default (ALLOWED).

    The request body accepts:

    • value (string) — ALLOWED or NOT_ALLOWED

    • workflow_id (optional string) — Specific review configuration ID to override global settings

    Value
    Description

    ALLOWED

    Assigned reviewers can reassign rows (default)

    NOT_ALLOWED

    Assigned reviewers cannot reassign rows

    Example request to disable reviewer reassignment globally:

    Example request to disable reviewer reassignment for a specific review configuration:

    Retrieve the current reviewer reassignment setting. Include the optional workflow_id query parameter to get the setting for a specific review configuration.

    Global Settings Request:

    Configuration-Specific Request:

    Example response:

    Update the reviewer reassignment setting globally or for a specific review configuration. Requires Admin or Operator role.

    Global Settings Request:

    Configuration-Specific Request:

    Example response:

    Parameters

    Examples

    Get Reviewer Reassignment Setting

    Set Reviewer Reassignment Setting

    curl 'https://{{VezaURL}}/api/preview/awf/access_graph' \
    -H 'authorization: Bearer '$TOKEN \
    -G -d 'certification_id=abe5c346-84ad-49b0-bafc-614a8365c883' \
    -d 'result_id=1'
    {
      "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
            }
      ]
    }
    {
      "users": [
        {
          "user_type": "OktaUser",
          "id": "123456",
          "email": "mhines@cookie.ai",
          "name": "Marilyn Hines"
        }
      ]
    }
    {
      "users": [
        {
          "user_type": "OktaUser",
          "id": "123456",
          "email": "mhines@cookie.ai",
          "name": "Marilyn Hines"
        }
      ]
    }
    {
      "users": [
        {
          "user_type": "OktaUser",
          "id": "123456",
          "email": "mhines@cookie.ai",
          "name": "Marilyn Hines"
        }
      ]
    }
    {"type": "USER", "id": "<veza-user-uuid>"}
    {"type": "GROUP", "id": "<veza-group-uuid>"}
    curl -L -X GET 'https://your-organization.vezacloud.com/api/private/workflows/access/settings/action_allowlist_enabled' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN'
    {"enabled": false}
    {
      "enabled": true
    }
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/settings/action_allowlist_enabled' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN' \
      -H 'Content-Type: application/json' \
      -d '{"enabled": true}'
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/settings/action_allowlist_enabled' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN' \
      -H 'Content-Type: application/json' \
      -d '{"enabled": false}'
    {
      "principals": [
        {"type": "USER", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"}
      ],
      "allowed_action": ["DELETE_IN_PROGRESS_REVIEW", "MODIFY_IN_PROGRESS_REVIEW_DUE_DATE"]
    }
    curl -L -X POST 'https://your-organization.vezacloud.com/api/private/workflows/access/action_allowlist' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN' \
      -H 'Content-Type: application/json' \
      -d '{
        "principals": [{"type": "USER", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"}],
        "allowed_action": ["DELETE_IN_PROGRESS_REVIEW", "MODIFY_IN_PROGRESS_REVIEW_DUE_DATE"]
      }'
    curl -L -X POST 'https://your-organization.vezacloud.com/api/private/workflows/access/action_allowlist' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN' \
      -H 'Content-Type: application/json' \
      -d '{
        "principals": [{"type": "GROUP", "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"}],
        "allowed_action": ["DELETE_IN_PROGRESS_REVIEW", "MODIFY_IN_PROGRESS_REVIEW_DUE_DATE"]
      }'
    {
      "principals": [
        {"type": "USER", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"}
      ],
      "allowed_action": ["DELETE_IN_PROGRESS_REVIEW", "MODIFY_IN_PROGRESS_REVIEW_DUE_DATE"]
    }
    curl -L -X POST 'https://your-organization.vezacloud.com/api/private/workflows/access/action_allowlist:delete' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN' \
      -H 'Content-Type: application/json' \
      -d '{
        "principals": [{"type": "USER", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"}],
        "allowed_action": ["DELETE_IN_PROGRESS_REVIEW", "MODIFY_IN_PROGRESS_REVIEW_DUE_DATE"]
      }'
    curl -L -X GET 'https://your-organization.vezacloud.com/api/private/workflows/access/action_allowlist' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN'
    {
      "entries": [
        {
          "principal": {"type": "USER", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Jane Smith"},
          "allowed_action": "DELETE_IN_PROGRESS_REVIEW"
        },
        {
          "principal": {"type": "USER", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Jane Smith"},
          "allowed_action": "MODIFY_IN_PROGRESS_REVIEW_DUE_DATE"
        },
        {
          "principal": {"type": "GROUP", "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Review Admins"},
          "allowed_action": "DELETE_IN_PROGRESS_REVIEW"
        }
      ],
      "next_page_token": "",
      "has_more": false,
      "total_count": 3
    }
    curl -L -X GET 'https://your-organization.vezacloud.com/api/private/workflows/access/action_allowlist/a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
      -H 'Authorization: Bearer YOUR_SECRET_TOKEN'
    {"allowed_actions": ["DELETE_IN_PROGRESS_REVIEW", "MODIFY_IN_PROGRESS_REVIEW_DUE_DATE"]}
    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"}'
    {
      "value": "NOT_ALLOWED"
    }
    {
      "value": "NOT_ALLOWED",
      "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264"
    }
    curl -L 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/allow_reviewers_to_reassign_rows' \
    -H 'Authorization: Bearer YOUR_API_KEY'
    curl -L 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/allow_reviewers_to_reassign_rows?workflow_id=8ae1c414-3a76-46cb-950a-925316b3f264' \
    -H 'Authorization: Bearer YOUR_API_KEY'
    {
      "value": "ALLOWED"
    }
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/allow_reviewers_to_reassign_rows' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "value": "NOT_ALLOWED"
    }'
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/allow_reviewers_to_reassign_rows' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "value": "NOT_ALLOWED",
      "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264"
    }'
    {}

    1

    REVIEWERS_MANAGER

    Assign the manager of the prevented candidate

    2

    CERTIFICATION_ALTERNATE_REVIEWERS

    Assign to the first valid fallback reviewer

    3

    WORKFLOW_CREATOR

    Assign to the workflow creator

    4

    ADMIN

    Assign to an arbitrary local Veza admin user

    This enables all four fallback methods in order: reviewer's manager, then fallback reviewers, then workflow creator, then admin.

    For example, to enable only the first two methods:

    With this configuration, Veza will not fall back to the workflow creator or a system administrator. Rows are left unassigned if no valid manager or fallback reviewer exists.

    Retrieve current alternate reviewer selection method settings:

    Example response:

    Update the alternate reviewer selection methods. The order of values in the selection_methods array determines the evaluation order.

    Using integer values:

    Early Access Feature: The Alternate Reviewer Settings API endpoint is currently in Early Access as part of the private API namespace. The endpoint is subject to change as features are added or modified.

    Parameters

    Reviewer Selection Methods
    {
      "value": {
        "selection_methods": ["REVIEWERS_MANAGER", "CERTIFICATION_ALTERNATE_REVIEWERS", "WORKFLOW_CREATOR", "ADMIN"]
      }
    }
    {
      "value": {
        "selection_methods": [1, 2]
      }
    }
    curl -L 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/alternate_reviewer_settings' \
    -H 'Authorization: Bearer YOUR_API_KEY'
    {
      "value": {
        "selection_methods": [
          "REVIEWERS_MANAGER",
          "CERTIFICATION_ALTERNATE_REVIEWERS",
          "WORKFLOW_CREATOR",
          "ADMIN"
        ]
      }
    }
    curl -L -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/alternate_reviewer_settings' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "value": {
        "selection_methods": [1, 2, 3, 4]
      }
    }'

    Example request body (PUT)

    Get Alternate Reviewer Settings

    Set Alternate Reviewer Settings

    hide_from_reviewers_columns
    : Array of column names that will be hidden from users with the reviewer role but remain visible to administrators and operators

    Important validation rules:

    • Column names cannot appear in both default_ordered_columns and hide_from_reviewers_columns simultaneously

    • Column names cannot be empty strings

    • Column names cannot contain spaces or commas

    • The system validates these constraints and returns an error if violations are found

    The valid values to show entity attributes include:

    • source.ATTR

    • destination.ATTR

    • waypoint.ATTR

    • path_summary.ATTR

    • idp.ATTR

    Where ATTR is an attribute name such as "id" or "name".

    The following column values are also valid:

    • status

    • abstract_permissions

    • concrete_permissions

    • updated_at

    • notes

    • reviewers

    • decision

    • decision_by

    • decision_by_id

    • decision_by_name

    • decision_by_email

    • decision_at

    • marked_fixed_by_id

    • marked_fixed_by_name

    • marked_fixed_by_email

    • marked_fixed_at

    • signed_off_state

    • signed_off_by_id

    • signed_off_by_name

    • signed_off_by_email

    • signed_off_at

    • notification_status

    • automation_run_ids

    • no_decision_or_decision_by

    • Is_signed_off

    This example configuration shows sensitive identity information (unique IDs and distinguished names) to administrators while hiding them from reviewers, allowing for better security and privacy control in access reviews.

    {
      "value": {
        "default_ordered_columns": [
          "source.name",
          "source.department",
          "source.customprop_worker_status",
          "source.tags",
          "path_summary.name",
          "concrete_permissions",
          "destination.name",
          "destination.customprop_display_name",
          "reviewers"
        ],
        "hide_from_reviewers_columns": [
          "source.identity_unique_id",
          "idp.on_premises_distinguished_name"
        ]
      },
      "workflow_id": "002063d2-7898-4183-b5fb-1192758fdec7"
    }

    Validation Rules

    Valid Column Values

    Example

    Get Review Column Defaults

    Set Review Column Defaults

    List All Column Settings

    Create a certification

    Create an access review certification from a workflow, optionally scoped to specific identities

    Create an access review certification from an existing workflow. To scope the review to specific identities, such as a user who changed departments, send dynamic_information. In the Veza UI, a certification is an access review; see Create Access Review.

    Common uses:

    • Review one person's access after a change, such as a department move: send dynamic_information.

    • Run a two-level review that ends with a second sign-off: set final_approval_level to 1.

    • Create a draft to adjust before it starts: set creation_instructions to 1, then publish the review.

    This endpoint requires one of these built-in : Administrator, Access Reviews Admin, Operator, or Access Reviews Monitor. Requests from other roles return PermissionDenied. Callers must belong to the root team. OAuth2 client-credentials tokens can't call this endpoint.

    Send these fields as top-level keys of the JSON body.

    Field
    Type
    Required?
    Description

    reviewer_assignment and reviewer_assignment_second_level can assign explicit reviewers, managers, entity owners, earlier reviewers, or the row's own identity. See for all fields and how they combine.

    final_approval_level sets the last approval level of the review, which determines how many levels the review has. A review can have one or two levels. Levels are zero-indexed, so the value is one less than the number of levels:

    • 0 (REVIEW_APPROVAL_LEVEL_FIRST): one level. This is the default when the field is omitted.

    • 1 (REVIEW_APPROVAL_LEVEL_SECOND): two levels. The review completes after second-level sign-off.

    The Veza UI and email notifications number levels from 1. A review created with final_approval_level set to 1 shows a Level 1 and a Level 2.

    Values above 0 require multi-level review to be enabled for your tenant. See .

    A workflow can be configured to require an exact final approval level. When this requirement is enabled, Veza rejects a request whose final_approval_level is different, and doesn't create the review. See .

    Set a due date for each level with first_level_data and second_level_data:

    • Only send level data for levels the review has.

    • For a single-level review, omit second_level_data.

    • Due dates can't decrease from one level to the next.

    • If you set a due date for a level, also set one for each later level. A missing later due date fails with DueDates must be in non-decreasing order.

    The dynamic_information parameter narrows the workflow query to specific identities when the certification is created. The workflow itself doesn't change. The certification stores the narrowed query as its query_used, and contains only results for the identities you list.

    When identities is empty or omitted, the workflow query runs unchanged.

    Field
    Type
    Required?
    Description

    Each identity object has these fields:

    Field
    Type
    Required?
    Description

    Veza groups the identities by type and adds one filter for each type: the node's id must be one of the IDs listed for that type. Veza adds this filter to the conditions the workflow query already has on the matched node type. The filter can only remove results from the workflow query, not add them.

    For each type, Veza searches for a node type in the workflow query to filter, in this order:

    1. A source node type equal to type.

    2. A destination node type equal to type.

    3. A linked node type. If no node type in the query equals type, Veza searches for entities of the query's node types (source first, then destination) that are linked in the graph to the listed identities. Veza then filters that node type to the linked entities. For example, OktaUser identities can scope a workflow whose source is an application account type linked to those Okta users.

    If a type matches no node type in the query, the request fails and Veza doesn't create the review. Every type in the request must match: a single unmatched type fails the whole request. See . use the same matching.

    The identity type is the graph node type of the identity. Common identity provider user types include:

    Integration
    Identity type

    You can also use other node types if they match a node type in the workflow query or are linked to one in the graph. See .

    Identity IDs and types must match the values stored in the Access Graph. You can find these values by querying the graph or viewing entity details in the Veza UI.

    Set VEZA_URL and VEZA_TOKEN as described in .

    Create a certification with the latest data:

    Example response:

    Scope a certification to specific identities, for example a user who changed departments:

    Create a two-level review with a due date for each level. Because approval levels are zero-indexed, a two-level review sets final_approval_level to 1:

    For errors common to all endpoints, see . When a request fails validation, this endpoint returns InvalidArgument (HTTP 400) with one of these error fields, and doesn't create the review:

    Error field
    Cause
    Message

    The final_approval_level message counts levels from 1. A final_approval_level above 0 on a tenant without multi-level review returns the error reason SYSTEM_FEATURE_NOT_ENABLED.

    To find workflow IDs, see . To view created certifications, see . For every field of the workflow and certification objects, see .

    List Certifications

    Get pending and completed certifications for a workflow

    Returns all certifications for an access workflow.

    Method
    syntax

    GET

    {{base_url}}/api/preview/awf/certifications

    Parameters

    Name
    type
    Req.
    Description

    You can use to retrieve all valid workflow IDs.

    Request

    Response

    values will contain all workflow details. The response may be paginated:

    Name
    type
    Description

    Sample response:

    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:

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

    Example response:

    Smart Action Definitions

    Define filter-based actions that reviewers can apply to certifications results with a matching attribute or status.

    Reviewers can view and apply custom actions from the Review interface by clicking Smart Action > Prepared Actions.

    • Add smart action definition

      • Mutable fields and mutable filters

    Create a smart action definition, globally or for a single Workflow.

    A certification includes all source and destination node properties discovered or added by Veza. You can specify a SCIM filter to select the results to affect, for example:

    Example request:

    The filter can apply to any source or destination node property.

    When apply_to_all_rows is true and no other filter criteria is specified, the action will run on all certification results.

    Mutable fields contain result attributes that are not sourced from Access Graph metadata. Use mutable_fields to apply changes to a result, and mutable_filter to filter results based on decision or sign-off state:

    Mutable field
    Value

    Delete a prepared action by definition id.

    Returns an array of smart action definitions. By default, this endpoint lists all definitions. If a workflow_id is specified, only definitions for that workflow are included in the response.

    Alter a smart action definition by specifying the id and an array of values to change.

    Delegate Reviewers

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

    Method
    Operation
    syntax
    get
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Responses
    200

    OK

    application/json
    selection_methodsinteger · enum[]Optional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    get/api/private/workflows/access/global_settings/alternate_reviewer_settings
    GET /api/private/workflows/access/global_settings/alternate_reviewer_settings HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    {
      "value": {
        "selection_methods": [
          1
        ]
      }
    }
    put
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Body
    selection_methodsinteger · enum[]Optional
    Responses
    200

    OK

    application/json
    object · SetAccessWorkflowAlternateReviewerSettingsResponseOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    put/api/private/workflows/access/global_settings/alternate_reviewer_settings
    PUT /api/private/workflows/access/global_settings/alternate_reviewer_settings HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 35
    
    {
      "value": {
        "selection_methods": [
          1
        ]
      }
    }
    {}

    Get Review Columns

    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    objectOptional
    get/api/private/workflows/access/global_settings/ui_column_settings
    GET /api/private/workflows/access/global_settings/ui_column_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    200

    OK

    {
      "value": {
        "default_ordered_columns": [
          "source.name",
          "source.identity_unique_id",
          "concrete_permissions",
          "idp.on_premises_distinguished_name",
          "idp.name",
          "destination.name",
          "destination.type",
          "reviewers",
          "notes",
          "decision_by",
          "decision_at",
          "notification_status",
          "automation_run_ids"
        ]
      }
    }

    Set Review Columns

    put
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    Content-TypestringOptionalExample: application/json
    AcceptstringOptionalExample: application/json
    Body
    objectOptionalExample: {"value":{"default_ordered_columns":["source.name","source.identity_unique_id","concrete_permissions","idp.on_premises_distinguished_name","idp.name","destination.name","destination.type","reviewers","notes","decision_by","decision_at","notification_status","automation_run_ids"]}}
    Responses
    200

    OK

    application/json
    objectOptional
    put/api/private/workflows/access/global_settings/ui_column_settings
    PUT /api/private/workflows/access/global_settings/ui_column_settings HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 281
    
    {
      "value": {
        "default_ordered_columns": [
          "source.name",
          "source.identity_unique_id",
          "concrete_permissions",
          "idp.on_premises_distinguished_name",
          "idp.name",
          "destination.name",
          "destination.type",
          "reviewers",
          "notes",
          "decision_by",
          "decision_at",
          "notification_status",
          "automation_run_ids"
        ]
      }
    }
    200

    OK

    {
      "value": {
        "default_ordered_columns": [
          "source.name",
          "source.identity_unique_id",
          "concrete_permissions",
          "idp.on_premises_distinguished_name",
          "idp.name",
          "destination.name",
          "destination.type",
          "reviewers",
          "notes",
          "decision_by",
          "decision_at",
          "notification_status",
          "automation_run_ids"
        ]
      }
    }

    Get All Column Customizations

    get
    Authorizations
    AuthorizationstringRequired
    Bearer authentication header of the form Bearer <token>.
    Header parameters
    AcceptstringOptionalExample: application/json
    Responses
    200

    OK

    application/json
    objectOptional
    500

    Internal Server Error

    application/json
    Content-TypestringOptionalExample: application/json
    Responseobject
    get/api/private/workflows/access/global_settings/ui_column_settings:list_all
    GET /api/private/workflows/access/global_settings/ui_column_settings:list_all HTTP/1.1
    Host: {{baseurl}}
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    {
      "global_settings": {
        "default_ordered_columns": [
          "source.name",
          "source.identity_unique_id",
          "concrete_permissions",
          "idp.on_premises_distinguished_name",
          "idp.name",
          "destination.name",
          "destination.type",
          "reviewers",
          "notes",
          "decision_by",
          "decision_at",
          "notification_status",
          "automation_run_ids"
        ]
      },
      "workflow_settings": [
        {
          "workflow_id": "002063d2-7898-4183-b5fb-1192758fdec7",
          "settings": {
            "default_ordered_columns": [
              "source.name",
              "source.department",
              "source.customprop_worker_status",
              "source.tags",
              "path_summary.name",
              "concrete_permissions",
              "destination.name",
              "destination.type",
              "destination.customprop_display_name",
              "reviewers",
              "notes"
            ]
          }
        },
        {
          "workflow_id": "84459ad9-3976-4f21-9d56-fa9c0694a8a7",
          "settings": {
            "default_ordered_columns": [
              "source.aws_userid",
              "source.name",
              "source.identity_unique_id",
              "concrete_permissions",
              "destination.name",
              "destination.type",
              "reviewers",
              "notes",
              "decision_by",
              "decision_at",
              "notification_status",
              "automation_run_ids"
            ]
          }
        }
      ]
    }

    workflow_id

    string

    Y

    Workflow to get certifications for

    has_more

    bool

    Indicates if additional results are available.

    total_result_count

    int

    The total number of results.

    values

    AccessCertResult

    Contains details for each certification (see workflow parameters).

    Examples

    List Workflows
    sw "starts with"
  • ew "ends with"

  • List all quick filters

    Remove quick filter by quick filter id

    List Quick Filters

    Remove User Delegations

    /api/preview/awf/delegation/users:remove

    Administrators can configure delegate reviewers for managers who would otherwise be assigned or auto-assigned to certification results. Specifying a delegate reviewer for another Veza user allows them to fulfill the responsibilities of that user — for example, if a manager is on leave, out-of-office, or otherwise unavailable.

    • Any certification items assigned to the original reviewer are also assigned to the delegated reviewer.

    • Delegate reviewers are notified of the assignment and receive notifications in place of the original reviewer. They can review and sign-off on any results assigned to the original reviewer.

    • The original reviewer can still act on results, but will not receive assignment or reminder emails.

    The JSON payload contain pairs of original and delegate Workflow Users. You can use List Reviewer Infos to get all the required details for reviewers assigned to a certification.

    Add delegation for Veza system users:

    A successful response will be empty.

    You can map both local Veza users and identities from an integrated identity provider.

    Add delegation for Okta users (with IdP settings configured):

    Note that this assumes the IdP setting are configured to use "idp_unique_id" to correlate identities, as in the Okta example here.

    A successful response will list all configured delegations, contained in a values array:

    To remove delegations, post the configuration to /api/preview/awf/delegation/users:remove.

    A successful response will be empty.

    GET

    List User Delegations

    /api/preview/awf/delegation/users

    POST

    Add User Delegations

    /api/preview/awf/delegation/users:add

    POST

    Examples

    Add user delegations

    List user delegations

    Remove user delegations

    curl '{{VEZA_URL}}/api/preview/awf/certifications?workfow_id=17ce79c7-a2e6-4baf-87ff-f386764c9659' \
      -H 'authorization: Bearer '$token
    {
      "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": "cookie@cookie.ai",
                  "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": "cookie@cookie.ai",
                  "name": "earlypreview-auth0"
              },
              "updated_at": "2023-07-27T03:44:31.410413829Z",
              "updated_by": {
                  "user_type": "localCookieUser",
                  "id": "e3ac5e6a-1946-4688-82a7-8a607133a1c8",
                  "email": "cookie@cookie.ai",
                  "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
          }
      ]
    }
    POST {Veza URL}/api/preview/awf/quick_filters
    {
        "name": "custom filter",
        "filter": "source.type co \"admin\"",
        "workflow_id": "ad78350a-bfe5-4eff-a160-dccbe28c6961"
    }
    {
        "id": "41761624-cb9c-4668-be69-3b0f359a45e3"
    }
    GET {Veza URL}/api/preview/awf/quick_filters
    GET {Veza URL}/api/preview/awf/quick_filters?workflow_id=78be0b3d-d6f4-4e5d-98c4-7b1db1a88575
    {
        "values": [
            {
                "id": "4a1dbf1a-282f-4faf-81f2-6ee3752b5cb2",
                "name": "User type = admin",
                "workflow_id": "78be0b3d-d6f4-4e5d-98c4-7b1db1a88575",
                "filter": "source.type eq \"admin\""
            },
            {
                "id": "69b131b0-8af5-4ab1-9099-91c03ca54555",
                "name": "abstract permissions include delete",
                "workflow_id": "",
                "filter": "abstract_permissions co \"Delete\""
            },
            {
                "id": "88e5d197-6555-4e3f-a48d-43713b340a2c",
                "name": "destination org filter",
                "workflow_id": "",
                "filter": "destination.google_cloud_organization_name eq \"acme\""
            },
            {
                "id": "df944da1-76fe-42e0-829e-b8bf0a200f39",
                "name": "concrete permissions include abort multipart upload",
                "workflow_id": "78be0b3d-d6f4-4e5d-98c4-7b1db1a88575",
                "filter": "concrete_permissions co \"s3:AbortMultipartUpload\""
            },
            {
                "id": "f722936d-a8f7-4b38-acb2-a41e12ec2673",
                "name": "User type is AwsIamUser",
                "workflow_id": "78be0b3d-d6f4-4e5d-98c4-7b1db1a88575",
                "filter": "source.type co \"AwsIamUser\""
            }
        ]
    }
    DELETE {Veza URL}/api/preview/awf/quick_filters/d31cfa3f-1999-4789-8ec1-a844c03dd622
    curl -X POST 'https://{{VezaURL}}/api/preview/awf/delegation/users:add' \
    -H 'authorization: Bearer '$TOKEN \
    -d @configuration.json
    {
      "values": [
        {
          "original_user": {
            "user_type": "localCookieUser",
            "id": "2cdfb6e9-6f20-4198-925c-a045a3d690a0",
            "email": "original_reviewer@veza.com",
            "name": "External User"
          },
          "delegate_user": {
            "user_type": "localCookieUser",
            "id": "b8678b1b-0f31-40e4-9842-47b272694354",
            "email": "delegate_reviewer@veza.com",
            "name": "External User"
          }
        }
      ]
    }
    {
      "values": [
        {
          "original_user": {
            "user_type": "OktaUser",
            "id": "00upa6s0hSGtl1eGL5d5",
            "email": "Abel_Maclead@veza.com",
            "name": "Abel_Maclead@veza.com"
          },
          "delegate_user": {
            "user_type": "OktaUser",
            "id": "00u6h8rl61RiosYzi5d7",
            "email": "adam_lee@veza.com",
            "name": "adam_lee@veza.com"
          }
        }
      ]
    }
    curl 'https://{{VezaURL}}/api/preview/awf/delegation/users' \
    -H 'authorization: Bearer '$TOKEN
    {
      "values": [
        {
          "original_user": {
            "user_type": "localCookieUser",
            "id": "2cdfb6e9-6f20-4198-925c-a045a3d690a0",
            "email": "original_reviewer@veza.com",
            "name": "Resource Manager"
          },
          "delegate_user": {
            "user_type": "localCookieUser",
            "id": "52c38da6-3b2e-44e9-9787-88ffa5ef398c",
            "email": "delegate_reviewer@veza.com",
            "name": "Backup Manager"
          }
        }
      ]
    }
    curl -X POST 'https://{{VezaURL}}/api/preview/awf/delegation/users:remove' \
    -H 'authorization: Bearer '$TOKEN \
    -d @configuration/to/remove.json

    snapshot_id

    string

    Conditional

    The numeric ID of the snapshot to use. Required when data_source is 2

    name

    string

    No

    Name for the certification

    notes

    string

    No

    Additional notes or context

    creation_instructions

    integer

    No

    0 (default) publishes the review when its query completes. 1 creates the review as a draft

    reviewer_assignment

    object

    No

    First-level reviewer assignment, as a object

    reviewer_assignment_second_level

    object

    No

    Second-level reviewer assignment, as a object

    alternate_reviewers

    array of

    No

    Review-level alternate reviewers, used when the include the CERTIFICATION_ALTERNATE_REVIEWERS selection method

    automation_ids

    array

    No

    IDs of automations to run during creation

    final_approval_level

    integer

    No

    The last approval level the review requires. Levels are zero-indexed, and 0 (a single-level review) is the default. See

    first_level_data

    object

    No

    First-level settings: due_date (RFC 3339 timestamp). See

    second_level_data

    object

    No

    Second-level settings: due_date (RFC 3339 timestamp)

    dynamic_information

    object

    No

    Identities to scope the review to. See

  • started_at is set by Veza and can't be sent.

  • The certification due_date returned by the API is the due date of the final level.

  • If the Mandatory Due Date setting requires a due date for a level, the request must include it for that level.

  • No

    Accepted, but Veza ignores this field

    POST /api/preview/awf/certifications
    post

    Creates an access review (certification) from an existing workflow and returns its certification_id. Set final_approval_level for a multi-level review, and dynamic_information to limit the review to specific identities.

    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Body
    workflow_idstringOptional
    data_sourceinteger · enumOptional

    The graph data that the workflow's query runs against. With SPECIFIED_SNAPSHOT, also set snapshot_id.

    Example: 0Possible values:
    snapshot_idstringOptional
    users_managerbooleanOptional

    Assigns the manager of each row's identity as a reviewer, found through the global identity provider (IdP) settings, which must be enabled. Assigns at most one manager per row.

    resource_managersbooleanOptional

    Assigns the owner of whichever entity is being reviewed as a reviewer. Despite the field name (kept for wire/backward-compat reasons - see resource_owner_lookup_order), this is not restricted to graph nodes labeled "Resource" in the schema: it resolves the tagged owner (entity owners property, or the legacy resource-manager tag) of whichever side of the query result actually has one, trying resource_owner_lookup_order's preferred side first.

    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    itemsinteger · enumOptionalPossible values:
    previous_review_assignmentbooleanOptional

    Assign reviewer(s) from the comparable row (matched by principal.type/id + resource.type/id) in the prior review. New rows fall through. Creation-only.

    assign_selfbooleanOptional

    Assign reviewer to be the same as the row subject.

    resource_owner_lookup_orderinteger · enumOptional

    Controls which side of the query resource_managers tries first when resolving an owner, when the query has both a principal and a resource node; if that side has no tagged owner, the other side is tried. Has no effect unless resource_managers is set.

    Example: 0Possible values:
    current_reviewers_managersbooleanOptional

    Assign the managers of each row's current reviewers. Only supported in OverdueReassignSettings.targets; rejected for review creation, schedules and reviewer updates. Not the same as reviewers_managers_for_approval_levels, which uses an earlier approval level's reviewers when a review is created.

    users_managerbooleanOptional

    Assigns the manager of each row's identity as a reviewer, found through the global identity provider (IdP) settings, which must be enabled. Assigns at most one manager per row.

    resource_managersbooleanOptional

    Assigns the owner of whichever entity is being reviewed as a reviewer. Despite the field name (kept for wire/backward-compat reasons - see resource_owner_lookup_order), this is not restricted to graph nodes labeled "Resource" in the schema: it resolves the tagged owner (entity owners property, or the legacy resource-manager tag) of whichever side of the query result actually has one, trying resource_owner_lookup_order's preferred side first.

    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    itemsinteger · enumOptionalPossible values:
    previous_review_assignmentbooleanOptional

    Assign reviewer(s) from the comparable row (matched by principal.type/id + resource.type/id) in the prior review. New rows fall through. Creation-only.

    assign_selfbooleanOptional

    Assign reviewer to be the same as the row subject.

    resource_owner_lookup_orderinteger · enumOptional

    Controls which side of the query resource_managers tries first when resolving an owner, when the query has both a principal and a resource node; if that side has no tagged owner, the other side is tried. Has no effect unless resource_managers is set.

    Example: 0Possible values:
    current_reviewers_managersbooleanOptional

    Assign the managers of each row's current reviewers. Only supported in OverdueReassignSettings.targets; rejected for review creation, schedules and reviewer updates. Not the same as reviewers_managers_for_approval_levels, which uses an earlier approval level's reviewers when a review is created.

    creation_instructionsinteger · enumOptional

    Whether the review is published or kept as a draft when its query completes.

    Example: 0Possible values:
    namestringOptional
    notesstringOptional
    due_datestring · date-timeRead-onlyOptional
    completion_summarystringOptional
    bookmarkstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    automation_idsstring[]Optional

    The id's of the automations that should be run as the certification is created

    final_approval_levelinteger · enumOptional

    The last approval level of the review, which sets how many levels it has. Values are zero-indexed: 0 is one level (the default), and 1 is two levels. Values other than 0 require multi-level review to be enabled for the tenant. If the workflow requires a specific final approval level, the value must match it, or the request is rejected. Send second_level_data only for a two-level review.

    Example: 0Possible values:
    started_atstring · date-timeRead-onlyOptional
    due_datestring · date-timeOptional
    started_atstring · date-timeRead-onlyOptional
    due_datestring · date-timeOptional
    idstringOptional

    The ID of the identity's node in the Access Graph (its id property).

    typestringOptional

    The node type of the identity in the Access Graph, such as OktaUser. This can be any node type, not only an identity provider user type. It's matched against the node types in the workflow's query.

    previous_manager_idstringOptional

    Ignored. Veza does not read this field.

    Responses
    200

    OK

    application/json
    certification_idstringOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    post/api/preview/awf/certifications
    POST /api/preview/awf/certifications HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 1440
    
    {
      "workflow_id": "text",
      "data_source": 0,
      "snapshot_id": "text",
      "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": [
          0
        ],
        "previous_review_assignment": true,
        "assign_self": true,
        "resource_owner_lookup_order": 0,
        "current_reviewers_managers": true
      },
      "reviewer_assignment_second_level": {
        "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": [
          0
        ],
        "previous_review_assignment": true,
        "assign_self": true,
        "resource_owner_lookup_order": 0,
        "current_reviewers_managers": true
      },
      "creation_instructions": 0,
      "name": "text",
      "notes": "text",
      "completion_summary": "text",
      "bookmark": "text",
      "alternate_reviewers": [
        {
          "user_type": "text",
          "id": "text",
          "email": "text",
          "name": "text",
          "alternate_email": "text"
        }
      ],
      "automation_ids": [
        "text"
      ],
      "final_approval_level": 0,
      "first_level_data": {
        "due_date": "2026-01-01T00:00:00.000Z"
      },
      "second_level_data": {
        "due_date": "2026-01-01T00:00:00.000Z"
      },
      "dynamic_information": {
        "identities": [
          {
            "id": "text",
            "type": "text",
            "previous_manager_id": "text"
          }
        ]
      }
    }
    {
      "certification_id": "text"
    }

    workflow_id

    string

    Yes

    The ID of the workflow to create a certification from

    data_source

    integer

    No

    Data source type: 0 (current, the default), 1 (most recent snapshot), 2 (specified snapshot)

    identities

    array

    No

    List of identity objects to filter by

    id

    string

    Yes

    The ID of the identity's node in the Access Graph, for example an Okta user ID

    type

    string

    Yes

    The graph node type of the identity, for example OktaUser. The type doesn't have to be an identity provider user type. See Identity types

    previous_manager_id

    Okta

    OktaUser

    Microsoft Entra ID (Azure AD)

    AzureADUser

    Active Directory

    ActiveDirectoryUser

    Google Workspace

    GoogleWorkspaceUser

    curl -X POST "$VEZA_URL/api/preview/awf/certifications" \
      -H "Authorization: Bearer $VEZA_TOKEN" \
      -H "Content-Type: application/json" \
      --data '{
        "workflow_id": "<workflow-id>",
        "name": "Q4 Access Review",
        "data_source": 0
      }'
    {
      "certification_id": "<certification-id>"
    }
    curl -X POST "$VEZA_URL/api/preview/awf/certifications" \
      -H "Authorization: Bearer $VEZA_TOKEN" \
      -H "Content-Type: application/json" \
      --data '{
        "workflow_id": "<workflow-id>",
        "name": "Department Transfer Review",
        "data_source": 0,
        "dynamic_information": {
          "identities": [
            {
              "id": "<okta-user-id>",
              "type": "OktaUser"
            }
          ]
        }
      }'
    curl -X POST "$VEZA_URL/api/preview/awf/certifications" \
      -H "Authorization: Bearer $VEZA_TOKEN" \
      -H "Content-Type: application/json" \
      --data '{
        "workflow_id": "<workflow-id>",
        "name": "High-Risk Access Review",
        "data_source": 0,
        "reviewer_assignment": {
          "resource_managers": true
        },
        "reviewer_assignment_second_level": {
          "users_manager": true
        },
        "final_approval_level": 1,
        "first_level_data": {
          "due_date": "2026-12-01T00:00:00Z"
        },
        "second_level_data": {
          "due_date": "2026-12-15T00:00:00Z"
        }
      }'

    final_approval_level

    The workflow requires a different number of approval levels

    review creation blocked: this configuration requires reviews to have <n> approval level(s), but the creation plan requested <m>. Update the review's approval levels to match the configuration's required approval level setting so reviews can be created.

    due_date

    A level's due date is earlier than the previous level's, or a later level has no due date

    DueDates must be in non-decreasing order

    identity

    A dynamic_information identity type matches no node type in the workflow query

    No matching node type found for identity type <type>

    Preview status: These APIs are functional and have undergone review, but specifications may evolve. Future updates may not be fully backward-compatible.

    Endpoint

    Request

    Final approval level

    Approval levels are zero-indexed: set final_approval_level to 1 for a two-level review.

    Due dates per level

    Dynamic information

    How identity types are matched

    Union queries and multiple identity types

    For workflows built on a saved query, Veza checks the query's related node types for a destination match, then each sub-query of a union query. In a union query, Veza filters every sub-query that contains the type.

    When a request includes more than one identity or type, the filters combine as follows:

    • IDs of the same type are combined with OR. A row matches if its node has any of the listed IDs.

    • Types that match different destination node types, or different sub-queries of a union query, are combined with OR. The review includes rows for each type, and each type's rows are limited to that type's IDs.

    • A type that matches a source node type and a type that matches a destination node type are combined with AND. A row must have a source from the first list and a destination from the second list.

    • Node types in the query that no identity type matched aren't filtered. For example, a workflow with two destination node types that receives identities for only one of them still returns all rows for the other destination node type.

    Identity types

    Examples

    Errors and limits

    roles
    ReviewerAssignmentInstructions
    Multi-Level Review
    Errors and limits
    Errors and limits
    LCM-triggered access reviews
    How identity types are matched
    API tokens
    Errors
    List workflows
    List certifications
    Workflow parameters

    string

    post
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Body
    namestringOptional
    descriptionstringOptional
    workflow_idstringOptional

    empty workflow_id would mean that the smartAction can be used for any workflowId

    filterstringOptional
    decisioninteger · enumOptional
    notesstringOptional
    updated_atstring · date-timeOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    notification_typeinteger · enumOptional
    webhook_typeinteger · enumOptional
    statusinteger · enumOptional
    error_messagestringOptional
    updated_atstring · date-timeOptional
    ticket_numberstringOptional
    sys_idstringOptional
    infostringOptional
    keysstring[]Optional
    slack_app_infoobject · NotificationResponseInfo_SlackAppInfoOptional
    notification_idstringOptional

    Which configured notification produced this entry. notification_type alone cannot attribute it: a review may bind two ServiceNow actions to one event. Empty for entries predating this field.

    triggered_atstring · date-timeOptional

    The row update this was sent for, as opposed to updated_at, when it was sent. Read back by the per-row job to tell its own sends from earlier ones on the row. Empty outside row actions.

    action_namestringOptional

    The row event this was sent for, e.g. REJECTED. One bulk update can put a row into two event buckets sharing one triggered_at -- rejecting with a note raises REJECTED and EDIT_NOTES -- and a review may bind one notification to both. Without this, the per-row job's skip cannot tell the second event's send from the first's and drops it. Empty outside row actions.

    notification_statusinteger · enumOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    signed_off_stateinteger · enumOptional
    signed_off_atstring · date-timeOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    actioninteger · enumOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    timestring · date-timeOptional
    notestringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    reasoninteger · enumOptional
    decisioninteger · enumOptional
    notestringOptional
    previous_decisioninteger · enumOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    reasoninteger · enumOptional
    note_outcomeinteger · enumOptional

    What clearing the decision did to the row's note.

    request_idstringOptional
    approval_levelinteger · enumOptional
    users_managerbooleanOptional

    Assigns the manager of each row's identity as a reviewer, found through the global identity provider (IdP) settings, which must be enabled. Assigns at most one manager per row.

    resource_managersbooleanOptional

    Assigns the owner of whichever entity is being reviewed as a reviewer. Despite the field name (kept for wire/backward-compat reasons - see resource_owner_lookup_order), this is not restricted to graph nodes labeled "Resource" in the schema: it resolves the tagged owner (entity owners property, or the legacy resource-manager tag) of whichever side of the query result actually has one, trying resource_owner_lookup_order's preferred side first.

    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    itemsinteger · enumOptionalPossible values:
    previous_review_assignmentbooleanOptional

    Assign reviewer(s) from the comparable row (matched by principal.type/id + resource.type/id) in the prior review. New rows fall through. Creation-only.

    assign_selfbooleanOptional

    Assign reviewer to be the same as the row subject.

    resource_owner_lookup_orderinteger · enumOptional

    Controls which side of the query resource_managers tries first when resolving an owner, when the query has both a principal and a resource node; if that side has no tagged owner, the other side is tried. Has no effect unless resource_managers is set.

    Example: 0Possible values:
    current_reviewers_managersbooleanOptional

    Assign the managers of each row's current reviewers. Only supported in OverdueReassignSettings.targets; rejected for review creation, schedules and reviewer updates. Not the same as reviewers_managers_for_approval_levels, which uses an earlier approval level's reviewers when a review is created.

    automation_run_idsstring[]Optional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    decision_atstring · date-timeOptional
    idstringOptional
    stateinteger · enumOptional
    error_messagestringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    question_idstringOptional
    answer_idstringOptional
    answer_textstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    responded_atstring · date-timeRead-onlyOptional
    is_assigned_to_current_userbooleanOptional
    suggestioninteger · enumOptional
    reason_codesstring[]Optional
    cohort_idstringOptional
    cohort_indexinteger · uint32Optional
    itsm_request_numberstringOptional
    itsm_request_statusstringOptional
    itsm_request_urlstringOptional
    itsm_request_last_updated_atstring · date-timeOptional
    rest_action_idstringOptional
    statusinteger · enumOptional
    error_messagestringOptional
    updated_atstring · date-timeOptional
    response_bodystringOptional

    Raw response body, truncated. The endpoint belongs to the customer, so the shape is unknown and the whole body is kept rather than parsed.

    response_truncatedbooleanOptional

    Set when the body was longer than the retained limit.

    do_not_retrybooleanOptional

    Set when the endpoint refused the request in a way retrying cannot fix, so the row is not attempted again for this action. Left false for anything that might succeed later.

    mutable_filterstringOptional
    apply_to_all_rowsbooleanOptional
    Responses
    200

    OK

    application/json
    idstringOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    post/api/preview/awf/smart_action_definitions
    POST /api/preview/awf/smart_action_definitions HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 3046
    
    {
      "name": "text",
      "description": "text",
      "workflow_id": "text",
      "filter": "text",
      "mutable_fields": {
        "decision": 1,
        "notes": "text",
        "updated_at": "2026-01-01T00:00:00.000Z",
        "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": "2026-01-01T00:00:00.000Z",
              "snow_info": {
                "ticket_number": "text",
                "sys_id": "text"
              },
              "webhook_info": {
                "info": "text"
              },
              "jira_info": {
                "keys": [
                  "text"
                ]
              },
              "slack_app_info": {},
              "notification_id": "text",
              "triggered_at": "2026-01-01T00:00:00.000Z",
              "action_name": "text"
            }
          ]
        },
        "notification_status": 1,
        "reviewers": [
          {
            "user_type": "text",
            "id": "text",
            "email": "text",
            "name": "text",
            "alternate_email": "text"
          }
        ],
        "signed_off_state": 1,
        "signed_off_at": "2026-01-01T00:00:00.000Z",
        "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": "2026-01-01T00:00:00.000Z",
              "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"
                  }
                ],
                "reason": 1
              },
              "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,
                "note_outcome": 1
              },
              "revocation_request_detail": {
                "request_id": "text"
              },
              "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": [
            0
          ],
          "previous_review_assignment": true,
          "assign_self": true,
          "resource_owner_lookup_order": 0,
          "current_reviewers_managers": true
        },
        "automation_run_ids": [
          "text"
        ],
        "decision_by": {
          "user_type": "text",
          "id": "text",
          "email": "text",
          "name": "text",
          "alternate_email": "text"
        },
        "decision_at": "2026-01-01T00:00:00.000Z",
        "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,
        "ai_suggestion": {
          "suggestion": 1,
          "reason_codes": [
            "text"
          ],
          "cohort_id": "text",
          "cohort_index": 1
        },
        "itsm_request_number": "text",
        "itsm_request_status": "text",
        "itsm_request_url": "text",
        "itsm_request_last_updated_at": "2026-01-01T00:00:00.000Z",
        "rest_action_infos": [
          {
            "rest_action_id": "text",
            "status": 1,
            "error_message": "text",
            "updated_at": "2026-01-01T00:00:00.000Z",
            "response_body": "text",
            "response_truncated": true,
            "do_not_retry": true
          }
        ]
      },
      "mutable_filter": "text",
      "apply_to_all_rows": true
    }
    {
      "id": "text"
    }
    curl -X POST "https://{{veza_url}}/api/preview/awf/smart_action_definitions" \
    -H 'authorization: Bearer {{access_token}}' \
    -d '{
      "apply_to_all_rows": "false",
      "description": "Reject users where the user `is active` value is not `true`",
      "filter": "source.is_active ne \"true\"",
      "mutable_fields": {
        "decision": "RESULT_DECISION_REJECTED"
      },
      "mutable_filter": "",
      "name": "Reject inactive users",
      "workflow_id": ""
    }'
    {
      "apply_to_all_rows": "false",
      "description": "Sign off on all rejected rows",
      "filter": "",
      "mutable_fields": {
        "signed_off_state": "SIGNED_OFF"
      },
      "mutable_filter": "decision eq \"RESULT_DECISION_REJECTED\"",
      "name": "Sign off rejected rows",
      "workflow_id": ""
    }

    decision

    One of: "RESULT_DECISION_UNKNOWN" "RESULT_DECISION_NONE" "RESULT_DECISION_ACCEPTED" "RESULT_DECISION_REJECTED" "RESULT_DECISION_FIXED"

    notes

    string

    signed_off_state

    One of: "UNKNOWN" "NOT_SIGNED_OFF" "SIGNED_OFF"

    delete
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Path parameters
    idstringRequired
    Responses
    200

    OK

    application/json
    object · RemoveAwfSmartActionDefinitionResponseOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    delete/api/preview/awf/smart_action_definitions/{id}
    DELETE /api/preview/awf/smart_action_definitions/{id} HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    {}
    get
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Query parameters
    workflow_idstringOptional

    If no value is passed for workflow_id, all smart actions will be returned. If workflow_id is not "", smart actions with a matching workflow_id or with an empty workflow_id will be returned.

    Responses
    200

    OK

    application/json
    idstringOptional
    descriptionstringOptional
    namestringOptional
    workflow_idstringOptional

    empty workflow_id would mean that the smartAction can be used for any workflowId

    filterstringOptional
    decisioninteger · enumOptional
    notesstringOptional
    updated_atstring · date-timeOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    notification_typeinteger · enumOptional
    webhook_typeinteger · enumOptional
    statusinteger · enumOptional
    error_messagestringOptional
    updated_atstring · date-timeOptional
    ticket_numberstringOptional
    sys_idstringOptional
    infostringOptional
    keysstring[]Optional
    slack_app_infoobject · NotificationResponseInfo_SlackAppInfoOptional
    notification_idstringOptional

    Which configured notification produced this entry. notification_type alone cannot attribute it: a review may bind two ServiceNow actions to one event. Empty for entries predating this field.

    triggered_atstring · date-timeOptional

    The row update this was sent for, as opposed to updated_at, when it was sent. Read back by the per-row job to tell its own sends from earlier ones on the row. Empty outside row actions.

    action_namestringOptional

    The row event this was sent for, e.g. REJECTED. One bulk update can put a row into two event buckets sharing one triggered_at -- rejecting with a note raises REJECTED and EDIT_NOTES -- and a review may bind one notification to both. Without this, the per-row job's skip cannot tell the second event's send from the first's and drops it. Empty outside row actions.

    notification_statusinteger · enumOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    signed_off_stateinteger · enumOptional
    signed_off_atstring · date-timeOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    actioninteger · enumOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    timestring · date-timeOptional
    notestringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    reasoninteger · enumOptional
    decisioninteger · enumOptional
    notestringOptional
    previous_decisioninteger · enumOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    reasoninteger · enumOptional
    note_outcomeinteger · enumOptional

    What clearing the decision did to the row's note.

    request_idstringOptional
    approval_levelinteger · enumOptional
    users_managerbooleanOptional

    Assigns the manager of each row's identity as a reviewer, found through the global identity provider (IdP) settings, which must be enabled. Assigns at most one manager per row.

    resource_managersbooleanOptional

    Assigns the owner of whichever entity is being reviewed as a reviewer. Despite the field name (kept for wire/backward-compat reasons - see resource_owner_lookup_order), this is not restricted to graph nodes labeled "Resource" in the schema: it resolves the tagged owner (entity owners property, or the legacy resource-manager tag) of whichever side of the query result actually has one, trying resource_owner_lookup_order's preferred side first.

    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    itemsinteger · enumOptionalPossible values:
    previous_review_assignmentbooleanOptional

    Assign reviewer(s) from the comparable row (matched by principal.type/id + resource.type/id) in the prior review. New rows fall through. Creation-only.

    assign_selfbooleanOptional

    Assign reviewer to be the same as the row subject.

    resource_owner_lookup_orderinteger · enumOptional

    Controls which side of the query resource_managers tries first when resolving an owner, when the query has both a principal and a resource node; if that side has no tagged owner, the other side is tried. Has no effect unless resource_managers is set.

    Example: 0Possible values:
    current_reviewers_managersbooleanOptional

    Assign the managers of each row's current reviewers. Only supported in OverdueReassignSettings.targets; rejected for review creation, schedules and reviewer updates. Not the same as reviewers_managers_for_approval_levels, which uses an earlier approval level's reviewers when a review is created.

    automation_run_idsstring[]Optional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    decision_atstring · date-timeOptional
    idstringOptional
    stateinteger · enumOptional
    error_messagestringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    question_idstringOptional
    answer_idstringOptional
    answer_textstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    responded_atstring · date-timeRead-onlyOptional
    is_assigned_to_current_userbooleanOptional
    suggestioninteger · enumOptional
    reason_codesstring[]Optional
    cohort_idstringOptional
    cohort_indexinteger · uint32Optional
    itsm_request_numberstringOptional
    itsm_request_statusstringOptional
    itsm_request_urlstringOptional
    itsm_request_last_updated_atstring · date-timeOptional
    rest_action_idstringOptional
    statusinteger · enumOptional
    error_messagestringOptional
    updated_atstring · date-timeOptional
    response_bodystringOptional

    Raw response body, truncated. The endpoint belongs to the customer, so the shape is unknown and the whole body is kept rather than parsed.

    response_truncatedbooleanOptional

    Set when the body was longer than the retained limit.

    do_not_retrybooleanOptional

    Set when the endpoint refused the request in a way retrying cannot fix, so the row is not attempted again for this action. Left false for anything that might succeed later.

    mutable_filterstringOptional
    apply_to_all_rowsbooleanOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    get/api/preview/awf/smart_action_definitions
    GET /api/preview/awf/smart_action_definitions HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    {
      "values": [
        {
          "id": "text",
          "description": "text",
          "name": "text",
          "workflow_id": "text",
          "filter": "text",
          "mutable_fields": {
            "decision": 1,
            "notes": "text",
            "updated_at": "2026-01-01T00:00:00.000Z",
            "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": "2026-01-01T00:00:00.000Z",
                  "snow_info": {
                    "ticket_number": "text",
                    "sys_id": "text"
                  },
                  "webhook_info": {
                    "info": "text"
                  },
                  "jira_info": {
                    "keys": [
                      "text"
                    ]
                  },
                  "slack_app_info": {},
                  "notification_id": "text",
                  "triggered_at": "2026-01-01T00:00:00.000Z",
                  "action_name": "text"
                }
              ]
            },
            "notification_status": 1,
            "reviewers": [
              {
                "user_type": "text",
                "id": "text",
                "email": "text",
                "name": "text",
                "alternate_email": "text"
              }
            ],
            "signed_off_state": 1,
            "signed_off_at": "2026-01-01T00:00:00.000Z",
            "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": "2026-01-01T00:00:00.000Z",
                  "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"
                      }
                    ],
                    "reason": 1
                  },
                  "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,
                    "note_outcome": 1
                  },
                  "revocation_request_detail": {
                    "request_id": "text"
                  },
                  "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": [
                0
              ],
              "previous_review_assignment": true,
              "assign_self": true,
              "resource_owner_lookup_order": 0,
              "current_reviewers_managers": true
            },
            "automation_run_ids": [
              "text"
            ],
            "decision_by": {
              "user_type": "text",
              "id": "text",
              "email": "text",
              "name": "text",
              "alternate_email": "text"
            },
            "decision_at": "2026-01-01T00:00:00.000Z",
            "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": "2026-01-01T00:00:00.000Z"
              }
            ],
            "is_assigned_to_current_user": true,
            "ai_suggestion": {
              "suggestion": 1,
              "reason_codes": [
                "text"
              ],
              "cohort_id": "text",
              "cohort_index": 1
            },
            "itsm_request_number": "text",
            "itsm_request_status": "text",
            "itsm_request_url": "text",
            "itsm_request_last_updated_at": "2026-01-01T00:00:00.000Z",
            "rest_action_infos": [
              {
                "rest_action_id": "text",
                "status": 1,
                "error_message": "text",
                "updated_at": "2026-01-01T00:00:00.000Z",
                "response_body": "text",
                "response_truncated": true,
                "do_not_retry": true
              }
            ]
          },
          "mutable_filter": "text",
          "apply_to_all_rows": true
        }
      ]
    }
    put
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Body
    idstringOptional
    descriptionstringOptional
    namestringOptional
    workflow_idstringOptional

    empty workflow_id would mean that the smartAction can be used for any workflowId

    filterstringOptional
    decisioninteger · enumOptional
    notesstringOptional
    updated_atstring · date-timeOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    notification_typeinteger · enumOptional
    webhook_typeinteger · enumOptional
    statusinteger · enumOptional
    error_messagestringOptional
    updated_atstring · date-timeOptional
    ticket_numberstringOptional
    sys_idstringOptional
    infostringOptional
    keysstring[]Optional
    slack_app_infoobject · NotificationResponseInfo_SlackAppInfoOptional
    notification_idstringOptional

    Which configured notification produced this entry. notification_type alone cannot attribute it: a review may bind two ServiceNow actions to one event. Empty for entries predating this field.

    triggered_atstring · date-timeOptional

    The row update this was sent for, as opposed to updated_at, when it was sent. Read back by the per-row job to tell its own sends from earlier ones on the row. Empty outside row actions.

    action_namestringOptional

    The row event this was sent for, e.g. REJECTED. One bulk update can put a row into two event buckets sharing one triggered_at -- rejecting with a note raises REJECTED and EDIT_NOTES -- and a review may bind one notification to both. Without this, the per-row job's skip cannot tell the second event's send from the first's and drops it. Empty outside row actions.

    notification_statusinteger · enumOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    signed_off_stateinteger · enumOptional
    signed_off_atstring · date-timeOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    actioninteger · enumOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    timestring · date-timeOptional
    notestringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    reasoninteger · enumOptional
    decisioninteger · enumOptional
    notestringOptional
    previous_decisioninteger · enumOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    reasoninteger · enumOptional
    note_outcomeinteger · enumOptional

    What clearing the decision did to the row's note.

    request_idstringOptional
    approval_levelinteger · enumOptional
    users_managerbooleanOptional

    Assigns the manager of each row's identity as a reviewer, found through the global identity provider (IdP) settings, which must be enabled. Assigns at most one manager per row.

    resource_managersbooleanOptional

    Assigns the owner of whichever entity is being reviewed as a reviewer. Despite the field name (kept for wire/backward-compat reasons - see resource_owner_lookup_order), this is not restricted to graph nodes labeled "Resource" in the schema: it resolves the tagged owner (entity owners property, or the legacy resource-manager tag) of whichever side of the query result actually has one, trying resource_owner_lookup_order's preferred side first.

    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    itemsinteger · enumOptionalPossible values:
    previous_review_assignmentbooleanOptional

    Assign reviewer(s) from the comparable row (matched by principal.type/id + resource.type/id) in the prior review. New rows fall through. Creation-only.

    assign_selfbooleanOptional

    Assign reviewer to be the same as the row subject.

    resource_owner_lookup_orderinteger · enumOptional

    Controls which side of the query resource_managers tries first when resolving an owner, when the query has both a principal and a resource node; if that side has no tagged owner, the other side is tried. Has no effect unless resource_managers is set.

    Example: 0Possible values:
    current_reviewers_managersbooleanOptional

    Assign the managers of each row's current reviewers. Only supported in OverdueReassignSettings.targets; rejected for review creation, schedules and reviewer updates. Not the same as reviewers_managers_for_approval_levels, which uses an earlier approval level's reviewers when a review is created.

    automation_run_idsstring[]Optional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    decision_atstring · date-timeOptional
    idstringOptional
    stateinteger · enumOptional
    error_messagestringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    question_idstringOptional
    answer_idstringOptional
    answer_textstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    responded_atstring · date-timeRead-onlyOptional
    is_assigned_to_current_userbooleanOptional
    suggestioninteger · enumOptional
    reason_codesstring[]Optional
    cohort_idstringOptional
    cohort_indexinteger · uint32Optional
    itsm_request_numberstringOptional
    itsm_request_statusstringOptional
    itsm_request_urlstringOptional
    itsm_request_last_updated_atstring · date-timeOptional
    rest_action_idstringOptional
    statusinteger · enumOptional
    error_messagestringOptional
    updated_atstring · date-timeOptional
    response_bodystringOptional

    Raw response body, truncated. The endpoint belongs to the customer, so the shape is unknown and the whole body is kept rather than parsed.

    response_truncatedbooleanOptional

    Set when the body was longer than the retained limit.

    do_not_retrybooleanOptional

    Set when the endpoint refused the request in a way retrying cannot fix, so the row is not attempted again for this action. Left false for anything that might succeed later.

    mutable_filterstringOptional
    apply_to_all_rowsbooleanOptional
    Responses
    200

    OK

    application/json
    object · UpdateAwfSmartActionDefinitionResponseOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    put/api/preview/awf/smart_action_definitions
    PUT /api/preview/awf/smart_action_definitions HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 3068
    
    {
      "value": {
        "id": "text",
        "description": "text",
        "name": "text",
        "workflow_id": "text",
        "filter": "text",
        "mutable_fields": {
          "decision": 1,
          "notes": "text",
          "updated_at": "2026-01-01T00:00:00.000Z",
          "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": "2026-01-01T00:00:00.000Z",
                "snow_info": {
                  "ticket_number": "text",
                  "sys_id": "text"
                },
                "webhook_info": {
                  "info": "text"
                },
                "jira_info": {
                  "keys": [
                    "text"
                  ]
                },
                "slack_app_info": {},
                "notification_id": "text",
                "triggered_at": "2026-01-01T00:00:00.000Z",
                "action_name": "text"
              }
            ]
          },
          "notification_status": 1,
          "reviewers": [
            {
              "user_type": "text",
              "id": "text",
              "email": "text",
              "name": "text",
              "alternate_email": "text"
            }
          ],
          "signed_off_state": 1,
          "signed_off_at": "2026-01-01T00:00:00.000Z",
          "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": "2026-01-01T00:00:00.000Z",
                "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"
                    }
                  ],
                  "reason": 1
                },
                "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,
                  "note_outcome": 1
                },
                "revocation_request_detail": {
                  "request_id": "text"
                },
                "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": [
              0
            ],
            "previous_review_assignment": true,
            "assign_self": true,
            "resource_owner_lookup_order": 0,
            "current_reviewers_managers": true
          },
          "automation_run_ids": [
            "text"
          ],
          "decision_by": {
            "user_type": "text",
            "id": "text",
            "email": "text",
            "name": "text",
            "alternate_email": "text"
          },
          "decision_at": "2026-01-01T00:00:00.000Z",
          "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,
          "ai_suggestion": {
            "suggestion": 1,
            "reason_codes": [
              "text"
            ],
            "cohort_id": "text",
            "cohort_index": 1
          },
          "itsm_request_number": "text",
          "itsm_request_status": "text",
          "itsm_request_url": "text",
          "itsm_request_last_updated_at": "2026-01-01T00:00:00.000Z",
          "rest_action_infos": [
            {
              "rest_action_id": "text",
              "status": 1,
              "error_message": "text",
              "updated_at": "2026-01-01T00:00:00.000Z",
              "response_body": "text",
              "response_truncated": true,
              "do_not_retry": true
            }
          ]
        },
        "mutable_filter": "text",
        "apply_to_all_rows": true
      }
    }
    {}

    Add smart action definition

    Mutable fields and mutable filters

    Remove a smart action definition

    List smart action definitions

    Update a smart action definition

    Remove a smart action definition
    List smart action definitions
    Update a smart action definition
    result

    Update Multiple Certification Results

    Apply the same decision, notes, sign-off, or reviewer assignment to up to 100 results of an access review in one call.

    Applies one set of field changes to up to 100 results of an access review in a single call. A result is one row of the review, identified by its result_id.

    Preview status: These APIs are functional and have undergone review, but specifications may evolve. Future updates may not be fully backward-compatible.

    Available starting with Veza v2026.9.21. Earlier releases don't include this endpoint.

    Endpoint

    POST /api/preview/awf/certifications/{certification_id}/results:batch_update

    This endpoint requires one of these built-in roles: Administrator, Access Reviews Admin, Operator, Access Reviewer, Watcher, Re-assigner, or Access Reviews Monitor. Requests from other roles return PermissionDenied. Callers must belong to the root team. OAuth2 client-credentials tokens can't call this endpoint.

    Veza checks the caller's permissions on each result as it does for a single-result update. For example, an Access Reviewer can change only the results assigned to them.

    Request

    The URL path identifies the review:

    Field
    Type
    Required?
    Description

    The JSON body lists the results and the changes:

    Field
    Type
    Required?
    Description

    value accepts the same mutable fields as . An omitted field stays unchanged on every result:

    Field
    Type
    Required?
    Description

    After a review expires or completes, only the Administrator, Access Reviews Admin, and Operator roles can update its results. They can make these changes:

    • Set decision to FIXED to mark a rejected result as fixed, or set it back to REJECTED.

    • Update notes.

    These changes have no time limit. If a request changes signed_off_state or sets any other decision, the whole call fails. To undo a sign-off or make other changes on an expired review, use , which updates one result per call.

    Set VEZA_URL and VEZA_TOKEN as described in .

    A successful call returns an empty object. To read an updated result, use .

    A call updates at most 100 results. Updating more results requires several calls.

    The call is synchronous: Veza writes every result, applies reviewer assignment, and starts any Veza Actions before it returns the response.

    Veza validates every result before it writes any. If one result fails validation, or a reviewer can't be found, the call fails and no result changes.

    These requests return InvalidArgument (HTTP 400):

    Field
    Cause
    Message

    These requests return FailedPrecondition (HTTP 400):

    Field
    Cause
    Message

    For error codes shared by all Veza APIs, see .

    To update one result, use . For changes that a standard update doesn't allow, use . To find result IDs, use .

    ReviewerAssignmentInstructions
    ReviewerAssignmentInstructions
    WorkflowUser
    alternate reviewer settings
    Final approval level
    Due dates per level
    Dynamic information

    Create a certification

    enum

    No

    SIGNED_OFF signs off the results. This endpoint can't return a signed-off result to NOT_SIGNED_OFF; can, one result per call.

    reviewer_assignment

    object

    No

    The reviewers to assign to every result: reviewers, and optionally fallback_reviewers. Identify each reviewer by email, or by id and user_type. See .

    reviewers

    array

    No

    Deprecated; use reviewer_assignment.

    Omitted

    value is required: it carries the mutable fields applied to every row in result_ids

    reviewer_assignment

    A reviewer email that matches no user

    could not find reviewer with email : <masked email>

    certification_id

    string

    Yes

    ID of the access review (certification) that contains the results.

    result_ids

    array of integers

    Yes

    IDs of the results to update: 1 to 100, with no duplicates. These are the result_id values that List Certification Results returns.

    value

    object

    Yes

    The changes to apply to every result in result_ids. A result_id inside value is ignored.

    decision

    enum

    No

    NONE, ACCEPTED, REJECTED, or FIXED. FIXED marks a rejected result as fixed.

    notes

    string

    No

    Replaces the note on each result. A single space (" ") clears the note.

    curl -X POST "$VEZA_URL/api/preview/awf/certifications/<certification-id>/results:batch_update" \
      -H "Authorization: Bearer $VEZA_TOKEN" \
      -H "Content-Type: application/json" \
      --data '{
        "result_ids": [2, 3, 7],
        "value": {
          "decision": "REJECTED",
          "notes": "Access no longer needed"
        }
      }'
    curl -X POST "$VEZA_URL/api/preview/awf/certifications/<certification-id>/results:batch_update" \
      -H "Authorization: Bearer $VEZA_TOKEN" \
      -H "Content-Type: application/json" \
      --data '{
        "result_ids": [2, 3, 7],
        "value": {
          "decision": "FIXED",
          "notes": "Access removed in the target application"
        }
      }'
    {}

    result_ids

    Empty array

    List cannot be empty

    result_ids

    More than 100 IDs

    List has a max length of 100

    result_ids

    A repeated ID

    List cannot contain duplicate items

    value

    A change that the review's state doesn't allow, such as a signed_off_state change or a decision other than FIXED or REJECTED on an expired review

    Cannot modify a review that is already completed or expired.

    value

    A change that a result's state doesn't allow, such as undoing a sign-off

    Review result update is not allowed.

    Expired and completed reviews

    Examples

    Reject results with a note

    Mark rejected results as fixed on an expired review

    Response

    Errors and limits

    Update Certification Result
    Force Update Result
    API tokens
    Get Certification Result
    Errors
    Update Certification Result
    Force Update Result
    List Certification Results
    post

    Applies the same changes to up to 100 rows of an access review in one call. It works like the single-row update (PUT /api/preview/awf/certifications/{certification_id}/results), except that you select rows with result_ids instead of value.result_id.

    Veza validates every listed row before writing any of them, so a single row that can't be updated fails the whole call.

    Returns an empty object on success. A request with no result_ids, more than 100 IDs, duplicate IDs, or no value is rejected with 400 Bad Request.

    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Path parameters
    certification_idstringRequired
    Body
    certification_idstringOptional

    Ignored. The review comes from the certification_id path parameter, which overrides any value sent here. Omit it from the body.

    result_idsinteger · uint32[] · min: 1 · max: 100Required

    The rows to update, from 1 to 100. These are the same identifiers as AwfResult.result_id. Duplicate IDs are rejected.

    result_idinteger · uint32Optional
    sourceobjectRead-onlyOptional
    destinationobjectRead-onlyOptional
    accumulated_effective_permissionsstring[]Read-onlyOptional
    accumulated_raw_permissionsstring[]Read-onlyOptional
    updated_atstring · date-timeRead-onlyOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    signed_off_atstring · date-timeRead-onlyOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    notification_typeinteger · enumOptional
    webhook_typeinteger · enumOptional
    statusinteger · enumOptional
    error_messagestringOptional
    updated_atstring · date-timeOptional
    ticket_numberstringOptional
    sys_idstringOptional
    infostringOptional
    keysstring[]Optional
    slack_app_infoobject · NotificationResponseInfo_SlackAppInfoOptional
    notification_idstringOptional

    Which configured notification produced this entry. notification_type alone cannot attribute it: a review may bind two ServiceNow actions to one event. Empty for entries predating this field.

    triggered_atstring · date-timeOptional

    The row update this was sent for, as opposed to updated_at, when it was sent. Read back by the per-row job to tell its own sends from earlier ones on the row. Empty outside row actions.

    action_namestringOptional

    The row event this was sent for, e.g. REJECTED. One bulk update can put a row into two event buckets sharing one triggered_at -- rejecting with a note raises REJECTED and EDIT_NOTES -- and a review may bind one notification to both. Without this, the per-row job's skip cannot tell the second event's send from the first's and drops it. Empty outside row actions.

    notification_statusinteger · enumRead-onlyOptional
    waypointobjectRead-onlyOptional
    actioninteger · enumOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    timestring · date-timeOptional
    notestringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    reasoninteger · enumOptional
    decisioninteger · enumOptional
    notestringOptional
    previous_decisioninteger · enumOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    reasoninteger · enumOptional
    note_outcomeinteger · enumOptional

    What clearing the decision did to the row's note.

    request_idstringOptional
    approval_levelinteger · enumOptional
    automation_run_idsinteger · int32[]Read-onlyOptional
    decisioninteger · enumOptional
    notesstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    signed_off_stateinteger · enumOptional
    users_managerbooleanOptional

    Assigns the manager of each row's identity as a reviewer, found through the global identity provider (IdP) settings, which must be enabled. Assigns at most one manager per row.

    resource_managersbooleanOptional

    Assigns the owner of whichever entity is being reviewed as a reviewer. Despite the field name (kept for wire/backward-compat reasons - see resource_owner_lookup_order), this is not restricted to graph nodes labeled "Resource" in the schema: it resolves the tagged owner (entity owners property, or the legacy resource-manager tag) of whichever side of the query result actually has one, trying resource_owner_lookup_order's preferred side first.

    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    itemsinteger · enumOptionalPossible values:
    previous_review_assignmentbooleanOptional

    Assign reviewer(s) from the comparable row (matched by principal.type/id + resource.type/id) in the prior review. New rows fall through. Creation-only.

    assign_selfbooleanOptional

    Assign reviewer to be the same as the row subject.

    resource_owner_lookup_orderinteger · enumOptional

    Controls which side of the query resource_managers tries first when resolving an owner, when the query has both a principal and a resource node; if that side has no tagged owner, the other side is tried. Has no effect unless resource_managers is set.

    Example: 0Possible values:
    current_reviewers_managersbooleanOptional

    Assign the managers of each row's current reviewers. Only supported in OverdueReassignSettings.targets; rejected for review creation, schedules and reviewer updates. Not the same as reviewers_managers_for_approval_levels, which uses an earlier approval level's reviewers when a review is created.

    path_summary_nodesobject[]Read-onlyOptional
    Other propertiesobjectOptional
    question_textstringOptional
    answer_textstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    responded_atstring · date-timeOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    rest_action_idstringOptional
    statusinteger · enumOptional
    error_messagestringOptional
    updated_atstring · date-timeOptional
    response_bodystringOptional

    Raw response body, truncated. The endpoint belongs to the customer, so the shape is unknown and the whole body is kept rather than parsed.

    response_truncatedbooleanOptional

    Set when the body was longer than the retained limit.

    do_not_retrybooleanOptional

    Set when the endpoint refused the request in a way retrying cannot fix, so the row is not attempted again for this action. Left false for anything that might succeed later.

    Responses
    200

    OK

    application/json
    object · UpdateAwfResultsResponseOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    post/api/preview/awf/certifications/{certification_id}/results:batch_update
    POST /api/preview/awf/certifications/{certification_id}/results:batch_update HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 709
    
    {
      "certification_id": "text",
      "result_ids": [
        1
      ],
      "value": {
        "result_id": 1,
        "decision": 1,
        "notes": "text",
        "reviewers": [
          {
            "user_type": "text",
            "id": "text",
            "email": "text",
            "name": "text",
            "alternate_email": "text"
          }
        ],
        "signed_off_state": 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": [
            0
          ],
          "previous_review_assignment": true,
          "assign_self": true,
          "resource_owner_lookup_order": 0,
          "current_reviewers_managers": true
        },
        "joined_nodes": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      }
    }
    {}

    signed_off_state

    value

    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

    Update multiple review results

    Force Update Result
    Re-assigning reviewers

    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.

    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: Opens only when a reviewer selects the User Guide icon in the reviewer interface. It does not open automatically.

    • REVIEW_START: Opens automatically when a reviewer first opens the review. After the reviewer acknowledges it, it does not open again for that review in the same browser.

    • 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.

    The template can use markdown and placeholders, for example:

    See for more information about placeholders.

    Example request:

    Three placeholders personalize the review-start and sign-off pop-ups with the signed-in reviewer's identity and the current date. Use them to build attestation statements that each reviewer acknowledges before starting a review or when signing off rows.

    Placeholder
    Description

    These placeholders are valid only in REVIEW_START and SIGN_OFF templates, because they resolve from the signed-in reviewer at the moment the pop-up opens. They carry no value anywhere else, including the HELP_PAGE template (and the tenant-wide default) and email, Slack, and Teams notification templates. Saving one in any other template returns a validation error:

    Example sign-off attestation statement (usage set to SIGN_OFF):

    Get all configured help page templates.

    Example response:

    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:

    Returns the current template for a given certification id.

    Example request:

    Example response:

    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:

    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:

    POST

    {veza_url}/api/preview/awf/help_page_templates

    GET

    {veza_url}/api/preview/awf/help_page_templates

    GET

    {veza_url}/api/preview/awf/help_page_templates/{workflow_id}/{usage}

    GET

    {veza_url}/api/preview/awf/certification_help_page?certification_id={cert_id}

    DELETE

    {veza_url}/api/preview/awf/help_page_templates/{workflow_id}/{usage}

    PUT

    {veza_url}/api/preview/awf/help_page_templates

    # Help for {{WORKFLOW_NAME}}
    
    ## Formatting
    
    Formatting text in Markdown:
    
    - *Italic text*
    - **Bold text**
    - `Code block`
    - [Link text](https://example.com)
    
    ## Bullet Lists
    
    Bullet lists in Markdown:
    
    - Item 1
    - Item 2
    - Item 3
    
    ## Numbered Lists
    
    Numbered lists in Markdown:
    
    1. First item
    2. Second item
    3. Third item
    
    ## Placeholders
    
    The following placeholders are available:
    
    - {{WORKFLOW_NAME}}
    - {{WORKFLOW_URL}}
    - {{WORKFLOW_TIME}}
    - {{WORKFLOW_OWNER}}
    - {{WORKFLOW_DESCRIPTION}}
    - {{WORKFLOW_CERT_STARTED_ON_DATE}}
    - {{WORKFLOW_CERT_STARTED_ON_TIME}}
    - {{WORKFLOW_CERT_CREATED_BY}}
    - {{WORKFLOW_CERT_LAST_UPDATED_ON_DATE}}
    - {{WORKFLOW_CERT_LAST_UPDATED_ON_TIME}}
    - {{WORKFLOW_CERT_LAST_UPDATED_BY}}
    - {{WORKFLOW_CERT_COMPLETED_ON_DATE}}
    - {{WORKFLOW_CERT_COMPLETED_ON_TIME}}
    - {{WORKFLOW_CERT_COMPLETED_BY}}
    - {{WORKFLOW_CERT_LAST_ACTIVITY_ON_DATE}}
    - {{WORKFLOW_CERT_LAST_ACTIVITY_ON_TIME}}
    - {{WORKFLOW_CERT_LAST_ACTIVITY_BY}}
    - {{WORKFLOW_CERT_DUE_ON_DATE}}
    - {{WORKFLOW_CERT_DUE_ON_DATE_TIME}}
    - {{WORKFLOW_CERT_DUE_ON_DATE_TIME_24H}}
    - {{WORKFLOW_CERT_REVIEWERS}}
    POST {{veza_url}}/api/preview/awf/help_page_templates
    {
      "value": {
        "workflow_id": "bc2b2daa-3508-4c0c-a0f2-8a2fb0ef59d9",
        "name": "Review Help",
        "template_body": "# {{WORKFLOW_NAME}} Review Guide\n\nWelcome to the {{WORKFLOW_NAME}} review process. Please follow the steps below:\n\n## Review Steps\n\n",
        "usage": "HELP_PAGE"
      }
    }

    {{WORKFLOW_CERT_LOGGED_IN_USER_DISPLAY_NAME}}

    Display name of the reviewer signed in to Veza.

    {{WORKFLOW_CERT_LOGGED_IN_USER_EMAIL}}

    Email address of the reviewer signed in to Veza.

    {{DATE_NOW}}

    Current date in your tenant's configured time zone, in YYYY-MM-DD format (for example, 2026-06-09).

    placeholder {{WORKFLOW_CERT_LOGGED_IN_USER_EMAIL}} is only supported in REVIEW_START and SIGN_OFF templates
    I, {{WORKFLOW_CERT_LOGGED_IN_USER_DISPLAY_NAME}} ({{WORKFLOW_CERT_LOGGED_IN_USER_EMAIL}}), confirm that I have reviewed the selected rows in {{WORKFLOW_NAME}} and that my access decisions are accurate.
    
    Acknowledged on {{DATE_NOW}}.
    GET {{veza_url}}/api/preview/awf/help_page_templates
    {
        "values": [
            {
                "workflow_id": "8c1772da-a7c3-4dc7-8b09-b900af011ee5",
                "name": "Review Start Popup",
                "usage": "REVIEW_START"
            }
        ]
    }
    GET {{veza_url}}/api/preview/awf/help_page_templates/{{workflow_id}}/{{usage}}
    GET {{veza_url}}/api/preview/awf/certification_help_page?certification_id={{cert_id}}
    {
        "content": "# Help for Reviewers\n\n## Instructions:\n\n"
    }
    DELETE {{veza_url}}/api/preview/awf/help_page_templates/{{workflow_id}}/{{usage}}
    {
      "value": {
        "name": "Global Sign Off Confirmation",
        "template_body": "string",
        "workflow_id": "00000000-0000-0000-0000-000000000000",
        "usage": "SIGN_OFF"
      }
    }

    Create help page

    Template usage

    Template formatting

    Attestation statement placeholders

    These placeholders personalize the text shown in the pop-up. Veza does not store the acknowledged statement as a signed record.

    List help pages

    Get help page

    Get review help page

    Delete help page

    Update help page

    notification-templates
    Create Help Page
    List Help Pages
    Help_Page_Templates_postman_collection.json
    3KB
    Open
    Get Help Page
    Get Review Help Page
    Delete help page
    Update workflow help page

    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

    {
      "id": "e48dd2c8-3633-463b-a477-0177a942b5a6",
      "name": "Highlight inactive sources",
      "description": "Highlight rows where the source account is inactive",
      "priority": 0,
      "attachment_behavior": {
        "attach_to_new_workflows": true,
        "opt_in": true
      },
      "criteria": {
        "filter": "source.is_active eq false",
        "mutable_filter": ""
      },
      "action": {
        "display_style": "HIGHLIGHT",
        "display_text": "Source account is inactive",
        "highlight_color": "#FF6B35"
      }
    }
    {
      "id": "f59ee3d9-4744-574c-b588-1288b0942c7c",
      "name": "Reject privileged account access",
      "description": "Suggest reject for admin or root accounts",
      "priority": 0,
      "attachment_behavior": {
        "attach_to_new_workflows": true,
        "opt_in": true
      },
      "criteria": {
        "filter": "(destination.name eq \"admin\") OR (source.name eq \"root\")",
        "mutable_filter": ""
      },
      "action": {
        "display_style": "SUGGEST_REJECT",
        "display_text": "Privileged account detected - review carefully"
      }
    }

    For more information about this feature see Intelligent Automations.

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

    Key Concepts

    When working with the Automations API, it is important to understand the relationship between three identifiers:

    ID Type
    Description
    Scope

    At an API level,

    • An Automation is a reusable rule that can be attached to one or more Workflows

    • A Workflow (review configuration) defines how reviews are created and can have multiple Certifications over time

    • A Certification is a single instance of a review where Automations run against the results

    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.

    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.

    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.

    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.

    The filter field in an Automation's criteria accepts a SCIM-style expression. Each filter field referenced in the expression is either a bare field or a two-part endpoint.field. Filter fields with three or more dot-separated segments (for example, source.tags.value, reviewers.id, or decision.by) are invalid and are rejected at parse time.

    A filter that fails to parse prevents the Automation from running. When multiple Automations are attached to a Certification, a single unparseable filter on any one of them blocks every attached Automation from running on that Certification.

    The endpoint must be one of the following:

    Endpoint
    Valid fields

    Notes on two-part form:

    • tags matches on the tag key only, never the value. For example, source.tags eq "owner" matches any source node carrying a tag whose key is owner, regardless of that tag's value.

    • Use the exact property key as stored on the node. Built-in properties use their own name (for example, source.is_active). Customer-ingested custom properties carry the customprop_ prefix that is applied during ingest (for example, source.customprop_attribute_code).

    Bare fields refer to attributes of the Certification result row itself, not to the source, destination, waypoint, or path-summary nodes. The field must be exactly one of the following:

    Category
    Fields

    These fields are bare-only. Dotted forms such as reviewers.id, decision.by, or signed_off_state.id are not supported and are rejected at parse time.

    The following filter expressions do not conform to the grammar and are rejected when an Automation is created or updated:

    Filter
    Reason

    When an Access Review configuration includes , you can filter on enriched entity attributes in Automations. Reference joined nodes by their alias directly (e.g., idp.attribute), not using joined_nodes.idp.attribute.

    For complete guidance on finding aliases, filter syntax, and examples, see .

    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"

      • "RESULT_DECISION_ACCEPTED"

    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;

    The preview API does not currently support Reviewer assignment.

    Use the endpoints documented below to create and manage automations:

    • Endpoint: /api/preview/awf/automations

    • Method: GET

    • Description: Returns all Automations and configuration details.

    Returns all in a values array.

    • Endpoint: /api/preview/awf/automations

    • Method: PUT

    • Description: Updates an existing Automation. The full Automation object is required.

    • Endpoint: /api/preview/awf/automations

    • Method: POST

    • Description: Creates a new Automation.

    • Endpoint: /api/preview/awf/automations/{id}

    • Method: GET

    • Description: Get details for a single Automation by ID.

    • Endpoint: /api/preview/awf/automations/{id}

    • Method: DELETE

    • Description: Deletes a specific Automation by its ID.

    • 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.

    • Endpoint: /api/preview/awf/automations:attached/{workflow_id}

    • Method: GET

    • Description: Returns all Automations eligible to run on Certifications for a given Workflow id.

    • Endpoint: /api/preview/awf/automations:detach

    • Method: POST

    • Description: Detach one or all Automations from an Access Review Workflow.

    Access Review Exports

    Programmatic creation and download of access review exports

    The Access Review Export API enables you to programmatically create, monitor, and download exports of access review results in CSV or XLSX format. These endpoints provide the same export functionality available in the Veza UI, allowing you to automate report generation and integrate review data into external systems.

    Endpoints

    • Create Access Review Export - Initiate a new export job

    • Get Access Review Export - Check export status and metadata

    • Download Access Review Export - Download the completed export file

    Workflow

    1. Create an export job with certification ID and format

    2. Poll the status endpoint until FINISHED

    3. Download the export file

    Create a new export job for an access review certification.

    POST /api/preview/awf/exports/access_review:create

    Field
    Type
    Required
    Description

    Create a CSV export:

    Create a filtered CSV export (rejected rows only):

    Create an XLSX diff export:

    Retrieve the status and metadata for an export job.

    GET /api/preview/awf/exports/access_review/{export_id}

    Parameter
    Type
    Required
    Description
    Status
    Description

    Download the completed export file.

    GET /api/preview/awf/exports/access_review/{export_id}:download

    Parameter
    Type
    Required
    Description

    The response returns the file contents with appropriate content-type headers:

    • XLSX exports: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

    • CSV exports: text/csv

    Both filter and mutable_filter parameters use SCIM filter syntax (RFC 7644), not SQL syntax.

    Operator
    Description
    Example

    For mutable_filter, the decision field accepts these enum values:

    Value
    Description

    Export pending decisions only:

    Use Case
    Expression
    • - Get certification IDs for export

    • - View results before exporting

    • - Create certifications programmatically

    priority (Integer): Priority value of the Automation (not currently supported).

    mutable_filter (String): A filter on a previous result mutable field using the syntax previous.attribute. Example: "previous.decision eq "RESULT_DECISION_ACCEPTED""

    Join-spec aliases are valid only when the workflow's query declares a joined node with that alias. See for finding and using aliases.

    "RESULT_DECISION_REJECTED"

  • "RESULT_DECISION_FIXED"

  • notes: string

  • signed_off_state:

    • "UNKNOWN"

    • "NOT_SIGNED_OFF"

    • "SIGNED_OFF"

  • display_style (String): Visual indicator to apply to matching rows:
    • HIGHLIGHT: Highlight the row

    • SUGGEST_ACCEPT: Mark the row as suggested for acceptance

    • SUGGEST_REJECT: Mark the row as suggested for rejection

  • display_text (String): Custom message to show when display_style is set

  • highlight_color (String): Hex color code for custom row highlighting (e.g., #FF0000, #00FF00). Only applies when display_style is HIGHLIGHT. Must be a valid 6-digit hex color in the format #RRGGBB. If omitted, the default highlight color is used.

  • )
  • REJECTED (3)

  • FIXED (4)

  • opt_in (boolean): If False the Automation can be selected when creating a certification. Otherwise, operators can enable it when creating certifications.

    Automation ID

    Unique identifier for a reusable Automation rule

    Global (can be attached to multiple workflows)

    Workflow ID

    Unique identifier for an Access Review configuration

    Defines the query, reviewers, and settings for reviews

    Certification ID

    Unique identifier for a specific Access Review instance created from a workflow

    A single review cycle with results to act upon

    {
      "id": "string",
      "name": "string",
      "description": "string",
      "priority": 0,
      "attachment_behavior": {
        "attach_to_new_workflows": boolean,
        "opt_in": boolean
      },
      "criteria": {
        "filter": "string",
        "mutable_filter": "string"
      },
      "action": {
        // For modification actions:
        "decision": "string",
        "signed_off_state": "string",
        "notes": "string",
        "reviewer_assignment": null,
    
        // OR for display actions:
        "display_style": "string",
        "display_text": "string",
        "highlight_color": "string"
      }
    }

    source

    id, name, type, alternate_name, veza_unique_name, tags, or any property key stored on the source node

    destination

    id, name, type, alternate_name, veza_unique_name, tags, or any property key stored on the destination node

    waypoint

    id, name, type, alternate_name, veza_unique_name, or any property key stored on the waypoint node. tags is not supported.

    path_summary

    id, name, type

    Join-spec alias

    Any property key stored on the joined node (same fields as source). The alias must be declared on the workflow's query.

    Decision and sign-off state

    status, decision, signed_off_state, is_signed_off, no_decision_or_decision_by

    Decision actor and timestamp

    decision_by, decision_by_id, decision_by_name, decision_by_email, decision_at

    Marked-fixed actor and time

    marked_fixed_by_id, marked_fixed_by_name, marked_fixed_by_email, marked_fixed_at

    Sign-off actor and timestamp

    signed_off_by_id, signed_off_by_name, signed_off_by_email, signed_off_at

    Reviewers and assignment

    reviewers, is_assigned_to_current_user

    reviewers.id eq "12345"

    reviewers is a bare field. Dotted form is not supported.

    decision.by eq "alice@example.com"

    Both decision and decision_by are bare fields. Dotted form is not supported.

    source.tags.value eq "prod"

    Three dot-separated segments. tags matches tag keys only, not tag values.

    idp.email co "@example.com"

    idp is valid only when it is declared as a join-spec alias on the workflow's query. See .

    Error handling and conflicts

    Automation Object Schema

    attachment_behavior (Object)

    criteria (Object)

    AWF Automation Filter Grammar

    Two-part form: endpoint.field

    One-part form: field

    Invalid filter examples

    One invalid filter blocks every Automation on a Certification. If any Automation attached to a Certification fails to parse, the Automation run fails for that Certification and no other attached Automations are applied. Validate new filters against a test workflow before attaching them to production Access Reviews.

    Filtering by Joined Node Attributes

    Early Access: Filtering by joined node attributes in Automations is currently in early access. Contact Veza Support for the latest status.

    Filtering by Mutable Fields

    action (Object)

    reviewer_assignment (Object)

    Preview API Documentation

    List Automations

    Update Automation

    Create Automation

    Get Automation

    Delete Automation

    Attach Automations

    List attached Workflow Automations

    Detach Automations

    IdP or HRIS enrichment
    Using Enrichment Data in Automations
    Automations

    format

    integer

    Yes

    Export format: 0 (CSV) or 6 (XLSX)

    certification_id

    string

    Yes

    The ID of the certification to export

    {
      "export_id": "019abd80-a80a-7601-b97d-2dfb6b3a35d1"
    }
    curl -X POST "$VEZA_URL/api/preview/awf/exports/access_review:create" \
      -H "authorization: Bearer $VEZA_TOKEN" \
      -H "content-type: application/json" \
      -d '{
        "format": 0,
        "certification_id": "b2562ef3-a4b3-4b30-8a45-1ba36f945d10",
        "title": "Access Review Export"
      }'
    curl -X POST "$VEZA_URL/api/preview/awf/exports/access_review:create" \
      -H "authorization: Bearer $VEZA_TOKEN" \
      -H "content-type: application/json" \
      -d '{
        "format": 0,
        "certification_id": "b2562ef3-a4b3-4b30-8a45-1ba36f945d10",
        "mutable_filter": "decision eq \"RESULT_DECISION_REJECTED\"",
        "title": "Rejected Access"
      }'
    curl -X POST "$VEZA_URL/api/preview/awf/exports/access_review:create" \
      -H "authorization: Bearer $VEZA_TOKEN" \
      -H "content-type: application/json" \
      -d '{
        "format": 6,
        "certification_id": "b2562ef3-a4b3-4b30-8a45-1ba36f945d10",
        "previous_certification_id": "a1234abc-1234-5678-9abc-def123456789",
        "title": "Access Changes"
      }'

    export_id

    string

    Yes

    The export ID returned from the create request

    {
      "value": {
        "id": "019abd80-a80a-7601-b97d-2dfb6b3a35d1",
        "state": "FINISHED",
        "created_by": "59fd8ac9-26d8-4d06-aa98-c66c2da0e822",
        "created_at": "2025-11-26T00:11:56.810394292Z",
        "updated_at": null,
        "finished_row_count": 0,
        "format": "CSV",
        "error_reason": "",
        "title": "Test Export",
        "last_completed_export": "2025-11-26T00:11:57.513887Z"
      }
    }

    CREATED

    Export job is queued and waiting to start

    PROCESSING

    Export is being generated

    FINISHED

    Export completed successfully and is ready for download

    FAILED

    Export failed due to an error

    CANCELLED

    Export was cancelled before completion

    curl "$VEZA_URL/api/preview/awf/exports/access_review/019abd80-a80a-7601-b97d-2dfb6b3a35d1" \
      -H "authorization: Bearer $VEZA_TOKEN"

    export_id

    string

    Yes

    The export ID of a completed export

    curl "$VEZA_URL/api/preview/awf/exports/access_review/019abd80-a80a-7601-b97d-2dfb6b3a35d1:download" \
      -H "authorization: Bearer $VEZA_TOKEN" \
      -o access_review_export.csv
    #!/bin/bash
    set -e
    
    VEZA_URL="${VEZA_URL}"
    VEZA_TOKEN="${VEZA_TOKEN}"
    CERT_ID="${1}"
    
    # Create export
    EXPORT_RESPONSE=$(curl -s -X POST "$VEZA_URL/api/preview/awf/exports/access_review:create" \
      -H "authorization: Bearer $VEZA_TOKEN" \
      -H "content-type: application/json" \
      -d "{\"format\": 0, \"certification_id\": \"$CERT_ID\"}")
    
    EXPORT_ID=$(echo "$EXPORT_RESPONSE" | grep -o '"export_id":"[^"]*"' | cut -d'"' -f4)
    echo "Export created: $EXPORT_ID"
    
    # Poll for completion
    while true; do
      STATUS=$(curl -s "$VEZA_URL/api/preview/awf/exports/access_review/$EXPORT_ID" \
        -H "authorization: Bearer $VEZA_TOKEN" | grep -o '"state":"[^"]*"' | cut -d'"' -f4)
    
      echo "Status: $STATUS"
      [ "$STATUS" = "FINISHED" ] && break
      [ "$STATUS" = "FAILED" ] && echo "Export failed" && exit 1
      [ "$STATUS" = "CANCELLED" ] && echo "Export cancelled" && exit 1
      [ "$STATUS" = "EXPIRED" ] && echo "Export expired" && exit 1
      sleep 5
    done
    
    # Download
    curl -s "$VEZA_URL/api/preview/awf/exports/access_review/$EXPORT_ID:download" \
      -H "authorization: Bearer $VEZA_TOKEN" \
      -o "export_${CERT_ID}.csv"
    
    echo "Downloaded: export_${CERT_ID}.csv"

    eq

    Equal

    source.name eq "jsmith"

    ne

    Not equal

    decision ne "RESULT_DECISION_NONE"

    co

    Contains

    source.name co "admin"

    RESULT_DECISION_NONE

    No decision made (pending)

    RESULT_DECISION_ACCEPTED

    Access was approved

    RESULT_DECISION_REJECTED

    Access was rejected

    RESULT_DECISION_FIXED

    Access was remediated

    {
      "format": 0,
      "certification_id": "abc123",
      "mutable_filter": "decision eq \"RESULT_DECISION_NONE\"",
      "order_by": "source.name ASC"
    }

    Pending decisions

    "mutable_filter": "decision eq \"RESULT_DECISION_NONE\""

    Rejected access

    "mutable_filter": "decision eq \"RESULT_DECISION_REJECTED\""

    Accepted access

    "mutable_filter": "decision eq \"RESULT_DECISION_ACCEPTED\""

    Source name contains

    "filter": "source.name co \"Test\""

    Source email equals

    "filter": "source.email eq \"user@example.com\""

    Create Access Review Export

    Request

    Request Body

    Supported Formats: Only CSV (format 0) and XLSX (format 6) are supported for access review exports.

    Response

    Examples

    Get Access Review Export

    Request

    Path Parameters

    Response

    Export Status Values

    Poll the export status endpoint periodically until the status is FINISHED before attempting to download. Large exports may take several minutes to complete.

    Example

    Download Access Review Export

    Request

    Path Parameters

    Response

    The export must have status FINISHED before you can download it. Attempting to download an incomplete export will result in an error.

    Example

    Complete Export Script

    Filter Syntax

    SCIM Operators

    Decision Values

    Filter Examples

    See Also

    List Certifications
    List Certification Results
    Create Certification

    previous_certification_id

    string

    No

    Previous certification ID for diff exports

    order_by

    string

    No

    Sort order for results (e.g., "source.name ASC")

    filter

    string

    No

    SCIM filter for source/destination fields (e.g., "source.email eq \"user@example.com\"")

    mutable_filter

    string

    No

    SCIM filter for mutable fields (e.g., "decision eq \"RESULT_DECISION_REJECTED\"")

    title

    string

    No

    Title for XLSX exports (max 30 characters)

    EXPIRED

    Export file has expired and is no longer available for download

    sw

    Starts with

    source.email sw "john"

    ew

    Ends with

    source.email ew "@example.com"

    gt

    Greater than

    source.c gt 100

    ge

    Greater than or equal

    source.d ge 50

    lt

    Less than

    source.c lt 100

    le

    Less than or equal

    source.d le 50

    PR

    Present (not null)

    source.email PR

    Combined filter

    "mutable_filter": "decision eq \"RESULT_DECISION_ACCEPTED\" and signed_off_state eq \"SIGNED_OFF\""

    Risk and access metadata

    risk_level, access_path_risk_score, access_stats_last_used, is_outlier, abstract_permissions, concrete_permissions

    AI suggestions

    ai_suggestion_type, ai_suggestion_reason_codes, ai_suggestion_cohort_id, ai_suggestion_cohort_index

    Notes, automation, notifications

    notes, updated_at, notification_status, automation_run_ids

    Filtering by Joined Node Attributes
    Filtering by Joined Node Attributes
    get
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Responses
    200

    OK

    application/json
    idstringOptional
    namestringOptional
    descriptionstringOptional
    priorityinteger · int32Optional
    attach_to_new_workflowsbooleanOptional
    opt_inbooleanOptional
    filterstringOptional
    mutable_filterstringOptional
    decisioninteger · enumOptional
    signed_off_stateinteger · enumOptional
    notesstringOptional
    users_managerbooleanOptional

    Assigns the manager of each row's identity as a reviewer, found through the global identity provider (IdP) settings, which must be enabled. Assigns at most one manager per row.

    resource_managersbooleanOptional

    Assigns the owner of whichever entity is being reviewed as a reviewer. Despite the field name (kept for wire/backward-compat reasons - see resource_owner_lookup_order), this is not restricted to graph nodes labeled "Resource" in the schema: it resolves the tagged owner (entity owners property, or the legacy resource-manager tag) of whichever side of the query result actually has one, trying resource_owner_lookup_order's preferred side first.

    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    itemsinteger · enumOptionalPossible values:
    previous_review_assignmentbooleanOptional

    Assign reviewer(s) from the comparable row (matched by principal.type/id + resource.type/id) in the prior review. New rows fall through. Creation-only.

    assign_selfbooleanOptional

    Assign reviewer to be the same as the row subject.

    resource_owner_lookup_orderinteger · enumOptional

    Controls which side of the query resource_managers tries first when resolving an owner, when the query has both a principal and a resource node; if that side has no tagged owner, the other side is tried. Has no effect unless resource_managers is set.

    Example: 0Possible values:
    current_reviewers_managersbooleanOptional

    Assign the managers of each row's current reviewers. Only supported in OverdueReassignSettings.targets; rejected for review creation, schedules and reviewer updates. Not the same as reviewers_managers_for_approval_levels, which uses an earlier approval level's reviewers when a review is created.

    display_styleinteger · enumOptional
    display_textstringOptional

    The display text can be used to show a message to the user when the automation is applied. Currently supported for display_style type actions.

    highlight_colorstringOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    get/api/preview/awf/automations
    GET /api/preview/awf/automations HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    {
      "values": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "priority": 1,
          "attachment_behavior": {
            "attach_to_new_workflows": true,
            "opt_in": true
          },
          "criteria": {
            "filter": "text",
            "mutable_filter": "text"
          },
          "action": {
            "decision": 1,
            "signed_off_state": 1,
            "notes": "text",
            "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": [
                0
              ],
              "previous_review_assignment": true,
              "assign_self": true,
              "resource_owner_lookup_order": 0,
              "current_reviewers_managers": true
            },
            "display_style": 1,
            "display_text": "text",
            "highlight_color": "text"
          }
        }
      ]
    }
    put
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Body
    idstringOptional
    namestringOptional
    descriptionstringOptional
    priorityinteger · int32Optional
    attach_to_new_workflowsbooleanOptional
    opt_inbooleanOptional
    filterstringOptional
    mutable_filterstringOptional
    decisioninteger · enumOptional
    signed_off_stateinteger · enumOptional
    notesstringOptional
    users_managerbooleanOptional

    Assigns the manager of each row's identity as a reviewer, found through the global identity provider (IdP) settings, which must be enabled. Assigns at most one manager per row.

    resource_managersbooleanOptional

    Assigns the owner of whichever entity is being reviewed as a reviewer. Despite the field name (kept for wire/backward-compat reasons - see resource_owner_lookup_order), this is not restricted to graph nodes labeled "Resource" in the schema: it resolves the tagged owner (entity owners property, or the legacy resource-manager tag) of whichever side of the query result actually has one, trying resource_owner_lookup_order's preferred side first.

    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    itemsinteger · enumOptionalPossible values:
    previous_review_assignmentbooleanOptional

    Assign reviewer(s) from the comparable row (matched by principal.type/id + resource.type/id) in the prior review. New rows fall through. Creation-only.

    assign_selfbooleanOptional

    Assign reviewer to be the same as the row subject.

    resource_owner_lookup_orderinteger · enumOptional

    Controls which side of the query resource_managers tries first when resolving an owner, when the query has both a principal and a resource node; if that side has no tagged owner, the other side is tried. Has no effect unless resource_managers is set.

    Example: 0Possible values:
    current_reviewers_managersbooleanOptional

    Assign the managers of each row's current reviewers. Only supported in OverdueReassignSettings.targets; rejected for review creation, schedules and reviewer updates. Not the same as reviewers_managers_for_approval_levels, which uses an earlier approval level's reviewers when a review is created.

    display_styleinteger · enumOptional
    display_textstringOptional

    The display text can be used to show a message to the user when the automation is applied. Currently supported for display_style type actions.

    highlight_colorstringOptional
    Responses
    200

    OK

    application/json
    object · UpdateAwfAutomationResponseOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    put/api/preview/awf/automations
    PUT /api/preview/awf/automations HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 763
    
    {
      "value": {
        "id": "text",
        "name": "text",
        "description": "text",
        "priority": 1,
        "attachment_behavior": {
          "attach_to_new_workflows": true,
          "opt_in": true
        },
        "criteria": {
          "filter": "text",
          "mutable_filter": "text"
        },
        "action": {
          "decision": 1,
          "signed_off_state": 1,
          "notes": "text",
          "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": [
              0
            ],
            "previous_review_assignment": true,
            "assign_self": true,
            "resource_owner_lookup_order": 0,
            "current_reviewers_managers": true
          },
          "display_style": 1,
          "display_text": "text",
          "highlight_color": "text"
        }
      }
    }
    {}
    post
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Body
    namestringOptional
    descriptionstringOptional
    priorityinteger · int32Optional
    attach_to_new_workflowsbooleanOptional
    opt_inbooleanOptional
    filterstringOptional
    mutable_filterstringOptional
    decisioninteger · enumOptional
    signed_off_stateinteger · enumOptional
    notesstringOptional
    users_managerbooleanOptional

    Assigns the manager of each row's identity as a reviewer, found through the global identity provider (IdP) settings, which must be enabled. Assigns at most one manager per row.

    resource_managersbooleanOptional

    Assigns the owner of whichever entity is being reviewed as a reviewer. Despite the field name (kept for wire/backward-compat reasons - see resource_owner_lookup_order), this is not restricted to graph nodes labeled "Resource" in the schema: it resolves the tagged owner (entity owners property, or the legacy resource-manager tag) of whichever side of the query result actually has one, trying resource_owner_lookup_order's preferred side first.

    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    itemsinteger · enumOptionalPossible values:
    previous_review_assignmentbooleanOptional

    Assign reviewer(s) from the comparable row (matched by principal.type/id + resource.type/id) in the prior review. New rows fall through. Creation-only.

    assign_selfbooleanOptional

    Assign reviewer to be the same as the row subject.

    resource_owner_lookup_orderinteger · enumOptional

    Controls which side of the query resource_managers tries first when resolving an owner, when the query has both a principal and a resource node; if that side has no tagged owner, the other side is tried. Has no effect unless resource_managers is set.

    Example: 0Possible values:
    current_reviewers_managersbooleanOptional

    Assign the managers of each row's current reviewers. Only supported in OverdueReassignSettings.targets; rejected for review creation, schedules and reviewer updates. Not the same as reviewers_managers_for_approval_levels, which uses an earlier approval level's reviewers when a review is created.

    display_styleinteger · enumOptional
    display_textstringOptional

    The display text can be used to show a message to the user when the automation is applied. Currently supported for display_style type actions.

    highlight_colorstringOptional
    Responses
    200

    OK

    application/json
    idstringOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    post/api/preview/awf/automations
    POST /api/preview/awf/automations HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 741
    
    {
      "name": "text",
      "description": "text",
      "priority": 1,
      "attachment_behavior": {
        "attach_to_new_workflows": true,
        "opt_in": true
      },
      "criteria": {
        "filter": "text",
        "mutable_filter": "text"
      },
      "action": {
        "decision": 1,
        "signed_off_state": 1,
        "notes": "text",
        "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": [
            0
          ],
          "previous_review_assignment": true,
          "assign_self": true,
          "resource_owner_lookup_order": 0,
          "current_reviewers_managers": true
        },
        "display_style": 1,
        "display_text": "text",
        "highlight_color": "text"
      }
    }
    {
      "id": "text"
    }
    get
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Path parameters
    idstringRequired
    Responses
    200

    OK

    application/json
    idstringOptional
    namestringOptional
    descriptionstringOptional
    priorityinteger · int32Optional
    attach_to_new_workflowsbooleanOptional
    opt_inbooleanOptional
    filterstringOptional
    mutable_filterstringOptional
    decisioninteger · enumOptional
    signed_off_stateinteger · enumOptional
    notesstringOptional
    users_managerbooleanOptional

    Assigns the manager of each row's identity as a reviewer, found through the global identity provider (IdP) settings, which must be enabled. Assigns at most one manager per row.

    resource_managersbooleanOptional

    Assigns the owner of whichever entity is being reviewed as a reviewer. Despite the field name (kept for wire/backward-compat reasons - see resource_owner_lookup_order), this is not restricted to graph nodes labeled "Resource" in the schema: it resolves the tagged owner (entity owners property, or the legacy resource-manager tag) of whichever side of the query result actually has one, trying resource_owner_lookup_order's preferred side first.

    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    itemsinteger · enumOptionalPossible values:
    previous_review_assignmentbooleanOptional

    Assign reviewer(s) from the comparable row (matched by principal.type/id + resource.type/id) in the prior review. New rows fall through. Creation-only.

    assign_selfbooleanOptional

    Assign reviewer to be the same as the row subject.

    resource_owner_lookup_orderinteger · enumOptional

    Controls which side of the query resource_managers tries first when resolving an owner, when the query has both a principal and a resource node; if that side has no tagged owner, the other side is tried. Has no effect unless resource_managers is set.

    Example: 0Possible values:
    current_reviewers_managersbooleanOptional

    Assign the managers of each row's current reviewers. Only supported in OverdueReassignSettings.targets; rejected for review creation, schedules and reviewer updates. Not the same as reviewers_managers_for_approval_levels, which uses an earlier approval level's reviewers when a review is created.

    display_styleinteger · enumOptional
    display_textstringOptional

    The display text can be used to show a message to the user when the automation is applied. Currently supported for display_style type actions.

    highlight_colorstringOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    get/api/preview/awf/automations/{id}
    GET /api/preview/awf/automations/{id} HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    {
      "value": {
        "id": "text",
        "name": "text",
        "description": "text",
        "priority": 1,
        "attachment_behavior": {
          "attach_to_new_workflows": true,
          "opt_in": true
        },
        "criteria": {
          "filter": "text",
          "mutable_filter": "text"
        },
        "action": {
          "decision": 1,
          "signed_off_state": 1,
          "notes": "text",
          "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": [
              0
            ],
            "previous_review_assignment": true,
            "assign_self": true,
            "resource_owner_lookup_order": 0,
            "current_reviewers_managers": true
          },
          "display_style": 1,
          "display_text": "text",
          "highlight_color": "text"
        }
      }
    }
    delete
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Path parameters
    idstringRequired
    Responses
    200

    OK

    application/json
    object · DeleteAwfAutomationResponseOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    delete/api/preview/awf/automations/{id}
    DELETE /api/preview/awf/automations/{id} HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    {}
    post
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Body

    Attaches an automation to one or all workflows Attach will succeeds if the automation is already attached and will update the "opt_in" if necessary

    idstringOptional
    workflow_idstringOptional
    allbooleanOptional
    opt_inbooleanOptional
    Responses
    200

    OK

    application/json
    object · AttachAwfAutomationResponseOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    post/api/preview/awf/automations:attach
    POST /api/preview/awf/automations:attach HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 59
    
    {
      "id": "text",
      "workflow_id": "text",
      "all": true,
      "opt_in": true
    }
    {}
    get
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Path parameters
    workflow_idstringRequired
    Responses
    200

    OK

    application/json
    idstringOptional
    namestringOptional
    descriptionstringOptional
    priorityinteger · int32Optional
    attach_to_new_workflowsbooleanOptional
    opt_inbooleanOptional
    filterstringOptional
    mutable_filterstringOptional
    decisioninteger · enumOptional
    signed_off_stateinteger · enumOptional
    notesstringOptional
    users_managerbooleanOptional

    Assigns the manager of each row's identity as a reviewer, found through the global identity provider (IdP) settings, which must be enabled. Assigns at most one manager per row.

    resource_managersbooleanOptional

    Assigns the owner of whichever entity is being reviewed as a reviewer. Despite the field name (kept for wire/backward-compat reasons - see resource_owner_lookup_order), this is not restricted to graph nodes labeled "Resource" in the schema: it resolves the tagged owner (entity owners property, or the legacy resource-manager tag) of whichever side of the query result actually has one, trying resource_owner_lookup_order's preferred side first.

    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    user_typestringOptional
    idstringOptional
    emailstringOptional
    namestringOptional
    alternate_emailstringOptional
    itemsinteger · enumOptionalPossible values:
    previous_review_assignmentbooleanOptional

    Assign reviewer(s) from the comparable row (matched by principal.type/id + resource.type/id) in the prior review. New rows fall through. Creation-only.

    assign_selfbooleanOptional

    Assign reviewer to be the same as the row subject.

    resource_owner_lookup_orderinteger · enumOptional

    Controls which side of the query resource_managers tries first when resolving an owner, when the query has both a principal and a resource node; if that side has no tagged owner, the other side is tried. Has no effect unless resource_managers is set.

    Example: 0Possible values:
    current_reviewers_managersbooleanOptional

    Assign the managers of each row's current reviewers. Only supported in OverdueReassignSettings.targets; rejected for review creation, schedules and reviewer updates. Not the same as reviewers_managers_for_approval_levels, which uses an earlier approval level's reviewers when a review is created.

    display_styleinteger · enumOptional
    display_textstringOptional

    The display text can be used to show a message to the user when the automation is applied. Currently supported for display_style type actions.

    highlight_colorstringOptional
    opt_inbooleanOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    get/api/preview/awf/automations:attached/{workflow_id}
    GET /api/preview/awf/automations:attached/{workflow_id} HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*
    
    {
      "values": [
        {
          "automation": {
            "id": "text",
            "name": "text",
            "description": "text",
            "priority": 1,
            "attachment_behavior": {
              "attach_to_new_workflows": true,
              "opt_in": true
            },
            "criteria": {
              "filter": "text",
              "mutable_filter": "text"
            },
            "action": {
              "decision": 1,
              "signed_off_state": 1,
              "notes": "text",
              "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": [
                  0
                ],
                "previous_review_assignment": true,
                "assign_self": true,
                "resource_owner_lookup_order": 0,
                "current_reviewers_managers": true
              },
              "display_style": 1,
              "display_text": "text",
              "highlight_color": "text"
            }
          },
          "opt_in": true
        }
      ]
    }
    post
    Authorizations
    AuthorizationstringRequired

    Veza API key for authentication. Generate keys in Administration > API Keys.

    Body

    Detaches an automation from one or all workflows

    idstringOptional
    workflow_idstringOptional
    allbooleanOptional
    Responses
    200

    OK

    application/json
    object · DetachAwfAutomationResponseOptional
    default

    Default error response

    application/json

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

    codeinteger · int32Optional

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    messagestringOptional

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    @typestringOptional

    The type of the serialized message.

    Other propertiesanyOptional
    post/api/preview/awf/automations:detach
    POST /api/preview/awf/automations:detach HTTP/1.1
    Host: your-tenant.vezacloud.com
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 45
    
    {
      "id": "text",
      "workflow_id": "text",
      "all": true
    }
    {}

    Workflow Parameters Reference

    Workflows, certifications, and result details

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

    Workflow Properties

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

    Name
    Type
    Description

    workflow_id

    returns all Certifications for a workflow, within a values array.

    Note that to maintain certification integrity, some properties are immutable and can't be modified, while other values system-updated. Mutable fields such as "name," "notes," "reviewers" and "due date" can be changed by operators and admins using the Veza UI:

    Name
    Type
    Description

    See for more details on query construction.

    Internal fields are updated by the workflow service to store important metadata:

    Name
    Type
    Description

    States can be:

    • CERT_STATE_SEARCHING // The query is still running

    • CERT_STATE_IN_PROGRESS // the certification is being reviewed

    • CERT_STATE_COMPLETED // the review of the certification is complete

    include a numeric ID, the query details, and any decisions and notes. Each result includes entity details for the source -> destination nodes and the cumulative permissions under review:

    Name
    Type
    Description

    Valid decisions are:

    1. RESULT_DECISION_NONE // No decision has been made

    2. RESULT_DECISION_ACCEPTED // The access described in the result row is acceptable

    3. RESULT_DECISION_REJECTED // The access described in the result row isn't correct

    Both the number or string value for the decision are allowed, for example "decision": 4 or "decision": RESULT_DECISION_FIXED.

    The notes field will always contain the most recent note. Previous notes can be reviewed in the using the List Cert Results API.

    Shows source, destination, or intermediate entity details for a query result:

    Name
    type
    Description

    Reviewer details, typically a Veza user account. If are configured, the user type and id refer to Veza graph entities:

    Name
    Type
    Description

    You can get details for a local Veza user from Administration > User Management. For graph entities (identities from an external identity provider), inspect the entity details using Access Search or the Entities page. will return all users for a given certification.

    • When assigning reviewers using preview Workflows APIs, requested users are validated before assigning them to a certification result, and not assigned when the user can’t be found. Assignee id and user_type are required to identify reviewers. name and email are optional but if provided must match the Veza user record.

    Results contain a record of all prior actions on a certification result.

    Name
    Type
    Description

    Possible actions are:

    • NOTE_ADDED

    • REVIEWER_ASSIGNED

    • DECISION

    The response will include the type, id, email, and name of the user who made the change:

    A reviewer_assignment object specifies how Veza assigns reviewers to rows. It's used when a certification is created (reviewer_assignment for the first level and reviewer_assignment_second_level for the second level), when reviewers are reassigned on result updates, and by smart actions. On a result update, the object applies to the review's current approval level.

    Name
    Type
    Description

    users_manager, resource_managers, and assign_self require to be enabled.

    Veza determines each row's reviewers for a level as follows:

    1. Veza collects candidates from every field that is set: reviewers, managers and owners (users_manager, resource_managers, and reviewers_managers_for_approval_levels), earlier reviewers (previous_review_assignment), and the row's identity (assign_self). You can set several fields in one object.

    2. Veza replaces any candidate who has an active with their delegate.

    When a certification is created, reviewer assignment runs after the review query completes. Once the request passes validation, an error while assigning reviewers doesn't stop Veza from creating the review.

    • users_manager, resource_managers, or assign_self on any level while global IdP settings are turned off: Cannot perform auto assignment if idp settings are disabled.

    • assign_self on more than one approval level: Self assignment can only be used on a single approval level.

    string

    Certification name (not used)

    notes

    string

    Certification notes

    due_date

    string (RFC 3339 timestamp)

    Due date timestamp

    reviewers

    object

    List of reviewers

    query_completed_at

    string (RFC 3339 timestamp)

    Timestamp indicating when certification results were generated

    completed_at

    string (RFC 3339 timestamp)

    Certification completion date

    created_by

    object

    Certification creator details

    completed_by

    object

    User who marked certification as complete

    total_result_count

    int

    Total query results

    results_updated_at

    string (RFC 3339 timestamp)

    Timestamp

    results_updated_by

    object

    User details

    total_complete_count

    int

    Number or result rows with an accept, reject, or fixed decision

    creator

    object

    User details

    created_at

    string (RFC 3339 timestamp)

    Timestamp

    updated_at

    string (RFC 3339 timestamp)

    Timestamp

    updated_by

    object

    User details

    error_reason

    string

    Error message, if the workflow query failed

    expired_at

    string (RFC 3339 timestamp)

    Timestamp

    total_result_count

    int

    Total number of results

    total_complete_count

    int

    Results with a final decision

    total_rejected_count

    int

    Results with a "reject" decision

    total_accepted_count

    int

    Results with an "accept" decision

    total_fixed_count

    int

    Results that have been "marked as fixed"

    decision

    string

    Row decision

    destination

    object

    The result destination (typically a resource)

    notes

    string

    The most recent note applied to the result

    notification_response_infos

    array

    Error message and status for Webhook integrations, pushed with

    notification_status

    string

    Whether the integration triggered successfully

    result_id

    int

    Result unique identifier for the certification

    reviewers

    Array of

    Reviewer details

    reviewer_assignment

    object

    Instructions for fallback and auto-assigned reviewers

    signed_off_at

    string (RFC 3339 timestamp)

    signed_off_by

    object

    Details for a single reviewer

    signed_off_state

    string

    UNKNOWN_SIGNED_OFF NOT_SIGNED_OFF SIGNED_OFF

    source

    object

    Result source (typically a principal)

    updated_at

    string (RFC 3339 timestamp)

    updated_by

    object

    waypoint

    object

    Related intermediate entity details, if specified by the workflow query

    RESULT_DECISION_FIXED // The access was rejected, but has been fixed

    key:value pair

    Entity properties

    string

    Full username

    alternate_email

    string

    Alternate email address for reviewer notifications

    object

    Decision type and any notes

    array of

    Reviewers to assign instead of managers and owners, when users_manager or resource_managers is set and no allowed manager or owner is found for a row. Ignored otherwise.

    reviewers_managers_for_approval_levels

    array of integer

    Zero-indexed approval levels (0 is the first level). For each listed level, Veza assigns the manager of that level's reviewer for the row. Levels are assigned in order, so list only levels below the one this object configures. Supported only when a certification is created.

    previous_review_assignment

    boolean

    Assign the reviewers of the matching row in the workflow's most recent completed or expired review, at the same approval level. Rows match when they have the same source and destination entity (type, name, and ID), and the same waypoint, if the query has one. Rows with no match get no reviewers from this field. Supported only when a certification is created.

    assign_self

    boolean

    Assign the row's identity as its own reviewer. Self-review prevention doesn't apply when this field is set. Can be set on only one approval level of a review.

    resource_owner_lookup_order

    integer

    Which side of the row resource_managers checks first for an owner. 0 (default): the destination (resource), then the source (principal). 1: the source, then the destination. Has no effect unless resource_managers is true.

    If users_manager or resource_managers is set and none of the manager or owner candidates passes the checks in step 4, Veza uses fallback_reviewers in their place.

  • Veza removes candidates who already review the same row at another approval level, candidates on the reviewer deny list, and, when self-review prevention is enabled and assign_self isn't set, candidates who would review their own access.

  • If no candidate remains, Veza tries the alternate reviewer settings selection methods, in order.

  • Veza removes duplicate reviewers.

  • reviewers_managers_for_approval_levels on a result update: Assigning to previous reviewers not supported for result updates. Smart actions return the same message ending in for smart actions.

    string

    Workflow GUID

    name

    string

    Workflow display name

    description

    string

    Extended description

    owner

    WorkflowUser object

    Owner user details

    notes

    string

    Workflow notes

    query

    WorkflowQuery object

    Workflow search conditions

    creator

    WorkflowUser object

    Creator user details

    created_at

    string (RFC 3339 timestamp)

    Creation date

    certification_id

    string

    Certification GUID

    workflow_id

    string

    Workflow GUID

    query_used

    WorkflowQuery

    The query the certification ran, including any dynamic_information filter (immutable).

    state

    AccessCertState

    Certification status

    snapshot_time

    string (RFC 3339 timestamp)

    Date of graph snapshot at certification creation

    started_at

    string (RFC 3339 timestamp)

    accumulated_effective_permissions

    string list

    Cumulative canonical (C/R/U/D) permissions to the resource

    accumulated_raw_permissions

    string list

    List of concrete system permissions to the resource

    action_log_entries

    ActionLog array

    Log of previous actions on the result

    type

    string

    Entity type

    name

    string

    Entity name

    id

    string

    Entity UID

    user_type

    string

    SSO entity type or localCookieUser

    id

    string

    User GUID

    email

    string

    User email address

    action

    string

    Action log event type

    user

    WorkflowUser object

    Reviewer details

    time

    string

    RFC 3339 timestamp

    {
      "entries": [
        {
          "action": "REVIEWER_ASSIGNED",
          "user": {
            "user_type": "localCookieUser",
            "id": "e5aeaaf6-5d7a-4982-aa61-d0e6dea612a5",
            "email": "cookie@cookie.ai",
            "name": "preview-auth0"
          },
          "time": "2022-09-20T17:50:06.939577367Z",
          "reviewer_detail": {
            "old_reviewers": [],
            "new_reviewers": [
              {
                "user_type": "localCookieUser",
                "id": "299d63c2-8edb-4ed1-a725-e56d84d956b7",
                "email": "aallen@veza.com",
                "name": "docs"
              }
            ]
          }
        },
        {
          "action": "DECISION",
          "user": {
            "user_type": "localCookieUser",
            "id": "e5aeaaf6-5d7a-4982-aa61-d0e6dea612a5",
            "email": "cookie@cookie.ai",
            "name": "preview-auth0"
          },
          "time": "2022-09-20T17:50:21.424281596Z",
          "decision_detail": {
            "decision": "RESULT_DECISION_ACCEPTED",
            "note": "OK"
          }
        },
        {
          "action": "DECISION",
          "user": {
            "user_type": "localCookieUser",
            "id": "e5aeaaf6-5d7a-4982-aa61-d0e6dea612a5",
            "email": "cookie@cookie.ai",
            "name": "preview-auth0"
          },
          "time": "2022-09-20T17:50:44.381372987Z",
          "decision_detail": {
            "decision": "RESULT_DECISION_FIXED",
            "note": ""
          }
        },
        {
          "action": "NOTE_ADDED",
          "user": {
            "user_type": "localCookieUser",
            "id": "e5aeaaf6-5d7a-4982-aa61-d0e6dea612a5",
            "email": "cookie@cookie.ai",
            "name": "preview-auth0"
          },
          "time": "2022-09-20T17:52:14.773114900Z",
          "note": "updating the note"
        }
      ]
    }

    users_manager

    boolean

    Assign the manager of the row's identity, found through the global IdP settings.

    resource_managers

    boolean

    Assign the owner of the entity under review. Veza uses the tagged owner of whichever side of the row has one, trying the side set by resource_owner_lookup_order first. Not limited to resource entities.

    reviewers

    array of WorkflowUser

    Reviewers to assign to every row, if they're allowed to review it.

    {
        "reviewer_assignment": {
            "users_manager": true,
            "resource_managers": false,
            "reviewers": [
                {
                    "email": "<reviewer-email>",
                    "id": "<reviewer-id>",
                    "name": "<reviewer-name>",
                    "user_type": "<user-type>"
                }
            ],
            "fallback_reviewers": [
                {
                    "email": "<reviewer-email>",
                    "id": "<reviewer-id>",
                    "name": "<reviewer-name>",
                    "user_type": "<user-type>"
                }
            ],
            "reviewers_managers_for_approval_levels": [],
            "previous_review_assignment": false,
            "assign_self": false,
            "resource_owner_lookup_order": 0
        }
    }

    Certification Properties

    Result Properties

    ResultNode

    WorkflowUser

    ActionLog

    ReviewerAssignmentInstructions

    How the fields combine

    Validation errors

    Example

    Listing access certifications
    Query Builder API
    Certification results
    action log
    global IdP settings
    List Reviewer Infos
    global IdP settings
    delegation

    name

    Certification creation date

    properties

    name

    decision_detail

    fallback_reviewers

    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:

    1. Peer Grouping: Users are grouped based on configurable properties (default: users sharing the same manager)

    2. 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

    3. Threshold Comparison: Access paths where the statistical lower bound is at or below the configured threshold are flagged as outliers

    4. Reviewer Visibility: Flagged items are highlighted in the reviewer interface with explanations indicating the access is rare within the peer group

    5. Risk Score Boost: On reviews that use Access Intelligence, Veza multiplies the Access Path Risk Score of a flagged path by 1.25, rounds the result, and caps it at 100. The Risk Level is then re-derived from the boosted score. Paths that are not flagged are unchanged. See for the scoring model and worked examples.

    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)

    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.

    Administrators can customize outlier detection using APIs:

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

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

    Name
    Type
    Required
    In
    Description

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

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

    Name
    Type
    Required
    Description

    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)

    Each property reference has these fields:

    Field
    Type
    Required
    Description

    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:

    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:

    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".

    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.

    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.

    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.

    Groups by destination resource classification with a 20% threshold:

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

    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.

    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.

    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.

    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.

    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.

    • - Overview of all Access Reviews settings

    • - Complete Access Reviews documentation

    WorkflowUser
    WorkflowUser
    WorkflowUser
    WorkflowUser
    WorkflowUser
    WorkflowUser
    ResultNode
    UpdateWebhookInfo
    WorkflowUsers
    ReviewerAssignmentInstructions
    WorkflowUser
    ResultNode
    WorkflowUser
    ResultNode
    WorkflowUser

    array

    No

    Array of property references defining how to group users into peer groups. If empty, uses population-wide comparison. See below.

    value.threshold

    number

    Yes

    Threshold percentage (0.0 to 1.0) below which access is considered an outlier. For example, 0.15 means access held by ≤15% of peers is flagged.

    Conditional

    Required when target is TARGET_NODE_JOINED. The alias of the joined node from the review query's JoinNodeSpec

    is_active
    - Whether the user account is active
  • employee_type - Employee classification (e.g., full-time, contractor)

  • environment
    - Environment (prod, dev, test)

    workflow_id

    string

    No

    query

    Review configuration ID. If specified, returns the configuration for that specific review configuration. If omitted or empty, returns the global configuration.

    curl 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/manager_centric_config' \
      -H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
      -H 'Content-Type: application/json'
    curl 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/manager_centric_config?workflow_id=8ae1c414-3a76-46cb-950a-925316b3f264' \
      -H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
      -H 'Content-Type: application/json'
    {
      "value": {
        "grouping_properties": [
          {
            "property_name": "manager_idp_unique_id"
          }
        ],
        "threshold": 0.15
      }
    }

    workflow_id

    string

    No

    Review configuration ID. If specified, applies settings only to that configuration. If omitted, updates the global default.

    value

    object

    Yes

    Configuration object

    curl -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/manager_centric_config' \
      -H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
      -H 'Content-Type: application/json' \
      -d '{
        "value": {
          "grouping_properties": [
            {
              "property_name": "department",
              "target": "TARGET_NODE_SOURCE"
            },
            {
              "property_name": "location",
              "target": "TARGET_NODE_SOURCE"
            }
          ],
          "threshold": 0.1
        }
      }'
    curl -X PUT 'https://your-organization.vezacloud.com/api/private/workflows/access/global_settings/manager_centric_config' \
      -H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
      -H 'Content-Type: application/json' \
      -d '{
        "workflow_id": "8ae1c414-3a76-46cb-950a-925316b3f264",
        "value": {
          "grouping_properties": [
            {
              "property_name": "manager_idp_unique_id"
            }
          ],
          "threshold": 0.2
        }
      }'
    {}

    property_name

    string

    Yes

    The name of the property to group by (e.g., "department", "location", "manager_idp_unique_id")

    target

    enum

    No

    Where the property comes from. Options: TARGET_NODE_UNSPECIFIED (default, assumes source), TARGET_NODE_SOURCE, TARGET_NODE_DESTINATION, TARGET_NODE_JOINED

    joined_node_alias

    {
      "property_name": "department",
      "target": "TARGET_NODE_SOURCE"
    }
    {
      "property_name": "classification",
      "target": "TARGET_NODE_DESTINATION"
    }
    {
      "property_name": "department",
      "target": "TARGET_NODE_JOINED",
      "joined_node_alias": "manager"
    }
    {
      "value": {
        "grouping_properties": [
          {
            "property_name": "manager_idp_unique_id"
          }
        ],
        "threshold": 0.15
      }
    }
    {
      "value": {
        "grouping_properties": [
          {
            "property_name": "department",
            "target": "TARGET_NODE_SOURCE"
          },
          {
            "property_name": "location",
            "target": "TARGET_NODE_SOURCE"
          }
        ],
        "threshold": 0.1
      }
    }
    {
      "value": {
        "grouping_properties": [],
        "threshold": 0.05
      }
    }
    {
      "value": {
        "grouping_properties": [
          {
            "property_name": "classification",
            "target": "TARGET_NODE_DESTINATION"
          }
        ],
        "threshold": 0.2
      }
    }
    {
      "value": {
        "grouping_properties": [
          {
            "property_name": "department",
            "target": "TARGET_NODE_JOINED",
            "joined_node_alias": "manager"
          }
        ],
        "threshold": 0.15
      }
    }
    {
      "value": {
        "grouping_properties": [
          {
            "property_name": "department",
            "target": "TARGET_NODE_SOURCE"
          }
        ],
        "threshold": 0.05
      }
    }
    {
      "value": {
        "grouping_properties": [
          {
            "property_name": "team",
            "target": "TARGET_NODE_SOURCE"
          },
          {
            "property_name": "environment",
            "target": "TARGET_NODE_DESTINATION"
          }
        ],
        "threshold": 0.1
      }
    }
    {
      "value": {
        "grouping_properties": [
          {
            "property_name": "job_role",
            "target": "TARGET_NODE_SOURCE"
          }
        ],
        "threshold": 0.15
      }
    }
    {
      "value": {
        "grouping_properties": [
          {
            "property_name": "department",
            "target": "TARGET_NODE_SOURCE"
          },
          {
            "property_name": "location",
            "target": "TARGET_NODE_SOURCE"
          }
        ],
        "threshold": 0.08
      }
    }

    Default Behavior

    Example Scenario

    API Endpoints

    Get Outlier Detection Configuration

    Parameters

    Example: Get Global Configuration

    Example: Get Configuration for Specific Review

    Response

    Set Outlier Detection Configuration

    Parameters

    Example: Set Global Configuration

    Example: Set Configuration for Specific Review

    Response

    Grouping Properties

    Property Reference Schema

    Target Node Types

    SOURCE Node Properties

    DESTINATION Node Properties

    JOINED Node Properties (Enrichment)

    Configuration Examples

    Example 1: Default Manager-Based Grouping

    Example 2: Department and Location Grouping

    Example 3: No Grouping (Population-Wide)

    Example 4: Resource Classification Grouping

    Example 5: Manager's Department (Enrichment)

    Use Cases

    Finance Audit Compliance

    Engineering Production Access

    Role-Based Access Review

    Cross-Department Anomaly Detection

    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

    After implementing Outlier Detection, monitor reviewer feedback and adjust accordingly.

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

    Related Documentation

    Access Path Risk Score
    Access Reviews Settings
    Access Reviews Configuration

    value.grouping_properties

    string

    Grouping Properties