Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Anomaly API

3 actions 3 updates phrasing extends openapi/auth0-anomaly-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['/anomaly/blocks/ips/{id}'].get

$.paths['/anomaly/blocks/ips/{id}'].delete

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 Anomaly API
  version: 1.0.0
extends: openapi/auth0-anomaly-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['/anomaly/blocks/ips/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an IP is blocked for suspicious activity
      effect: read
      questions:
      - Is a particular IP address being throttled because of suspicious login attempts?
      - Why can't anyone from our office IP log in right now?
      instructions:
      - text: Check whether IP {id} is blocked by suspicious IP throttling.
        slots:
          id: path.id
      - text: Tell me if {id} is currently on the suspicious IP block list.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/anomaly/blocks/ips/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unblock an IP blocked for suspicious activity
      effect: destructive
      questions:
      - How do I lift a suspicious IP throttling block on an address?
      - Can I unblock our office IP after it got throttled?
      instructions:
      - text: Remove the suspicious IP block on {id}.
        slots:
          id: path.id
      - text: Unblock IP address {id} from suspicious IP throttling.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'