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)

• 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

Validation Rules

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

Valid Column Values

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

Example

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

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.

Get Review Column Defaults

Get Review Columns

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

AcceptstringOptionalExample: application/json

Responses

200

OK

application/json

Responseobject

get

/api/private/workflows/access/global_settings/ui_column_settings

HTTPcURLJavaScriptPython

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 Column Defaults

Set Review Columns

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringOptionalExample: application/json

AcceptstringOptionalExample: application/json

Body

application/json

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

Responseobject

put

/api/private/workflows/access/global_settings/ui_column_settings

HTTPcURLJavaScriptPython

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"
    ]
  }
}

List All Column Settings

Get All Column Customizations

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

AcceptstringOptionalExample: application/json

Responses

200

OK

application/json

Responseobject

500

Internal Server Error

application/json

get

/api/private/workflows/access/global_settings/ui_column_settings:list_all

HTTPcURLJavaScriptPython

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"
        ]
      }
    }
  ]
}