Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend Actor Tokens API

3 actions 3 updates phrasing extends openapi/clerk-com-actor-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 3

$.info

$.paths['/actor_tokens'].post

$.paths['/actor_tokens/{actor_token_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 Clerk Backend Actor Tokens API
  version: 1.0.0
extends: openapi/clerk-com-actor-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: 2
- target: $.paths['/actor_tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an actor token to impersonate a user
      effect: write
      questions:
      - How do I let a support agent impersonate a user?
      - Can I limit how long an impersonation token or session lasts?
      instructions:
      - text: Create an actor token for user {user_id} with actor {actor}.
        slots:
          user_id: requestBody.user_id
          actor: requestBody.actor
      - text: Let actor {actor} impersonate {user_id} for {expires_in_seconds} seconds.
        slots:
          user_id: requestBody.user_id
          actor: requestBody.actor
          expires_in_seconds: requestBody.expires_in_seconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/actor_tokens/{actor_token_id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a pending actor token
      effect: destructive
      questions:
      - How do I cancel an impersonation token before it's used?
      - Can only pending actor tokens be revoked?
      instructions:
      - text: Revoke actor token {actor_token_id}.
        slots:
          actor_token_id: path.actor_token_id
      - text: Cancel impersonation token {actor_token_id}.
        slots:
          actor_token_id: path.actor_token_id
      method: generated
      generated: '2026-09-26'