Clerk · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Clerk Com JWT Templates API
11 actions
11 updates
phrasing
extends
openapi/clerk-com-jwt-templates-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/jwt_templates'].get
$.paths['/jwt_templates'].post
$.paths['/jwt_templates/{template_id}'].get
$.paths['/jwt_templates/{template_id}'].delete
$.paths['/jwt_templates/{template_id}'].patch
$.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/jwt_templates'].get
$.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/jwt_templates'].post
$.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/jwt_templates/{templateID}'].get
$.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/jwt_templates/{templateID}'].delete
$.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/jwt_templates/{templateID}'].patch
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 Com JWT Templates API
version: 1.0.0
extends: openapi/clerk-com-jwt-templates-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: 10
- target: $.paths['/jwt_templates'].get
update:
x-apievangelist-phrasing:
intent: List JWT templates
effect: read
questions:
- What JWT templates are set up in my instance?
- How do I page through all my session token templates?
instructions:
- text: List all my JWT templates.
- text: Show the first {limit} JWT templates in this instance.
slots:
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/jwt_templates'].post
update:
x-apievangelist-phrasing:
intent: Create a JWT template
effect: write
questions:
- How do I create a JWT template with custom claims for a third-party service?
- Can I set a custom signing key and algorithm on a new JWT template?
- What token lifetime can I give a JWT template?
instructions:
- text: Create a JWT template named {name} with claims {claims}.
slots:
name: requestBody.name
claims: requestBody.claims
- text: Create JWT template {name} with claims {claims} and a lifetime of {lifetime} seconds.
slots:
name: requestBody.name
claims: requestBody.claims
lifetime: requestBody.lifetime
method: generated
generated: '2026-09-26'
- target: $.paths['/jwt_templates/{template_id}'].get
update:
x-apievangelist-phrasing:
intent: Retrieve a JWT template
effect: read
questions:
- How do I view the claims configured on one JWT template?
- What details are stored on a single JWT template?
instructions:
- text: Get JWT template {template_id}.
slots:
template_id: path.template_id
- text: Show the claims and lifetime of template {template_id}.
slots:
template_id: path.template_id
method: generated
generated: '2026-09-26'
- target: $.paths['/jwt_templates/{template_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a JWT template
effect: destructive
questions:
- How do I delete a JWT template I no longer use?
- Can I remove a session token template from my instance?
instructions:
- text: Delete JWT template {template_id}.
slots:
template_id: path.template_id
- text: Remove the unused token template {template_id}.
slots:
template_id: path.template_id
method: generated
generated: '2026-09-26'
- target: $.paths['/jwt_templates/{template_id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a JWT template
effect: write
questions:
- How do I change the claims on an existing JWT template?
- Can I extend the lifetime or clock skew of a JWT template I already have?
instructions:
- text: Update template {template_id} to name {name} with claims {claims}.
slots:
template_id: path.template_id
name: requestBody.name
claims: requestBody.claims
- text: Change the claims of existing JWT template {template_id} to {claims}, keeping name {name}.
slots:
template_id: path.template_id
claims: requestBody.claims
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/jwt_templates'].get
update:
x-apievangelist-phrasing:
intent: List an application instance's JWT templates
effect: read
questions:
- How do I list JWT templates for one of my applications using the Platform API?
- Which scope do I need to read JWT templates across applications?
instructions:
- text: List the JWT templates of application {applicationID} in environment {envOrInsID}.
slots:
applicationID: path.applicationID
envOrInsID: path.envOrInsID
- text: Show the token templates on the {envOrInsID} instance of app {applicationID} via the platform.
slots:
envOrInsID: path.envOrInsID
applicationID: path.applicationID
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/jwt_templates'].post
update:
x-apievangelist-phrasing:
intent: Create a JWT template in an application instance
effect: write
questions:
- How do I add a JWT template to another application's instance through the Platform API?
- Can I create a JWT template for my production environment from a platform token?
instructions:
- text: Create JWT template {name} with claims {claims} in application {applicationID} instance {envOrInsID}.
slots:
name: requestBody.name
claims: requestBody.claims
applicationID: path.applicationID
envOrInsID: path.envOrInsID
- text: Via the platform, add token template {name} to the {envOrInsID} environment of app {applicationID} with claims {claims}.
slots:
name: requestBody.name
envOrInsID: path.envOrInsID
applicationID: path.applicationID
claims: requestBody.claims
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/jwt_templates/{templateID}'].get
update:
x-apievangelist-phrasing:
intent: Get a JWT template in an application instance
effect: read
questions:
- How do I read one JWT template from a specific application instance via the Platform API?
- Can a platform token fetch a template's claims in another app's environment?
instructions:
- text: Get JWT template {templateID} from application {applicationID} instance {envOrInsID}.
slots:
templateID: path.templateID
applicationID: path.applicationID
envOrInsID: path.envOrInsID
- text: Via the platform, show template {templateID} in the {envOrInsID} environment of app {applicationID}.
slots:
templateID: path.templateID
envOrInsID: path.envOrInsID
applicationID: path.applicationID
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/jwt_templates/{templateID}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a JWT template in an application instance
effect: destructive
questions:
- How do I delete a JWT template from one of my application instances via the Platform API?
- Which scope is required to delete JWT templates across applications?
instructions:
- text: Delete JWT template {templateID} from application {applicationID} instance {envOrInsID}.
slots:
templateID: path.templateID
applicationID: path.applicationID
envOrInsID: path.envOrInsID
- text: Via the platform, remove template {templateID} from the {envOrInsID} environment of app {applicationID}.
slots:
templateID: path.templateID
envOrInsID: path.envOrInsID
applicationID: path.applicationID
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/jwt_templates/{templateID}'].patch
update:
x-apievangelist-phrasing:
intent: Update a JWT template in an application instance
effect: write
questions:
- How do I edit a JWT template's claims in another application's instance with the Platform API?
- Can I change a template's signing algorithm through the platform?
instructions:
- text: Update template {templateID} in application {applicationID} instance {envOrInsID} to name {name} and claims {claims}.
slots:
templateID: path.templateID
applicationID: path.applicationID
envOrInsID: path.envOrInsID
name: requestBody.name
claims: requestBody.claims
- text: Via the platform, set claims {claims} on template {templateID} ({name}) in the {envOrInsID} environment of app {applicationID}.
slots:
claims: requestBody.claims
templateID: path.templateID
name: requestBody.name
envOrInsID: path.envOrInsID
applicationID: path.applicationID
method: generated
generated: '2026-09-26'