Advanced Themes

Overview

This API has been available since 1.8.0

UI login themes can be configured to enable custom branding for your FusionAuth login workflow. Themes are configured per Tenant or optionally by Application.

The following APIs are provided to manage Themes.

Create an Advanced Theme

This API is used to create a new Theme.

Request

Create a new Theme with a randomly generated Id

POST /api/theme

Create a Theme with the provided unique Id

POST /api/theme/{themeId}

Request Parameters

themeIdUUIDDefaults to secure random UUID

The Id to use for the new Theme. If not specified a secure random UUID will be generated.

Request Body

Note that the rest of this page will assume that the theme.type of this theme is advanced.

theme.dataObject

An object that can hold any information about the Theme that should be persisted.

theme.defaultMessagesString

A properties file formatted String containing at least all of the message keys defined in the FusionAuth shipped messages file. Required if not copying an existing Theme.

theme.localizedMessagesMap<Locale,String>

A Map of localized versions of the messages. The key is the Locale and the value is a properties file formatted String.

theme.nameStringrequired

A unique name for the Theme.

theme.stylesheetString

A CSS stylesheet used to style the templates.

theme.typeStringDefaults to advancedAvailable since 1.51.0

The type of the Theme. This value determines what content is required for the Theme. There are two distinct values.

advanced - This is the default FusionAuth theme type. This type allows for full customization of the html, css, and messaging via Freemarker templates. If a Theme is advanced then the theme.defaultMessages and theme.templates fields are required. The theme.defaultMessages should specify every message in the message bundle. See Theme Localization.
simple - A simple theme only requires a set of variables that will applied to css across the theme. If a Theme is simple then the theme.variables field is required. If a theme is simple then the theme.defaultMessages need only specify any text that you would like to change from what is included in theme.

theme.templates.accountEditStringAvailable since 1.26.0

A FreeMarker template that is rendered when the user requests the /account/edit path.

This page contains a form that enables authenticated users to update their profile.

theme.templates.accountIndexStringAvailable since 1.26.0

A FreeMarker template that is rendered when the user requests the /account path.

This is the self-service account landing page. An authenticated user may use this as a starting point for operations such as updating their profile or configuring multi-factor authentication.

theme.templates.accountTwoFactorDisableStringAvailable since 1.26.0

A FreeMarker template that is rendered when the user requests the /account/two-factor/disable path.

This page contains a form that accepts a verification code used to disable a multi-factor authentication method.

theme.templates.accountTwoFactorEnableStringAvailable since 1.26.0

A FreeMarker template that is rendered when the user requests the /account/two-factor/enable path.

This page contains a form that accepts a verification code used to enable a multi-factor authentication method. Additionally, this page displays recovery codes when a user enables multi-factor authentication for the first time.

theme.templates.accountTwoFactorIndexStringAvailable since 1.26.0

A FreeMarker template that is rendered when the user requests the /account/two-factor path.

This page displays an authenticated user's configured multi-factor authentication methods. Additionally, it provides links to enable and disable a method.

theme.templates.accountWebAuthnAddStringAvailable since 1.41.0

A FreeMarker template that is rendered when the user requests the /account/webauthn/add path.

This page contains a form that allows a user to register a new WebAuthn passkey.

theme.templates.accountWebAuthnDeleteStringAvailable since 1.41.0

A FreeMarker template that is rendered when the user requests the /account/webauthn/delete path.

This page contains a form that allows a user to delete a WebAuthn passkey.

theme.templates.accountWebAuthnIndexStringAvailable since 1.41.0

A FreeMarker template that is rendered when the user requests the /account/webauthn/ path.

This page displays an authenticated user's registered WebAuthn passkeys. Additionally, it provides links to delete an existing passkey and register a new passkey.

theme.templates.confirmationRequiredStringAvailable since 1.49.0

A FreeMarker template that is rendered when the user requests the /confirmation-required path.

This page is displayed when a user attempts to complete an email based workflow that did not begin in the same browser. For example, if the user starts a forgot password workflow, and then opens the link in a separate browser the user will be shown this panel.

theme.templates.emailCompleteString

A FreeMarker template that is rendered when the user requests the /email/complete path.

This page is used after a user has verified their email address by clicking the URL in the email. After FusionAuth has updated their user object to indicate that their email was verified, the browser is redirected to this page.

theme.templates.emailSentString

A FreeMarker template that is rendered when the user requests the /email/sent path.

This page is used after a user has asked for the verification email to be resent. This can happen if the URL in the email expired and the user clicked it. In this case, the user can provide their email address again and FusionAuth will resend the email. After the user submits their email and FusionAuth re-sends a verification email to them, the browser is redirected to this page.

