すべてのレンダリングを取得

すべての画面のレンダリング設定を取得します。

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
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

クエリパラメータ

fields · string

結果に含める、または結果から除外するフィールドのカンマ区切りリストです（include_fields に指定した値に基づきます）。すべてのフィールドを取得するには空のままにします。

include_fields · boolean

指定したフィールドを含めるか（デフォルト: true）、除外するか（false）を指定します。

page · integer

返される結果のページインデックスです。最初のページは 0 です。

必須範囲: x >= 0

per_page · integer

1 ページあたりの結果数です。最大値は 100、デフォルト値は 50 です。

必須範囲: 1 <= x <= 100

include_totals · boolean

結果を、設定の合計数を含むオブジェクトとして返すか（true）、結果の配列を直接返すか（false、デフォルト）を指定します。

prompt · string

絞り込み対象のプロンプト名

screen · string

絞り込み対象の画面名

rendering_mode · enum<string>

絞り込み対象のレンダリングモード フィルター対象のレンダリングモード

利用可能なオプション: advanced, standard

レスポンス

200

application/json

ACUL 設定を正常に取得しました。

object[]

object

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

使用可能にするコンテキスト値

静的なコンテキスト値

利用可能なオプション: 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 · デフォルト: false

Universal Login のデフォルトの head タグを上書きする

filters · object | null

レンダリングルールを特定のエンティティに適用するためのオプションのフィルター

Show child attributes

head_tags · object[] | null

head タグの配列

Show child attributes

prompt · string

プロンプトの名前

rendering_mode · enum<string>

レンダリングモード

利用可能なオプション: advanced, standard

screen · string

画面の名前

tenant · string

Tenant ID

use_page_template · boolean | null · デフォルト: false

ACUL でページテンプレートを使用する