Get render setting configurations for all screens

Get render setting configurations for all screens.

GET https://{tenantDomain}/api/v2/prompts/rendering

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Prompts;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Prompts.Rendering.ListAsync(
            new ListAculsRequestParameters {
                Fields = "fields",
                IncludeFields = true,
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Prompt = "prompt",
                Screen = "screen",
                RenderingMode = AculRenderingModeEnum.Advanced
            }
        );
    }

}

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.ListAculsRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Prompt: management.String(
            "prompt",
        ),
        Screen: management.String(
            "screen",
        ),
        RenderingMode: management.AculRenderingModeEnumAdvanced.Ptr(),
    }
    client.Prompts.Rendering.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.prompts.rendering.requests.ListAculsRequestParameters;
import com.auth0.client.mgmt.types.AculRenderingModeEnum;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .token("<token>")
            .build();

        client.prompts().rendering().list(
            ListAculsRequestParameters
                .builder()
                .fields("fields")
                .includeFields(true)
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .prompt("prompt")
                .screen("screen")
                .renderingMode(AculRenderingModeEnum.ADVANCED)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Prompts\Rendering\Requests\ListAculsRequestParameters;
use Auth0\SDK\API\Management\Types\AculRenderingModeEnum;

$client = new Management(
    token: '<token>',
);
$client->prompts->rendering->list(
    new ListAculsRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'prompt' => 'prompt',
        'screen' => 'screen',
        'renderingMode' => AculRenderingModeEnum::Advanced->value,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.prompts.rendering.list(
    fields="fields",
    include_fields=True,
    page=1,
    per_page=1,
    include_totals=True,
    prompt="prompt",
    screen="screen",
    rendering_mode="advanced",
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.prompts.rendering.list(
  fields: "fields",
  include_fields: true,
  page: 1,
  per_page: 1,
  include_totals: true,
  prompt: "prompt",
  screen: "screen",
  rendering_mode: "advanced"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.prompts.rendering.list({
        fields: "fields",
        includeFields: true,
        page: 1,
        perPage: 1,
        includeTotals: true,
        prompt: "prompt",
        screen: "screen",
        renderingMode: "advanced",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.prompts.rendering.list({
        fields: "fields",
        includeFields: true,
        page: 1,
        perPage: 1,
        includeTotals: true,
        prompt: "prompt",
        screen: "screen",
        renderingMode: "advanced",
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/prompts/rendering \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "tenant": "<string>",
    "prompt": "<string>",
    "screen": "<string>",
    "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>"
        }
      ]
    }
  }
]

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Query Parameters

fields · string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields · boolean

Whether specified fields are to be included (default: true) or excluded (false).

page · integer

Page index of the results to return. First page is 0.

Required range: x >= 0

per_page · integer

Number of results per page. Maximum value is 100, default value is 50.

Required range: 1 <= x <= 100

include_totals · boolean

Return results inside an object that contains the total configuration count (true) or as a direct array of results (false, default).

prompt · string

Name of the prompt to filter by

screen · string

Name of the screen to filter by

rendering_mode · enum<string>

Rendering mode to filter by

Available options: advanced, standard

Response

200

application/json

ACUL settings successfully retrieved.

object[]

object

tenant · string

Tenant ID

prompt · string

Name of the prompt

screen · string

Name of the screen

rendering_mode · enum<string>

Rendering mode

Available options: advanced, standard

context_configuration · enum<string> · string · string · string · string · string · string[] | null

Context values to make available

Static context values

Available options: 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 · default: false

Override Universal Login default head tags

use_page_template · boolean | null · default: 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