Auth0 branding API

openapi: 3.2.0
info:
  title: Auth0 Management Branding API
  description: Auth0 Management API v2.
  termsOfService: https://auth0.com/web-terms/
  contact:
    name: Auth0 Support
    url: https://support.auth0.com
  version: '2.0'
servers:
- url: https://{tenantDomain}/api/v2
  variables:
    tenantDomain:
      default: '{TENANT}.auth0.com'
      description: Auth0 Tenant Domain
security:
- bearerAuth: []
tags:
- name: branding
paths:
  /branding:
    get:
      summary: Get Branding Settings
      description: Retrieve branding settings.
      tags:
      - branding
      responses:
        '200':
          description: Branding settings successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBrandingResponseContent'
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
        '403':
          description: The specified client cannot perform the requested operation.
          x-description-1: 'Insufficient scope; expected any of: read:branding.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_branding
      x-release-lifecycle: GA
      x-operation-name: get
      x-operation-group: branding
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:branding
    patch:
      summary: Update Branding Settings
      description: Update branding settings.
      tags:
      - branding
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBrandingRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateBrandingRequestContent'
      responses:
        '200':
          description: Branding settings successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBrandingResponseContent'
        '400':
          description: Invalid request body. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
        '403':
          description: 'Insufficient scope; expected any of: update:branding.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: patch_branding
      x-release-lifecycle: GA
      x-operation-name: update
      x-operation-group: branding
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:branding
  /branding/phone/providers:
    get:
      summary: Get a List of Phone Providers
      description: 'Retrieve a list of <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone providers</a> details set for a Tenant. A list of fields to include or exclude may also be specified.

        '
      tags:
      - branding
      parameters:
      - name: disabled
        in: query
        description: Whether the provider is enabled (false) or disabled (true).
        schema:
          type: boolean
      responses:
        '200':
          description: Phone providers have been successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBrandingPhoneProvidersResponseContent'
        '400':
          description: Invalid request query string. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
        '403':
          description: 'Insufficient scope; expected any of: read:phone_provider.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_branding_phone_providers
      x-release-lifecycle: GA
      x-operation-name: list
      x-operation-request-parameters-name: ListBrandingPhoneProvidersRequestParameters
      x-operation-group:
      - branding
      - phone
      - providers
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:phone_providers
    post:
      summary: Configure the Phone Provider
      description: 'Create a <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</a>.

        The <code>credentials</code> object requires different properties depending on the phone provider (which is specified using the <code>name</code> property).

        '
      tags:
      - branding
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBrandingPhoneProviderRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateBrandingPhoneProviderRequestContent'
      responses:
        '201':
          description: Phone notification provider successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBrandingPhoneProviderResponseContent'
        '400':
          description: Invalid request body. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
        '403':
          description: 'Insufficient scope; expected any of: create:phone_provider.'
        '409':
          description: Custom phone provider conflict.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: create_phone_provider
      x-release-lifecycle: GA
      x-operation-name: create
      x-operation-group:
      - branding
      - phone
      - providers
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - create:phone_providers
  /branding/phone/providers/{id}:
    get:
      summary: Get a Phone Provider
      description: 'Retrieve <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</a> details. A list of fields to include or exclude may also be specified.

        '
      tags:
      - branding
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      responses:
        '200':
          description: Phone provider successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBrandingPhoneProviderResponseContent'
        '400':
          description: Invalid id for provider.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
        '403':
          description: 'Insufficient scope; expected any of: read:phone_provider.'
        '404':
          description: Phone provider has not been configured.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_phone_provider
      x-release-lifecycle: GA
      x-operation-name: get
      x-operation-group:
      - branding
      - phone
      - providers
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:phone_providers
    delete:
      summary: Deletes a Phone Provider
      description: 'Delete the configured phone provider.

        '
      tags:
      - branding
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      responses:
        '204':
          description: Phone provider successfully deleted.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
        '403':
          description: 'Insufficient scope; expected any of: delete:phone_provider.'
        '404':
          description: Phone provider has not been configured.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: delete_phone_provider
      x-release-lifecycle: GA
      x-operation-name: delete
      x-operation-group:
      - branding
      - phone
      - providers
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:phone_providers
    patch:
      summary: Update the Phone Provider
      description: 'Update a <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</a>.

        The <code>credentials</code> object requires different properties depending on the phone provider (which is specified using the <code>name</code> property).

        '
      tags:
      - branding
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBrandingPhoneProviderRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateBrandingPhoneProviderRequestContent'
      responses:
        '200':
          description: Phone provider successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBrandingPhoneProviderResponseContent'
        '400':
          description: Invalid request body. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
        '403':
          description: 'Insufficient scope; expected any of: update:phone_provider.'
        '404':
          description: Phone provider has not been configured.
        '409':
          description: Custom phone provider conflict.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: update_phone_provider
      x-release-lifecycle: GA
      x-operation-name: update
      x-operation-group:
      - branding
      - phone
      - providers
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:phone_providers
  /branding/phone/providers/{id}/try:
    post:
      summary: Send a Test Phone Notification for the Configured Provider
      tags:
      - branding
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePhoneProviderSendTestRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreatePhoneProviderSendTestRequestContent'
      responses:
        '202':
          description: Phone notification sent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePhoneProviderSendTestResponseContent'
        '400':
          description: Invalid request URI. The message will vary depending on the cause.
          x-description-1: Invalid request body. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
        '403':
          description: 'Insufficient scope, expected: create:phone_provider.'
        '404':
          description: Phone provider has not been configured.
        '409':
          description: Custom phone provider conflict.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: try_phone_provider
      x-release-lifecycle: GA
      x-operation-name: test
      x-operation-group:
      - branding
      - phone
      - providers
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - create:phone_providers
  /branding/phone/templates:
    get:
      summary: Get a List of Phone Notification Templates
      tags:
      - branding
      parameters:
      - name: disabled
        in: query
        description: Whether the template is enabled (false) or disabled (true).
        schema:
          type: boolean
      responses:
        '200':
          description: The phone notification templates were retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPhoneTemplatesResponseContent'
        '400':
          description: Invalid request URI. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation
        '403':
          description: 'Insufficient scope, expected any of: read:phone_templates'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_phone_templates
      x-release-lifecycle: GA
      x-operation-name: list
      x-operation-request-parameters-name: ListPhoneTemplatesRequestParameters
      x-operation-group:
      - branding
      - phone
      - templates
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:phone_templates
    post:
      summary: Create a Phone Notification Template
      tags:
      - branding
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePhoneTemplateRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreatePhoneTemplateRequestContent'
      responses:
        '201':
          description: The phone notification template was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePhoneTemplateResponseContent'
        '400':
          description: Invalid request body. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation
        '403':
          description: 'Insufficient scope, expected any of: create:phone_templates'
        '409':
          description: Phone template already configured for tenant
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: create_phone_template
      x-release-lifecycle: GA
      x-operation-name: create
      x-operation-group:
      - branding
      - phone
      - templates
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - create:phone_templates
  /branding/phone/templates/{id}:
    get:
      summary: Get a Phone Notification Template
      tags:
      - branding
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      responses:
        '200':
          description: The phone notification template were retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPhoneTemplateResponseContent'
        '400':
          description: Invalid request URI. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation
        '403':
          description: 'Insufficient scope, expected any of: read:phone_templates'
        '404':
          description: Phone template does not exist
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_phone_template
      x-release-lifecycle: GA
      x-operation-name: get
      x-operation-group:
      - branding
      - phone
      - templates
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:phone_templates
    delete:
      summary: Delete a Phone Notification Template
      tags:
      - branding
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      responses:
        '204':
          description: The phone notification template was deleted.
        '400':
          description: Invalid request URI. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation
        '403':
          description: 'Insufficient scope, expected any of: delete:phone_templates'
        '404':
          description: Phone template does not exist
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: delete_phone_template
      x-release-lifecycle: GA
      x-operation-name: delete
      x-operation-group:
      - branding
      - phone
      - templates
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:phone_templates
    patch:
      summary: Update a Phone Notification Template
      tags:
      - branding
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePhoneTemplateRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdatePhoneTemplateRequestContent'
      responses:
        '200':
          description: The phone notification template was updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePhoneTemplateResponseContent'
        '400':
          description: Invalid request body. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation
        '403':
          description: 'Insufficient scope, expected any of: update:phone_templates'
        '404':
          description: Phone template does not exist
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: update_phone_template
      x-release-lifecycle: GA
      x-operation-name: update
      x-operation-group:
      - branding
      - phone
      - templates
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:phone_templates
  /branding/phone/templates/{id}/reset:
    patch:
      summary: Resets a Phone Notification Template Values
      tags:
      - branding
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetPhoneTemplateRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ResetPhoneTemplateRequestContent'
      responses:
        '200':
          description: The phone notification template was reset.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetPhoneTemplateResponseContent'
        '400':
          description: Invalid request body. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation
        '403':
          description: 'Insufficient scope, expected any of: create:phone_templates'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: reset_phone_template
      x-release-lifecycle: GA
      x-operation-name: reset
      x-operation-group:
      - branding
      - phone
      - templates
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:phone_templates
  /branding/phone/templates/{id}/try:
    post:
      summary: Send a Test Phone Notification for the Configured Template
      tags:
      - branding
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePhoneTemplateTestNotificationRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreatePhoneTemplateTestNotificationRequestContent'
      responses:
        '202':
          description: The phone testing notification for the template was sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePhoneTemplateTestNotificationResponseContent'
        '400':
          description: Invalid request body. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation
        '403':
          description: 'Insufficient scope, expected any of: create:phone_templates'
        '404':
          description: Phone template does not exist
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: try_phone_template
      x-release-lifecycle: GA
      x-operation-name: test
      x-operation-group:
      - branding
      - phone
      - templates
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - create:phone_templates
  /branding/templates/universal-login:
    get:
      summary: Get Template for New Universal Login Experience
      tags:
      - branding
      responses:
        '200':
          description: Template successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUniversalLoginTemplateResponseContent'
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
        '402':
          description: A paid subscription is required for this feature.
        '403':
          description: 'Insufficient scope; expected: read:branding'
        '404':
          description: Template does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_universal-login
      x-release-lifecycle: GA
      x-operation-name: getUniversalLogin
      x-operation-group:
      - branding
      - templates
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:branding
    delete:
      summary: Delete Template for New Universal Login Experience
      tags:
      - branding
      responses:
        '204':
          description: Template successfully deleted.
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
        '402':
          description: A paid subscription is required for this feature.
        '403':
          description: 'Insufficient scope; expected: delete:branding.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: delete_universal-login
      x-release-lifecycle: GA
      x-operation-name: deleteUniversalLogin
      x-operation-group:
      - branding
      - templates
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:branding
    put:
      summary: Set Template for New Universal Login Experience
      description: "Update the Universal Login branding template.\n\n<p>When <code>content-type</code> header is set to <code>application/json</code>:</p>\n<pre>\n{\n  \"template\": \"&lt;!DOCTYPE html&gt;{% assign resolved_dir = dir | default: \"auto\" %}&lt;html lang=\"{{locale}}\" dir=\"{{resolved_dir}}\"&gt;&lt;head&gt;{%- auth0:head -%}&lt;/head&gt;&lt;body class=\"_widget-auto-layout\"&gt;{%- auth0:widget -%}&lt;/body&gt;&lt;/html&gt;\"\n}\n</pre>\n\n<p>\n  When <code>content-type</code> header is set to <code>text/html</code>:\n</p>\n<pre>\n&lt!DOCTYPE html&gt;\n{% assign resolved_dir = dir | default: \"auto\" %}\n&lt;html lang=\"{{locale}}\" dir=\"{{resolved_dir}}\"&gt;\n  &lt;head&gt;\n    {%- auth0:head -%}\n  &lt;/head&gt;\n  &lt;body class=\"_widget-auto-layout\"&gt;\n    {%- auth0:widget -%}\n  &lt;/body&gt;\n&lt;/html&gt;\n</pre>\n"
      tags:
      - branding
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUniversalLoginTemplateRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateUniversalLoginTemplateRequestContent'
      responses:
        '201':
          description: Template successfully created.
        '204':
          description: Template successfully updated.
        '400':
          description: 'Payload content length greater than maximum allowed: 102400.'
          x-description-1: Payload content missing required Liquid tags (auth0:head and auth0:widget).
          x-description-2: 'Liquid template syntax error: <error details>.'
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
        '402':
          description: A paid subscription is required for this feature.
        '403':
          description: 'Insufficient scope; expected: update:branding.'
        '409':
          description: Template update conflict.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: put_universal-login
      x-release-lifecycle: GA
      x-operation-name: updateUniversalLogin
      x-operation-group:
      - branding
      - templates
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:branding
  /branding/themes:
    post:
      summary: Create Branding Theme
      description: Create branding theme.
      tags:
      - branding
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBrandingThemeRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateBrandingThemeRequestContent'
      responses:
        '200':
          description: Branding settings successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBrandingThemeResponseContent'
        '400':
          description: Invalid request body. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
        '403':
          description: 'Insufficient scope; expected any of: update:branding.'
        '409':
          description: 'There was an error updating branding settings: The theme already exists'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: post_branding_theme
      x-release-lifecycle: GA
      x-operation-name: create
      x-operation-group:
      - branding
      - themes
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:branding
  /branding/themes/default:
    get:
      summary: Get Default Branding Theme
      description: Retrieve default branding theme.
      tags:
      - branding
      responses:
        '200':
          description: Branding theme successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBrandingDefaultThemeResponseContent'
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
        '403':
          description: The specified client cannot perform the requested operation.
          x-description-1: 'Insufficient scope; expected any of: read:branding.'
        '404':
          description: 'There was an error retrieving branding settings: invalid theme ID'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_default_branding_theme
      x-release-lifecycle: GA
      x-operation-name: getDefault
      x-operation-group:
      - branding
      - themes
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:branding
  /branding/themes/{themeId}:
    get:
      summary: Get Branding Theme
      description: Retrieve branding theme.
      tags:
      - branding
      parameters:
      - name: themeId
        in: path
        description: The ID of the theme
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Branding theme successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBrandingThemeResponseContent'
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
        '403':
          description: The specified client cannot perform the requested operation.
          x-description-1: 'Insufficient scope; expected any of: read:branding.'
        '404':
          description: 'There was an error retrieving branding settings: invalid theme ID'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_branding_theme
      x-release-lifecycle: GA
      x-operation-name: get
      x-operation-gr

# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/auth0/refs/heads/main/openapi/auth0-branding-api-openapi.yml