Auth0

Pulumi Official
Package maintained by Pulumi
v2.9.0 published on Thursday, May 26, 2022 by Pulumi

PromptCustomText

With this resource, you can manage custom text on your Auth0 prompts. You can read more about custom texts here.

Example Usage

using System.Collections.Generic;
using System.Text.Json;
using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Auth0.PromptCustomText("example", new Auth0.PromptCustomTextArgs
        {
            Prompt = "login",
            Language = "en",
            Body = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                { "login", new Dictionary<string, object?>
                {
                    { "alertListTitle", "Alerts" },
                    { "buttonText", "Continue" },
                    { "description", "Login to" },
                    { "editEmailText", "Edit" },
                    { "emailPlaceholder", "Email address" },
                    { "federatedConnectionButtonText", $"Continue with {connectionName}" },
                    { "footerLinkText", "Sign up" },
                    { "footerText", "Don't have an account?" },
                    { "forgotPasswordText", "Forgot password?" },
                    { "invitationDescription", $"Log in to accept {inviterName}'s invitation to join {companyName} on {clientName}." },
                    { "invitationTitle", "You've Been Invited!" },
                    { "logoAltText", companyName },
                    { "pageTitle", $"Log in | {clientName}" },
                    { "passwordPlaceholder", "Password" },
                    { "separatorText", "Or" },
                    { "signupActionLinkText", footerLinkText },
                    { "signupActionText", footerText },
                    { "title", "Welcome" },
                    { "usernamePlaceholder", "Username or email address" },
                } },
            }),
        });
    }

}
package main

