pulumi-fusionauth
Version:
A Pulumi package for managing FusionAuth instances.
818 lines • 60.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## # Theme Resource
*
* UI login themes can be configured to enable custom branding for your FusionAuth login workflow. Themes are configured per Tenant or optionally by Application.
*
* [Themes API](https://fusionauth.io/docs/v1/tech/apis/themes)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fusionauth from "pulumi-fusionauth";
*
* const mytheme = new fusionauth.FusionAuthTheme("mytheme", {
* accountEdit: "[#ftl/]",
* accountIndex: "[#ftl/]",
* accountTwoFactorDisable: "[#ftl/]",
* accountTwoFactorEnable: "[#ftl/]",
* accountTwoFactorIndex: "[#ftl/]",
* accountWebauthnAdd: "[#ftl/]",
* accountWebauthnDelete: "[#ftl/]",
* accountWebauthnIndex: "[#ftl/]",
* confirmationRequired: "[#ftl/]",
* defaultMessages: "[#ftl/]",
* emailComplete: "[#ftl/]",
* emailSend: "[#ftl/]",
* emailSent: "[#ftl/]",
* emailVerificationRequired: "[#ftl/]",
* emailVerify: "[#ftl/]",
* helpers: "[#ftl/]",
* index: "[#ftl/]",
* oauth2Authorize: "[#ftl/]",
* oauth2AuthorizedNotRegistered: "[#ftl/]",
* oauth2ChildRegistrationNotAllowed: "[#ftl/]",
* oauth2ChildRegistrationNotAllowedComplete: "[#ftl/]",
* oauth2CompleteRegistration: "[#ftl/]",
* oauth2Consent: "[#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/]",
* registrationSend: "[#ftl/]",
* registrationSent: "[#ftl/]",
* registrationVerificationRequired: "[#ftl/]",
* registrationVerify: "[#ftl/]",
* samlv2Logout: "[#ftl/]",
* stylesheet: "/* stylish */",
* unauthorized: "[#ftl/]",
* });
* ```
*/
export declare class FusionAuthTheme extends pulumi.CustomResource {
/**
* Get an existing FusionAuthTheme resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FusionAuthThemeState, opts?: pulumi.CustomResourceOptions): FusionAuthTheme;
/**
* Returns true if the given object is an instance of FusionAuthTheme. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is FusionAuthTheme;
/**
* 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.
*/
readonly accountEdit: pulumi.Output<string>;
/**
* 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.
*/
readonly accountIndex: pulumi.Output<string>;
/**
* 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.
*/
readonly accountTwoFactorDisable: pulumi.Output<string>;
/**
* 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 contains presentation of recovery codes when a user enables multi-factor authentication for the first time.
*/
readonly accountTwoFactorEnable: pulumi.Output<string>;
/**
* 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.
*/
readonly accountTwoFactorIndex: pulumi.Output<string>;
/**
* 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.
*/
readonly accountWebauthnAdd: pulumi.Output<string>;
/**
* 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.
*/
readonly accountWebauthnDelete: pulumi.Output<string>;
/**
* 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.
*/
readonly accountWebauthnIndex: pulumi.Output<string>;
/**
* 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.
*/
readonly confirmationRequired: pulumi.Output<string>;
/**
* An object that can hold any information about the Theme that should be persisted.
*/
readonly data: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A properties file formatted String containing at least all of the message keys defined in the FusionAuth shipped messages file.
*
* > **Note:** `defaultMessages` Is Required if not copying an existing Theme.
*/
readonly defaultMessages: pulumi.Output<string>;
/**
* 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.
*/
readonly emailComplete: pulumi.Output<string>;
/**
* A FreeMarker template that is rendered when the user requests the /email/send page. 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.
*
* @deprecated Use emailSent instead. API endpoint has been migrated from /email/send to /email/sent.
*/
readonly emailSend: pulumi.Output<string>;
/**
* 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.
*/
readonly emailSent: pulumi.Output<string>;
/**
* 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.
*/
readonly emailVerificationRequired: pulumi.Output<string>;
/**
* 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.
*/
readonly emailVerify: pulumi.Output<string>;
/**
* A 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.
*/
readonly helpers: pulumi.Output<string>;
/**
* 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.
*/
readonly index: pulumi.Output<string>;
/**
* A Map of localized versions of the messages. The key is the Locale and the value is a properties file formatted String.
*/
readonly localizedMessages: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A unique name for the Theme.
*/
readonly name: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2Authorize: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2AuthorizedNotRegistered: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2ChildRegistrationNotAllowed: pulumi.Output<string>;
/**
* A FreeMarker template that is rendered when the user requests the /oauth2/child-registration-not-allowed-complete path. This page is rendered is rendered after a child provides their parent’s email address for parental consent in a Consent workflow.
*/
readonly oauth2ChildRegistrationNotAllowedComplete: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2CompleteRegistration: pulumi.Output<string>;
/**
* A FreeMarker template that is rendered when a third party application requests scopes from the user.
*/
readonly oauth2Consent: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2Device: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2DeviceComplete: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2Error: pulumi.Output<string>;
/**
* A FreeMarker template that is rendered when the user requests the /oauth2/logout page. This page is used if the user initiates a logout. This page causes the user to be logged out of all associated applications via a front-channel mechanism before being redirected.
*/
readonly oauth2Logout: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2Passwordless: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2Register: pulumi.Output<string>;
/**
* A FreeMarker template that is rendered when the user requests the /oauth2/start-idp-link path. This page is used if the Identity Provider is configured to have a pending link. The user is presented with the option to link their account with an existing FusionAuth user account.
*/
readonly oauth2StartIdpLink: pulumi.Output<string>;
/**
* 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 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.
*/
readonly oauth2TwoFactor: pulumi.Output<string>;
/**
* A FreeMarker template that contains the OAuth2 two-factor enable form.
*/
readonly oauth2TwoFactorEnable: pulumi.Output<string>;
/**
* A FreeMarker template that contains the OAuth2 two-factor enable complete form.
*/
readonly oauth2TwoFactorEnableComplete: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2TwoFactorMethods: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2Wait: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2Webauthn: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2WebauthnReauth: pulumi.Output<string>;
/**
* 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.
*/
readonly oauth2WebauthnReauthEnable: pulumi.Output<string>;
/**
* 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.
*/
readonly passwordChange: pulumi.Output<string>;
/**
* 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.
*/
readonly passwordComplete: pulumi.Output<string>;
/**
* 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.
*/
readonly passwordForgot: pulumi.Output<string>;
/**
* 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.
*/
readonly passwordSent: pulumi.Output<string>;
/**
* 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.
*/
readonly registrationComplete: pulumi.Output<string>;
/**
* A FreeMarker template that is rendered when the user requests the /registration/send page. 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.
*
* @deprecated Use registrationSent instead. API endpoint has been migrated from /registration/send to /registration/sent.
*/
readonly registrationSend: pulumi.Output<string>;
/**
* 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.
*/
readonly registrationSent: pulumi.Output<string>;
/**
* 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.
*/
readonly registrationVerificationRequired: pulumi.Output<string>;
/**
* 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.
*/
readonly registrationVerify: pulumi.Output<string>;
/**
* 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.
*/
readonly samlv2Logout: pulumi.Output<string>;
/**
* The optional Id of an existing Theme to make a copy of. If present, the defaultMessages, localizedMessages, templates,
* and stylesheet from the source Theme will be copied to the new Theme.
*/
readonly sourceThemeId: pulumi.Output<string | undefined>;
/**
* A CSS stylesheet used to style the templates.
*/
readonly stylesheet: pulumi.Output<string>;
/**
* The Id to use for the new Theme. If not specified a secure random UUID will be generated.
*/
readonly themeId: pulumi.Output<string>;
/**
* An optional FreeMarker template that contains the unauthorized page.
*/
readonly unauthorized: pulumi.Output<string>;
/**
* Create a FusionAuthTheme resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: FusionAuthThemeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FusionAuthTheme resources.
*/
export interface FusionAuthThemeState {
/**
* 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.
*/
accountEdit?: pulumi.Input<string>;
/**
* 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.
*/
accountIndex?: pulumi.Input<string>;
/**
* 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.
*/
accountTwoFactorDisable?: pulumi.Input<string>;
/**
* 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 contains presentation of recovery codes when a user enables multi-factor authentication for the first time.
*/
accountTwoFactorEnable?: pulumi.Input<string>;
/**
* 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.
*/
accountTwoFactorIndex?: pulumi.Input<string>;
/**
* 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.
*/
accountWebauthnAdd?: pulumi.Input<string>;
/**
* 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.
*/
accountWebauthnDelete?: pulumi.Input<string>;
/**
* 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.
*/
accountWebauthnIndex?: pulumi.Input<string>;
/**
* 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.
*/
confirmationRequired?: pulumi.Input<string>;
/**
* An object that can hold any information about the Theme that should be persisted.
*/
data?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A properties file formatted String containing at least all of the message keys defined in the FusionAuth shipped messages file.
*
* > **Note:** `defaultMessages` Is Required if not copying an existing Theme.
*/
defaultMessages?: pulumi.Input<string>;
/**
* 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.
*/
emailComplete?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when the user requests the /email/send page. 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.
*
* @deprecated Use emailSent instead. API endpoint has been migrated from /email/send to /email/sent.
*/
emailSend?: pulumi.Input<string>;
/**
* 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.
*/
emailSent?: pulumi.Input<string>;
/**
* 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.
*/
emailVerificationRequired?: pulumi.Input<string>;
/**
* 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.
*/
emailVerify?: pulumi.Input<string>;
/**
* A 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.
*/
helpers?: pulumi.Input<string>;
/**
* 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.
*/
index?: pulumi.Input<string>;
/**
* A Map of localized versions of the messages. The key is the Locale and the value is a properties file formatted String.
*/
localizedMessages?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A unique name for the Theme.
*/
name?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Authorize?: pulumi.Input<string>;
/**
* 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.
*/
oauth2AuthorizedNotRegistered?: pulumi.Input<string>;
/**
* 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.
*/
oauth2ChildRegistrationNotAllowed?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when the user requests the /oauth2/child-registration-not-allowed-complete path. This page is rendered is rendered after a child provides their parent’s email address for parental consent in a Consent workflow.
*/
oauth2ChildRegistrationNotAllowedComplete?: pulumi.Input<string>;
/**
* 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.
*/
oauth2CompleteRegistration?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when a third party application requests scopes from the user.
*/
oauth2Consent?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Device?: pulumi.Input<string>;
/**
* 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.
*/
oauth2DeviceComplete?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Error?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when the user requests the /oauth2/logout page. This page is used if the user initiates a logout. This page causes the user to be logged out of all associated applications via a front-channel mechanism before being redirected.
*/
oauth2Logout?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Passwordless?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Register?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when the user requests the /oauth2/start-idp-link path. This page is used if the Identity Provider is configured to have a pending link. The user is presented with the option to link their account with an existing FusionAuth user account.
*/
oauth2StartIdpLink?: pulumi.Input<string>;
/**
* 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 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.
*/
oauth2TwoFactor?: pulumi.Input<string>;
/**
* A FreeMarker template that contains the OAuth2 two-factor enable form.
*/
oauth2TwoFactorEnable?: pulumi.Input<string>;
/**
* A FreeMarker template that contains the OAuth2 two-factor enable complete form.
*/
oauth2TwoFactorEnableComplete?: pulumi.Input<string>;
/**
* 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.
*/
oauth2TwoFactorMethods?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Wait?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Webauthn?: pulumi.Input<string>;
/**
* 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.
*/
oauth2WebauthnReauth?: pulumi.Input<string>;
/**
* 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.
*/
oauth2WebauthnReauthEnable?: pulumi.Input<string>;
/**
* 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.
*/
passwordChange?: pulumi.Input<string>;
/**
* 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.
*/
passwordComplete?: pulumi.Input<string>;
/**
* 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.
*/
passwordForgot?: pulumi.Input<string>;
/**
* 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.
*/
passwordSent?: pulumi.Input<string>;
/**
* 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.
*/
registrationComplete?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when the user requests the /registration/send page. 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.
*
* @deprecated Use registrationSent instead. API endpoint has been migrated from /registration/send to /registration/sent.
*/
registrationSend?: pulumi.Input<string>;
/**
* 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.
*/
registrationSent?: pulumi.Input<string>;
/**
* 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.
*/
registrationVerificationRequired?: pulumi.Input<string>;
/**
* 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.
*/
registrationVerify?: pulumi.Input<string>;
/**
* 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.
*/
samlv2Logout?: pulumi.Input<string>;
/**
* The optional Id of an existing Theme to make a copy of. If present, the defaultMessages, localizedMessages, templates,
* and stylesheet from the source Theme will be copied to the new Theme.
*/
sourceThemeId?: pulumi.Input<string>;
/**
* A CSS stylesheet used to style the templates.
*/
stylesheet?: pulumi.Input<string>;
/**
* The Id to use for the new Theme. If not specified a secure random UUID will be generated.
*/
themeId?: pulumi.Input<string>;
/**
* An optional FreeMarker template that contains the unauthorized page.
*/
unauthorized?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a FusionAuthTheme resource.
*/
export interface FusionAuthThemeArgs {
/**
* 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.
*/
accountEdit?: pulumi.Input<string>;
/**
* 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.
*/
accountIndex?: pulumi.Input<string>;
/**
* 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.
*/
accountTwoFactorDisable?: pulumi.Input<string>;
/**
* 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 contains presentation of recovery codes when a user enables multi-factor authentication for the first time.
*/
accountTwoFactorEnable?: pulumi.Input<string>;
/**
* 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.
*/
accountTwoFactorIndex?: pulumi.Input<string>;
/**
* 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.
*/
accountWebauthnAdd?: pulumi.Input<string>;
/**
* 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.
*/
accountWebauthnDelete?: pulumi.Input<string>;
/**
* 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.
*/
accountWebauthnIndex?: pulumi.Input<string>;
/**
* 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.
*/
confirmationRequired?: pulumi.Input<string>;
/**
* An object that can hold any information about the Theme that should be persisted.
*/
data?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A properties file formatted String containing at least all of the message keys defined in the FusionAuth shipped messages file.
*
* > **Note:** `defaultMessages` Is Required if not copying an existing Theme.
*/
defaultMessages?: pulumi.Input<string>;
/**
* 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.
*/
emailComplete?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when the user requests the /email/send page. 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.
*
* @deprecated Use emailSent instead. API endpoint has been migrated from /email/send to /email/sent.
*/
emailSend?: pulumi.Input<string>;
/**
* 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.
*/
emailSent?: pulumi.Input<string>;
/**
* 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.
*/
emailVerificationRequired?: pulumi.Input<string>;
/**
* 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.
*/
emailVerify?: pulumi.Input<string>;
/**
* A 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.
*/
helpers?: pulumi.Input<string>;
/**
* 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.
*/
index?: pulumi.Input<string>;
/**
* A Map of localized versions of the messages. The key is the Locale and the value is a properties file formatted String.
*/
localizedMessages?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A unique name for the Theme.
*/
name?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Authorize?: pulumi.Input<string>;
/**
* 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.
*/
oauth2AuthorizedNotRegistered?: pulumi.Input<string>;
/**
* 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.
*/
oauth2ChildRegistrationNotAllowed?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when the user requests the /oauth2/child-registration-not-allowed-complete path. This page is rendered is rendered after a child provides their parent’s email address for parental consent in a Consent workflow.
*/
oauth2ChildRegistrationNotAllowedComplete?: pulumi.Input<string>;
/**
* 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.
*/
oauth2CompleteRegistration?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when a third party application requests scopes from the user.
*/
oauth2Consent?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Device?: pulumi.Input<string>;
/**
* 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.
*/
oauth2DeviceComplete?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Error?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when the user requests the /oauth2/logout page. This page is used if the user initiates a logout. This page causes the user to be logged out of all associated applications via a front-channel mechanism before being redirected.
*/
oauth2Logout?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Passwordless?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Register?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when the user requests the /oauth2/start-idp-link path. This page is used if the Identity Provider is configured to have a pending link. The user is presented with the option to link their account with an existing FusionAuth user account.
*/
oauth2StartIdpLink?: pulumi.Input<string>;
/**
* 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 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.
*/
oauth2TwoFactor?: pulumi.Input<string>;
/**
* A FreeMarker template that contains the OAuth2 two-factor enable form.
*/
oauth2TwoFactorEnable?: pulumi.Input<string>;
/**
* A FreeMarker template that contains the OAuth2 two-factor enable complete form.
*/
oauth2TwoFactorEnableComplete?: pulumi.Input<string>;
/**
* 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.
*/
oauth2TwoFactorMethods?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Wait?: pulumi.Input<string>;
/**
* 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.
*/
oauth2Webauthn?: pulumi.Input<string>;
/**
* 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.
*/
oauth2WebauthnReauth?: pulumi.Input<string>;
/**
* 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.
*/
oauth2WebauthnReauthEnable?: pulumi.Input<string>;
/**
* 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.
*/
passwordChange?: pulumi.Input<string>;
/**
* 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.
*/
passwordComplete?: pulumi.Input<string>;
/**
* 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.
*/
passwordForgot?: pulumi.Input<string>;
/**
* 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.
*/
passwordSent?: pulumi.Input<string>;
/**
* 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.
*/
registrationComplete?: pulumi.Input<string>;
/**
* A FreeMarker template that is rendered when the user requests the /registration/send page. 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.
*
* @deprecated Use registrationSent instead. API endpoint has been migrated from /registration/send to /registration/sent.
*/
registrationSend?: pulumi.Input<string>;
/**
* 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.
*/
registrationSent?: pulumi.Input<string>;
/**
* 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.
*/
registrationVerificationRequired?: pulumi.Input<string>;
/**
* 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.
*/
registrationVerify?: pulumi.Input<string>;
/**
* 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.
*/
samlv2Logout?: pulumi.Input<string>;
/**
* The optional Id of an existing Theme to make a copy of. If present, the defaultMessages, localizedMessages, templates,
* and stylesheet from the source Theme will be copied to the new Theme.
*/
sourceThemeId?: pulumi.Input<string>;
/**
* A CSS stylesheet used to style the templates.
*/
stylesheet?: pulumi.Input<string>;
/**
* The Id to use for the new Theme. If not specified a secure random UUID will be generated.
*/
themeId?: pulumi.Input<string>;
/**
* An optional FreeMarker template that contains the unauthorized page.
*/
unauthorized?: pulumi.Input<string>;
}