Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Authentication Logout API

4 actions 4 updates phrasing extends openapi/auth0-logout-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 4

$.info

$.paths['/v2/logout'].get

$.paths['/oidc/logout'].get

$.paths['/samlp/{CLIENT_ID}/logout'].post

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 Authentication Logout API
  version: 1.0.0
extends: openapi/auth0-logout-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: 3
- target: $.paths['/v2/logout'].get
  update:
    x-apievangelist-phrasing:
      intent: Log a user out and redirect with returnTo
      effect: write
      questions:
      - How do I log a user out of their session and send them back to my homepage?
      - Can logout also sign the user out of the upstream identity provider?
      instructions:
      - text: Log the user out and redirect to {returnTo}.
        slots:
          returnTo: query.returnTo
      - text: Log out from application {client_id}, return to {returnTo}, and set federated to {federated}.
        slots:
          client_id: query.client_id
          returnTo: query.returnTo
          federated: query.federated
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oidc/logout'].get
  update:
    x-apievangelist-phrasing:
      intent: Log a user out via OIDC RP-initiated logout
      effect: write
      questions:
      - What is the OpenID Connect compliant way to end a user's session?
      - Can I pass an ID token hint and post-logout redirect URI when signing out?
      instructions:
      - text: Do an OIDC logout with ID token hint {id_token_hint} and redirect to {post_logout_redirect_uri}.
        slots:
          id_token_hint: query.id_token_hint
          post_logout_redirect_uri: query.post_logout_redirect_uri
      - text: End the session via OIDC logout for client {client_id}, keeping state {state}.
        slots:
          client_id: query.client_id
          state: query.state
      method: generated
      generated: '2026-10-01'
- target: $.paths['/samlp/{CLIENT_ID}/logout'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a user out of a SAML identity provider app
      effect: write
      questions:
      - How do I handle single logout when Auth0 acts as the SAML identity provider?
      - Which endpoint performs SAML logout for a SAML2 Web App addon application?
      instructions:
      - text: Run SAML logout for application {CLIENT_ID}.
        slots:
          CLIENT_ID: path.CLIENT_ID
      - text: Log the user out of the SAML IdP session for client {CLIENT_ID}.
        slots:
          CLIENT_ID: path.CLIENT_ID
      method: generated
      generated: '2026-10-01'