Clerk · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Clerk Backend Instance Settings API
12 actions
12 updates
phrasing
extends
openapi/clerk-com-instance-settings-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 12
$.info
$.paths['/instance'].get
$.paths['/instance'].patch
$.paths['/instance/restrictions'].patch
$.paths['/instance/protect'].get
$.paths['/instance/protect'].patch
$.paths['/instance/communication'].get
$.paths['/instance/communication'].patch
$.paths['/instance/oauth_application_settings'].get
$.paths['/instance/oauth_application_settings'].patch
$.paths['/instance/organization_settings'].get
$.paths['/instance/organization_settings'].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 Backend Instance Settings API
version: 1.0.0
extends: openapi/clerk-com-instance-settings-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: 11
- target: $.paths['/instance'].get
update:
x-apievangelist-phrasing:
intent: Fetch the current instance
effect: read
questions:
- What are the current settings of my Clerk instance?
- Can I read back the instance record my secret key belongs to?
instructions:
- text: Fetch my current instance.
- text: Show the configuration of this instance.
method: generated
generated: '2026-09-26'
- target: $.paths['/instance'].patch
update:
x-apievangelist-phrasing:
intent: Update general instance settings
effect: write
questions:
- How do I change the support email shown for my instance?
- Can I turn on breached-password checks or test mode for the instance?
instructions:
- text: Set the instance support email to {support_email}.
slots:
support_email: requestBody.support_email
- text: Update the instance's allowed origins to {allowed_origins}.
slots:
allowed_origins: requestBody.allowed_origins
method: generated
generated: '2026-09-26'
- target: $.paths['/instance/restrictions'].patch
update:
x-apievangelist-phrasing:
intent: Update sign-up allowlist and blocklist restrictions
effect: write
questions:
- How do I restrict sign-ups to an allowlist of identifiers?
- Can I block disposable email domains and email subaddresses on my instance?
instructions:
- text: Enable the allowlist restriction on my instance.
- text: Block disposable email domains and email subaddresses for sign-ups.
method: generated
generated: '2026-09-26'
- target: $.paths['/instance/protect'].get
update:
x-apievangelist-phrasing:
intent: Get the instance's protect settings
effect: read
questions:
- Are protect rules currently enabled on my instance?
- What bot and fraud protection settings does the instance have right now?
instructions:
- text: Get the protect settings for my instance.
- text: Show whether protect rules are turned on.
method: generated
generated: '2026-09-26'
- target: $.paths['/instance/protect'].patch
update:
x-apievangelist-phrasing:
intent: Update the instance's protect settings
effect: write
questions:
- How do I turn protect rules on for my instance?
- Can I enable or disable Specter protection on the instance?
instructions:
- text: Enable protect rules on my instance.
- text: Turn Specter protection {specter_enabled} for this instance.
slots:
specter_enabled: requestBody.specter_enabled
method: generated
generated: '2026-09-26'
- target: $.paths['/instance/communication'].get
update:
x-apievangelist-phrasing:
intent: Get SMS communication settings
effect: read
questions:
- Which countries are blocked from receiving SMS for my instance?
- What SMS communication settings does my instance have?
instructions:
- text: Show my instance's SMS country blocklist.
- text: Get the SMS communication settings for this instance.
method: generated
generated: '2026-09-26'
- target: $.paths['/instance/communication'].patch
update:
x-apievangelist-phrasing:
intent: Replace the SMS country blocklist
effect: write
questions:
- How do I stop sending SMS codes to certain countries?
- What happens to unrecognized country codes in the SMS blocklist?
instructions:
- text: Block SMS delivery to countries {blocked_country_codes}.
slots:
blocked_country_codes: requestBody.blocked_country_codes
- text: Replace the SMS country blocklist with {blocked_country_codes}.
slots:
blocked_country_codes: requestBody.blocked_country_codes
method: generated
generated: '2026-09-26'
- target: $.paths['/instance/oauth_application_settings'].get
update:
x-apievangelist-phrasing:
intent: Get OAuth application settings
effect: read
questions:
- Is dynamic OAuth client registration turned on for my instance?
- Does my instance issue JWT access tokens for OAuth applications?
instructions:
- text: Get the OAuth application settings for my instance.
- text: Show whether dynamic client registration is enabled.
method: generated
generated: '2026-09-26'
- target: $.paths['/instance/oauth_application_settings'].patch
update:
x-apievangelist-phrasing:
intent: Update OAuth application settings
effect: write
questions:
- How do I allow OAuth clients to register themselves dynamically?
- Can I switch OAuth access tokens to JWT format?
instructions:
- text: Enable dynamic OAuth client registration on my instance.
- text: Set JWT OAuth access tokens to {oauth_jwt_access_tokens}.
slots:
oauth_jwt_access_tokens: requestBody.oauth_jwt_access_tokens
method: generated
generated: '2026-09-26'
- target: $.paths['/instance/organization_settings'].get
update:
x-apievangelist-phrasing:
intent: Get instance organization settings
effect: read
questions:
- Are organizations enabled on my instance, and what's the membership limit?
- Which role does an organization's creator get by default?
instructions:
- text: Get the organization settings for my instance.
- text: Show the max allowed memberships per organization.
method: generated
generated: '2026-09-26'
- target: $.paths['/instance/organization_settings'].patch
update:
x-apievangelist-phrasing:
intent: Update instance organization settings
effect: write
questions:
- How do I enable organizations for my instance?
- Can I cap how many members each organization may have?
instructions:
- text: Enable organizations on my instance.
- text: Limit organizations to {max_allowed_memberships} members each.
slots:
max_allowed_memberships: requestBody.max_allowed_memberships
- text: Give organization creators the role {creator_role_id}.
slots:
creator_role_id: requestBody.creator_role_id
method: generated
generated: '2026-09-26'