Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend M2M Tokens API

5 actions 5 updates phrasing extends openapi/clerk-com-m2m-tokens-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Clerk's API. It is a proposal applied on top of the contract, not a document Clerk publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/m2m_tokens'].get
$.paths['/m2m_tokens'].post
$.paths['/m2m_tokens/{m2m_token_id}/revoke'].post
$.paths['/m2m_tokens/verify'].post

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 Clerk Backend M2M Tokens API
  version: 1.0.0
extends: openapi/clerk-com-m2m-tokens-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/m2m_tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List M2M tokens for a machine
      effect: read
      questions:
      - Which machine-to-machine tokens have been issued for a machine?
      - Can I filter a machine's M2M tokens to exclude revoked or expired ones?
      instructions:
      - text: List M2M tokens for machine {subject}.
        slots:
          subject: query.subject
      - text: Show unexpired, unrevoked opaque tokens issued to {subject}.
        slots:
          subject: query.subject
      method: generated
      generated: '2026-09-26'
- target: $.paths['/m2m_tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a machine-to-machine token
      effect: write
      questions:
      - How does a machine get a token to call another machine's API?
      - Can I choose JWT or opaque format and set an expiry for an M2M token?
      instructions:
      - text: Create an M2M token that expires in {seconds_until_expiration} seconds.
        slots:
          seconds_until_expiration: requestBody.seconds_until_expiration
      - text: Issue a machine token in {token_format} format with claims {claims}.
        slots:
          token_format: requestBody.token_format
          claims: requestBody.claims
      method: generated
      generated: '2026-09-26'
- target: $.paths['/m2m_tokens/{m2m_token_id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke an M2M token
      effect: destructive
      questions:
      - How do I revoke a machine token that leaked?
      - Can JWT-format machine tokens be revoked?
      instructions:
      - text: Revoke M2M token {m2m_token_id}.
        slots:
          m2m_token_id: path.m2m_token_id
      - text: Revoke machine token {m2m_token_id} because {revocation_reason}.
        slots:
          m2m_token_id: path.m2m_token_id
          revocation_reason: requestBody.revocation_reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/m2m_tokens/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an M2M token
      effect: read
      questions:
      - How do I check that an incoming machine token is valid?
      - Does verifying an M2M token confirm it has access to my machine?
      instructions:
      - text: Verify M2M token {token}.
        slots:
          token: requestBody.token
      - text: Check whether machine token {token} is valid.
        slots:
          token: requestBody.token
      method: generated
      generated: '2026-09-26'