Update render settings for a screen

Learn more about configuring render settings for advanced customization.

PATCH https://{tenantDomain}/api/v2/prompts/{prompt}/screen/{screen}/rendering

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
    prompts "github.com/auth0/go-auth0/management/management/prompts"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &prompts.UpdateAculRequestContent{}
    client.Prompts.Rendering.Update(
        context.TODO(),
        management.PromptGroupNameEnumLogin.Ptr(),
        management.ScreenGroupNameEnumLogin.Ptr(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.prompts.rendering.update("login", "login", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.prompts.rendering.update("login", "login", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/prompts/{prompt}/screen/{screen}/rendering \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "context_configuration": [],
  "default_head_tags_disabled": false,
  "use_page_template": false,
  "head_tags": [
    {
      "tag": "<string>",
      "attributes": {},
      "content": "<string>"
    }
  ],
  "filters": {
    "clients": [
      {
        "id": "<string>"
      }
    ],
    "organizations": [
      {
        "id": "<string>"
      }
    ],
    "domains": [
      {
        "id": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://{tenantDomain}/api/v2/prompts/{prompt}/screen/{screen}/rendering"

payload = {
    "context_configuration": [],
    "default_head_tags_disabled": False,
    "use_page_template": False,
    "head_tags": [
        {
            "tag": "<string>",
            "attributes": {},
            "content": "<string>"
        }
    ],
    "filters": {
        "clients": [{ "id": "<string>" }],
        "organizations": [{ "id": "<string>" }],
        "domains": [{ "id": "<string>" }]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/prompts/{prompt}/screen/{screen}/rendering",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'context_configuration' => [
        
    ],
    'default_head_tags_disabled' => false,
    'use_page_template' => false,
    'head_tags' => [
        [
                'tag' => '<string>',
                'attributes' => [
                                
                ],
                'content' => '<string>'
        ]
    ],
    'filters' => [
        'clients' => [
                [
                                'id' => '<string>'
                ]
        ],
        'organizations' => [
                [
                                'id' => '<string>'
                ]
        ],
        'domains' => [
                [
                                'id' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/prompts/{prompt}/screen/{screen}/rendering")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"context_configuration\": [],\n  \"default_head_tags_disabled\": false,\n  \"use_page_template\": false,\n  \"head_tags\": [\n    {\n      \"tag\": \"<string>\",\n      \"attributes\": {},\n      \"content\": \"<string>\"\n    }\n  ],\n  \"filters\": {\n    \"clients\": [\n      {\n        \"id\": \"<string>\"\n      }\n    ],\n    \"organizations\": [\n      {\n        \"id\": \"<string>\"\n      }\n    ],\n    \"domains\": [\n      {\n        \"id\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/prompts/{prompt}/screen/{screen}/rendering")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"context_configuration\": [],\n  \"default_head_tags_disabled\": false,\n  \"use_page_template\": false,\n  \"head_tags\": [\n    {\n      \"tag\": \"<string>\",\n      \"attributes\": {},\n      \"content\": \"<string>\"\n    }\n  ],\n  \"filters\": {\n    \"clients\": [\n      {\n        \"id\": \"<string>\"\n      }\n    ],\n    \"organizations\": [\n      {\n        \"id\": \"<string>\"\n      }\n    ],\n    \"domains\": [\n      {\n        \"id\": \"<string>\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "context_configuration": [],
  "default_head_tags_disabled": false,
  "use_page_template": false,
  "head_tags": [
    {
      "tag": "<string>",
      "attributes": {},
      "content": "<string>"
    }
  ],
  "filters": {
    "clients": [
      {
        "id": "<string>"
      }
    ],
    "organizations": [
      {
        "id": "<string>"
      }
    ],
    "domains": [
      {
        "id": "<string>"
      }
    ]
  }
}

Autorisations

bearerAuthoAuth2ClientCredentials

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, confirmation

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, confirmation, async-approval-wrong-user

Corps

application/jsonapplication/x-www-form-urlencoded

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, experiment

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

Show child attributes

filters · object | null

Optional filters to apply rendering rules to specific entities

Show child attributes

Réponse

200

application/json

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, experiment

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

Show child attributes

filters · object | null

Optional filters to apply rendering rules to specific entities

Show child attributes