Auth0 branding API is one of 76 APIs that Auth0 publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Branding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.
This API exposes
23 operations
across 12 paths,
and defines 82 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against a single base URL, https://{tenantDomain}/api/v2.
The identity and technical contract details declared by the specification.
GetBrandingDefaultThemeResponseContent
object
7 properties
7 required
GetBrandingPhoneProviderResponseContent
object
Phone provider configuration schema
8 properties
2 required
BrandingThemePageBackground
object
3 properties
3 required
BrandingThemeWidgetLogoPositionEnum
string
Logo position
CustomProviderConfiguration
object
1 property
1 required
BrandingThemeColors
object
20 properties
16 required
PhoneTemplateContent
object
3 properties
BrandingThemeColorsCaptchaWidgetThemeEnum
string
Captcha Widget Theme
UpdatePhoneTemplateRequestContent
object
2 properties
BrandingThemeFontLinks
object
Links
2 properties
2 required
BrandingPhoneDisplay
object
Phone number display settings.
2 properties
BrandingThemeWidget
object
5 properties
5 required
UpdateBrandingColors
objectnull
Custom color settings.
2 properties
CustomProviderCredentials
object
UpdatePhoneTemplateResponseContent
object
7 properties
4 required
UpdateBrandingPageBackground
Page Background Color or Gradient. Property contains either null to unset, a solid color as a string value FFFFFF , or a gradient as an object. { type: 'linear…
PhoneProviderDeliveryMethodEnum
string
The delivery method for the notification
CreatePhoneTemplateTestNotificationResponseContent
object
1 property
1 required
UpdateBrandingPhoneProviderRequestContent
object
4 properties
UpdateBrandingRequestContent
object
Branding settings
5 properties
PhoneProviderChannelEnum
string
This depicts the type of notifications this provider can receive.
TwilioProviderDeliveryMethodEnum
string
BrandingIdentifiers
object
Identifier input display settings.
3 properties
BrandingThemeBordersButtonsStyleEnum
string
Buttons style
BrandingThemeFontInputLabels
object
Input Labels
2 properties
2 required
CreateBrandingPhoneProviderRequestContent
object
Phone provider configuration schema
4 properties
2 required
CreatePhoneProviderSendTestResponseContent
object
2 properties
CreatePhoneProviderSendTestRequestContent
object
2 properties
1 required
BrandingThemeWidgetHeaderTextAlignmentEnum
string
Header text alignment
UpdateBrandingFont
objectnull
Custom font settings.
1 property
CreatePhoneTemplateTestNotificationRequestContent
object
2 properties
1 required
UpdateBrandingIdentifiers
objectnull
Identifier input display settings.
3 properties
CreateBrandingThemeResponseContent
object
7 properties
7 required
BrandingFont
object
Custom font settings.
1 property
PhoneProviderNameEnum
string
Name of the phone notification provider
ListPhoneTemplatesResponseContent
object
1 property
GetBrandingThemeResponseContent
object
7 properties
7 required
GetBrandingResponseContent
object
5 properties
BrandingPhoneFormattingEnum
string
Controls the format used when displaying phone numbers.
GetUniversalLoginTemplateResponseContent
object
BrandingPageBackground
Page Background Color or Gradient. Property contains either null to unset, a solid color as a string value FFFFFF , or a gradient as an object. { type: 'linear…
ResetPhoneTemplateRequestContent
UpdateBrandingPhoneProviderResponseContent
object
Phone provider configuration schema
8 properties
2 required
BrandingThemePageBackgroundPageLayoutEnum
string
Page Layout
BrandingThemeFontSubtitle
object
Subtitle
2 properties
2 required
ListBrandingPhoneProvidersResponseContent
object
1 property
CreateBrandingPhoneProviderResponseContent
object
Phone provider configuration schema
8 properties
2 required
CreatePhoneTemplateResponseContent
object
7 properties
4 required
BrandingThemeFontTitle
object
Title
2 properties
2 required
BrandingThemeFonts
object
9 properties
9 required
UpdateBrandingPhoneDisplay
objectnull
Phone number display settings.
2 properties
2 required
PhoneTemplateBody
object
2 properties
UpdateBrandingPhoneFormattingEnum
string
Controls the format used when displaying phone numbers.
BrandingPhoneMaskingEnum
string
Controls how phone numbers are masked when displayed back to users.
BrandingThemeBordersInputsStyleEnum
string
Inputs style
PhoneProviderCredentials
Provider credentials required to use authenticate to the provider.
BrandingThemeFontBodyText
object
Body text
2 properties
2 required
UpdateBrandingThemeResponseContent
object
7 properties
7 required
BrandingThemeFontLinksStyleEnum
string
Links style
PartialPhoneTemplateContent
object
2 properties
PhoneTemplate
object
7 properties
4 required
UpdateBrandingLoginDisplayEnum
string
Controls identifier input presentation on the login flow. Defaults to "unified" for legacy tenants, "separate" for tenants created post-GA of this feature.
BrandingThemeWidgetSocialButtonsLayoutEnum
string
Social buttons layout
BrandingThemeFontButtonsText
object
Buttons text
2 properties
2 required
UpdateBrandingThemeRequestContent
object
Branding theme
6 properties
5 required
UpdateUniversalLoginTemplateRequestContent
TwilioProviderCredentials
object
1 property
1 required
UpdateBrandingResponseContent
object
5 properties
ResetPhoneTemplateResponseContent
object
7 properties
4 required
PhoneProviderConfiguration
object
BrandingThemeBorders
object
9 properties
9 required
TwilioProviderConfiguration
object
4 properties
2 required
CustomProviderDeliveryMethodEnum
string
CreatePhoneTemplateRequestContent
object
3 properties
BrandingColors
object
Custom color settings.
2 properties
GetPhoneTemplateResponseContent
object
7 properties
4 required
PhoneTemplateNotificationTypeEnum
string
PhoneProviderSchemaMasked
object
Phone provider configuration schema
8 properties
2 required
GetUniversalLoginTemplate
object
1 property
BrandingLoginDisplayEnum
string
Controls identifier input presentation on the login flow. Defaults to "unified" for legacy tenants, "separate" for tenants created post-GA of this feature.
CreateBrandingThemeRequestContent
object
Branding theme
6 properties
5 required
UpdateBrandingPhoneMaskingEnum
string
Controls how phone numbers are masked when displayed back to users.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Auth0 publishes across the network.
