Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Supplemental Signals API

3 actions 3 updates phrasing extends openapi/auth0-supplemental-signals-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Auth0's API. It is a proposal applied on top of the contract, not a document Auth0 publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/supplemental-signals'].get

$.paths['/supplemental-signals'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Supplemental Signals API
  version: 1.0.0
extends: openapi/auth0-supplemental-signals-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/supplemental-signals'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the supplemental signals configuration
      effect: read
      questions:
      - Is my tenant set up to use Akamai supplemental signals?
      - Where do I check the tenant's supplemental signals setting?
      instructions:
      - text: Show me the supplemental signals configuration.
      - text: Check whether Akamai supplemental signals are enabled.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/supplemental-signals'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn Akamai supplemental signals on or off
      effect: write
      questions:
      - How do I start using Akamai bot signals in my tenant's attack protection?
      - Can I disable Akamai supplemental signals?
      instructions:
      - text: Set Akamai supplemental signals enabled to {akamai_enabled}.
        slots:
          akamai_enabled: requestBody.akamai_enabled
      - text: Enable Akamai signals for the tenant by setting akamai_enabled to {akamai_enabled}.
        slots:
          akamai_enabled: requestBody.akamai_enabled
      method: generated
      generated: '2026-10-01'