import (
	"encoding/json"
	"fmt"

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"login": map[string]interface{}{
				"alertListTitle":                "Alerts",
				"buttonText":                    "Continue",
				"description":                   "Login to",
				"editEmailText":                 "Edit",
				"emailPlaceholder":              "Email address",
				"federatedConnectionButtonText": fmt.Sprintf("%v%v", "Continue with ", connectionName),
				"footerLinkText":                "Sign up",
				"footerText":                    "Don't have an account?",
				"forgotPasswordText":            "Forgot password?",
				"invitationDescription":         fmt.Sprintf("%v%v%v%v%v%v%v", "Log in to accept ", inviterName, "'s invitation to join ", companyName, " on ", clientName, "."),
				"invitationTitle":               "You've Been Invited!",
				"logoAltText":                   companyName,
				"pageTitle":                     fmt.Sprintf("%v%v", "Log in | ", clientName),
				"passwordPlaceholder":           "Password",
				"separatorText":                 "Or",
				"signupActionLinkText":          footerLinkText,
				"signupActionText":              footerText,
				"title":                         "Welcome",
				"usernamePlaceholder":           "Username or email address",
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err := auth0.NewPromptCustomText(ctx, "example", &auth0.PromptCustomTextArgs{
			Prompt:   pulumi.String("login"),
			Language: pulumi.String("en"),
			Body:     pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
import static com.pulumi.codegen.internal.Serialization.*;

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

    public static void stack(Context ctx) {
        var example = new PromptCustomText("example", PromptCustomTextArgs.builder()        
            .prompt("login")
            .language("en")
            .body(serializeJson(
                jsonObject(
                    jsonProperty("login", jsonObject(
                        jsonProperty("alertListTitle", "Alerts"),
                        jsonProperty("buttonText", "Continue"),
                        jsonProperty("description", "Login to"),
                        jsonProperty("editEmailText", "Edit"),
                        jsonProperty("emailPlaceholder", "Email address"),
                        jsonProperty("federatedConnectionButtonText", String.format("Continue with %s", connectionName)),
                        jsonProperty("footerLinkText", "Sign up"),
                        jsonProperty("footerText", "Don't have an account?"),
                        jsonProperty("forgotPasswordText", "Forgot password?"),
                        jsonProperty("invitationDescription", String.format("Log in to accept %s's invitation to join %s on %s.", inviterName,companyName,clientName)),
                        jsonProperty("invitationTitle", "You've Been Invited!"),
                        jsonProperty("logoAltText", companyName),
                        jsonProperty("pageTitle", String.format("Log in | %s", clientName)),
                        jsonProperty("passwordPlaceholder", "Password"),
                        jsonProperty("separatorText", "Or"),
                        jsonProperty("signupActionLinkText", footerLinkText),
                        jsonProperty("signupActionText", footerText),
                        jsonProperty("title", "Welcome"),
                        jsonProperty("usernamePlaceholder", "Username or email address")
                    ))
                )))
            .build());

    }
}
import pulumi
import json
import pulumi_auth0 as auth0

example = auth0.PromptCustomText("example",
    prompt="login",
    language="en",
    body=json.dumps({
        "login": {
            "alertListTitle": "Alerts",
            "buttonText": "Continue",
            "description": "Login to",
            "editEmailText": "Edit",
            "emailPlaceholder": "Email address",
            "federatedConnectionButtonText": f"Continue with {connection_name}",
            "footerLinkText": "Sign up",
            "footerText": "Don't have an account?",
            "forgotPasswordText": "Forgot password?",
            "invitationDescription": f"Log in to accept {inviter_name}'s invitation to join {company_name} on {client_name}.",
            "invitationTitle": "You've Been Invited!",
            "logoAltText": company_name,
            "pageTitle": f"Log in | {client_name}",
            "passwordPlaceholder": "Password",
            "separatorText": "Or",
            "signupActionLinkText": footer_link_text,
            "signupActionText": footer_text,
            "title": "Welcome",
            "usernamePlaceholder": "Username or email address",
        },
    }))
import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

const example = new auth0.PromptCustomText("example", {
    prompt: "login",
    language: "en",
    body: JSON.stringify({
        login: {
            alertListTitle: "Alerts",
            buttonText: "Continue",
            description: "Login to",
            editEmailText: "Edit",
            emailPlaceholder: "Email address",
            federatedConnectionButtonText: `Continue with ${connectionName}`,
            footerLinkText: "Sign up",
            footerText: "Don't have an account?",
            forgotPasswordText: "Forgot password?",
            invitationDescription: `Log in to accept ${inviterName}'s invitation to join ${companyName} on ${clientName}.`,
            invitationTitle: "You've Been Invited!",
            logoAltText: companyName,
            pageTitle: `Log in | ${clientName}`,
            passwordPlaceholder: "Password",
            separatorText: "Or",
            signupActionLinkText: footerLinkText,
            signupActionText: footerText,
            title: "Welcome",
            usernamePlaceholder: "Username or email address",
        },
    }),
});
resources:
  example:
    type: auth0:PromptCustomText
    properties:
      prompt: login
      language: en
      body:
        Fn::ToJSON:
          login:
            alertListTitle: Alerts
            buttonText: Continue
            description: Login to
            editEmailText: Edit
            emailPlaceholder: Email address
            federatedConnectionButtonText: Continue with ${connectionName}
            footerLinkText: Sign up
            footerText: Don't have an account?
            forgotPasswordText: Forgot password?
            invitationDescription: Log in to accept ${inviterName}'s invitation to join ${companyName} on ${clientName}.
            invitationTitle: You've Been Invited!
            logoAltText: ${companyName}
            pageTitle: Log in | ${clientName}
            passwordPlaceholder: Password
            separatorText: Or
            signupActionLinkText: ${footerLinkText}
            signupActionText: ${footerText}
            title: Welcome
            usernamePlaceholder: Username or email address

Create a PromptCustomText Resource

new PromptCustomText(name: string, args: PromptCustomTextArgs, opts?: CustomResourceOptions);
@overload
def PromptCustomText(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     body: Optional[str] = None,
                     language: Optional[str] = None,
                     prompt: Optional[str] = None)
@overload
def PromptCustomText(resource_name: str,
                     args: PromptCustomTextArgs,
                     opts: Optional[ResourceOptions] = None)
func NewPromptCustomText(ctx *Context, name string, args PromptCustomTextArgs, opts ...ResourceOption) (*PromptCustomText, error)
public PromptCustomText(string name, PromptCustomTextArgs args, CustomResourceOptions? opts = null)
public PromptCustomText(String name, PromptCustomTextArgs args)
public PromptCustomText(String name, PromptCustomTextArgs args, CustomResourceOptions options)
type: auth0:PromptCustomText
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

PromptCustomText Resource Properties

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

Inputs

The PromptCustomText resource accepts the following input properties:

Body string

JSON containing the custom texts. You can check the options for each prompt here

Language string

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

Prompt string

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

Body string

JSON containing the custom texts. You can check the options for each prompt here

Language string

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

Prompt string

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

body String

JSON containing the custom texts. You can check the options for each prompt here

language String

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

prompt String

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

body string

JSON containing the custom texts. You can check the options for each prompt here

language string

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

prompt string

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

body str

JSON containing the custom texts. You can check the options for each prompt here

language str

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

prompt str

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

body String

JSON containing the custom texts. You can check the options for each prompt here

language String

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

prompt String

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

Outputs

All input properties are implicitly available as output properties. Additionally, the PromptCustomText 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 an Existing PromptCustomText Resource

Get an existing PromptCustomText 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?: PromptCustomTextState, opts?: CustomResourceOptions): PromptCustomText
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        body: Optional[str] = None,
        language: Optional[str] = None,
        prompt: Optional[str] = None) -> PromptCustomText
func GetPromptCustomText(ctx *Context, name string, id IDInput, state *PromptCustomTextState, opts ...ResourceOption) (*PromptCustomText, error)
public static PromptCustomText Get(string name, Input<string> id, PromptCustomTextState? state, CustomResourceOptions? opts = null)
public static PromptCustomText get(String name, Output<String> id, PromptCustomTextState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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:
Body string

JSON containing the custom texts. You can check the options for each prompt here

Language string

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

Prompt string

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

Body string

JSON containing the custom texts. You can check the options for each prompt here

Language string

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

Prompt string

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

body String

JSON containing the custom texts. You can check the options for each prompt here

language String

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

prompt String

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

body string

JSON containing the custom texts. You can check the options for each prompt here

language string

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

prompt string

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

body str

JSON containing the custom texts. You can check the options for each prompt here

language str

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

prompt str

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

body String

JSON containing the custom texts. You can check the options for each prompt here

language String

Language of the custom text. Options include ar, bg, bs, cs, da, de, el, en, es, et, fi, fr, fr-CA, fr-FR, he, hi, hr, hu, id, is, it, ja, ko, lt, lv, nb, nl, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-TW

prompt String

The term prompt is used to refer to a specific step in the login flow. Options include login, login-id, login-password, login-email-verification, signup, signup-id, signup-password, reset-password, consent, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common

Import

This resource can be imported using the import command and specifying the prompt and language separated by : , e.g.

 $ pulumi import auth0:index/promptCustomText:PromptCustomText example login:en

Package Details

Repository
https://github.com/pulumi/pulumi-auth0
License
Apache-2.0
Notes

This Pulumi package is based on the auth0 Terraform Provider.