ブランディングテーマを作成

ブランディングテーマを作成します。

POST https://{tenantDomain}/api/v2/branding/themes

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    branding "github.com/auth0/go-auth0/management/management/branding"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &branding.CreateBrandingThemeRequestContent{
        Borders: &management.BrandingThemeBorders{
            ButtonBorderRadius: 1.1,
            ButtonBorderWeight: 1.1,
            ButtonsStyle: management.BrandingThemeBordersButtonsStyleEnumPill,
            InputBorderRadius: 1.1,
            InputBorderWeight: 1.1,
            InputsStyle: management.BrandingThemeBordersInputsStyleEnumPill,
            ShowWidgetShadow: true,
            WidgetBorderWeight: 1.1,
            WidgetCornerRadius: 1.1,
        },
        Colors: &management.BrandingThemeColors{
            BodyText: "body_text",
            Error: "error",
            Header: "header",
            Icons: "icons",
            InputBackground: "input_background",
            InputBorder: "input_border",
            InputFilledText: "input_filled_text",
            InputLabelsPlaceholders: "input_labels_placeholders",
            LinksFocusedComponents: "links_focused_components",
            PrimaryButton: "primary_button",
            PrimaryButtonLabel: "primary_button_label",
            SecondaryButtonBorder: "secondary_button_border",
            SecondaryButtonLabel: "secondary_button_label",
            Success: "success",
            WidgetBackground: "widget_background",
            WidgetBorder: "widget_border",
        },
        Fonts: &management.BrandingThemeFonts{
            BodyText: &management.BrandingThemeFontBodyText{
                Bold: true,
                Size: 1.1,
            },
            ButtonsText: &management.BrandingThemeFontButtonsText{
                Bold: true,
                Size: 1.1,
            },
            FontUrl: "font_url",
            InputLabels: &management.BrandingThemeFontInputLabels{
                Bold: true,
                Size: 1.1,
            },
            Links: &management.BrandingThemeFontLinks{
                Bold: true,
                Size: 1.1,
            },
            LinksStyle: management.BrandingThemeFontLinksStyleEnumNormal,
            ReferenceTextSize: 1.1,
            Subtitle: &management.BrandingThemeFontSubtitle{
                Bold: true,
                Size: 1.1,
            },
            Title: &management.BrandingThemeFontTitle{
                Bold: true,
                Size: 1.1,
            },
        },
        PageBackground: &management.BrandingThemePageBackground{
            BackgroundColor: "background_color",
            BackgroundImageUrl: "background_image_url",
            PageLayout: management.BrandingThemePageBackgroundPageLayoutEnumCenter,
        },
        Widget: &management.BrandingThemeWidget{
            HeaderTextAlignment: management.BrandingThemeWidgetHeaderTextAlignmentEnumCenter,
            LogoHeight: 1.1,
            LogoPosition: management.BrandingThemeWidgetLogoPositionEnumCenter,
            LogoUrl: "logo_url",
            SocialButtonsLayout: management.BrandingThemeWidgetSocialButtonsLayoutEnumBottom,
        },
    }
    client.Branding.Themes.Create(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.branding.themes.create({
        borders: {
            buttonBorderRadius: 1.1,
            buttonBorderWeight: 1.1,
            buttonsStyle: "pill",
            inputBorderRadius: 1.1,
            inputBorderWeight: 1.1,
            inputsStyle: "pill",
            showWidgetShadow: true,
            widgetBorderWeight: 1.1,
            widgetCornerRadius: 1.1,
        },
        colors: {
            bodyText: "body_text",
            error: "error",
            header: "header",
            icons: "icons",
            inputBackground: "input_background",
            inputBorder: "input_border",
            inputFilledText: "input_filled_text",
            inputLabelsPlaceholders: "input_labels_placeholders",
            linksFocusedComponents: "links_focused_components",
            primaryButton: "primary_button",
            primaryButtonLabel: "primary_button_label",
            secondaryButtonBorder: "secondary_button_border",
            secondaryButtonLabel: "secondary_button_label",
            success: "success",
            widgetBackground: "widget_background",
            widgetBorder: "widget_border",
        },
        fonts: {
            bodyText: {
                bold: true,
                size: 1.1,
            },
            buttonsText: {
                bold: true,
                size: 1.1,
            },
            fontUrl: "font_url",
            inputLabels: {
                bold: true,
                size: 1.1,
            },
            links: {
                bold: true,
                size: 1.1,
            },
            linksStyle: "normal",
            referenceTextSize: 1.1,
            subtitle: {
                bold: true,
                size: 1.1,
            },
            title: {
                bold: true,
                size: 1.1,
            },
        },
        pageBackground: {
            backgroundColor: "background_color",
            backgroundImageUrl: "background_image_url",
            pageLayout: "center",
        },
        widget: {
            headerTextAlignment: "center",
            logoHeight: 1.1,
            logoPosition: "center",
            logoUrl: "logo_url",
            socialButtonsLayout: "bottom",
        },
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.branding.themes.create({
        borders: {
            buttonBorderRadius: 1.1,
            buttonBorderWeight: 1.1,
            buttonsStyle: "pill",
            inputBorderRadius: 1.1,
            inputBorderWeight: 1.1,
            inputsStyle: "pill",
            showWidgetShadow: true,
            widgetBorderWeight: 1.1,
            widgetCornerRadius: 1.1,
        },
        colors: {
            bodyText: "body_text",
            error: "error",
            header: "header",
            icons: "icons",
            inputBackground: "input_background",
            inputBorder: "input_border",
            inputFilledText: "input_filled_text",
            inputLabelsPlaceholders: "input_labels_placeholders",
            linksFocusedComponents: "links_focused_components",
            primaryButton: "primary_button",
            primaryButtonLabel: "primary_button_label",
            secondaryButtonBorder: "secondary_button_border",
            secondaryButtonLabel: "secondary_button_label",
            success: "success",
            widgetBackground: "widget_background",
            widgetBorder: "widget_border",
        },
        fonts: {
            bodyText: {
                bold: true,
                size: 1.1,
            },
            buttonsText: {
                bold: true,
                size: 1.1,
            },
            fontUrl: "font_url",
            inputLabels: {
                bold: true,
                size: 1.1,
            },
            links: {
                bold: true,
                size: 1.1,
            },
            linksStyle: "normal",
            referenceTextSize: 1.1,
            subtitle: {
                bold: true,
                size: 1.1,
            },
            title: {
                bold: true,
                size: 1.1,
            },
        },
        pageBackground: {
            backgroundColor: "background_color",
            backgroundImageUrl: "background_image_url",
            pageLayout: "center",
        },
        widget: {
            headerTextAlignment: "center",
            logoHeight: 1.1,
            logoPosition: "center",
            logoUrl: "logo_url",
            socialButtonsLayout: "bottom",
        },
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/branding/themes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "borders": {
    "button_border_radius": 5.5,
    "button_border_weight": 5,
    "input_border_radius": 5,
    "input_border_weight": 1.5,
    "show_widget_shadow": true,
    "widget_border_weight": 5,
    "widget_corner_radius": 25
  },
  "colors": {
    "body_text": "<string>",
    "error": "<string>",
    "header": "<string>",
    "icons": "<string>",
    "input_background": "<string>",
    "input_border": "<string>",
    "input_filled_text": "<string>",
    "input_labels_placeholders": "<string>",
    "links_focused_components": "<string>",
    "primary_button": "<string>",
    "primary_button_label": "<string>",
    "secondary_button_border": "<string>",
    "secondary_button_label": "<string>",
    "success": "<string>",
    "widget_background": "<string>",
    "widget_border": "<string>",
    "base_focus_color": "<string>",
    "base_hover_color": "<string>",
    "read_only_background": "<string>"
  },
  "fonts": {
    "body_text": {
      "bold": true,
      "size": 75
    },
    "buttons_text": {
      "bold": true,
      "size": 75
    },
    "font_url": "<string>",
    "input_labels": {
      "bold": true,
      "size": 75
    },
    "links": {
      "bold": true,
      "size": 75
    },
    "reference_text_size": 18,
    "subtitle": {
      "bold": true,
      "size": 75
    },
    "title": {
      "bold": true,
      "size": 112.5
    }
  },
  "page_background": {
    "background_color": "<string>",
    "background_image_url": "<string>"
  },
  "widget": {
    "logo_height": 50.5,
    "logo_url": "<string>"
  },
  "displayName": "<string>"
}
'

import requests

url = "https://{tenantDomain}/api/v2/branding/themes"

payload = {
    "borders": {
        "button_border_radius": 5.5,
        "button_border_weight": 5,
        "input_border_radius": 5,
        "input_border_weight": 1.5,
        "show_widget_shadow": True,
        "widget_border_weight": 5,
        "widget_corner_radius": 25
    },
    "colors": {
        "body_text": "<string>",
        "error": "<string>",
        "header": "<string>",
        "icons": "<string>",
        "input_background": "<string>",
        "input_border": "<string>",
        "input_filled_text": "<string>",
        "input_labels_placeholders": "<string>",
        "links_focused_components": "<string>",
        "primary_button": "<string>",
        "primary_button_label": "<string>",
        "secondary_button_border": "<string>",
        "secondary_button_label": "<string>",
        "success": "<string>",
        "widget_background": "<string>",
        "widget_border": "<string>",
        "base_focus_color": "<string>",
        "base_hover_color": "<string>",
        "read_only_background": "<string>"
    },
    "fonts": {
        "body_text": {
            "bold": True,
            "size": 75
        },
        "buttons_text": {
            "bold": True,
            "size": 75
        },
        "font_url": "<string>",
        "input_labels": {
            "bold": True,
            "size": 75
        },
        "links": {
            "bold": True,
            "size": 75
        },
        "reference_text_size": 18,
        "subtitle": {
            "bold": True,
            "size": 75
        },
        "title": {
            "bold": True,
            "size": 112.5
        }
    },
    "page_background": {
        "background_color": "<string>",
        "background_image_url": "<string>"
    },
    "widget": {
        "logo_height": 50.5,
        "logo_url": "<string>"
    },
    "displayName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/branding/themes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'borders' => [
        'button_border_radius' => 5.5,
        'button_border_weight' => 5,
        'input_border_radius' => 5,
        'input_border_weight' => 1.5,
        'show_widget_shadow' => true,
        'widget_border_weight' => 5,
        'widget_corner_radius' => 25
    ],
    'colors' => [
        'body_text' => '<string>',
        'error' => '<string>',
        'header' => '<string>',
        'icons' => '<string>',
        'input_background' => '<string>',
        'input_border' => '<string>',
        'input_filled_text' => '<string>',
        'input_labels_placeholders' => '<string>',
        'links_focused_components' => '<string>',
        'primary_button' => '<string>',
        'primary_button_label' => '<string>',
        'secondary_button_border' => '<string>',
        'secondary_button_label' => '<string>',
        'success' => '<string>',
        'widget_background' => '<string>',
        'widget_border' => '<string>',
        'base_focus_color' => '<string>',
        'base_hover_color' => '<string>',
        'read_only_background' => '<string>'
    ],
    'fonts' => [
        'body_text' => [
                'bold' => true,
                'size' => 75
        ],
        'buttons_text' => [
                'bold' => true,
                'size' => 75
        ],
        'font_url' => '<string>',
        'input_labels' => [
                'bold' => true,
                'size' => 75
        ],
        'links' => [
                'bold' => true,
                'size' => 75
        ],
        'reference_text_size' => 18,
        'subtitle' => [
                'bold' => true,
                'size' => 75
        ],
        'title' => [
                'bold' => true,
                'size' => 112.5
        ]
    ],
    'page_background' => [
        'background_color' => '<string>',
        'background_image_url' => '<string>'
    ],
    'widget' => [
        'logo_height' => 50.5,
        'logo_url' => '<string>'
    ],
    'displayName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/branding/themes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"borders\": {\n    \"button_border_radius\": 5.5,\n    \"button_border_weight\": 5,\n    \"input_border_radius\": 5,\n    \"input_border_weight\": 1.5,\n    \"show_widget_shadow\": true,\n    \"widget_border_weight\": 5,\n    \"widget_corner_radius\": 25\n  },\n  \"colors\": {\n    \"body_text\": \"<string>\",\n    \"error\": \"<string>\",\n    \"header\": \"<string>\",\n    \"icons\": \"<string>\",\n    \"input_background\": \"<string>\",\n    \"input_border\": \"<string>\",\n    \"input_filled_text\": \"<string>\",\n    \"input_labels_placeholders\": \"<string>\",\n    \"links_focused_components\": \"<string>\",\n    \"primary_button\": \"<string>\",\n    \"primary_button_label\": \"<string>\",\n    \"secondary_button_border\": \"<string>\",\n    \"secondary_button_label\": \"<string>\",\n    \"success\": \"<string>\",\n    \"widget_background\": \"<string>\",\n    \"widget_border\": \"<string>\",\n    \"base_focus_color\": \"<string>\",\n    \"base_hover_color\": \"<string>\",\n    \"read_only_background\": \"<string>\"\n  },\n  \"fonts\": {\n    \"body_text\": {\n      \"bold\": true,\n      \"size\": 75\n    },\n    \"buttons_text\": {\n      \"bold\": true,\n      \"size\": 75\n    },\n    \"font_url\": \"<string>\",\n    \"input_labels\": {\n      \"bold\": true,\n      \"size\": 75\n    },\n    \"links\": {\n      \"bold\": true,\n      \"size\": 75\n    },\n    \"reference_text_size\": 18,\n    \"subtitle\": {\n      \"bold\": true,\n      \"size\": 75\n    },\n    \"title\": {\n      \"bold\": true,\n      \"size\": 112.5\n    }\n  },\n  \"page_background\": {\n    \"background_color\": \"<string>\",\n    \"background_image_url\": \"<string>\"\n  },\n  \"widget\": {\n    \"logo_height\": 50.5,\n    \"logo_url\": \"<string>\"\n  },\n  \"displayName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/branding/themes")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"borders\": {\n    \"button_border_radius\": 5.5,\n    \"button_border_weight\": 5,\n    \"input_border_radius\": 5,\n    \"input_border_weight\": 1.5,\n    \"show_widget_shadow\": true,\n    \"widget_border_weight\": 5,\n    \"widget_corner_radius\": 25\n  },\n  \"colors\": {\n    \"body_text\": \"<string>\",\n    \"error\": \"<string>\",\n    \"header\": \"<string>\",\n    \"icons\": \"<string>\",\n    \"input_background\": \"<string>\",\n    \"input_border\": \"<string>\",\n    \"input_filled_text\": \"<string>\",\n    \"input_labels_placeholders\": \"<string>\",\n    \"links_focused_components\": \"<string>\",\n    \"primary_button\": \"<string>\",\n    \"primary_button_label\": \"<string>\",\n    \"secondary_button_border\": \"<string>\",\n    \"secondary_button_label\": \"<string>\",\n    \"success\": \"<string>\",\n    \"widget_background\": \"<string>\",\n    \"widget_border\": \"<string>\",\n    \"base_focus_color\": \"<string>\",\n    \"base_hover_color\": \"<string>\",\n    \"read_only_background\": \"<string>\"\n  },\n  \"fonts\": {\n    \"body_text\": {\n      \"bold\": true,\n      \"size\": 75\n    },\n    \"buttons_text\": {\n      \"bold\": true,\n      \"size\": 75\n    },\n    \"font_url\": \"<string>\",\n    \"input_labels\": {\n      \"bold\": true,\n      \"size\": 75\n    },\n    \"links\": {\n      \"bold\": true,\n      \"size\": 75\n    },\n    \"reference_text_size\": 18,\n    \"subtitle\": {\n      \"bold\": true,\n      \"size\": 75\n    },\n    \"title\": {\n      \"bold\": true,\n      \"size\": 112.5\n    }\n  },\n  \"page_background\": {\n    \"background_color\": \"<string>\",\n    \"background_image_url\": \"<string>\"\n  },\n  \"widget\": {\n    \"logo_height\": 50.5,\n    \"logo_url\": \"<string>\"\n  },\n  \"displayName\": \"<string>\"\n}"

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

200

{
  "borders": {
    "button_border_radius": 5.5,
    "button_border_weight": 5,
    "input_border_radius": 5,
    "input_border_weight": 1.5,
    "show_widget_shadow": true,
    "widget_border_weight": 5,
    "widget_corner_radius": 25
  },
  "colors": {
    "body_text": "<string>",
    "error": "<string>",
    "header": "<string>",
    "icons": "<string>",
    "input_background": "<string>",
    "input_border": "<string>",
    "input_filled_text": "<string>",
    "input_labels_placeholders": "<string>",
    "links_focused_components": "<string>",
    "primary_button": "<string>",
    "primary_button_label": "<string>",
    "secondary_button_border": "<string>",
    "secondary_button_label": "<string>",
    "success": "<string>",
    "widget_background": "<string>",
    "widget_border": "<string>",
    "base_focus_color": "<string>",
    "base_hover_color": "<string>",
    "read_only_background": "<string>"
  },
  "displayName": "<string>",
  "fonts": {
    "body_text": {
      "bold": true,
      "size": 75
    },
    "buttons_text": {
      "bold": true,
      "size": 75
    },
    "font_url": "<string>",
    "input_labels": {
      "bold": true,
      "size": 75
    },
    "links": {
      "bold": true,
      "size": 75
    },
    "reference_text_size": 18,
    "subtitle": {
      "bold": true,
      "size": 75
    },
    "title": {
      "bold": true,
      "size": 112.5
    }
  },
  "page_background": {
    "background_color": "<string>",
    "background_image_url": "<string>"
  },
  "themeId": "<string>",
  "widget": {
    "logo_height": 50.5,
    "logo_url": "<string>"
  }
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

ブランディングテーマ

borders · object · 必須

Show child attributes

colors · object · 必須

Show child attributes

fonts · object · 必須

Show child attributes

page_background · object · 必須

Show child attributes

widget · object · 必須

Show child attributes

displayName · string

表示名

Maximum string length: 2048

Pattern: ^[^<>]*$

レスポンス

200

application/json

ブランディング設定は正常に更新されました。

borders · object · 必須

Show child attributes

colors · object · 必須

Show child attributes

displayName · string · 必須

表示名

Maximum string length: 2048

Pattern: ^[^<>]*$

fonts · object · 必須

Show child attributes

page_background · object · 必須

Show child attributes

themeId · string · 必須

テーマ ID

Maximum string length: 32

Pattern: ^[a-zA-Z0-9]{32}$

widget · object · 必須

Show child attributes