Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Authentication SAML API

3 actions 3 updates phrasing extends openapi/auth0-saml-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['/samlp/{client_id}'].get
$.paths['/samlp/metadata/{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 SAML API
  version: 1.0.0
extends: openapi/auth0-saml-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['/samlp/{client_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Start a SAML login for an application
      effect: read
      questions:
      - Where should my SAML service provider send its login request in Auth0?
      - Can an SP-initiated SAML login go straight to a specific connection or organization?
      instructions:
      - text: Start a SAML login for client {client_id}.
        slots:
          client_id: path.client_id
      - text: Begin SAML login for client {client_id} through connection {connection} in organization {organization}.
        slots:
          client_id: path.client_id
          connection: query.connection
          organization: query.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/samlp/metadata/{client_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get SAML 2.0 metadata for an application
      effect: read
      questions:
      - Where do I get the SAML identity provider metadata XML for my app?
      - What metadata should I give a service provider to trust my tenant as a SAML IdP?
      instructions:
      - text: Get the SAML metadata for client {client_id}.
        slots:
          client_id: path.client_id
      - text: Download the SAML 2.0 IdP metadata XML for application {client_id}.
        slots:
          client_id: path.client_id
      method: generated
      generated: '2026-10-01'