Obtener toda la configuración de renderizado

Obtenga la configuración de renderizado de todas las pantallas.

GET https://{tenantDomain}/api/v2/prompts/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.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,
    )
}

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>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/prompts/rendering",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/prompts/rendering")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

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

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de consulta

fields · string

Lista de campos separados por comas para incluir o excluir (según el valor proporcionado para include_fields) en el resultado. Déjelo vacío para recuperar todos los campos.

include_fields · boolean

Indica si los campos especificados deben incluirse (predeterminado: true) o excluirse (false).

page · integer

Índice de página de los resultados que se devolverán. La primera página es 0.

Rango requerido: x >= 0

per_page · integer

Número de resultados por página. El valor máximo es 100 y el valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

include_totals · boolean

Devuelva los resultados dentro de un objeto que contenga el recuento total de configuraciones (true) o como un array directo de resultados (false, valor predeterminado).

prompt · string

Nombre del prompt por el que filtrar

screen · string

Nombre de la pantalla por la que filtrar

rendering_mode · enum<string>

Modo de renderizado por el que filtrar Modo de renderizado por el que se debe filtrar

Opciones disponibles: advanced, standard

Respuesta

200

application/json

La configuración de ACUL se recuperó correctamente.

object[]

object

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

Valores de contexto que estarán disponibles

Valores de contexto estáticos

Opciones 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 · predeterminado: false

Anular las etiquetas predeterminadas de Universal Login

filters · object | null

Filtros opcionales para aplicar reglas de renderizado a entidades específicas

Show child attributes

head_tags · object[] | null

Un array de etiquetas

Show child attributes

prompt · string

Nombre del prompt

rendering_mode · enum<string>

Modo de renderizado

Opciones disponibles: advanced, standard

screen · string

Nombre de la pantalla

tenant · string

ID del inquilino

use_page_template · boolean | null · predeterminado: false

Usar plantilla de página con ACUL