Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Sessions API

5 actions 5 updates phrasing extends openapi/auth0-sessions-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['/sessions/{id}'].get

$.paths['/sessions/{id}'].delete

$.paths['/sessions/{id}'].patch

$.paths['/sessions/{id}/revoke'].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 Management Sessions API
  version: 1.0.0
extends: openapi/auth0-sessions-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['/sessions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a login session
      effect: read
      questions:
      - What device and timing details does an Auth0 session record?
      - Can I look up a user's session by its session ID?
      instructions:
      - text: Get session {id}.
        slots:
          id: path.id
      - text: Show the details of session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a session
      effect: destructive
      questions:
      - Can I delete a single session by ID?
      - What's the call to remove a session record?
      instructions:
      - text: Delete session {id}.
        slots:
          id: path.id
      - text: Remove the session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a session's metadata
      effect: write
      questions:
      - How do I attach custom metadata to a session?
      - Can I change the metadata stored on an existing session?
      instructions:
      - text: Set the metadata of session {id} to {session_metadata}.
        slots:
          id: path.id
          session_metadata: requestBody.session_metadata
      - text: Update session {id} with metadata {session_metadata}.
        slots:
          id: path.id
          session_metadata: requestBody.session_metadata
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a session and its refresh tokens
      effect: destructive
      questions:
      - How do I sign a user out of one session and kill its refresh tokens too?
      - Does revoking a session also invalidate the associated refresh tokens?
      instructions:
      - text: Revoke session {id} and its refresh tokens.
        slots:
          id: path.id
      - text: Force-logout session {id}, revoking every refresh token tied to it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'