TypeScript
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.prompts.rendering.bulkUpdate({
configs: [
{
prompt: "login",
screen: "login",
},
],
});
}
main();import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.prompts.rendering.bulkUpdate({
configs: [
{
prompt: "login",
screen: "login",
},
],
});
}
main();
package example
import (
context "context"
management "github.com/auth0/go-auth0/v3/management"
client "github.com/auth0/go-auth0/v3/management/client"
option "github.com/auth0/go-auth0/v3/management/option"
)
func do() {
mgmt, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &management.BulkUpdateAculRequestContent{
Configs: []*management.AculConfigsItem{
&management.AculConfigsItem{
Prompt: management.PromptGroupNameEnumLogin,
Screen: management.ScreenGroupNameEnumLogin,
},
},
}
mgmt.Prompts.Rendering.BulkUpdate(
context.TODO(),
request,
)
}
# Ensure you're logged in: auth0 login
auth0 api patch "prompts/rendering" --data '{
"configs": [
{
"prompt": "login",
"screen": "login"
}
]
}'using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Prompts;
using System.Collections.Generic;
public partial class Examples
{
public async Task Example() {
var client = new ManagementApiClient(
token: "<token>",
clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
);
await client.Prompts.Rendering.BulkUpdateAsync(
new BulkUpdateAculRequestContent {
Configs = new List<AculConfigsItem>(){
new AculConfigsItem {
Prompt = PromptGroupNameEnum.Login,
Screen = ScreenGroupNameEnum.Login
},
}
}
);
}
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.prompts.types.BulkUpdateAculRequestContent;
import com.auth0.client.mgmt.types.AculConfigsItem;
import com.auth0.client.mgmt.types.PromptGroupNameEnum;
import com.auth0.client.mgmt.types.ScreenGroupNameEnum;
import java.util.Arrays;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.prompts().rendering().bulkUpdate(
BulkUpdateAculRequestContent
.builder()
.configs(
Arrays.asList(
AculConfigsItem
.builder()
.prompt(PromptGroupNameEnum.LOGIN)
.screen(ScreenGroupNameEnum.LOGIN)
.build()
)
)
.build()
);
}
}<?php
namespace Example;
use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Prompts\Rendering\Requests\BulkUpdateAculRequestContent;
use Auth0\SDK\API\Management\Types\AculConfigsItem;
use Auth0\SDK\API\Management\Types\PromptGroupNameEnum;
use Auth0\SDK\API\Management\Types\ScreenGroupNameEnum;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->prompts->rendering->bulkUpdate(
new BulkUpdateAculRequestContent([
'configs' => [
new AculConfigsItem([
'prompt' => PromptGroupNameEnum::Login->value,
'screen' => ScreenGroupNameEnum::Login->value,
]),
],
]),
);
from auth0.management import ManagementClient, AculConfigsItem
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.prompts.rendering.bulk_update(
configs=[
AculConfigsItem(
prompt="login",
screen="login",
)
],
)
require "auth0"
client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")
client.prompts.rendering.bulk_update(configs: [{
prompt: "login",
screen: "login"
}])
curl --request PATCH \
--url https://{tenantDomain}/api/v2/prompts/rendering \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"configs": [
{
"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>"
}
]
}
}
]
}
'{
"configs": [
{
"prompt": "login",
"screen": "login",
"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>"
}
]
}
}
]
}Update render settings for multiple screens
Learn more about configuring render settings for advanced customization.
PATCH
https://{tenantDomain}/api/v2
/
prompts
/
rendering
TypeScript
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.prompts.rendering.bulkUpdate({
configs: [
{
prompt: "login",
screen: "login",
},
],
});
}
main();import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.prompts.rendering.bulkUpdate({
configs: [
{
prompt: "login",
screen: "login",
},
],
});
}
main();
package example
import (
context "context"
management "github.com/auth0/go-auth0/v3/management"
client "github.com/auth0/go-auth0/v3/management/client"
option "github.com/auth0/go-auth0/v3/management/option"
)
func do() {
mgmt, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &management.BulkUpdateAculRequestContent{
Configs: []*management.AculConfigsItem{
&management.AculConfigsItem{
Prompt: management.PromptGroupNameEnumLogin,
Screen: management.ScreenGroupNameEnumLogin,
},
},
}
mgmt.Prompts.Rendering.BulkUpdate(
context.TODO(),
request,
)
}
# Ensure you're logged in: auth0 login
auth0 api patch "prompts/rendering" --data '{
"configs": [
{
"prompt": "login",
"screen": "login"
}
]
}'using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Prompts;
using System.Collections.Generic;
public partial class Examples
{
public async Task Example() {
var client = new ManagementApiClient(
token: "<token>",
clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
);
await client.Prompts.Rendering.BulkUpdateAsync(
new BulkUpdateAculRequestContent {
Configs = new List<AculConfigsItem>(){
new AculConfigsItem {
Prompt = PromptGroupNameEnum.Login,
Screen = ScreenGroupNameEnum.Login
},
}
}
);
}
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.prompts.types.BulkUpdateAculRequestContent;
import com.auth0.client.mgmt.types.AculConfigsItem;
import com.auth0.client.mgmt.types.PromptGroupNameEnum;
import com.auth0.client.mgmt.types.ScreenGroupNameEnum;
import java.util.Arrays;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.prompts().rendering().bulkUpdate(
BulkUpdateAculRequestContent
.builder()
.configs(
Arrays.asList(
AculConfigsItem
.builder()
.prompt(PromptGroupNameEnum.LOGIN)
.screen(ScreenGroupNameEnum.LOGIN)
.build()
)
)
.build()
);
}
}<?php
namespace Example;
use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Prompts\Rendering\Requests\BulkUpdateAculRequestContent;
use Auth0\SDK\API\Management\Types\AculConfigsItem;
use Auth0\SDK\API\Management\Types\PromptGroupNameEnum;
use Auth0\SDK\API\Management\Types\ScreenGroupNameEnum;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->prompts->rendering->bulkUpdate(
new BulkUpdateAculRequestContent([
'configs' => [
new AculConfigsItem([
'prompt' => PromptGroupNameEnum::Login->value,
'screen' => ScreenGroupNameEnum::Login->value,
]),
],
]),
);
from auth0.management import ManagementClient, AculConfigsItem
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.prompts.rendering.bulk_update(
configs=[
AculConfigsItem(
prompt="login",
screen="login",
)
],
)
require "auth0"
client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")
client.prompts.rendering.bulk_update(configs: [{
prompt: "login",
screen: "login"
}])
curl --request PATCH \
--url https://{tenantDomain}/api/v2/prompts/rendering \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"configs": [
{
"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>"
}
]
}
}
]
}
'{
"configs": [
{
"prompt": "login",
"screen": "login",
"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>"
}
]
}
}
]
}Authorizations
bearerAuthoAuth2ClientCredentials
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/jsonapplication/x-www-form-urlencoded
Bulk update render settings for multiple screens
Array of screen configurations to update
Minimum array length:
1Show child attributes
Show child attributes
Response
ACUL settings successfully updated.
Array of screen configurations to update
Minimum array length:
1Show child attributes
Show child attributes