Auth0 API | Branding › Themes › Update Branding Theme

Branding

branding

Methods

Get Branding Settings ->

BrandingSettings

get/branding

Retrieve branding settings.

Update Branding Settings -> { colors, favicon_url, font, 1 more... }

patch/branding

Update branding settings.

Domain types

BrandingSettings = { colors, favicon_url, font, 1 more... }

Branding

Templates

branding.templates

Branding Templates

Universal Login

branding.templates.universal_login

Methods

Delete Template For New Universal Login Experience ->

delete/branding/templates/universal-login

Delete template for New Universal Login Experience

Get Template For New Universal Login Experience -> { body } | string

get/branding/templates/universal-login

Get template for New Universal Login Experience

Set Template For New Universal Login Experience ->

put/branding/templates/universal-login

Update the Universal Login branding template.

When content-type header is set to application/json, the expected body must be JSON:

{
  "template": "<!DOCTYPE html><html><head>{%- auth0:head -%}</head><body>{%- auth0:widget -%}</body></html>"
}

When content-type header is set to text/html, the expected body must be the HTML template:

<!DOCTYPE html>
<code>
  <html>
    <head>
     {%- auth0:head -%}
    </head>
    <body>
      {%- auth0:widget -%}
    </body>
  </html>
</code>

Branding

Themes

branding.themes

Methods

Create Branding Theme -> { borders, colors, displayName, 4 more... }

post/branding/themes

Create branding theme.

Get Default Branding Theme -> { borders, colors, displayName, 4 more... }

get/branding/themes/default

Retrieve default branding theme.

Delete Branding Theme ->

delete/branding/themes/{themeId}

Delete branding theme.

Get Branding Theme ->

BrandingTheme

get/branding/themes/{themeId}

Retrieve branding theme.

Update Branding Theme -> { borders, colors, displayName, 4 more... }

patch/branding/themes/{themeId}

Update branding theme.

Security

Example: Authorization: Bearer My Bearer Token

Parameters

themeId: string

Response fields

borders: { button_border_radius, button_border_weight, buttons_style, 6 more... }

colors: { body_text, error, header, 16 more... }

displayName: string

(maxLength: 2048)

Display Name

fonts: { body_text, buttons_text, font_url, 6 more... }

page_background: { background_color, background_image_url, page_layout }

themeId: string

(maxLength: 32)

Theme Id

widget: { header_text_alignment, logo_height, logo_position, 2 more... }

Request example

curl https://login0.local.dev.auth0.com/api/v2/branding/themes/$THEME_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BEARER_TOKEN" \
    -d '{
      "borders": {
        "button_border_radius": 0,
        "button_border_weight": 0,
        "buttons_style": "pill",
        "input_border_radius": 0,
        "input_border_weight": 0,
        "inputs_style": "pill",
        "show_widget_shadow": true,
        "widget_border_weight": 0,
        "widget_corner_radius": 0
      },
      "colors": {
        "body_text": "body_text",
        "error": "error",
        "header": "header",
        "icons": "icons",
        "input_background": "input_background",
        "input_border": "input_border",
        "input_filled_text": "input_filled_text",
        "input_labels_placeholders": "input_labels_placeholders",
        "links_focused_components": "links_focused_components",
        "primary_button": "primary_button",
        "primary_button_label": "primary_button_label",
        "secondary_button_border": "secondary_button_border",
        "secondary_button_label": "secondary_button_label",
        "success": "success",
        "widget_background": "widget_background",
        "widget_border": "widget_border"
      },
      "fonts": {
        "body_text": {
          "bold": true,
          "size": 0
        },
        "buttons_text": {
          "bold": true,
          "size": 0
        },
        "font_url": "font_url",
        "input_labels": {
          "bold": true,
          "size": 0
        },
        "links": {
          "bold": true,
          "size": 0
        },
        "links_style": "normal",
        "reference_text_size": 0,
        "subtitle": {
          "bold": true,
          "size": 0
        },
        "title": {
          "bold": true,
          "size": 0
        }
      },
      "page_background": {
        "background_color": "background_color",
        "background_image_url": "background_image_url",
        "page_layout": "center"
      },
      "widget": {
        "header_text_alignment": "center",
        "logo_height": 0,
        "logo_position": "center",
        "logo_url": "logo_url",
        "social_buttons_layout": "bottom"
      }
    }'

200Example

{
  "borders": {
    "button_border_radius": 0,
    "button_border_weight": 0,
    "buttons_style": "pill",
    "input_border_radius": 0,
    "input_border_weight": 0,
    "inputs_style": "pill",
    "show_widget_shadow": true,
    "widget_border_weight": 0,
    "widget_corner_radius": 0
  },
  "colors": {
    "body_text": "body_text",
    "error": "error",
    "header": "header",
    "icons": "icons",
    "input_background": "input_background",
    "input_border": "input_border",
    "input_filled_text": "input_filled_text",
    "input_labels_placeholders": "input_labels_placeholders",
    "links_focused_components": "links_focused_components",
    "primary_button": "primary_button",
    "primary_button_label": "primary_button_label",
    "secondary_button_border": "secondary_button_border",
    "secondary_button_label": "secondary_button_label",
    "success": "success",
    "widget_background": "widget_background",
    "widget_border": "widget_border",
    "base_focus_color": "base_focus_color",
    "base_hover_color": "base_hover_color",
    "captcha_widget_theme": "auto"
  },
  "displayName": "displayName",
  "fonts": {
    "body_text": {
      "bold": true,
      "size": 0
    },
    "buttons_text": {
      "bold": true,
      "size": 0
    },
    "font_url": "font_url",
    "input_labels": {
      "bold": true,
      "size": 0
    },
    "links": {
      "bold": true,
      "size": 0
    },
    "links_style": "normal",
    "reference_text_size": 0,
    "subtitle": {
      "bold": true,
      "size": 0
    },
    "title": {
      "bold": true,
      "size": 0
    }
  },
  "page_background": {
    "background_color": "background_color",
    "background_image_url": "background_image_url",
    "page_layout": "center"
  },
  "themeId": "themeId",
  "widget": {
    "header_text_alignment": "center",
    "logo_height": 0,
    "logo_position": "center",
    "logo_url": "logo_url",
    "social_buttons_layout": "bottom"
  }
}

Domain types

BrandingTheme = { borders, colors, displayName, 4 more... }