Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. PromptScreenPartial
Auth0 v3.17.1 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-auth0

auth0.PromptScreenPartial

Explore with Pulumi AI

Auth0 v3.17.1 published on Tuesday, Apr 15, 2025 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 appends a specific prompt screen to the list of prompt screens displayed to the user during the authentication flow. In contrast, the auth0.PromptScreenPartials resource manages the complete set of prompt screens that are displayed during the authentication flow. To avoid potential issues, it is recommended not to use this resource in conjunction with the auth0.PromptScreenPartials resource when managing prompt screens for the same prompt.

Example Usage

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

const login = new auth0.PromptScreenPartial("login", {
    promptType: "login",
    screenName: "login",
    insertionPoints: {
        formContentStart: "<div>Form Content Start</div>",
        formContentEnd: "<div>Form Content End</div>",
    },
});
const customized_consent = new auth0.PromptScreenPartial("customized-consent", {
    promptType: "customized-consent",
    screenName: "customized-consent",
    insertionPoints: {
        formContent: "<div>Form Content</div>",
    },
});
Copy
import pulumi
import pulumi_auth0 as auth0

login = auth0.PromptScreenPartial("login",
    prompt_type="login",
    screen_name="login",
    insertion_points={
        "form_content_start": "<div>Form Content Start</div>",
        "form_content_end": "<div>Form Content End</div>",
    })
customized_consent = auth0.PromptScreenPartial("customized-consent",
    prompt_type="customized-consent",
    screen_name="customized-consent",
    insertion_points={
        "form_content": "<div>Form Content</div>",
    })
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.NewPromptScreenPartial(ctx, "login", &auth0.PromptScreenPartialArgs{
			PromptType: pulumi.String("login"),
			ScreenName: pulumi.String("login"),
			InsertionPoints: &auth0.PromptScreenPartialInsertionPointsArgs{
				FormContentStart: pulumi.String("<div>Form Content Start</div>"),
				FormContentEnd:   pulumi.String("<div>Form Content End</div>"),
			},
		})
		if err != nil {
			return err
		}
		_, err = auth0.NewPromptScreenPartial(ctx, "customized-consent", &auth0.PromptScreenPartialArgs{
			PromptType: pulumi.String("customized-consent"),
			ScreenName: pulumi.String("customized-consent"),
			InsertionPoints: &auth0.PromptScreenPartialInsertionPointsArgs{
				FormContent: pulumi.String("<div>Form Content</div>"),
			},
		})
		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 login = new Auth0.PromptScreenPartial("login", new()
    {
        PromptType = "login",
        ScreenName = "login",
        InsertionPoints = new Auth0.Inputs.PromptScreenPartialInsertionPointsArgs
        {
            FormContentStart = "<div>Form Content Start</div>",
            FormContentEnd = "<div>Form Content End</div>",
        },
    });

    var customized_consent = new Auth0.PromptScreenPartial("customized-consent", new()
    {
        PromptType = "customized-consent",
        ScreenName = "customized-consent",
        InsertionPoints = new Auth0.Inputs.PromptScreenPartialInsertionPointsArgs
        {
            FormContent = "<div>Form Content</div>",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.PromptScreenPartial;
import com.pulumi.auth0.PromptScreenPartialArgs;
import com.pulumi.auth0.inputs.PromptScreenPartialInsertionPointsArgs;
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 login = new PromptScreenPartial("login", PromptScreenPartialArgs.builder()
            .promptType("login")
            .screenName("login")
            .insertionPoints(PromptScreenPartialInsertionPointsArgs.builder()
                .formContentStart("<div>Form Content Start</div>")
                .formContentEnd("<div>Form Content End</div>")
                .build())
            .build());

        var customized_consent = new PromptScreenPartial("customized-consent", PromptScreenPartialArgs.builder()
            .promptType("customized-consent")
            .screenName("customized-consent")
            .insertionPoints(PromptScreenPartialInsertionPointsArgs.builder()
                .formContent("<div>Form Content</div>")
                .build())
            .build());

    }
}
Copy
resources:
  login:
    type: auth0:PromptScreenPartial
    properties:
      promptType: login
      screenName: login
      insertionPoints:
        formContentStart: <div>Form Content Start</div>
        formContentEnd: <div>Form Content End</div>
  customized-consent:
    type: auth0:PromptScreenPartial
    properties:
      promptType: customized-consent
      screenName: customized-consent
      insertionPoints:
        formContent: <div>Form Content</div>
Copy

Create PromptScreenPartial Resource

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

Constructor syntax

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

@overload
def PromptScreenPartial(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        prompt_type: Optional[str] = None,
                        screen_name: Optional[str] = None,
                        insertion_points: Optional[PromptScreenPartialInsertionPointsArgs] = None)
func NewPromptScreenPartial(ctx *Context, name string, args PromptScreenPartialArgs, opts ...ResourceOption) (*PromptScreenPartial, error)
public PromptScreenPartial(string name, PromptScreenPartialArgs args, CustomResourceOptions? opts = null)
public PromptScreenPartial(String name, PromptScreenPartialArgs args)
public PromptScreenPartial(String name, PromptScreenPartialArgs args, CustomResourceOptions options)

type: auth0:PromptScreenPartial
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 This property is required. PromptScreenPartialArgs
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 This property is required. PromptScreenPartialArgs
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 This property is required. PromptScreenPartialArgs
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 This property is required. PromptScreenPartialArgs
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. PromptScreenPartialArgs
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 promptScreenPartialResource = new Auth0.PromptScreenPartial("promptScreenPartialResource", new()
{
    PromptType = "string",
    ScreenName = "string",
    InsertionPoints = new Auth0.Inputs.PromptScreenPartialInsertionPointsArgs
    {
        FormContent = "string",
        FormContentEnd = "string",
        FormContentStart = "string",
        FormFooterEnd = "string",
        FormFooterStart = "string",
        SecondaryActionsEnd = "string",
        SecondaryActionsStart = "string",
    },
});
Copy
example, err := auth0.NewPromptScreenPartial(ctx, "promptScreenPartialResource", &auth0.PromptScreenPartialArgs{
	PromptType: pulumi.String("string"),
	ScreenName: pulumi.String("string"),
	InsertionPoints: &auth0.PromptScreenPartialInsertionPointsArgs{
		FormContent:           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"),
	},
})
Copy
var promptScreenPartialResource = new PromptScreenPartial("promptScreenPartialResource", PromptScreenPartialArgs.builder()
    .promptType("string")
    .screenName("string")
    .insertionPoints(PromptScreenPartialInsertionPointsArgs.builder()
        .formContent("string")
        .formContentEnd("string")
        .formContentStart("string")
        .formFooterEnd("string")
        .formFooterStart("string")
        .secondaryActionsEnd("string")
        .secondaryActionsStart("string")
        .build())
    .build());
Copy
prompt_screen_partial_resource = auth0.PromptScreenPartial("promptScreenPartialResource",
    prompt_type="string",
    screen_name="string",
    insertion_points={
        "form_content": "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",
    })
Copy
const promptScreenPartialResource = new auth0.PromptScreenPartial("promptScreenPartialResource", {
    promptType: "string",
    screenName: "string",
    insertionPoints: {
        formContent: "string",
        formContentEnd: "string",
        formContentStart: "string",
        formFooterEnd: "string",
        formFooterStart: "string",
        secondaryActionsEnd: "string",
        secondaryActionsStart: "string",
    },
});
Copy
type: auth0:PromptScreenPartial
properties:
    insertionPoints:
        formContent: string
        formContentEnd: string
        formContentStart: string
        formFooterEnd: string
        formFooterStart: string
        secondaryActionsEnd: string
        secondaryActionsStart: string
    promptType: string
    screenName: string
Copy

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

PromptType This property is required. string
The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless, customized-consent.
ScreenName This property is required. string
The name of the screen associated with the partials
InsertionPoints PromptScreenPartialInsertionPoints
The insertion points for the partials.
PromptType This property is required. string
The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless, customized-consent.
ScreenName This property is required. string
The name of the screen associated with the partials
InsertionPoints PromptScreenPartialInsertionPointsArgs
The insertion points for the partials.
promptType This property is required. String
The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless, customized-consent.
screenName This property is required. String
The name of the screen associated with the partials
insertionPoints PromptScreenPartialInsertionPoints
The insertion points for the partials.
promptType This property is required. string
The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless, customized-consent.
screenName This property is required. string
The name of the screen associated with the partials
insertionPoints PromptScreenPartialInsertionPoints
The insertion points for the partials.
prompt_type This property is required. str
The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless, customized-consent.
screen_name This property is required. str
The name of the screen associated with the partials
insertion_points PromptScreenPartialInsertionPointsArgs
The insertion points for the partials.
promptType This property is required. String
The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless, customized-consent.
screenName This property is required. String
The name of the screen associated with the partials
insertionPoints Property Map
The insertion points for the partials.

Outputs

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

Get an existing PromptScreenPartial 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?: PromptScreenPartialState, opts?: CustomResourceOptions): PromptScreenPartial
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        insertion_points: Optional[PromptScreenPartialInsertionPointsArgs] = None,
        prompt_type: Optional[str] = None,
        screen_name: Optional[str] = None) -> PromptScreenPartial
