1. Packages
  2. Auth0 Provider
  3. API Docs
  4. PromptScreenRenderer
Auth0 v3.16.0 published on Wednesday, Mar 12, 2025 by Pulumi

auth0.PromptScreenRenderer

Explore with Pulumi AI

auth0 logo
Auth0 v3.16.0 published on Wednesday, Mar 12, 2025 by Pulumi

    With this resource, you can Configure the render settings for a specific screen.You can read more about this here.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    const promptScreenRenderer = new auth0.PromptScreenRenderer("prompt_screen_renderer", {
        promptType: "login-id",
        screenName: "login-id",
        renderingMode: "advanced",
        defaultHeadTagsDisabled: false,
        contextConfigurations: [
            "branding.settings",
            "branding.themes.default",
            "client.logo_uri",
            "client.description",
            "client.metadata.key",
            "organization.display_name",
            "organization.branding",
            "organization.metadata.key",
            "screen.texts",
            "tenant.name",
            "tenant.friendly_name",
            "tenant.enabled_locales",
            "untrusted_data.submitted_form_data",
            "untrusted_data.authorization_params.login_hint",
            "untrusted_data.authorization_params.screen_hint",
            "untrusted_data.authorization_params.ui_locales",
            "untrusted_data.authorization_params.ext-key",
        ],
        headTags: JSON.stringify([{
            attributes: {
                async: true,
                defer: true,
                integrity: ["sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g=="],
                src: "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js",
            },
            tag: "script",
        }]),
    });
    
    import pulumi
    import json
    import pulumi_auth0 as auth0
    
    prompt_screen_renderer = auth0.PromptScreenRenderer("prompt_screen_renderer",
        prompt_type="login-id",
        screen_name="login-id",
        rendering_mode="advanced",
        default_head_tags_disabled=False,
        context_configurations=[
            "branding.settings",
            "branding.themes.default",
            "client.logo_uri",
            "client.description",
            "client.metadata.key",
            "organization.display_name",
            "organization.branding",
            "organization.metadata.key",
            "screen.texts",
            "tenant.name",
            "tenant.friendly_name",
            "tenant.enabled_locales",
            "untrusted_data.submitted_form_data",
            "untrusted_data.authorization_params.login_hint",
            "untrusted_data.authorization_params.screen_hint",
            "untrusted_data.authorization_params.ui_locales",
            "untrusted_data.authorization_params.ext-key",
        ],
        head_tags=json.dumps([{
            "attributes": {
                "async": True,
                "defer": True,
                "integrity": ["sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g=="],
                "src": "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js",
            },
            "tag": "script",
        }]))
    
    package main
    
    import (
    	"encoding/json"
    
    	"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 {
    		tmpJSON0, err := json.Marshal([]map[string]interface{}{
    			map[string]interface{}{
    				"attributes": map[string]interface{}{
    					"async": true,
    					"defer": true,
    					"integrity": []string{
    						"sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==",
    					},
    					"src": "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js",
    				},
    				"tag": "script",
    			},
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		_, err = auth0.NewPromptScreenRenderer(ctx, "prompt_screen_renderer", &auth0.PromptScreenRendererArgs{
    			PromptType:              pulumi.String("login-id"),
    			ScreenName:              pulumi.String("login-id"),
    			RenderingMode:           pulumi.String("advanced"),
    			DefaultHeadTagsDisabled: pulumi.Bool(false),
    			ContextConfigurations: pulumi.StringArray{
    				pulumi.String("branding.settings"),
    				pulumi.String("branding.themes.default"),
    				pulumi.String("client.logo_uri"),
    				pulumi.String("client.description"),
    				pulumi.String("client.metadata.key"),
    				pulumi.String("organization.display_name"),
    				pulumi.String("organization.branding"),
    				pulumi.String("organization.metadata.key"),
    				pulumi.String("screen.texts"),
    				pulumi.String("tenant.name"),
    				pulumi.String("tenant.friendly_name"),
    				pulumi.String("tenant.enabled_locales"),
    				pulumi.String("untrusted_data.submitted_form_data"),
    				pulumi.String("untrusted_data.authorization_params.login_hint"),
    				pulumi.String("untrusted_data.authorization_params.screen_hint"),
    				pulumi.String("untrusted_data.authorization_params.ui_locales"),
    				pulumi.String("untrusted_data.authorization_params.ext-key"),
    			},
    			HeadTags: pulumi.String(json0),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Auth0 = Pulumi.Auth0;
    
    return await Deployment.RunAsync(() => 
    {
        var promptScreenRenderer = new Auth0.PromptScreenRenderer("prompt_screen_renderer", new()
        {
            PromptType = "login-id",
            ScreenName = "login-id",
            RenderingMode = "advanced",
            DefaultHeadTagsDisabled = false,
            ContextConfigurations = new[]
            {
                "branding.settings",
                "branding.themes.default",
                "client.logo_uri",
                "client.description",
                "client.metadata.key",
                "organization.display_name",
                "organization.branding",
                "organization.metadata.key",
                "screen.texts",
                "tenant.name",
                "tenant.friendly_name",
                "tenant.enabled_locales",
                "untrusted_data.submitted_form_data",
                "untrusted_data.authorization_params.login_hint",
                "untrusted_data.authorization_params.screen_hint",
                "untrusted_data.authorization_params.ui_locales",
                "untrusted_data.authorization_params.ext-key",
            },
            HeadTags = JsonSerializer.Serialize(new[]
            {
                new Dictionary<string, object?>
                {
                    ["attributes"] = new Dictionary<string, object?>
                    {
                        ["async"] = true,
                        ["defer"] = true,
                        ["integrity"] = new[]
                        {
                            "sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==",
                        },
                        ["src"] = "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js",
                    },
                    ["tag"] = "script",
                },
            }),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.auth0.PromptScreenRenderer;
    import com.pulumi.auth0.PromptScreenRendererArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    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 promptScreenRenderer = new PromptScreenRenderer("promptScreenRenderer", PromptScreenRendererArgs.builder()
                .promptType("login-id")
                .screenName("login-id")
                .renderingMode("advanced")
                .defaultHeadTagsDisabled(false)
                .contextConfigurations(            
                    "branding.settings",
                    "branding.themes.default",
                    "client.logo_uri",
                    "client.description",
                    "client.metadata.key",
                    "organization.display_name",
                    "organization.branding",
                    "organization.metadata.key",
                    "screen.texts",
                    "tenant.name",
                    "tenant.friendly_name",
                    "tenant.enabled_locales",
                    "untrusted_data.submitted_form_data",
                    "untrusted_data.authorization_params.login_hint",
                    "untrusted_data.authorization_params.screen_hint",
                    "untrusted_data.authorization_params.ui_locales",
                    "untrusted_data.authorization_params.ext-key")
                .headTags(serializeJson(
                    jsonArray(jsonObject(
                        jsonProperty("attributes", jsonObject(
                            jsonProperty("async", true),
                            jsonProperty("defer", true),
                            jsonProperty("integrity", jsonArray("sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==")),
                            jsonProperty("src", "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js")
                        )),
                        jsonProperty("tag", "script")
                    ))))
                .build());
    
        }
    }
    
    resources:
      promptScreenRenderer:
        type: auth0:PromptScreenRenderer
        name: prompt_screen_renderer
        properties:
          promptType: login-id
          screenName: login-id
          renderingMode: advanced
          defaultHeadTagsDisabled: false
          contextConfigurations:
            - branding.settings
            - branding.themes.default
            - client.logo_uri
            - client.description
            - client.metadata.key
            - organization.display_name
            - organization.branding
            - organization.metadata.key
            - screen.texts
            - tenant.name
            - tenant.friendly_name
            - tenant.enabled_locales
            - untrusted_data.submitted_form_data
            - untrusted_data.authorization_params.login_hint
            - untrusted_data.authorization_params.screen_hint
            - untrusted_data.authorization_params.ui_locales
            - untrusted_data.authorization_params.ext-key
          headTags:
            fn::toJSON:
              - attributes:
                  async: true
                  defer: true
                  integrity:
                    - sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==
                  src: https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js
                tag: script
    

    Create PromptScreenRenderer Resource

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

    Constructor syntax

    new PromptScreenRenderer(name: string, args: PromptScreenRendererArgs, opts?: CustomResourceOptions);
    @overload
    def PromptScreenRenderer(resource_name: str,
                             args: PromptScreenRendererArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def PromptScreenRenderer(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             prompt_type: Optional[str] = None,
                             screen_name: Optional[str] = None,
                             context_configurations: Optional[Sequence[str]] = None,
                             default_head_tags_disabled: Optional[bool] = None,
                             head_tags: Optional[str] = None,
                             rendering_mode: Optional[str] = None)
    func NewPromptScreenRenderer(ctx *Context, name string, args PromptScreenRendererArgs, opts ...ResourceOption) (*PromptScreenRenderer, error)
    public PromptScreenRenderer(string name, PromptScreenRendererArgs args, CustomResourceOptions? opts = null)
    public PromptScreenRenderer(String name, PromptScreenRendererArgs args)
    public PromptScreenRenderer(String name, PromptScreenRendererArgs args, CustomResourceOptions options)
    
    type: auth0:PromptScreenRenderer
    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 PromptScreenRendererArgs
    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 PromptScreenRendererArgs
    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 PromptScreenRendererArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PromptScreenRendererArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PromptScreenRendererArgs
    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 promptScreenRendererResource = new Auth0.PromptScreenRenderer("promptScreenRendererResource", new()
    {
        PromptType = "string",
        ScreenName = "string",
        ContextConfigurations = new[]
        {
            "string",
        },
        DefaultHeadTagsDisabled = false,
        HeadTags = "string",
        RenderingMode = "string",
    });
    
    example, err := auth0.NewPromptScreenRenderer(ctx, "promptScreenRendererResource", &auth0.PromptScreenRendererArgs{
    	PromptType: pulumi.String("string"),
    	ScreenName: pulumi.String("string"),
    	ContextConfigurations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DefaultHeadTagsDisabled: pulumi.Bool(false),
    	HeadTags:                pulumi.String("string"),
    	RenderingMode:           pulumi.String("string"),
    })
    
    var promptScreenRendererResource = new PromptScreenRenderer("promptScreenRendererResource", PromptScreenRendererArgs.builder()
        .promptType("string")
        .screenName("string")
        .contextConfigurations("string")
        .defaultHeadTagsDisabled(false)
        .headTags("string")
        .renderingMode("string")
        .build());
    
    prompt_screen_renderer_resource = auth0.PromptScreenRenderer("promptScreenRendererResource",
        prompt_type="string",
        screen_name="string",
        context_configurations=["string"],
        default_head_tags_disabled=False,
        head_tags="string",
        rendering_mode="string")
    
    const promptScreenRendererResource = new auth0.PromptScreenRenderer("promptScreenRendererResource", {
        promptType: "string",
        screenName: "string",
        contextConfigurations: ["string"],
        defaultHeadTagsDisabled: false,
        headTags: "string",
        renderingMode: "string",
    });
    
    type: auth0:PromptScreenRenderer
    properties:
        contextConfigurations:
            - string
        defaultHeadTagsDisabled: false
        headTags: string
        promptType: string
        renderingMode: string
        screenName: string
    

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

    PromptType string
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    ScreenName string
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    ContextConfigurations List<string>
    Context values to make available
    DefaultHeadTagsDisabled bool
    Override Universal Login default head tags
    HeadTags string
    An array of head tags
    RenderingMode string
    Rendering modeOptions are: standard, advanced.
    PromptType string
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    ScreenName string
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    ContextConfigurations []string
    Context values to make available
    DefaultHeadTagsDisabled bool
    Override Universal Login default head tags
    HeadTags string
    An array of head tags
    RenderingMode string
    Rendering modeOptions are: standard, advanced.
    promptType String
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    screenName String
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    contextConfigurations List<String>
    Context values to make available
    defaultHeadTagsDisabled Boolean
    Override Universal Login default head tags
    headTags String
    An array of head tags
    renderingMode String
    Rendering modeOptions are: standard, advanced.
    promptType string
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    screenName string
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    contextConfigurations string[]
    Context values to make available
    defaultHeadTagsDisabled boolean
    Override Universal Login default head tags
    headTags string
    An array of head tags
    renderingMode string
    Rendering modeOptions are: standard, advanced.
    prompt_type str
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    screen_name str
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    context_configurations Sequence[str]
    Context values to make available
    default_head_tags_disabled bool
    Override Universal Login default head tags
    head_tags str
    An array of head tags
    rendering_mode str
    Rendering modeOptions are: standard, advanced.
    promptType String
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    screenName String
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    contextConfigurations List<String>
    Context values to make available
    defaultHeadTagsDisabled Boolean
    Override Universal Login default head tags
    headTags String
    An array of head tags
    renderingMode String
    Rendering modeOptions are: standard, advanced.

    Outputs

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

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

    Look up Existing PromptScreenRenderer Resource

    Get an existing PromptScreenRenderer 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?: PromptScreenRendererState, opts?: CustomResourceOptions): PromptScreenRenderer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            context_configurations: Optional[Sequence[str]] = None,
            default_head_tags_disabled: Optional[bool] = None,
            head_tags: Optional[str] = None,
            prompt_type: Optional[str] = None,
            rendering_mode: Optional[str] = None,
            screen_name: Optional[str] = None,
            tenant: Optional[str] = None) -> PromptScreenRenderer
    func GetPromptScreenRenderer(ctx *Context, name string, id IDInput, state *PromptScreenRendererState, opts ...ResourceOption) (*PromptScreenRenderer, error)
    public static PromptScreenRenderer Get(string name, Input<string> id, PromptScreenRendererState? state, CustomResourceOptions? opts = null)
    public static PromptScreenRenderer get(String name, Output<String> id, PromptScreenRendererState state, CustomResourceOptions options)
    resources:  _:    type: auth0:PromptScreenRenderer    get:      id: ${id}
    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:
    ContextConfigurations List<string>
    Context values to make available
    DefaultHeadTagsDisabled bool
    Override Universal Login default head tags
    HeadTags string
    An array of head tags
    PromptType string
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    RenderingMode string
    Rendering modeOptions are: standard, advanced.
    ScreenName string
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    Tenant string
    Tenant ID
    ContextConfigurations []string
    Context values to make available
    DefaultHeadTagsDisabled bool
    Override Universal Login default head tags
    HeadTags string
    An array of head tags
    PromptType string
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    RenderingMode string
    Rendering modeOptions are: standard, advanced.
    ScreenName string
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    Tenant string
    Tenant ID
    contextConfigurations List<String>
    Context values to make available
    defaultHeadTagsDisabled Boolean
    Override Universal Login default head tags
    headTags String
    An array of head tags
    promptType String
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    renderingMode String
    Rendering modeOptions are: standard, advanced.
    screenName String
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    tenant String
    Tenant ID
    contextConfigurations string[]
    Context values to make available
    defaultHeadTagsDisabled boolean
    Override Universal Login default head tags
    headTags string
    An array of head tags
    promptType string
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    renderingMode string
    Rendering modeOptions are: standard, advanced.
    screenName string
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    tenant string
    Tenant ID
    context_configurations Sequence[str]
    Context values to make available
    default_head_tags_disabled bool
    Override Universal Login default head tags
    head_tags str
    An array of head tags
    prompt_type str
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    rendering_mode str
    Rendering modeOptions are: standard, advanced.
    screen_name str
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    tenant str
    Tenant ID
    contextConfigurations List<String>
    Context values to make available
    defaultHeadTagsDisabled Boolean
    Override Universal Login default head tags
    headTags String
    An array of head tags
    promptType String
    The prompt that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkeys, captcha, login, signup, reset-password, mfa, mfa-sms, mfa-email, mfa-push.
    renderingMode String
    Rendering modeOptions are: standard, advanced.
    screenName String
    The screen that you are configuring settings for. Options are: signup-id, signup-password, login-id, login-password, login-passwordless-sms-otp, login-passwordless-email-code, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, passkey-enrollment, passkey-enrollment-local, interstitial-captcha, login, signup, reset-password-request, reset-password-email, reset-password, reset-password-success, reset-password-error, mfa-detect-browser-capabilities, mfa-enroll-result, mfa-begin-enroll-options, mfa-login-options, mfa-country-codes, mfa-sms-challenge, mfa-sms-enrollment, mfa-sms-list, mfa-email-challenge, mfa-email-list, mfa-push-challenge-push, mfa-push-enrollment-qr, mfa-push-list, mfa-push-welcome.
    tenant String
    Tenant ID

    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/promptScreenRenderer:PromptScreenRenderer auth0_prompt_screen_renderer "login-id:login-id"
    

    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.16.0 published on Wednesday, Mar 12, 2025 by Pulumi