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

auth0.Prompt

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 your Auth0 prompts, including choosing the login experience version.

    Example Usage

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

const myPrompt = new auth0.Prompt("my_prompt", {
    universalLoginExperience: "new",
    identifierFirst: false,
    webauthnPlatformFirstFactor: true,
});

    import pulumi
import pulumi_auth0 as auth0

my_prompt = auth0.Prompt("my_prompt",
    universal_login_experience="new",
    identifier_first=False,
    webauthn_platform_first_factor=True)

    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.NewPrompt(ctx, "my_prompt", &auth0.PromptArgs{
			UniversalLoginExperience:    pulumi.String("new"),
			IdentifierFirst:             pulumi.Bool(false),
			WebauthnPlatformFirstFactor: pulumi.Bool(true),
		})
		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 myPrompt = new Auth0.Prompt("my_prompt", new()
    {
        UniversalLoginExperience = "new",
        IdentifierFirst = false,
        WebauthnPlatformFirstFactor = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.Prompt;
import com.pulumi.auth0.PromptArgs;
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 myPrompt = new Prompt("myPrompt", PromptArgs.builder()
            .universalLoginExperience("new")
            .identifierFirst(false)
            .webauthnPlatformFirstFactor(true)
            .build());

    }
}

    resources:
  myPrompt:
    type: auth0:Prompt
    name: my_prompt
    properties:
      universalLoginExperience: new
      identifierFirst: false
      webauthnPlatformFirstFactor: true

    Create Prompt Resource

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

    Constructor syntax

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

@overload
def Prompt(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           identifier_first: Optional[bool] = None,
           universal_login_experience: Optional[str] = None,
           webauthn_platform_first_factor: Optional[bool] = None)
    func NewPrompt(ctx *Context, name string, args *PromptArgs, opts ...ResourceOption) (*Prompt, error)
    public Prompt(string name, PromptArgs? args = null, CustomResourceOptions? opts = null)
    public Prompt(String name, PromptArgs args)
public Prompt(String name, PromptArgs args, CustomResourceOptions options)

    type: auth0:Prompt
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 PromptArgs
    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 PromptArgs
    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 PromptArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PromptArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PromptArgs
    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 promptResource = new Auth0.Prompt("promptResource", new()
{
    IdentifierFirst = false,
    UniversalLoginExperience = "string",
    WebauthnPlatformFirstFactor = false,
});

    example, err := auth0.NewPrompt(ctx, "promptResource", &auth0.PromptArgs{
	IdentifierFirst:             pulumi.Bool(false),
	UniversalLoginExperience:    pulumi.String("string"),
	WebauthnPlatformFirstFactor: pulumi.Bool(false),
})

    var promptResource = new Prompt("promptResource", PromptArgs.builder()
    .identifierFirst(false)
    .universalLoginExperience("string")
    .webauthnPlatformFirstFactor(false)
    .build());

    prompt_resource = auth0.Prompt("promptResource",
    identifier_first=False,
    universal_login_experience="string",
    webauthn_platform_first_factor=False)

    const promptResource = new auth0.Prompt("promptResource", {
    identifierFirst: false,
    universalLoginExperience: "string",
    webauthnPlatformFirstFactor: false,
});

    type: auth0:Prompt
properties:
    identifierFirst: false
    universalLoginExperience: string
    webauthnPlatformFirstFactor: false

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

    IdentifierFirst bool
    Indicates whether the identifier first is used when using the new Universal Login experience.
    UniversalLoginExperience string
    Which login experience to use. Options include classic and new.
    WebauthnPlatformFirstFactor bool
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.
    IdentifierFirst bool
    Indicates whether the identifier first is used when using the new Universal Login experience.
    UniversalLoginExperience string
    Which login experience to use. Options include classic and new.
    WebauthnPlatformFirstFactor bool
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.
    identifierFirst Boolean
    Indicates whether the identifier first is used when using the new Universal Login experience.
    universalLoginExperience String
    Which login experience to use. Options include classic and new.
    webauthnPlatformFirstFactor Boolean
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.
    identifierFirst boolean
    Indicates whether the identifier first is used when using the new Universal Login experience.
    universalLoginExperience string
    Which login experience to use. Options include classic and new.
    webauthnPlatformFirstFactor boolean
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.
    identifier_first bool
    Indicates whether the identifier first is used when using the new Universal Login experience.
    universal_login_experience str
    Which login experience to use. Options include classic and new.
    webauthn_platform_first_factor bool
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.
    identifierFirst Boolean
    Indicates whether the identifier first is used when using the new Universal Login experience.
    universalLoginExperience String
    Which login experience to use. Options include classic and new.
    webauthnPlatformFirstFactor Boolean
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.

    Outputs

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

    Get an existing Prompt 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?: PromptState, opts?: CustomResourceOptions): Prompt
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        identifier_first: Optional[bool] = None,
        universal_login_experience: Optional[str] = None,
        webauthn_platform_first_factor: Optional[bool] = None) -> Prompt
    func GetPrompt(ctx *Context, name string, id IDInput, state *PromptState, opts ...ResourceOption) (*Prompt, error)
    public static Prompt Get(string name, Input<string> id, PromptState? state, CustomResourceOptions? opts = null)
    public static Prompt get(String name, Output<String> id, PromptState 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:
    IdentifierFirst bool
    Indicates whether the identifier first is used when using the new Universal Login experience.
    UniversalLoginExperience string
    Which login experience to use. Options include classic and new.
    WebauthnPlatformFirstFactor bool
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.
    IdentifierFirst bool
    Indicates whether the identifier first is used when using the new Universal Login experience.
    UniversalLoginExperience string
    Which login experience to use. Options include classic and new.
    WebauthnPlatformFirstFactor bool
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.
    identifierFirst Boolean
    Indicates whether the identifier first is used when using the new Universal Login experience.
    universalLoginExperience String
    Which login experience to use. Options include classic and new.
    webauthnPlatformFirstFactor Boolean
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.
    identifierFirst boolean
    Indicates whether the identifier first is used when using the new Universal Login experience.
    universalLoginExperience string
    Which login experience to use. Options include classic and new.
    webauthnPlatformFirstFactor boolean
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.
    identifier_first bool
    Indicates whether the identifier first is used when using the new Universal Login experience.
    universal_login_experience str
    Which login experience to use. Options include classic and new.
    webauthn_platform_first_factor bool
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.
    identifierFirst Boolean
    Indicates whether the identifier first is used when using the new Universal Login experience.
    universalLoginExperience String
    Which login experience to use. Options include classic and new.
    webauthnPlatformFirstFactor Boolean
    Determines if the login screen uses identifier and biometrics first. Setting this property to true, requires MFA factors enabled for enrollment; use the auth0.Guardian resource to set one up.

    Import

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

    prompts can be imported using a random string.

    We recommend Version 4 UUID

    Example:

    $ pulumi import auth0:index/prompt:Prompt my_prompt "22f4f21b-017a-319d-92e7-2291c1ca36c4"

    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