Get render setting configurations for all screens

Get render setting configurations for all screens.

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,
    )
}

200

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

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

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

Optional filters to apply rendering rules to specific entities

Show child attributes