Custom Provider Configurations

ListCustomProviderInternalConfigurationDefinitions returns the internal configuration definitions for all custom OAA providers, including built-in Veza integrations that use OAA templates.

This endpoint is useful for understanding the configuration schema of custom integrations, including connector types, data source configurations, and supported settings.

List custom provider configuration definitions

get

Retrieve the internal configuration definitions for all available OAA provider types. Returns metadata about each provider type including configuration property definitions (names, types, and whether fields are optional or secret), provider icon and MIME type, custom templates available, provider categories (application, IdP, HRIS, etc.), lifecycle management support, and documentation URL. Use this to discover available provider types and their configuration schema before creating a new custom provider instance.

Authorizations

bearerAuth

AuthorizationstringRequired

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

Responses

200

OK

application/json

List of OAA provider configuration definitions.

default

Default error response

application/json

get

/api/v1/providers/custom/configurations

HTTPcURLJavaScriptPython

GET /api/v1/providers/custom/configurations HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "values": [
    {
      "provider_name": "text",
      "properties": [
        {
          "name": "text",
          "description": "text",
          "type": 1,
          "optional": true,
          "secret": true,
          "internal": true,
          "oauth2_redirect_required": true,
          "vault_sourced": true,
          "enum_values": [
            {
              "value": "text",
              "label": "text"
            }
          ],
          "lifecycle_management_only": true
        }
      ],
      "icon": "text",
      "icon_mime_type": "text",
      "custom_templates": [
        "text"
      ],
      "provider_categories": [
        1
      ],
      "documentation_url": "text",
      "lifecycle_management_supported": true,
      "created_at": "2026-03-07T05:05:03.652Z"
    }
  ]
}

Sample request

curl -X GET "$BASE_URL/api/v1/providers/custom/configurations" \
  -H "authorization: Bearer $VEZA_TOKEN"