Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. Pages
Auth0 v3.17.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-auth0

auth0.Pages

Explore with Pulumi AI

Auth0 v3.17.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-auth0

With this resource you can manage custom HTML for the Login, Reset Password, Multi-Factor Authentication and Error pages.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

const myPages = new auth0.Pages("my_pages", {
    login: {
        enabled: true,
        html: "<html><body>My Custom Login Page</body></html>",
    },
    changePassword: {
        enabled: true,
        html: "<html><body>My Custom Reset Password Page</body></html>",
    },
    guardianMfa: {
        enabled: true,
        html: "<html><body>My Custom MFA Page</body></html>",
    },
    error: {
        showLogLink: true,
        html: "<html><body>My Custom Error Page</body></html>",
        url: "https://example.com",
    },
});
Copy
import pulumi
import pulumi_auth0 as auth0

my_pages = auth0.Pages("my_pages",
    login={
        "enabled": True,
        "html": "<html><body>My Custom Login Page</body></html>",
    },
    change_password={
        "enabled": True,
        "html": "<html><body>My Custom Reset Password Page</body></html>",
    },
    guardian_mfa={
        "enabled": True,
        "html": "<html><body>My Custom MFA Page</body></html>",
    },
    error={
        "show_log_link": True,
        "html": "<html><body>My Custom Error Page</body></html>",
        "url": "https://example.com",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.NewPages(ctx, "my_pages", &auth0.PagesArgs{
			Login: &auth0.PagesLoginArgs{
				Enabled: pulumi.Bool(true),
				Html:    pulumi.String("<html><body>My Custom Login Page</body></html>"),
			},
			ChangePassword: &auth0.PagesChangePasswordArgs{
				Enabled: pulumi.Bool(true),
				Html:    pulumi.String("<html><body>My Custom Reset Password Page</body></html>"),
			},
			GuardianMfa: &auth0.PagesGuardianMfaArgs{
				Enabled: pulumi.Bool(true),
				Html:    pulumi.String("<html><body>My Custom MFA Page</body></html>"),
			},
			Error: &auth0.PagesErrorArgs{
				ShowLogLink: pulumi.Bool(true),
				Html:        pulumi.String("<html><body>My Custom Error Page</body></html>"),
				Url:         pulumi.String("https://example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var myPages = new Auth0.Pages("my_pages", new()
    {
        Login = new Auth0.Inputs.PagesLoginArgs
        {
            Enabled = true,
            Html = "<html><body>My Custom Login Page</body></html>",
        },
        ChangePassword = new Auth0.Inputs.PagesChangePasswordArgs
        {
            Enabled = true,
            Html = "<html><body>My Custom Reset Password Page</body></html>",
        },
        GuardianMfa = new Auth0.Inputs.PagesGuardianMfaArgs
        {
            Enabled = true,
            Html = "<html><body>My Custom MFA Page</body></html>",
        },
        Error = new Auth0.Inputs.PagesErrorArgs
        {
            ShowLogLink = true,
            Html = "<html><body>My Custom Error Page</body></html>",
            Url = "https://example.com",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.Pages;
import com.pulumi.auth0.PagesArgs;
import com.pulumi.auth0.inputs.PagesLoginArgs;
import com.pulumi.auth0.inputs.PagesChangePasswordArgs;
import com.pulumi.auth0.inputs.PagesGuardianMfaArgs;
import com.pulumi.auth0.inputs.PagesErrorArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myPages = new Pages("myPages", PagesArgs.builder()
            .login(PagesLoginArgs.builder()
                .enabled(true)
                .html("<html><body>My Custom Login Page</body></html>")
                .build())
            .changePassword(PagesChangePasswordArgs.builder()
                .enabled(true)
                .html("<html><body>My Custom Reset Password Page</body></html>")
                .build())
            .guardianMfa(PagesGuardianMfaArgs.builder()
                .enabled(true)
                .html("<html><body>My Custom MFA Page</body></html>")
                .build())
            .error(PagesErrorArgs.builder()
                .showLogLink(true)
                .html("<html><body>My Custom Error Page</body></html>")
                .url("https://example.com")
                .build())
            .build());

    }
}
Copy
resources:
  myPages:
    type: auth0:Pages
    name: my_pages
    properties:
      login:
        enabled: true
        html: <html><body>My Custom Login Page</body></html>
      changePassword:
        enabled: true
        html: <html><body>My Custom Reset Password Page</body></html>
      guardianMfa:
        enabled: true
        html: <html><body>My Custom MFA Page</body></html>
      error:
        showLogLink: true
        html: <html><body>My Custom Error Page</body></html>
        url: https://example.com
Copy

Create Pages Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Pages(name: string, args?: PagesArgs, opts?: CustomResourceOptions);
@overload
def Pages(resource_name: str,
          args: Optional[PagesArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Pages(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          change_password: Optional[PagesChangePasswordArgs] = None,
          error: Optional[PagesErrorArgs] = None,
          guardian_mfa: Optional[PagesGuardianMfaArgs] = None,
          login: Optional[PagesLoginArgs] = None)
func NewPages(ctx *Context, name string, args *PagesArgs, opts ...ResourceOption) (*Pages, error)
public Pages(string name, PagesArgs? args = null, CustomResourceOptions? opts = null)
public Pages(String name, PagesArgs args)
public Pages(String name, PagesArgs args, CustomResourceOptions options)

type: auth0:Pages
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args PagesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args PagesArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args PagesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args PagesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PagesArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var pagesResource = new Auth0.Pages("pagesResource", new()
{
    ChangePassword = new Auth0.Inputs.PagesChangePasswordArgs
    {
        Enabled = false,
        Html = "string",
    },
    Error = new Auth0.Inputs.PagesErrorArgs
    {
        ShowLogLink = false,
        Html = "string",
        Url = "string",
    },
    GuardianMfa = new Auth0.Inputs.PagesGuardianMfaArgs
    {
        Enabled = false,
        Html = "string",
    },
    Login = new Auth0.Inputs.PagesLoginArgs
    {
        Enabled = false,
        Html = "string",
    },
});
Copy
example, err := auth0.NewPages(ctx, "pagesResource", &auth0.PagesArgs{
	ChangePassword: &auth0.PagesChangePasswordArgs{
		Enabled: pulumi.Bool(false),
		Html:    pulumi.String("string"),
	},
	Error: &auth0.PagesErrorArgs{
		ShowLogLink: pulumi.Bool(false),
		Html:        pulumi.String("string"),
		Url:         pulumi.String("string"),
	},
	GuardianMfa: &auth0.PagesGuardianMfaArgs{
		Enabled: pulumi.Bool(false),
		Html:    pulumi.String("string"),
	},
	Login: &auth0.PagesLoginArgs{
		Enabled: pulumi.Bool(false),
		Html:    pulumi.String("string"),
	},
})
Copy
var pagesResource = new Pages("pagesResource", PagesArgs.builder()
    .changePassword(PagesChangePasswordArgs.builder()
        .enabled(false)
        .html("string")
        .build())
    .error(PagesErrorArgs.builder()
        .showLogLink(false)
        .html("string")
        .url("string")
        .build())
    .guardianMfa(PagesGuardianMfaArgs.builder()
        .enabled(false)
        .html("string")
        .build())
    .login(PagesLoginArgs.builder()
        .enabled(false)
        .html("string")
        .build())
    .build());
Copy
pages_resource = auth0.Pages("pagesResource",
    change_password={
        "enabled": False,
        "html": "string",
    },
    error={
        "show_log_link": False,
        "html": "string",
        "url": "string",
    },
    guardian_mfa={
        "enabled": False,
        "html": "string",
    },
    login={
        "enabled": False,
        "html": "string",
    })
Copy
const pagesResource = new auth0.Pages("pagesResource", {
    changePassword: {
        enabled: false,
        html: "string",
    },
    error: {
        showLogLink: false,
        html: "string",
        url: "string",
    },
    guardianMfa: {
        enabled: false,
        html: "string",
    },
    login: {
        enabled: false,
        html: "string",
    },
});
Copy
type: auth0:Pages
properties:
    changePassword:
        enabled: false
        html: string
    error:
        html: string
        showLogLink: false
        url: string
    guardianMfa:
        enabled: false
        html: string
    login:
        enabled: false
        html: string
Copy

Pages Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Pages resource accepts the following input properties:

ChangePassword PagesChangePassword
Configuration settings for customizing the Password Reset page.
Error PagesError
Configuration settings for the Error pages.
GuardianMfa PagesGuardianMfa
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
Login PagesLogin
Configuration settings for customizing the Login page.
ChangePassword PagesChangePasswordArgs
Configuration settings for customizing the Password Reset page.
Error PagesErrorArgs
Configuration settings for the Error pages.
GuardianMfa PagesGuardianMfaArgs
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
Login PagesLoginArgs
Configuration settings for customizing the Login page.
changePassword PagesChangePassword
Configuration settings for customizing the Password Reset page.
error PagesError
Configuration settings for the Error pages.
guardianMfa PagesGuardianMfa
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
login PagesLogin
Configuration settings for customizing the Login page.
changePassword PagesChangePassword
Configuration settings for customizing the Password Reset page.
error PagesError
Configuration settings for the Error pages.
guardianMfa PagesGuardianMfa
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
login PagesLogin
Configuration settings for customizing the Login page.
change_password PagesChangePasswordArgs
Configuration settings for customizing the Password Reset page.
error PagesErrorArgs
Configuration settings for the Error pages.
guardian_mfa PagesGuardianMfaArgs
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
login PagesLoginArgs
Configuration settings for customizing the Login page.
changePassword Property Map
Configuration settings for customizing the Password Reset page.
error Property Map
Configuration settings for the Error pages.
guardianMfa Property Map
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
login Property Map
Configuration settings for customizing the Login page.

Outputs

All input properties are implicitly available as output properties. Additionally, the Pages resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Pages Resource

Get an existing Pages resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PagesState, opts?: CustomResourceOptions): Pages
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        change_password: Optional[PagesChangePasswordArgs] = None,
        error: Optional[PagesErrorArgs] = None,
        guardian_mfa: Optional[PagesGuardianMfaArgs] = None,
        login: Optional[PagesLoginArgs] = None) -> Pages
func GetPages(ctx *Context, name string, id IDInput, state *PagesState, opts ...ResourceOption) (*Pages, error)
public static Pages Get(string name, Input<string> id, PagesState? state, CustomResourceOptions? opts = null)
public static Pages get(String name, Output<String> id, PagesState state, CustomResourceOptions options)
resources:  _:    type: auth0:Pages    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ChangePassword PagesChangePassword
Configuration settings for customizing the Password Reset page.
Error PagesError
Configuration settings for the Error pages.
GuardianMfa PagesGuardianMfa
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
Login PagesLogin
Configuration settings for customizing the Login page.
ChangePassword PagesChangePasswordArgs
Configuration settings for customizing the Password Reset page.
Error PagesErrorArgs
Configuration settings for the Error pages.
GuardianMfa PagesGuardianMfaArgs
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
Login PagesLoginArgs
Configuration settings for customizing the Login page.
changePassword PagesChangePassword
Configuration settings for customizing the Password Reset page.
error PagesError
Configuration settings for the Error pages.
guardianMfa PagesGuardianMfa
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
login PagesLogin
Configuration settings for customizing the Login page.
changePassword PagesChangePassword
Configuration settings for customizing the Password Reset page.
error PagesError
Configuration settings for the Error pages.
guardianMfa PagesGuardianMfa
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
login PagesLogin
Configuration settings for customizing the Login page.
change_password PagesChangePasswordArgs
Configuration settings for customizing the Password Reset page.
error PagesErrorArgs
Configuration settings for the Error pages.
guardian_mfa PagesGuardianMfaArgs
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
login PagesLoginArgs
Configuration settings for customizing the Login page.
changePassword Property Map
Configuration settings for customizing the Password Reset page.
error Property Map
Configuration settings for the Error pages.
guardianMfa Property Map
Configuration settings for customizing the Guardian Multi-Factor Authentication page.
login Property Map
Configuration settings for customizing the Login page.

Supporting Types

PagesChangePassword
, PagesChangePasswordArgs

Enabled This property is required. bool
Indicates whether to use the custom Reset Password HTML (true) or the default Auth0 page (false).
Html This property is required. string
Customized content for the Reset Password page. HTML format with supported Liquid syntax.
Enabled This property is required. bool
Indicates whether to use the custom Reset Password HTML (true) or the default Auth0 page (false).
Html This property is required. string
Customized content for the Reset Password page. HTML format with supported Liquid syntax.
enabled This property is required. Boolean
Indicates whether to use the custom Reset Password HTML (true) or the default Auth0 page (false).
html This property is required. String
Customized content for the Reset Password page. HTML format with supported Liquid syntax.
enabled This property is required. boolean
Indicates whether to use the custom Reset Password HTML (true) or the default Auth0 page (false).
html This property is required. string
Customized content for the Reset Password page. HTML format with supported Liquid syntax.
enabled This property is required. bool
Indicates whether to use the custom Reset Password HTML (true) or the default Auth0 page (false).
html This property is required. str
Customized content for the Reset Password page. HTML format with supported Liquid syntax.
enabled This property is required. Boolean
Indicates whether to use the custom Reset Password HTML (true) or the default Auth0 page (false).
html This property is required. String
Customized content for the Reset Password page. HTML format with supported Liquid syntax.

PagesError
, PagesErrorArgs

ShowLogLink This property is required. bool
Indicates whether to show the link to logs as part of the default error page.
Html string
Customized content for the Error page. HTML format with supported Liquid syntax.
Url string
URL to redirect to when an error occurs, instead of showing the default error page.
ShowLogLink This property is required. bool
Indicates whether to show the link to logs as part of the default error page.
Html string
Customized content for the Error page. HTML format with supported Liquid syntax.
Url string
URL to redirect to when an error occurs, instead of showing the default error page.
showLogLink This property is required. Boolean
Indicates whether to show the link to logs as part of the default error page.
html String
Customized content for the Error page. HTML format with supported Liquid syntax.
url String
URL to redirect to when an error occurs, instead of showing the default error page.
showLogLink This property is required. boolean
Indicates whether to show the link to logs as part of the default error page.
html string
Customized content for the Error page. HTML format with supported Liquid syntax.
url string
URL to redirect to when an error occurs, instead of showing the default error page.
show_log_link This property is required. bool
Indicates whether to show the link to logs as part of the default error page.
html str
Customized content for the Error page. HTML format with supported Liquid syntax.
url str
URL to redirect to when an error occurs, instead of showing the default error page.
showLogLink This property is required. Boolean
Indicates whether to show the link to logs as part of the default error page.
html String
Customized content for the Error page. HTML format with supported Liquid syntax.
url String
URL to redirect to when an error occurs, instead of showing the default error page.

PagesGuardianMfa
, PagesGuardianMfaArgs

Enabled This property is required. bool
Indicates whether to use the custom Guardian MFA HTML (true) or the default Auth0 page (false).
Html This property is required. string
Customized content for the Guardian MFA page. HTML format with supported Liquid syntax.
Enabled This property is required. bool
Indicates whether to use the custom Guardian MFA HTML (true) or the default Auth0 page (false).
Html This property is required. string
Customized content for the Guardian MFA page. HTML format with supported Liquid syntax.
enabled This property is required. Boolean
Indicates whether to use the custom Guardian MFA HTML (true) or the default Auth0 page (false).
html This property is required. String
Customized content for the Guardian MFA page. HTML format with supported Liquid syntax.
enabled This property is required. boolean
Indicates whether to use the custom Guardian MFA HTML (true) or the default Auth0 page (false).
html This property is required. string
Customized content for the Guardian MFA page. HTML format with supported Liquid syntax.
enabled This property is required. bool
Indicates whether to use the custom Guardian MFA HTML (true) or the default Auth0 page (false).
html This property is required. str
Customized content for the Guardian MFA page. HTML format with supported Liquid syntax.
enabled This property is required. Boolean
Indicates whether to use the custom Guardian MFA HTML (true) or the default Auth0 page (false).
html This property is required. String
Customized content for the Guardian MFA page. HTML format with supported Liquid syntax.

PagesLogin
, PagesLoginArgs

Enabled This property is required. bool
Indicates whether to use the custom Login page HTML (true) or the default Auth0 page (false).
Html This property is required. string
Customized content for the Login page. HTML format with supported Liquid syntax.
Enabled This property is required. bool
Indicates whether to use the custom Login page HTML (true) or the default Auth0 page (false).
Html This property is required. string
Customized content for the Login page. HTML format with supported Liquid syntax.
enabled This property is required. Boolean
Indicates whether to use the custom Login page HTML (true) or the default Auth0 page (false).
html This property is required. String
Customized content for the Login page. HTML format with supported Liquid syntax.
enabled This property is required. boolean
Indicates whether to use the custom Login page HTML (true) or the default Auth0 page (false).
html This property is required. string
Customized content for the Login page. HTML format with supported Liquid syntax.
enabled This property is required. bool
Indicates whether to use the custom Login page HTML (true) or the default Auth0 page (false).
html This property is required. str
Customized content for the Login page. HTML format with supported Liquid syntax.
enabled This property is required. Boolean
Indicates whether to use the custom Login page HTML (true) or the default Auth0 page (false).
html This property is required. String
Customized content for the Login page. HTML format with supported Liquid syntax.

Import

As this is not a resource identifiable by an ID within the Auth0 Management API,

pages can be imported using a random string.

We recommend Version 4 UUID

Example:

$ pulumi import auth0:index/pages:Pages my_pages "22f4f21b-017a-319d-92e7-2291c1ca36c4"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Auth0 pulumi/pulumi-auth0
License
Apache-2.0
Notes
This Pulumi package is based on the auth0 Terraform Provider.
Auth0 v3.17.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-auth0