How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Auth0

Auth0 prompts API

The prompts API from Auth0 — 5 operation(s) for prompts.

Documentation Provider Profile APIs.io OpenAPI GitHub

Auth0 prompts API is one of 76 APIs that Auth0 publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Prompts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 10 operations across 5 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{tenantDomain}/api/v2.

10 operations 5 paths 42 schemas 5 GET3 PATCH2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://your-tenant.auth0.com/api/v2
Authentication
HTTP Bearer, OAuth 2.0
Contact
Auth0 Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Auth0 prompts API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (jwt) (bearerAuth). It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 221 scopes. By default, every request must be authenticated.

Paths & Operations 10

Across 5 paths, the API surfaces 10 operations — 5 GET, 3 PATCH, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

prompts 10
GET
/prompts
Get Prompt Settings
get_prompts → 200401403429
PATCH
/prompts
Update Prompt Settings
patch_prompts body → 200400401403429
GET
/prompts/rendering
Get Render Setting Configurations for All Screens
get_all_rendering 8 params → 200400401402403429
PATCH
/prompts/rendering
Update Render Settings for Multiple Screens
patch_bulk_rendering body → 200400401402403429
GET
/prompts/{prompt}/custom-text/{language}
Get Custom Text for a Prompt
get_custom-text_by_language 2 params → 200400401403404429
PUT
/prompts/{prompt}/custom-text/{language}
Set Custom Text for a Specific Prompt
put_custom-text_by_language 2 params body → 200400401403429
GET
/prompts/{prompt}/partials
Get Partials for a Prompt
get_partials 1 param → 200400401403404429
PUT
/prompts/{prompt}/partials
Set Partials for a Prompt
put_partials 1 param body → 200400401403429
GET
/prompts/{prompt}/screen/{screen}/rendering
Get Render Settings for a Screen
get_rendering 2 params → 200400401402403404429
PATCH
/prompts/{prompt}/screen/{screen}/rendering
Update Render Settings for a Screen
patch_rendering 2 params body → 200400401402403429

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are GetAculResponseContent (9 properties), ListAculsResponseContentItem (9 properties), UpdateAculRequestContent (6 properties), UpdateAculResponseContent (6 properties). Each schema is shown below with its type and property counts.

UpdateAculResponseContent
object
6 properties
UpdateSettingsResponseContent
object
3 properties
AculDomainMetadata
object
Domain metadata key/value pairs
GetCustomTextsByLanguageResponseContent
object
An object containing custom dictionaries for a group of screens.
AculOrganizationFilter
object
Organizations array filter items
AculDomainFilterByMetadata
object
1 property 1 required
SetPartialsRequestContent
object
An object containing template partials for a group of screens.
AculOrganizationFilterById
object
1 property 1 required
AculHeadTag
object
3 properties
AculContextConfigurationItem
PartialGroupsEnum
string
Name of the prompt.
PromptLanguageEnum
string
Language to update.
AculOrganizationMetadata
object
Organization metadata key/value pairs
BulkUpdateAculRequestContent
object
Bulk update render settings for multiple screens
1 property 1 required
AculHeadTagAttributes
object
Attributes of the HTML tag. See MDN documentation for valid attributes.
BulkUpdateAculResponseContent
object
1 property 1 required
ListAculsResponseContentItem
object
9 properties
AculContextEnum
string
Static context values
AculClientFilterByMetadata
object
1 property 1 required
AculClientFilter
object
Client array filter items
AculConfigs
array
Array of screen configurations to update
SetsCustomTextsByLanguageRequestContent
object
An object containing custom dictionaries for a group of screens.
AculFilters
objectnull
Optional filters to apply rendering rules to specific entities
4 properties
AculRenderingModeEnum
string
Rendering mode to filter by
ListAculsResponseContent
UpdateAculRequestContent
object
Render settings for the given screen
6 properties
AculClientFilterById
object
1 property 1 required
AculOrganizationFilterByMetadata
object
1 property 1 required
AculClientMetadata
object
Client metadata key/value pairs
GetAculResponseContent
object
9 properties
AculContextConfiguration
arraynull
Context values to make available
GetSettingsResponseContent
object
3 properties
AculHeadTagContent
string
Text or markup between the element’s opening and closing tags. You can use context variables to display dynamic values.
AculDomainFilterById
object
1 property 1 required
AculMatchTypeEnum
string
Type of match to apply
PromptGroupNameEnum
string
Name of the prompt
UpdateSettingsRequestContent
object
Prompts settings
3 properties
UniversalLoginExperienceEnum
string
Which login experience to use. Can be new or classic.
ListAculsOffsetPaginatedResponseContent
object
4 properties
ScreenGroupNameEnum
string
Name of the screen
AculDomainFilter
object
Domains array filter items
GetPartialsResponseContent
object
An object containing template partials for a group of screens.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

auth0-prompts-api-openapi.yml Raw ↑

Other APIs Auth0 publishes across the network.

Auth0 My Account API
AE Profile APIs.io
Auth0 My Organization API
AE Profile APIs.io
Auth0 for AI Agents
AE Profile APIs.io
Auth0 actions API
AE Profile APIs.io
Auth0 anomaly API
AE Profile APIs.io
Auth0 Assertions API
AE Profile APIs.io
Auth0 attack-protection API
AE Profile APIs.io
Auth0 Authorization Models API
AE Profile APIs.io
Auth0 Authorize User API
AE Profile APIs.io
Auth0 AuthZenService API
AE Profile APIs.io
Auth0 branding API
AE Profile APIs.io
Auth0 client-grants API
AE Profile APIs.io
#Prompts
← Back to A APIs
API Details
ID
auth0:auth0-prompts-api
Base URL
https://your-tenant.auth0.com/api/v2
Docs
https://auth0.com/docs/api/management/v2
Provider
Auth0
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=auth0-prompts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/auth0-prompts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Auth0 prompts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.