Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Device Credentials API

4 actions 4 updates phrasing extends openapi/auth0-device-credentials-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['/device-credentials'].get

$.paths['/device-credentials'].post

$.paths['/device-credentials/{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 Device Credentials API
  version: 1.0.0
extends: openapi/auth0-device-credentials-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['/device-credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's device credentials
      effect: read
      questions:
      - Which refresh tokens or device public keys does a user have?
      - Can I filter device credentials by application or credential type?
      instructions:
      - text: List device credentials for user {user_id}.
        slots:
          user_id: query.user_id
      - text: List {type} device credentials for user {user_id} in client {client_id}.
        slots:
          type: query.type
          user_id: query.user_id
          client_id: query.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/device-credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a device public key
      effect: write
      questions:
      - How do I register a device's public key for refresh token rotation?
      - What details about the device are needed to create a device credential?
      instructions:
      - text: Create a {type} device credential for device {device_name} ({device_id}) with value {value}.
        slots:
          type: requestBody.type
          device_name: requestBody.device_name
          device_id: requestBody.device_id
          value: requestBody.value
      - text: Register public key {value} for device {device_id} named {device_name} as type {type}.
        slots:
          value: requestBody.value
          device_id: requestBody.device_id
          device_name: requestBody.device_name
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/device-credentials/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device credential
      effect: destructive
      questions:
      - Can I revoke a refresh token stored as a device credential?
      - Is deleting a device credential permanent?
      instructions:
      - text: Delete device credential {id}.
        slots:
          id: path.id
      - text: Permanently remove the device credential {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'