Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. PromptScreenPartials
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.PromptScreenPartials

Explore with Pulumi AI

auth0 logo
Auth0 v3.8.3 published on Wednesday, Nov 6, 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.

    !> This resource manages the entire set of prompt screens enabled for a prompt. In contrast, the auth0.PromptScreenPartial resource appends a specific prompt screen to the list of prompt screens displayed to the user during the authentication flow. To avoid potential issues, it is recommended not to use this resource in conjunction with the auth0.PromptScreenPartial resource when managing prompt screens for the same prompt.

    Example Usage

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

const promptScreenPartials = new auth0.PromptScreenPartials("prompt_screen_partials", {
    promptType: "login-passwordless",
    screenPartials: [
        {
            screenName: "login-passwordless-email-code",
            insertionPoints: {
                formContentStart: "<div>Form Content Start</div>",
                formContentEnd: "<div>Form Content End</div>",
            },
        },
        {
            screenName: "login-passwordless-sms-otp",
            insertionPoints: {
                formContentStart: "<div>Form Content Start</div>",
                formContentEnd: "<div>Form Content End</div>",
            },
        },
    ],
});

    import pulumi
import pulumi_auth0 as auth0

prompt_screen_partials = auth0.PromptScreenPartials("prompt_screen_partials",
    prompt_type="login-passwordless",
    screen_partials=[
        {
            "screen_name": "login-passwordless-email-code",
            "insertion_points": {
                "form_content_start": "<div>Form Content Start</div>",
                "form_content_end": "<div>Form Content End</div>",
            },
        },
        {
            "screen_name": "login-passwordless-sms-otp",
            "insertion_points": {
                "form_content_start": "<div>Form Content Start</div>",
                "form_content_end": "<div>Form Content 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.NewPromptScreenPartials(ctx, "prompt_screen_partials", &auth0.PromptScreenPartialsArgs{
			PromptType: pulumi.String("login-passwordless"),
			ScreenPartials: auth0.PromptScreenPartialsScreenPartialArray{
				&auth0.PromptScreenPartialsScreenPartialArgs{
					ScreenName: pulumi.String("login-passwordless-email-code"),
					InsertionPoints: &auth0.PromptScreenPartialsScreenPartialInsertionPointsArgs{
						FormContentStart: pulumi.String("<div>Form Content Start</div>"),
						FormContentEnd:   pulumi.String("<div>Form Content End</div>"),
					},
				},
				&auth0.PromptScreenPartialsScreenPartialArgs{
					ScreenName: pulumi.String("login-passwordless-sms-otp"),
					InsertionPoints: &auth0.PromptScreenPartialsScreenPartialInsertionPointsArgs{
						FormContentStart: pulumi.String("<div>Form Content Start</div>"),
						FormContentEnd:   pulumi.String("<div>Form Content 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 promptScreenPartials = new Auth0.PromptScreenPartials("prompt_screen_partials", new()
    {
        PromptType = "login-passwordless",
        ScreenPartials = new[]
        {
            new Auth0.Inputs.PromptScreenPartialsScreenPartialArgs
            {
                ScreenName = "login-passwordless-email-code",
                InsertionPoints = new Auth0.Inputs.PromptScreenPartialsScreenPartialInsertionPointsArgs
                {
                    FormContentStart = "<div>Form Content Start</div>",
                    FormContentEnd = "<div>Form Content End</div>",
                },
            },
            new Auth0.Inputs.PromptScreenPartialsScreenPartialArgs
            {
                ScreenName = "login-passwordless-sms-otp",
                InsertionPoints = new Auth0.Inputs.PromptScreenPartialsScreenPartialInsertionPointsArgs
                {
                    FormContentStart = "<div>Form Content Start</div>",
                    FormContentEnd = "<div>Form Content End</div>",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.PromptScreenPartials;
import com.pulumi.auth0.PromptScreenPartialsArgs;
import com.pulumi.auth0.inputs.PromptScreenPartialsScreenPartialArgs;
import com.pulumi.auth0.inputs.PromptScreenPartialsScreenPartialInsertionPointsArgs;
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 promptScreenPartials = new PromptScreenPartials("promptScreenPartials", PromptScreenPartialsArgs.builder()
            .promptType("login-passwordless")
            .screenPartials(            
                PromptScreenPartialsScreenPartialArgs.builder()
                    .screenName("login-passwordless-email-code")
                    .insertionPoints(PromptScreenPartialsScreenPartialInsertionPointsArgs.builder()
                        .formContentStart("<div>Form Content Start</div>")
                        .formContentEnd("<div>Form Content End</div>")
                        .build())
                    .build(),
                PromptScreenPartialsScreenPartialArgs.builder()
                    .screenName("login-passwordless-sms-otp")
                    .insertionPoints(PromptScreenPartialsScreenPartialInsertionPointsArgs.builder()
                        .formContentStart("<div>Form Content Start</div>")
                        .formContentEnd("<div>Form Content End</div>")
                        .build())
                    .build())
            .build());

    }
}

    resources:
  promptScreenPartials:
    type: auth0:PromptScreenPartials
    name: prompt_screen_partials
    properties:
      promptType: login-passwordless
      screenPartials:
        - screenName: login-passwordless-email-code
          insertionPoints:
            formContentStart: <div>Form Content Start</div>
            formContentEnd: <div>Form Content End</div>
        - screenName: login-passwordless-sms-otp
          insertionPoints:
            formContentStart: <div>Form Content Start</div>
            formContentEnd: <div>Form Content End</div>

    Create PromptScreenPartials Resource

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

    Constructor syntax

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

@overload
def PromptScreenPartials(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         prompt_type: Optional[str] = None,
                         screen_partials: Optional[Sequence[PromptScreenPartialsScreenPartialArgs]] = None)
    func NewPromptScreenPartials(ctx *Context, name string, args PromptScreenPartialsArgs, opts ...ResourceOption) (*PromptScreenPartials, error)
    public PromptScreenPartials(string name, PromptScreenPartialsArgs args, CustomResourceOptions? opts = null)
    public PromptScreenPartials(String name, PromptScreenPartialsArgs args)
public PromptScreenPartials(String name, PromptScreenPartialsArgs args, CustomResourceOptions options)

    type: auth0:PromptScreenPartials
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 PromptScreenPartialsArgs
    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 PromptScreenPartialsArgs
    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 PromptScreenPartialsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PromptScreenPartialsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PromptScreenPartialsArgs
    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 promptScreenPartialsResource = new Auth0.PromptScreenPartials("promptScreenPartialsResource", new()
{
    PromptType = "string",
    ScreenPartials = new[]
    {
        new Auth0.Inputs.PromptScreenPartialsScreenPartialArgs
        {
            InsertionPoints = new Auth0.Inputs.PromptScreenPartialsScreenPartialInsertionPointsArgs
            {
                FormContentEnd = "string",
                FormContentStart = "string",
                FormFooterEnd = "string",
                FormFooterStart = "string",
                SecondaryActionsEnd = "string",
                SecondaryActionsStart = "string",
            },
            ScreenName = "string",
        },
    },
});

    example, err := auth0.NewPromptScreenPartials(ctx, "promptScreenPartialsResource", &auth0.PromptScreenPartialsArgs{
	PromptType: pulumi.String("string"),
	ScreenPartials: auth0.PromptScreenPartialsScreenPartialArray{
		&auth0.PromptScreenPartialsScreenPartialArgs{
			InsertionPoints: &auth0.PromptScreenPartialsScreenPartialInsertionPointsArgs{
				FormContentEnd:        pulumi.String("string"),
				FormContentStart:      pulumi.String("string"),
				FormFooterEnd:         pulumi.String("string"),
				FormFooterStart:       pulumi.String("string"),
				SecondaryActionsEnd:   pulumi.String("string"),
				SecondaryActionsStart: pulumi.String("string"),
			},
			ScreenName: pulumi.String("string"),
		},
	},
})

    var promptScreenPartialsResource = new PromptScreenPartials("promptScreenPartialsResource", PromptScreenPartialsArgs.builder()
    .promptType("string")
    .screenPartials(PromptScreenPartialsScreenPartialArgs.builder()
        .insertionPoints(PromptScreenPartialsScreenPartialInsertionPointsArgs.builder()
            .formContentEnd("string")
            .formContentStart("string")
            .formFooterEnd("string")
            .formFooterStart("string")
            .secondaryActionsEnd("string")
            .secondaryActionsStart("string")
            .build())
        .screenName("string")
        .build())
    .build());

    prompt_screen_partials_resource = auth0.PromptScreenPartials("promptScreenPartialsResource",
    prompt_type="string",
    screen_partials=[{
        "insertion_points": {
            "form_content_end": "string",
            "form_content_start": "string",
            "form_footer_end": "string",
            "form_footer_start": "string",
            "secondary_actions_end": "string",
            "secondary_actions_start": "string",
        },
        "screen_name": "string",
    }])

    const promptScreenPartialsResource = new auth0.PromptScreenPartials("promptScreenPartialsResource", {
    promptType: "string",
    screenPartials: [{
        insertionPoints: {
            formContentEnd: "string",
            formContentStart: "string",
            formFooterEnd: "string",
            formFooterStart: "string",
            secondaryActionsEnd: "string",
            secondaryActionsStart: "string",
        },
        screenName: "string",
    }],
});

    type: auth0:PromptScreenPartials
properties:
    promptType: string
    screenPartials:
        - insertionPoints:
            formContentEnd: string
            formContentStart: string
            formFooterEnd: string
            formFooterStart: string
            secondaryActionsEnd: string
            secondaryActionsStart: string
          screenName: string

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

    PromptType string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    ScreenPartials List<PromptScreenPartialsScreenPartial>
    PromptType string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    ScreenPartials []PromptScreenPartialsScreenPartialArgs
    promptType String
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    screenPartials List<PromptScreenPartialsScreenPartial>
    promptType string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    screenPartials PromptScreenPartialsScreenPartial[]
    prompt_type str
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    screen_partials Sequence[PromptScreenPartialsScreenPartialArgs]
    promptType String
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    screenPartials List<Property Map>

    Outputs

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

    Get an existing PromptScreenPartials 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?: PromptScreenPartialsState, opts?: CustomResourceOptions): PromptScreenPartials
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        prompt_type: Optional[str] = None,
        screen_partials: Optional[Sequence[PromptScreenPartialsScreenPartialArgs]] = None) -> PromptScreenPartials
    func GetPromptScreenPartials(ctx *Context, name string, id IDInput, state *PromptScreenPartialsState, opts ...ResourceOption) (*PromptScreenPartials, error)
    public static PromptScreenPartials Get(string name, Input<string> id, PromptScreenPartialsState? state, CustomResourceOptions? opts = null)
    public static PromptScreenPartials get(String name, Output<String> id, PromptScreenPartialsState 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:
    PromptType string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    ScreenPartials List<PromptScreenPartialsScreenPartial>
    PromptType string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    ScreenPartials []PromptScreenPartialsScreenPartialArgs
    promptType String
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    screenPartials List<PromptScreenPartialsScreenPartial>
    promptType string
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    screenPartials PromptScreenPartialsScreenPartial[]
    prompt_type str
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    screen_partials Sequence[PromptScreenPartialsScreenPartialArgs]
    promptType String
    The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless.
    screenPartials List<Property Map>

    Supporting Types

    PromptScreenPartialsScreenPartial, PromptScreenPartialsScreenPartialArgs

    InsertionPoints PromptScreenPartialsScreenPartialInsertionPoints
    ScreenName string
    The name of the screen associated with the partials
    InsertionPoints PromptScreenPartialsScreenPartialInsertionPoints
    ScreenName string
    The name of the screen associated with the partials
    insertionPoints PromptScreenPartialsScreenPartialInsertionPoints
    screenName String
    The name of the screen associated with the partials
    insertionPoints PromptScreenPartialsScreenPartialInsertionPoints
    screenName string
    The name of the screen associated with the partials
    insertion_points PromptScreenPartialsScreenPartialInsertionPoints
    screen_name str
    The name of the screen associated with the partials
    insertionPoints Property Map
    screenName String
    The name of the screen associated with the partials

    PromptScreenPartialsScreenPartialInsertionPoints, PromptScreenPartialsScreenPartialInsertionPointsArgs

    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.
    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.
    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.
    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.
    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.
    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.

    Import

    This resource can be imported using the prompt name.

    Example:

    $ pulumi import auth0:index/promptScreenPartials:PromptScreenPartials prompt_screen_partials "login-passwordless"

    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.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
    pulumi/pulumi-auth0