theme.templates.emailVerificationRequiredStringAvailable since 1.27.0

A FreeMarker template that is rendered when the user requests the /email/verification-required path.

This page is rendered when a user is required to verify their email address prior to being allowed to proceed with login. This occurs when Unverified behavior is set to Gated in email verification settings on the Tenant.

theme.templates.emailVerifyString

A FreeMarker template that is rendered when the user requests the /email/verify path.

This page is rendered when a user clicks the URL from the verification email and the verificationId has expired. FusionAuth expires verificationId after a period of time (which is configurable). If the user has a URL from the verification email that has expired, this page will be rendered and the error will be displayed to the user.

theme.templates.helpersString

A https://freemarker.apache.org[FreeMarker] template that contains all of the macros and templates used by the rest of the login Theme FreeMarker templates. This allows you to configure the general layout of your UI configuration and login theme without having to copy and paste HTML into each of the templates.

theme.templates.indexStringAvailable since 1.27.0

A FreeMarker template that is rendered when the user requests the / path.

This is the root landing page. This page is available to unauthenticated users and will be displayed whenever someone navigates to the FusionAuth host's root page. Prior to version 1.27.0, navigating to this URL would redirect to /admin and would subsequently render the FusionAuth admin login page.

theme.templates.oauth2AuthorizeString

A FreeMarker template that is rendered when the user requests the /oauth2/authorize path.

This is the main login page for FusionAuth and is used for all interactive OAuth2 and OpenID Connect workflows.

theme.templates.oauth2AuthorizedNotRegisteredStringAvailable since 1.28.0

A FreeMarker template that is rendered when the user requests the /oauth2/authorized-not-registered path.

This page is rendered when a user is not registered and the Application configuration requires registration before FusionAuth will complete the redirect.

theme.templates.oauth2ChildRegistrationNotAllowedString

A FreeMarker template that is rendered when the user requests the /oauth2/child-registration-not-allowed path.

This page contains a form where a child must provide their parent's email address to ask their parent to create an account for them in a Consent workflow.

theme.templates.oauth2ChildRegistrationNotAllowedCompleteString

A FreeMarker template that is rendered when the user requests the /oauth2/child-registration-not-allowed-complete path.

This page is rendered after a child provides their parent's email address for parental consent in a Consent workflow.

theme.templates.oauth2CompleteRegistrationString

A FreeMarker template that is rendered when the user requests the /oauth2/complete-registration path.

This page contains a form that is used for users that have accounts but might be missing required fields.

theme.templates.oauth2ConsentStringAvailable since 1.50.0

A FreeMarker template that is rendered when the user requests the /oauth2/consent path.

This page contains a form for capturing a user's OAuth scope consent choices. If there are no scopes that require a prompt, the user is redirected automatically.

theme.templates.oauth2DeviceStringAvailable since 1.11.0

A FreeMarker template that is rendered when the user requests the /oauth2/device path.

This page contains a form for accepting an end user's short code for the interactive portion of the OAuth Device Authorization Grant workflow.

theme.templates.oauth2DeviceCompleteStringAvailable since 1.12.0

A FreeMarker template that is rendered when the user requests the /oauth2/device-complete path.

This page contains a complete message indicating the device authentication has completed.

theme.templates.oauth2ErrorString

This page is used if the user starts or is in the middle of the OAuth workflow and any type of error occurs. This could be caused by the user messing with the URL or internally some type of information wasn't passed between the OAuth endpoints correctly. For example, if you are federating login to an external IdP and that IdP does not properly echo the state parameter, FusionAuth’s OAuth workflow will break and this page will be displayed.

theme.templates.oauth2LogoutString

A FreeMarker template that is rendered when the user requests the /oauth2/logout path.

This page is used if the user initiates an OAuth logout. This page causes the user to be logged out of all associated applications or just the initiating application, as configured, via a front-channel mechanism before being redirected.

theme.templates.oauth2PasswordlessString

A FreeMarker template that is rendered when the user requests the /oauth2/passwordless path.

This page is rendered when the user starts the passwordless login workflow. The page renders the form where the user types in their email address.

theme.templates.oauth2RegisterString

A FreeMarker template that is rendered when the user requests the /oauth2/register path.

This page is used to register or sign up the user for the application when self-service registration is enabled.

theme.templates.oauth2StartIdPLinkStringAvailable since 1.28.0

A FreeMarker template that is rendered when the user requests the /oauth2/start-idp-link path.

This page is used if the linking strategy of the Identity Provider is set to create a pending link. The user is presented with the option to link their account with an existing FusionAuth user account or create a new FusionAuth user.

