Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management User Blocks API

5 actions 5 updates phrasing extends openapi/auth0-user-blocks-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 5

$.info

$.paths['/user-blocks'].get

$.paths['/user-blocks'].delete

$.paths['/user-blocks/{id}'].get

$.paths['/user-blocks/{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 User Blocks API
  version: 1.0.0
extends: openapi/auth0-user-blocks-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: 4
- target: $.paths['/user-blocks'].get
  update:
    x-apievangelist-phrasing:
      intent: Check brute-force blocks by email, username or phone
      effect: read
      questions:
      - Is the person using a given email address locked out by brute-force protection?
      - Can I look up brute-force blocks by username or phone number instead of user ID?
      instructions:
      - text: Check brute-force blocks for identifier {identifier}.
        slots:
          identifier: query.identifier
      - text: Show whether {identifier} is blocked, considering brute-force enablement {consider_brute_force_enablement}.
        slots:
          identifier: query.identifier
          consider_brute_force_enablement: query.consider_brute_force_enablement
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user-blocks'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unblock by email, username or phone
      effect: destructive
      questions:
      - How do I unlock someone who got locked out after too many failed logins, using their email?
      - Can I clear brute-force blocks by phone number?
      instructions:
      - text: Unblock identifier {identifier}.
        slots:
          identifier: query.identifier
      - text: Remove all brute-force blocks for the email or username {identifier}.
        slots:
          identifier: query.identifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user-blocks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List brute-force blocks for a user ID
      effect: read
      questions:
      - Which IPs are blocking a specific user ID from logging in?
      - Can I see brute-force blocks for a user when I know their user ID?
      instructions:
      - text: Show brute-force blocks for user {id}.
        slots:
          id: path.id
      - text: List the blocked IPs for user ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user-blocks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unblock a user by user ID
      effect: destructive
      questions:
      - How do I lift brute-force blocks for a user when I have their user ID?
      - Does clearing a user's brute-force blocks also unblock an admin-blocked user?
      instructions:
      - text: Unblock user {id}.
        slots:
          id: path.id
      - text: Clear all brute-force protection blocks for user ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'