Docs Packages
  1. Packages
  2. Auth0
  3. API Docs
  4. PromptPartials
Auth0 v3.4.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.PromptPartials

Explore with Pulumi AI

auth0 logo
Auth0 v3.4.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-auth0

    With this resource, you can manage a customized sign up and login experience by adding custom content, form elements and css/javascript. You can read more about this here.

    Example Usage

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

const myLoginPromptPartials = new auth0.PromptPartials("my_login_prompt_partials", {
    prompt: "login",
    formContentStart: "<div>Updated Form Content Start</div>",
    formContentEnd: "<div>Updated Form Content End</div>",
    formFooterStart: "<div>Updated Footer Start</div>",
    formFooterEnd: "<div>Updated Footer End</div>",
    secondaryActionsStart: "<div>Updated Secondary Actions Start</div>",
    secondaryActionsEnd: "<div>Updated Secondary Actions End</div>",
});

    import pulumi
import pulumi_auth0 as auth0

my_login_prompt_partials = auth0.PromptPartials("my_login_prompt_partials",
    prompt="login",
    form_content_start="<div>Updated Form Content Start</div>",
    form_content_end="<div>Updated Form Content End</div>",
    form_footer_start="<div>Updated Footer Start</div>",
    form_footer_end="<div>Updated Footer End</div>",
    secondary_actions_start="<div>Updated Secondary Actions Start</div>",
    secondary_actions_end="<div>Updated Secondary Actions End</div>")

    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.NewPromptPartials(ctx, "my_login_prompt_partials", &auth0.PromptPartialsArgs{
			Prompt:                pulumi.String("login"),
			FormContentStart:      pulumi.String("<div>Updated Form Content Start</div>"),
			FormContentEnd:        pulumi.String("<div>Updated Form Content End</div>"),
			FormFooterStart:       pulumi.String("<div>Updated Footer Start</div>"),
			FormFooterEnd:         pulumi.String("<div>Updated Footer End</div>"),
			SecondaryActionsStart: pulumi.String("<div>Updated Secondary Actions Start</div>"),
			SecondaryActionsEnd:   pulumi.String("<div>Updated Secondary Actions End</div>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var myLoginPromptPartials = new Auth0.PromptPartials("my_login_prompt_partials", new()
    {
        Prompt = "login",
        FormContentStart = "<div>Updated Form Content Start</div>",
        FormContentEnd = "<div>Updated Form Content End</div>",
        FormFooterStart = "<div>Updated Footer Start</div>",
        FormFooterEnd = "<div>Updated Footer End</div>",
        SecondaryActionsStart = "<div>Updated Secondary Actions Start</div>",
        SecondaryActionsEnd = "<div>Updated Secondary Actions End</div>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.PromptPartials;
import com.pulumi.auth0.PromptPartialsArgs;
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 myLoginPromptPartials = new PromptPartials("myLoginPromptPartials", PromptPartialsArgs.builder()
            .prompt("login")
            .formContentStart("<div>Updated Form Content Start</div>")
            .formContentEnd("<div>Updated Form Content End</div>")
            .formFooterStart("<div>Updated Footer Start</div>")
            .formFooterEnd("<div>Updated Footer End</div>")
            .secondaryActionsStart("<div>Updated Secondary Actions Start</div>")
            .secondaryActionsEnd("<div>Updated Secondary Actions End</div>")
            .build());

    }
}

    resources:
  myLoginPromptPartials:
    type: auth0:PromptPartials
    name: my_login_prompt_partials
    properties:
      prompt: login
      formContentStart: <div>Updated Form Content Start</div>
      formContentEnd: <div>Updated Form Content End</div>
      formFooterStart: <div>Updated Footer Start</div>
      formFooterEnd: <div>Updated Footer End</div>
      secondaryActionsStart: <div>Updated Secondary Actions Start</div>
      secondaryActionsEnd: <div>Updated Secondary Actions End</div>

    Create PromptPartials Resource

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

    Constructor syntax

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

@overload
def PromptPartials(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   prompt: Optional[str] = None,
                   form_content_end: Optional[str] = None,
                   form_content_start: Optional[str] = None,
                   form_footer_end: Optional[str] = None,
                   form_footer_start: Optional[str] = None,
                   secondary_actions_end: Optional[str] = None,
                   secondary_actions_start: Optional[str] = None)
    func NewPromptPartials(ctx *Context, name string, args PromptPartialsArgs, opts ...ResourceOption) (*PromptPartials, error)
    public PromptPartials(string name, PromptPartialsArgs args, CustomResourceOptions? opts = null)
    public PromptPartials(String name, PromptPartialsArgs args)
public PromptPartials(String name, PromptPartialsArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args PromptPartialsArgs
    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 PromptPartialsArgs
    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 PromptPartialsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PromptPartialsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PromptPartialsArgs
    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 promptPartialsResource = new Auth0.PromptPartials("promptPartialsResource", new()
{
    Prompt = "string",
    FormContentEnd = "string",
    FormContentStart = "string",
    FormFooterEnd = "string",
    FormFooterStart = "string",
    SecondaryActionsEnd = "string",
    SecondaryActionsStart = "string",
});

    example, err := auth0.NewPromptPartials(ctx, "promptPartialsResource", &auth0.PromptPartialsArgs{
	Prompt:                pulumi.String("string"),
	FormContentEnd:        pulumi.String("string"),
	FormContentStart:      pulumi.String("string"),
	FormFooterEnd:         pulumi.String("string"),
	FormFooterStart:       pulumi.String("string"),
	SecondaryActionsEnd:   pulumi.String("string"),
	SecondaryActionsStart: pulumi.String("string"),
})

    var promptPartialsResource = new PromptPartials("promptPartialsResource", PromptPartialsArgs.builder()
    .prompt("string")
    .formContentEnd("string")
    .formContentStart("string")
    .formFooterEnd("string")
    .formFooterStart("string")
    .secondaryActionsEnd("string")
    .secondaryActionsStart("string")
    .build());

    prompt_partials_resource = auth0.PromptPartials("promptPartialsResource",
    prompt="string",
    form_content_end="string",
    form_content_start="string",
    form_footer_end="string",
    form_footer_start="string",
    secondary_actions_end="string",
    secondary_actions_start="string")

    const promptPartialsResource = new auth0.PromptPartials("promptPartialsResource", {
    prompt: "string",
    formContentEnd: "string",
    formContentStart: "string",
    formFooterEnd: "string",
    formFooterStart: "string",
    secondaryActionsEnd: "string",
    secondaryActionsStart: "string",
});

    type: auth0:PromptPartials
properties:
    formContentEnd: string
    formContentStart: string
    formFooterEnd: string
    formFooterStart: string
    prompt: string
    secondaryActionsEnd: string
    secondaryActionsStart: string

    PromptPartials 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 PromptPartials resource accepts the following input properties:

    Prompt string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    FormContentEnd string
    Content that goes at the end of the form.
    FormContentStart string
    Content that goes at the start of the form.
    FormFooterEnd string
    Footer content for the end of the footer.
    FormFooterStart string
    Footer content for the start of the footer.
    SecondaryActionsEnd string
    Actions that go at the end of secondary actions.
    SecondaryActionsStart string
    Actions that go at the start of secondary actions.
    Prompt string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    FormContentEnd string
    Content that goes at the end of the form.
    FormContentStart string
    Content that goes at the start of the form.
    FormFooterEnd string
    Footer content for the end of the footer.
    FormFooterStart string
    Footer content for the start of the footer.
    SecondaryActionsEnd string
    Actions that go at the end of secondary actions.
    SecondaryActionsStart string
    Actions that go at the start of secondary actions.
    prompt String
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    formContentEnd String
    Content that goes at the end of the form.
    formContentStart String
    Content that goes at the start of the form.
    formFooterEnd String
    Footer content for the end of the footer.
    formFooterStart String
    Footer content for the start of the footer.
    secondaryActionsEnd String
    Actions that go at the end of secondary actions.
    secondaryActionsStart String
    Actions that go at the start of secondary actions.
    prompt string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    formContentEnd string
    Content that goes at the end of the form.
    formContentStart string
    Content that goes at the start of the form.
    formFooterEnd string
    Footer content for the end of the footer.
    formFooterStart string
    Footer content for the start of the footer.
    secondaryActionsEnd string
    Actions that go at the end of secondary actions.
    secondaryActionsStart string
    Actions that go at the start of secondary actions.
    prompt str
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    form_content_end str
    Content that goes at the end of the form.
    form_content_start str
    Content that goes at the start of the form.
    form_footer_end str
    Footer content for the end of the footer.
    form_footer_start str
    Footer content for the start of the footer.
    secondary_actions_end str
    Actions that go at the end of secondary actions.
    secondary_actions_start str
    Actions that go at the start of secondary actions.
    prompt String
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    formContentEnd String
    Content that goes at the end of the form.
    formContentStart String
    Content that goes at the start of the form.
    formFooterEnd String
    Footer content for the end of the footer.
    formFooterStart String
    Footer content for the start of the footer.
    secondaryActionsEnd String
    Actions that go at the end of secondary actions.
    secondaryActionsStart String
    Actions that go at the start of secondary actions.

    Outputs

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

    Get an existing PromptPartials 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?: PromptPartialsState, opts?: CustomResourceOptions): PromptPartials
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        form_content_end: Optional[str] = None,
        form_content_start: Optional[str] = None,
        form_footer_end: Optional[str] = None,
        form_footer_start: Optional[str] = None,
        prompt: Optional[str] = None,
        secondary_actions_end: Optional[str] = None,
        secondary_actions_start: Optional[str] = None) -> PromptPartials
    func GetPromptPartials(ctx *Context, name string, id IDInput, state *PromptPartialsState, opts ...ResourceOption) (*PromptPartials, error)
    public static PromptPartials Get(string name, Input<string> id, PromptPartialsState? state, CustomResourceOptions? opts = null)
    public static PromptPartials get(String name, Output<String> id, PromptPartialsState 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:
    FormContentEnd string
    Content that goes at the end of the form.
    FormContentStart string
    Content that goes at the start of the form.
    FormFooterEnd string
    Footer content for the end of the footer.
    FormFooterStart string
    Footer content for the start of the footer.
    Prompt string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    SecondaryActionsEnd string
    Actions that go at the end of secondary actions.
    SecondaryActionsStart string
    Actions that go at the start of secondary actions.
    FormContentEnd string
    Content that goes at the end of the form.
    FormContentStart string
    Content that goes at the start of the form.
    FormFooterEnd string
    Footer content for the end of the footer.
    FormFooterStart string
    Footer content for the start of the footer.
    Prompt string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    SecondaryActionsEnd string
    Actions that go at the end of secondary actions.
    SecondaryActionsStart string
    Actions that go at the start of secondary actions.
    formContentEnd String
    Content that goes at the end of the form.
    formContentStart String
    Content that goes at the start of the form.
    formFooterEnd String
    Footer content for the end of the footer.
    formFooterStart String
    Footer content for the start of the footer.
    prompt String
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    secondaryActionsEnd String
    Actions that go at the end of secondary actions.
    secondaryActionsStart String
    Actions that go at the start of secondary actions.
    formContentEnd string
    Content that goes at the end of the form.
    formContentStart string
    Content that goes at the start of the form.
    formFooterEnd string
    Footer content for the end of the footer.
    formFooterStart string
    Footer content for the start of the footer.
    prompt string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    secondaryActionsEnd string
    Actions that go at the end of secondary actions.
    secondaryActionsStart string
    Actions that go at the start of secondary actions.
    form_content_end str
    Content that goes at the end of the form.
    form_content_start str
    Content that goes at the start of the form.
    form_footer_end str
    Footer content for the end of the footer.
    form_footer_start str
    Footer content for the start of the footer.
    prompt str
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    secondary_actions_end str
    Actions that go at the end of secondary actions.
    secondary_actions_start str
    Actions that go at the start of secondary actions.
    formContentEnd String
    Content that goes at the end of the form.
    formContentStart String
    Content that goes at the start of the form.
    formFooterEnd String
    Footer content for the end of the footer.
    formFooterStart String
    Footer content for the start of the footer.
    prompt String
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password.
    secondaryActionsEnd String
    Actions that go at the end of secondary actions.
    secondaryActionsStart String
    Actions that go at the start of secondary actions.

    Import

    This resource can be imported using the prompt name.

    Example:

    $ pulumi import auth0:index/promptPartials:PromptPartials my_login_prompt_partials "login"

    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 logo
    Auth0 v3.4.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-auth0