theme.templates.oauth2TwoFactorString

A FreeMarker template that is rendered when the user requests the /oauth2/two-factor path.

This page is used if the user has two-factor authentication enabled or two factor authentication is required and they need to type in their code again. FusionAuth will properly handle the processing on the back end. This page contains the form that the user will put their code into.

theme.templates.oauth2TwoFactorEnableStringAvailable since 1.42.0

A FreeMarker template that is rendered when the user requests the /oauth2/two-factor-enable path.

This page contains a form providing a user with the Oauth2 two-factor enable form

theme.templates.oauth2TwoFactorEnableCompleteStringAvailable since 1.42.0

A FreeMarker template that is rendered when the user requests the /oauth2/two-factor-enable-complete path.

This page contains a form providing a user with the Oauth2 two-factor enable complete form

theme.templates.oauth2TwoFactorMethodsStringAvailable since 1.26.0

A FreeMarker template that is rendered when the user requests the /oauth2/two-factor-methods path.

This page contains a form providing a user with their configured multi-factor authentication options that they may use to complete the authentication challenge.

theme.templates.oauth2WaitStringAvailable since 1.12.0

A FreeMarker template that is rendered when the user requests the /oauth2/wait path.

This page is rendered when FusionAuth is waiting for an external provider to complete an out of band authentication request. For example, during a HYPR login this page will be displayed until the user completes authentication.

theme.templates.oauth2WebAuthnStringAvailable since 1.41.0

A FreeMarker template that is rendered when the user requests the /oauth2/webauthn path.

This page contains a form where a user can enter their loginId (username or email address) to authenticate with one of their registered WebAuthn passkeys. This page uses the WebAuthn bootstrap workflow.

theme.templates.oauth2WebAuthnReauthStringAvailable since 1.41.0

A FreeMarker template that is rendered when the user requests the /oauth2/webauthn-reauth path.

This page contains a form that lists the WebAuthn passkeys currently available for re-authentication. A user can select one of the listed passkeys to authenticate using the corresponding passkey and user account.

theme.templates.oauth2WebAuthnReauthEnableStringAvailable since 1.41.0

A FreeMarker template that is rendered when the user requests the /oauth2/webauthn-reauth-enable path.

This page contains two forms. One allows the user to select one of their existing WebAuthn passkeys to use for re-authentication. The other allows the user to register a new WebAuthn passkey for re-authentication.

theme.templates.passwordChangeString

A FreeMarker template that is rendered when the user requests the /password/change path.

This page is used if the user is required to change their password or if they have requested a password reset. This page contains the form that allows the user to provide a new password.

theme.templates.passwordCompleteString

A FreeMarker template that is rendered when the user requests the /password/complete path.

This page is used after the user has successfully updated their password, or reset it. This page should instruct the user that their password was updated and that they need to login again.

theme.templates.passwordForgotString

A FreeMarker template that is rendered when the user requests the /password/forgot path.

This page is used when a user starts the forgot password workflow. This page renders the form where the user types in their email address.

theme.templates.passwordSentString

A FreeMarker template that is rendered when the user requests the /password/sent path.

This page is used when a user has submitted the forgot password form with their email. FusionAuth does not indicate back to the user if their email address was valid in order to prevent malicious activity that could reveal valid email addresses. Therefore, this page should indicate to the user that if their email was valid, they will receive an email shortly with a link to reset their password.

theme.templates.registrationCompleteString

A FreeMarker template that is rendered when the user requests the /registration/complete path.

This page is used after a user has verified their email address for a specific application (i.e. a user registration) by clicking the URL in the email. After FusionAuth has updated their registration object to indicate that their email was verified, the browser is redirected to this page.

theme.templates.registrationSentString

A FreeMarker template that is rendered when the user requests the /registration/sent path.

This page is used after a user has asked for the application specific verification email to be resent. This can happen if the URL in the email expired and the user clicked it. In this case, the user can provide their email address again and FusionAuth will resend the email. After the user submits their email and FusionAuth re-sends a verification email to them, the browser is redirected to this page.

theme.templates.registrationVerificationRequiredStringAvailable since 1.27.0

A FreeMarker template that is rendered when the user requests the /registration/verification-required path.

