Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Authentication WS Federation API

2 actions 2 updates phrasing extends openapi/auth0-ws-federation-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 2

$.info
$.paths['/wsfed/{client_id}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Authentication WS Federation API
  version: 1.0.0
extends: openapi/auth0-ws-federation-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: 1
- target: $.paths['/wsfed/{client_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Start a WS-Federation login
      effect: read
      questions:
      - How do I start a login from a WS-Federation relying party?
      - Can a WS-Fed login be sent to a specific home realm?
      instructions:
      - text: Start a WS-Federation login for client {client_id}.
        slots:
          client_id: path.client_id
      - text: Begin WS-Fed sign-in for {client_id} with realm {wtrealm} and reply URL {wreply}.
        slots:
          client_id: path.client_id
          wtrealm: query.wtrealm
          wreply: query.wreply
      method: generated
      generated: '2026-10-01'