Auth0 · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Auth0 Management Prompts API
11 actions
11 updates
phrasing
extends
openapi/auth0-prompts-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/prompts'].get
$.paths['/prompts'].patch
$.paths['/prompts/rendering'].get
$.paths['/prompts/rendering'].patch
$.paths['/prompts/{prompt}/custom-text/{language}'].get
$.paths['/prompts/{prompt}/custom-text/{language}'].put
$.paths['/prompts/{prompt}/partials'].get
$.paths['/prompts/{prompt}/partials'].put
$.paths['/prompts/{prompt}/screen/{screen}/rendering'].get
$.paths['/prompts/{prompt}/screen/{screen}/rendering'].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 Auth0 Management Prompts API
version: 1.0.0
extends: openapi/auth0-prompts-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: 10
- target: $.paths['/prompts'].get
update:
x-apievangelist-phrasing:
intent: Get Universal Login prompt settings
effect: read
questions:
- Is Identifier First authentication turned on for my Auth0 tenant?
- Which Universal Login experience is my tenant using?
instructions:
- text: Get my tenant's prompt settings.
- text: Show the current Universal Login configuration.
method: generated
generated: '2026-10-01'
- target: $.paths['/prompts'].patch
update:
x-apievangelist-phrasing:
intent: Update Universal Login prompt settings
effect: write
questions:
- How do I enable Identifier First login?
- Can I make WebAuthn platform authenticators the first factor?
instructions:
- text: Set Identifier First authentication to {identifier_first}.
slots:
identifier_first: requestBody.identifier_first
- text: Switch the Universal Login experience to {universal_login_experience}.
slots:
universal_login_experience: requestBody.universal_login_experience
method: generated
generated: '2026-10-01'
- target: $.paths['/prompts/rendering'].get
update:
x-apievangelist-phrasing:
intent: List render settings for all login screens
effect: read
questions:
- Which login screens use advanced rendering mode?
- Can I filter screen render settings by prompt or rendering mode?
instructions:
- text: List render settings for all screens.
- text: List screen render settings for prompt {prompt} in rendering mode {rendering_mode}.
slots:
prompt: query.prompt
rendering_mode: query.rendering_mode
method: generated
generated: '2026-10-01'
- target: $.paths['/prompts/rendering'].patch
update:
x-apievangelist-phrasing:
intent: Update render settings for many screens
effect: write
questions:
- Can I update the render settings of several login screens in one request?
- What's the bulk way to switch many screens to advanced customization?
instructions:
- text: Apply the render configs {configs} to multiple screens.
slots:
configs: requestBody.configs
- text: Bulk update screen rendering with {configs}.
slots:
configs: requestBody.configs
method: generated
generated: '2026-10-01'
- target: $.paths['/prompts/{prompt}/custom-text/{language}'].get
update:
x-apievangelist-phrasing:
intent: Get a prompt's custom text for a language
effect: read
questions:
- What custom wording is set on the login prompt in French?
- Can I read back the custom text for one prompt and language?
instructions:
- text: Get the custom text for prompt {prompt} in {language}.
slots:
prompt: path.prompt
language: path.language
- text: Show the {language} copy overrides on the {prompt} prompt.
slots:
language: path.language
prompt: path.prompt
method: generated
generated: '2026-10-01'
- target: $.paths['/prompts/{prompt}/custom-text/{language}'].put
update:
x-apievangelist-phrasing:
intent: Set a prompt's custom text for a language
effect: write
questions:
- How do I change the wording on the signup screen?
- Does setting custom text overwrite the existing texts for that language?
instructions:
- text: Set custom text for prompt {prompt} in {language}.
slots:
prompt: path.prompt
language: path.language
- text: Overwrite the {language} text on the {prompt} prompt.
slots:
language: path.language
prompt: path.prompt
method: generated
generated: '2026-10-01'
- target: $.paths['/prompts/{prompt}/partials'].get
update:
x-apievangelist-phrasing:
intent: Get template partials for a prompt
effect: read
questions:
- What template partials are injected into a login prompt?
- Can I see the custom partials on the signup prompt?
instructions:
- text: Get the template partials for prompt {prompt}.
slots:
prompt: path.prompt
- text: Show the partials set on the {prompt} prompt.
slots:
prompt: path.prompt
method: generated
generated: '2026-10-01'
- target: $.paths['/prompts/{prompt}/partials'].put
update:
x-apievangelist-phrasing:
intent: Set template partials for a prompt
effect: write
questions:
- How do I add custom fields to the signup prompt with partials?
- Can I replace a prompt's template partials?
instructions:
- text: Set the template partials for prompt {prompt}.
slots:
prompt: path.prompt
- text: Replace the partials on the {prompt} prompt.
slots:
prompt: path.prompt
method: generated
generated: '2026-10-01'
- target: $.paths['/prompts/{prompt}/screen/{screen}/rendering'].get
update:
x-apievangelist-phrasing:
intent: Get render settings for one login screen
effect: read
questions:
- Is a specific login screen rendered with advanced customization?
- What head tags are configured on one screen?
instructions:
- text: Get the render settings for screen {screen} of prompt {prompt}.
slots:
screen: path.screen
prompt: path.prompt
- text: Show how the {screen} screen in the {prompt} prompt is rendered.
slots:
screen: path.screen
prompt: path.prompt
method: generated
generated: '2026-10-01'
- target: $.paths['/prompts/{prompt}/screen/{screen}/rendering'].patch
update:
x-apievangelist-phrasing:
intent: Update render settings for one login screen
effect: write
questions:
- How do I switch one login screen to advanced rendering mode?
- Can I add custom head tags to a single screen?
instructions:
- text: Set rendering mode {rendering_mode} on screen {screen} of prompt {prompt}.
slots:
rendering_mode: requestBody.rendering_mode
screen: path.screen
prompt: path.prompt
- text: Add head tags {head_tags} to the {screen} screen of the {prompt} prompt.
slots:
head_tags: requestBody.head_tags
screen: path.screen
prompt: path.prompt
method: generated
generated: '2026-10-01'