Manage Global Settings

Configure global settings for Access Requests

Overview

Manages system-wide Access Request settings that control approval workflows and auto-grant behavior.

patch

Authorizations

bearerAuth

AuthorizationstringRequired

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

Query parameters

update_maskstring · field-maskOptional

Body

application/json

enabledbooleanOptional

available_explanationsstring[]Optional

deny_requestersstring[]Optional

deny_approversstring[]Optional

actions_require_sso_logininteger · enum[]Optional

Responses

200

OK

application/json

default

Default error response

application/json

patch

/api/private/lifecycle_management/access_requests/settings

HTTPcURLJavaScriptPython

PATCH /api/private/lifecycle_management/access_requests/settings HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1170

{
  "event_notification_settings": [
    {
      "event_type": 1,
      "notification_settings": {
        "notification_type": 1,
        "notification_id": "text",
        "type_settings": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "on_success": true,
      "on_failure": true,
      "on_success_custom_template_id": "text",
      "on_failure_custom_template_id": "text"
    }
  ],
  "admin_approval_settings": {
    "allow_approval_on_request": true,
    "grant_without_approval": true
  },
  "access_profile_owner_approval_settings": {
    "allow_approval_on_request": true,
    "grant_without_approval": true
  },
  "access_profile_requestable_settings": {
    "allow_all": true,
    "allow_with_labels": [
      "text"
    ],
    "allow_from_types": [
      "text"
    ]
  },
  "enabled": true,
  "access_request_event_notification_settings": {
    "values": [
      {
        "event_type": 1,
        "notification_type": 1,
        "email_setting": {
          "to_approvers": true,
          "to_creator": true,
          "to_beneficiary": true,
          "other_emails": [
            "text"
          ],
          "to_watchers": true
        },
        "notification_id": "text"
      }
    ]
  },
  "available_explanations": [
    "text"
  ],
  "delegations": {
    "delegations": [
      {
        "original_user": "text",
        "delegate_user": "text"
      }
    ]
  },
  "deny_requesters": [
    "text"
  ],
  "deny_approvers": [
    "text"
  ],
  "actions_require_sso_login": [
    1
  ],
  "app_owner_approval_settings": {
    "allow_approval_on_request": true,
    "grant_without_approval": true
  }
}

{
  "value": {
    "event_notification_settings": [
      {
        "event_type": 1,
        "notification_settings": {
          "notification_type": 1,
          "notification_id": "text",
          "type_settings": {
            "@type": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "on_success": true,
        "on_failure": true,
        "on_success_custom_template_id": "text",
        "on_failure_custom_template_id": "text"
      }
    ],
    "admin_approval_settings": {
      "allow_approval_on_request": true,
      "grant_without_approval": true
    },
    "access_profile_owner_approval_settings": {
      "allow_approval_on_request": true,
      "grant_without_approval": true
    },
    "access_profile_requestable_settings": {
      "allow_all": true,
      "allow_with_labels": [
        "text"
      ],
      "allow_from_types": [
        "text"
      ]
    },
    "enabled": true,
    "access_request_event_notification_settings": {
      "values": [
        {
          "event_type": 1,
          "notification_type": 1,
          "email_setting": {
            "to_approvers": true,
            "to_creator": true,
            "to_beneficiary": true,
            "other_emails": [
              "text"
            ],
            "to_watchers": true
          },
          "notification_id": "text"
        }
      ]
    },
    "available_explanations": [
      "text"
    ],
    "delegations": {
      "delegations": [
        {
          "original_user": "text",
          "delegate_user": "text"
        }
      ]
    },
    "deny_requesters": [
      "text"
    ],
    "deny_approvers": [
      "text"
    ],
    "actions_require_sso_login": [
      1
    ],
    "app_owner_approval_settings": {
      "allow_approval_on_request": true,
      "grant_without_approval": true
    }
  }
}

Examples

Enable Access Requests with Auto-Approval

curl -X PATCH "https://your-instance.vezacloud.com/api/private/lifecycle_management/access_requests/settings" \
  -H "authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "admin_approval_settings": {
      "allow_approval_on_request": true,
      "grant_without_approval": true
    },
    "access_profile_owner_approval_settings": {
      "allow_approval_on_request": false,
      "grant_without_approval": false
    },
    "app_owner_approval_settings": {
      "allow_approval_on_request": false,
      "grant_without_approval": false
    }
  }'

Response

{
  "value": {
    "event_notification_settings": [],
    "admin_approval_settings": {
      "allow_approval_on_request": true,
      "grant_without_approval": true
    },
    "access_profile_owner_approval_settings": {
      "allow_approval_on_request": false,
      "grant_without_approval": false
    },
    "access_profile_requestable_settings": {
      "allow_all": false,
      "allow_with_labels": [],
      "allow_from_types": []
    },
    "enabled": true,
    "access_request_event_notification_settings": {
      "values": []
    },
    "available_explanations": [],
    "delegations": {
      "delegations": []
    },
    "deny_requesters": [],
    "deny_approvers": [],
    "actions_require_sso_login": [],
    "app_owner_approval_settings": {
      "allow_approval_on_request": false,
      "grant_without_approval": false
    }
  }
}

Enable with Manual Approval

curl -X PATCH "https://your-instance.vezacloud.com/api/private/lifecycle_management/access_requests/settings" \
  -H "authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "admin_approval_settings": {
      "allow_approval_on_request": true,
      "grant_without_approval": false
    },
    "access_profile_owner_approval_settings": {
      "allow_approval_on_request": true,
      "grant_without_approval": false
    }
  }'

Get Current Settings

curl -X GET "https://your-instance.vezacloud.com/api/private/lifecycle_management/access_requests/settings" \
  -H "authorization: Bearer YOUR_API_TOKEN"