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.

circle-info

Allowed roles: admin, access_reviews_admin, operator

Parameters

Name
Type
Required
In
Description

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 /api/private/workflows/access/global_settings/column_name_overrides

Get Global Overrides

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'

Get Workflow-Scoped Overrides

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'

Example Response

Set Column Name Overrides

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

Example: Set Global Overrides

Example: Set Workflow-Scoped Overrides

Response

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

Clear All Global Overrides

Clear Specific Overrides

Response

circle-info

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.

Last updated

Was this helpful?