func GetPromptScreenPartial(ctx *Context, name string, id IDInput, state *PromptScreenPartialState, opts ...ResourceOption) (*PromptScreenPartial, error)
public static PromptScreenPartial Get(string name, Input<string> id, PromptScreenPartialState? state, CustomResourceOptions? opts = null)
public static PromptScreenPartial get(String name, Output<String> id, PromptScreenPartialState state, CustomResourceOptions options)
resources:  _:    type: auth0:PromptScreenPartial    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:
InsertionPoints PromptScreenPartialInsertionPoints
The insertion points for the partials.
PromptType string
The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless, customized-consent.
ScreenName string
The name of the screen associated with the partials
InsertionPoints PromptScreenPartialInsertionPointsArgs
The insertion points for the partials.
PromptType string
The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless, customized-consent.
ScreenName string
The name of the screen associated with the partials
insertionPoints PromptScreenPartialInsertionPoints
The insertion points for the partials.
promptType String
The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless, customized-consent.
screenName String
The name of the screen associated with the partials
insertionPoints PromptScreenPartialInsertionPoints
The insertion points for the partials.
promptType string
The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless, customized-consent.
screenName string
The name of the screen associated with the partials
insertion_points PromptScreenPartialInsertionPointsArgs
The insertion points for the partials.
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, customized-consent.
screen_name str
The name of the screen associated with the partials
insertionPoints Property Map
The insertion points for the partials.
promptType String
The prompt that you are adding partials for. Options are: login-id, login, login-password, signup, signup-id, signup-password, login-passwordless, customized-consent.
screenName String
The name of the screen associated with the partials

Supporting Types

PromptScreenPartialInsertionPoints
, PromptScreenPartialInsertionPointsArgs

FormContent string
Content that goes inside the form
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.
FormContent string
Content that goes inside the form
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.
formContent String
Content that goes inside the form
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.
formContent string
Content that goes inside the form
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 str
Content that goes inside the form
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.
formContent String
Content that goes inside the form
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 and screen_name.

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

login can be imported using the prompt name and screen name using the format:

prompt_name:screen_name

Example:

$ pulumi import auth0:index/promptScreenPartial:PromptScreenPartial login "login:login"
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.1 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-auth0