Overview
This article explains how to customize the text on the login page.
Applies To
- Universal Login
- Customizations
- Customize he text on the login page
Solution
Customize the text on the login page, including text field names and button text. The list of prompts is available at Customize Universal Login Text Elements.
Change prompts from the Auth0 dashboard:
- Navigate to Branding > Universal Login.
- Select Advanced Options.
- Select Custom Text.
A prompt
is a specific step in the login flow, for example, Multi-Factor Authentication OTP enrollment (mfa-otp
) or sign-in with a username and password (login-password
). A screen
is a subset of a prompt
. A prompt
might have one or multiple screens
.
- For example: The
login-password
prompt
has a singlescreen
(login-password
). Whereas, themfa-otp
prompt
has themfa-otp-enrollment-qr
screen
(for QR code enrollment) and themfa-otp-enrollment-code
screen
(for manual code entry).
Updating Text Prompts via API (Advanced): For advanced use cases, update prompts by calling the Management API Set custom text for a specific prompt. This can be done in addition to using the dashboard editor. The syntax for the API call is:
PUT https://<tenant_name>.auth0.com/api/v2/prompts/<prompt_name>/custom-text/<language_code>
Sample Request Payload:
{
"<screen_name>": {
"<text_id>": "Custom text for the specified language"
}
}
Where:
<tenant_name>
: The name of thetenant
.<prompt_name>
: Aprompt
from the list of available prompts (refer to Customize Login Text Prompts).<language_code>
: Alanguage
from the list of supported languages in Universal Login localization<screen_name>
: Ascreen
from the specifiedprompt
.<text_id>
: TheKey
from the screen that identifies thetext
to customize.
Example: To change the Trouble Scanning? text on the MFA OTP QR code enrollment prompt for users with their language set to English, send the following request:
PUT https://<tenant_name>.auth0.com/api/v2/prompts/mfa-otp/custom-text/en
Sample Request Payload:
{
"mfa-otp-enrollment-qr": {
"codeEnrollmentText": "Click here if you cleaned your camera lens and still have trouble scanning."
}
}