This page is rendered when a user is required to verify their registration prior to being allowed to proceed with the registration flow. This occurs when Unverified behavior`` is set to Gated` in registration verification settings on the Application.

theme.templates.registrationVerifyString

A FreeMarker template that is rendered when the user requests the /registration/verify path.

This page is used when a user clicks the URL from the application specific verification email and the verificationId has expired. FusionAuth expires verificationId after a period of time (which is configurable). If the user has a URL from the verification email that has expired, this page will be rendered and the error will be displayed to the user.

theme.templates.samlv2LogoutStringAvailable since 1.25.0

A FreeMarker template that is rendered when the user requests the /samlv2/logout path.

This page is used if the user initiates a SAML logout. This page causes the user to be logged out of all associated applications via a front-channel mechanism before being redirected.

theme.templates.unauthorizedStringAvailable since 1.30.0

A FreeMarker template that is rendered when the user requests the /unauthorized path.

This page is used if the user is not authorized to use the application or page. If you have advanced threat detection enabled, this page is generally made available to you.

Example Advanced Theme Request JSON

{
  "theme": {
    "data": {
      "addedBy": "richard"
    },
    "defaultMessages": "title=Login",
    "localizedMessages": {
      "fr": "title=Identifiant",
      "es": "title=Iniciar sesión"
    },
    "name": "Orange Theme",
    "templates": {
      "accountEdit": "[#ftl/]",
      "accountIndex": "[#ftl/]",
      "accountTwoFactorDisable": "[#ftl/]",
      "accountTwoFactorEnable": "[#ftl/]",
      "accountTwoFactorIndex": "[#ftl/]",
      "accountWebAuthnAdd": "[#ftl/]",
      "accountWebAuthnDelete": "[#ftl/]",
      "accountWebAuthnIndex": "[#ftl/]",
      "emailComplete": "[#ftl/]",
      "emailSent": "[#ftl/]",
      "emailVerificationRequired": "[#ftl/]",
      "emailVerify": "[#ftl/]",
      "helpers": "[#ftl/]",
      "index": "[#ftl/]",
      "oauth2Authorize": "[#ftl/]",
      "oauth2AuthorizedNotRegistered": "[#ftl/]",
      "oauth2ChildRegistrationNotAllowed": "[#ftl/]",
      "oauth2ChildRegistrationNotAllowedComplete": "[#ftl/]",
      "oauth2CompleteRegistration": "[#ftl/]",
      "oauth2Device": "[#ftl/]",
      "oauth2DeviceComplete": "[#ftl/]",
      "oauth2Error": "[#ftl/]",
      "oauth2Logout": "[#ftl/]",
      "oauth2Passwordless": "[#ftl/]",
      "oauth2Register": "[#ftl/]",
      "oauth2StartIdPLink": "[#ftl/]",
      "oauth2TwoFactor": "[#ftl/]",
      "oauth2TwoFactorEnable": "[#ftl/]",
      "oauth2TwoFactorEnableComplete": "[#ftl/]",
      "oauth2TwoFactorMethods": "[#ftl/]",
      "oauth2Wait": "[#ftl/]",
      "oauth2WebAuthn": "[#ftl/]",
      "oauth2WebAuthnReauth": "[#ftl/]",
      "oauth2WebAuthnReauthEnable": "[#ftl/]",
      "passwordChange": "[#ftl/]",
      "passwordComplete": "[#ftl/]",
      "passwordForgot": "[#ftl/]",
      "passwordSent": "[#ftl/]",
      "registrationComplete": "[#ftl/]",
      "registrationSent": "[#ftl/]",
      "registrationVerificationRequired": "[#ftl/]",
      "registrationVerify": "[#ftl/]",
      "samlv2Logout": "[#ftl/]",
      "unauthorized": "[#ftl/]"
    }
  }
}

Create a Theme from an existing Theme with a randomly generated Id

POST /api/theme

Create a Theme from an existing Theme with the provided unique Id

POST /api/theme/{themeId}

Request Parameters

themeIdUUIDDefaults to secure random UUID

The Id to use for the new Theme. If not specified a secure random UUID will be generated.

Request Body

sourceThemeIdUUIDrequired

The Id of an existing Theme from which a copy will be made.

The defaultMessages , localizedMessages , templates , and stylesheet from the source Theme will be copied to the new Theme.

theme.nameStringrequired

A unique name for the Theme.

Example request JSON

{
  "sourceThemeId": "64773453-bb11-457b-a3d6-7475ec2259d0",
  "theme": {
    "name": "Orange Theme - copied"
  }
}

Response

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body

theme.dataObject

An object that can hold any information about the Theme that should be persisted.

theme.defaultMessagesString

A properties file formatted String containing messages used within the templates.

theme.idUUID

The unique Id of the Theme.

theme.insertInstantLong

The instant that the theme was added to the FusionAuth database.

theme.lastUpdateInstantLong

The instant that the theme was last updated in the FusionAuth database.

theme.localizedMessagesMap<Locale,String>

A Map of localized versions of the messages. The key is the Locale and the value is a properties file formatted String.

theme.nameString