Passer au contenu principal
PATCH
/
prompts
/
{prompt}
/
screen
/
{screen}
/
rendering
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.prompts.rendering.update("login", "login", {});
}
main();
{
  "rendering_mode": "advanced",
  "context_configuration": [
    "branding.settings"
  ],
  "default_head_tags_disabled": false,
  "use_page_template": false,
  "head_tags": [
    {
      "tag": "<string>",
      "attributes": {},
      "content": "<string>"
    }
  ],
  "filters": {
    "match_type": "includes_any",
    "clients": [
      {
        "id": "<string>"
      }
    ],
    "organizations": [
      {
        "id": "<string>"
      }
    ],
    "domains": [
      {
        "id": "<string>"
      }
    ]
  }
}

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

prompt
enum<string>
requis

Name of the prompt

Options disponibles:
login,
login-id,
login-password,
login-passwordless,
login-email-verification,
signup,
signup-id,
signup-password,
phone-identifier-enrollment,
phone-identifier-challenge,
email-identifier-challenge,
reset-password,
custom-form,
consent,
customized-consent,
logout,
mfa-push,
mfa-otp,
mfa-voice,
mfa-phone,
mfa-webauthn,
mfa-sms,
mfa-email,
mfa-recovery-code,
mfa,
status,
device-flow,
email-verification,
email-otp-challenge,
organizations,
invitation,
common,
passkeys,
captcha,
brute-force-protection,
async-approval-flow
screen
enum<string>
requis

Name of the screen

Options disponibles:
login,
login-id,
login-password,
login-passwordless-email-code,
login-passwordless-email-link,
login-passwordless-sms-otp,
login-email-verification,
signup,
signup-id,
signup-password,
phone-identifier-enrollment,
phone-identifier-challenge,
email-identifier-challenge,
reset-password-request,
reset-password-email,
reset-password,
reset-password-success,
reset-password-error,
reset-password-mfa-email-challenge,
reset-password-mfa-otp-challenge,
reset-password-mfa-phone-challenge,
reset-password-mfa-push-challenge-push,
reset-password-mfa-recovery-code-challenge,
reset-password-mfa-sms-challenge,
reset-password-mfa-voice-challenge,
reset-password-mfa-webauthn-platform-challenge,
reset-password-mfa-webauthn-roaming-challenge,
custom-form,
consent,
customized-consent,
logout,
logout-complete,
logout-aborted,
mfa-push-welcome,
mfa-push-enrollment-qr,
mfa-push-enrollment-code,
mfa-push-success,
mfa-push-challenge-push,
mfa-push-list,
mfa-otp-enrollment-qr,
mfa-otp-enrollment-code,
mfa-otp-challenge,
mfa-voice-enrollment,
mfa-voice-challenge,
mfa-phone-challenge,
mfa-phone-enrollment,
mfa-webauthn-platform-enrollment,
mfa-webauthn-roaming-enrollment,
mfa-webauthn-platform-challenge,
mfa-webauthn-roaming-challenge,
mfa-webauthn-change-key-nickname,
mfa-webauthn-enrollment-success,
mfa-webauthn-error,
mfa-webauthn-not-available-error,
mfa-country-codes,
mfa-sms-enrollment,
mfa-sms-challenge,
mfa-sms-list,
mfa-email-challenge,
mfa-email-list,
mfa-recovery-code-enrollment,
mfa-recovery-code-challenge-new-code,
mfa-recovery-code-challenge,
mfa-detect-browser-capabilities,
mfa-enroll-result,
mfa-login-options,
mfa-begin-enroll-options,
status,
device-code-activation,
device-code-activation-allowed,
device-code-activation-denied,
device-code-confirmation,
email-verification-result,
email-otp-challenge,
organization-selection,
organization-picker,
pre-login-organization-picker,
accept-invitation,
redeem-ticket,
passkey-enrollment,
passkey-enrollment-local,
interstitial-captcha,
brute-force-protection-unblock,
brute-force-protection-unblock-success,
brute-force-protection-unblock-failure,
async-approval-error,
async-approval-accepted,
async-approval-denied,
async-approval-wrong-user

Corps

Render settings for the given screen

rendering_mode
enum<string>

Rendering mode

Options disponibles:
advanced,
standard
context_configuration
enum<string> · string · string · string · string · string · string[] | null

Context values to make available

Static context values

Options disponibles:
branding.settings,
branding.themes.default,
client.logo_uri,
client.description,
organization.display_name,
organization.branding,
screen.texts,
tenant.name,
tenant.friendly_name,
tenant.logo_url,
tenant.enabled_locales,
untrusted_data.submitted_form_data,
untrusted_data.authorization_params.login_hint,
untrusted_data.authorization_params.screen_hint,
untrusted_data.authorization_params.ui_locales,
user.organizations,
transaction.custom_domain.domain
default_head_tags_disabled
boolean | null
défaut:false

Override Universal Login default head tags

use_page_template
boolean | null
défaut:false

Use page template with ACUL

head_tags
object[] | null

An array of head tags

filters
object

Optional filters to apply rendering rules to specific entities

Réponse

ACUL settings successfully updated.

rendering_mode
enum<string>

Rendering mode

Options disponibles:
advanced,
standard
context_configuration
enum<string> · string · string · string · string · string · string[] | null

Context values to make available

Static context values

Options disponibles:
branding.settings,
branding.themes.default,
client.logo_uri,
client.description,
organization.display_name,
organization.branding,
screen.texts,
tenant.name,
tenant.friendly_name,
tenant.logo_url,
tenant.enabled_locales,
untrusted_data.submitted_form_data,
untrusted_data.authorization_params.login_hint,
untrusted_data.authorization_params.screen_hint,
untrusted_data.authorization_params.ui_locales,
user.organizations,
transaction.custom_domain.domain
default_head_tags_disabled
boolean | null
défaut:false

Override Universal Login default head tags

use_page_template
boolean | null
défaut:false

Use page template with ACUL

head_tags
object[] | null

An array of head tags

filters
object

Optional filters to apply rendering rules to specific entities