1. Packages
  2. Auth0 Provider
  3. API Docs
  4. Form
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi

auth0.Form

Explore with Pulumi AI

auth0 logo
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi

    With this resource, you can create and manage Forms for a tenant.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    // Example:
    const myForm = new auth0.Form("my_form", {
        name: "My KYC Form",
        start: JSON.stringify({
            coordinates: {
                x: 0,
                y: 0,
            },
            next_node: "step_ggeX",
        }),
        nodes: JSON.stringify([{
            alias: "New step",
            config: {
                components: [
                    {
                        category: "FIELD",
                        config: {
                            max_length: 50,
                            min_length: 1,
                            multiline: false,
                        },
                        id: "full_name",
                        label: "Your Name",
                        required: true,
                        sensitive: false,
                        type: "TEXT",
                    },
                    {
                        category: "BLOCK",
                        config: {
                            text: "Continue",
                        },
                        id: "next_button_3FbA",
                        type: "NEXT_BUTTON",
                    },
                ],
                next_node: "$ending",
            },
            coordinates: {
                x: 500,
                y: 0,
            },
            id: "step_ggeX",
            type: "STEP",
        }]),
        ending: JSON.stringify({
            after_submit: {
                flow_id: "<my_flow_id>",
            },
            coordinates: {
                x: 1250,
                y: 0,
            },
            resume_flow: true,
        }),
        style: JSON.stringify({
            css: `h1 {
      color: white;
      text-align: center;
    }`,
        }),
        translations: JSON.stringify({
            es: {
                components: {
                    rich_text_uctu: {
                        config: {
                            content: "<h2>Help us verify your personal information</h2><p>We want to learn more about you so that we can validate and protect your account...</p>",
                        },
                    },
                },
                messages: {
                    custom: {},
                    errors: {
                        ERR_ACCEPTANCE_REQUIRED: "Por favor, marca este campo para continuar.",
                    },
                },
            },
        }),
        languages: [{
            "default": "en",
            primary: "en",
        }],
    });
    
    import pulumi
    import json
    import pulumi_auth0 as auth0
    
    # Example:
    my_form = auth0.Form("my_form",
        name="My KYC Form",
        start=json.dumps({
            "coordinates": {
                "x": 0,
                "y": 0,
            },
            "next_node": "step_ggeX",
        }),
        nodes=json.dumps([{
            "alias": "New step",
            "config": {
                "components": [
                    {
                        "category": "FIELD",
                        "config": {
                            "max_length": 50,
                            "min_length": 1,
                            "multiline": False,
                        },
                        "id": "full_name",
                        "label": "Your Name",
                        "required": True,
                        "sensitive": False,
                        "type": "TEXT",
                    },
                    {
                        "category": "BLOCK",
                        "config": {
                            "text": "Continue",
                        },
                        "id": "next_button_3FbA",
                        "type": "NEXT_BUTTON",
                    },
                ],
                "next_node": "$ending",
            },
            "coordinates": {
                "x": 500,
                "y": 0,
            },
            "id": "step_ggeX",
            "type": "STEP",
        }]),
        ending=json.dumps({
            "after_submit": {
                "flow_id": "<my_flow_id>",
            },
            "coordinates": {
                "x": 1250,
                "y": 0,
            },
            "resume_flow": True,
        }),
        style=json.dumps({
            "css": """h1 {
      color: white;
      text-align: center;
    }""",
        }),
        translations=json.dumps({
            "es": {
                "components": {
                    "rich_text_uctu": {
                        "config": {
                            "content": "<h2>Help us verify your personal information</h2><p>We want to learn more about you so that we can validate and protect your account...</p>",
                        },
                    },
                },
                "messages": {
                    "custom": {},
                    "errors": {
                        "ERR_ACCEPTANCE_REQUIRED": "Por favor, marca este campo para continuar.",
                    },
                },
            },
        }),
        languages=[{
            "default": "en",
            "primary": "en",
        }])
    
    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{}{
    			"coordinates": map[string]interface{}{
    				"x": 0,
    				"y": 0,
    			},
    			"next_node": "step_ggeX",
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		tmpJSON1, err := json.Marshal([]map[string]interface{}{
    			map[string]interface{}{
    				"alias": "New step",
    				"config": map[string]interface{}{
    					"components": []interface{}{
    						map[string]interface{}{
    							"category": "FIELD",
    							"config": map[string]interface{}{
    								"max_length": 50,
    								"min_length": 1,
    								"multiline":  false,
    							},
    							"id":        "full_name",
    							"label":     "Your Name",
    							"required":  true,
    							"sensitive": false,
    							"type":      "TEXT",
    						},
    						map[string]interface{}{
    							"category": "BLOCK",
    							"config": map[string]interface{}{
    								"text": "Continue",
    							},
    							"id":   "next_button_3FbA",
    							"type": "NEXT_BUTTON",
    						},
    					},
    					"next_node": "$ending",
    				},
    				"coordinates": map[string]interface{}{
    					"x": 500,
    					"y": 0,
    				},
    				"id":   "step_ggeX",
    				"type": "STEP",
    			},
    		})
    		if err != nil {
    			return err
    		}
    		json1 := string(tmpJSON1)
    		tmpJSON2, err := json.Marshal(map[string]interface{}{
    			"after_submit": map[string]interface{}{
    				"flow_id": "<my_flow_id>",
    			},
    			"coordinates": map[string]interface{}{
    				"x": 1250,
    				"y": 0,
    			},
    			"resume_flow": true,
    		})
    		if err != nil {
    			return err
    		}
    		json2 := string(tmpJSON2)
    		tmpJSON3, err := json.Marshal(map[string]interface{}{
    			"css": "h1 {\n  color: white;\n  text-align: center;\n}",
    		})
    		if err != nil {
    			return err
    		}
    		json3 := string(tmpJSON3)
    		tmpJSON4, err := json.Marshal(map[string]interface{}{
    			"es": map[string]interface{}{
    				"components": map[string]interface{}{
    					"rich_text_uctu": map[string]interface{}{
    						"config": map[string]interface{}{
    							"content": "<h2>Help us verify your personal information</h2><p>We want to learn more about you so that we can validate and protect your account...</p>",
    						},
    					},
    				},
    				"messages": map[string]interface{}{
    					"custom": map[string]interface{}{},
    					"errors": map[string]interface{}{
    						"ERR_ACCEPTANCE_REQUIRED": "Por favor, marca este campo para continuar.",
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		json4 := string(tmpJSON4)
    		// Example:
    		_, err = auth0.NewForm(ctx, "my_form", &auth0.FormArgs{
    			Name:         pulumi.String("My KYC Form"),
    			Start:        pulumi.String(json0),
    			Nodes:        pulumi.String(json1),
    			Ending:       pulumi.String(json2),
    			Style:        pulumi.String(json3),
    			Translations: pulumi.String(json4),
    			Languages: auth0.FormLanguageArray{
    				&auth0.FormLanguageArgs{
    					Default: pulumi.String("en"),
    					Primary: pulumi.String("en"),
    				},
    			},
    		})
    		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(() => 
    {
        // Example:
        var myForm = new Auth0.Form("my_form", new()
        {
            Name = "My KYC Form",
            Start = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["coordinates"] = new Dictionary<string, object?>
                {
                    ["x"] = 0,
                    ["y"] = 0,
                },
                ["next_node"] = "step_ggeX",
            }),
            Nodes = JsonSerializer.Serialize(new[]
            {
                new Dictionary<string, object?>
                {
                    ["alias"] = "New step",
                    ["config"] = new Dictionary<string, object?>
                    {
                        ["components"] = new[]
                        {
                            new Dictionary<string, object?>
                            {
                                ["category"] = "FIELD",
                                ["config"] = new Dictionary<string, object?>
                                {
                                    ["max_length"] = 50,
                                    ["min_length"] = 1,
                                    ["multiline"] = false,
                                },
                                ["id"] = "full_name",
                                ["label"] = "Your Name",
                                ["required"] = true,
                                ["sensitive"] = false,
                                ["type"] = "TEXT",
                            },
                            new Dictionary<string, object?>
                            {
                                ["category"] = "BLOCK",
                                ["config"] = new Dictionary<string, object?>
                                {
                                    ["text"] = "Continue",
                                },
                                ["id"] = "next_button_3FbA",
                                ["type"] = "NEXT_BUTTON",
                            },
                        },
                        ["next_node"] = "$ending",
                    },
                    ["coordinates"] = new Dictionary<string, object?>
                    {
                        ["x"] = 500,
                        ["y"] = 0,
                    },
                    ["id"] = "step_ggeX",
                    ["type"] = "STEP",
                },
            }),
            Ending = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["after_submit"] = new Dictionary<string, object?>
                {
                    ["flow_id"] = "<my_flow_id>",
                },
                ["coordinates"] = new Dictionary<string, object?>
                {
                    ["x"] = 1250,
                    ["y"] = 0,
                },
                ["resume_flow"] = true,
            }),
            Style = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["css"] = @"h1 {
      color: white;
      text-align: center;
    }",
            }),
            Translations = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["es"] = new Dictionary<string, object?>
                {
                    ["components"] = new Dictionary<string, object?>
                    {
                        ["rich_text_uctu"] = new Dictionary<string, object?>
                        {
                            ["config"] = new Dictionary<string, object?>
                            {
                                ["content"] = "<h2>Help us verify your personal information</h2><p>We want to learn more about you so that we can validate and protect your account...</p>",
                            },
                        },
                    },
                    ["messages"] = new Dictionary<string, object?>
                    {
                        ["custom"] = new Dictionary<string, object?>
                        {
                        },
                        ["errors"] = new Dictionary<string, object?>
                        {
                            ["ERR_ACCEPTANCE_REQUIRED"] = "Por favor, marca este campo para continuar.",
                        },
                    },
                },
            }),
            Languages = new[]
            {
                new Auth0.Inputs.FormLanguageArgs
                {
                    Default = "en",
                    Primary = "en",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.auth0.Form;
    import com.pulumi.auth0.FormArgs;
    import com.pulumi.auth0.inputs.FormLanguageArgs;
    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) {
            // Example:
            var myForm = new Form("myForm", FormArgs.builder()
                .name("My KYC Form")
                .start(serializeJson(
                    jsonObject(
                        jsonProperty("coordinates", jsonObject(
                            jsonProperty("x", 0),
                            jsonProperty("y", 0)
                        )),
                        jsonProperty("next_node", "step_ggeX")
                    )))
                .nodes(serializeJson(
                    jsonArray(jsonObject(
                        jsonProperty("alias", "New step"),
                        jsonProperty("config", jsonObject(
                            jsonProperty("components", jsonArray(
                                jsonObject(
                                    jsonProperty("category", "FIELD"),
                                    jsonProperty("config", jsonObject(
                                        jsonProperty("max_length", 50),
                                        jsonProperty("min_length", 1),
                                        jsonProperty("multiline", false)
                                    )),
                                    jsonProperty("id", "full_name"),
                                    jsonProperty("label", "Your Name"),
                                    jsonProperty("required", true),
                                    jsonProperty("sensitive", false),
                                    jsonProperty("type", "TEXT")
                                ), 
                                jsonObject(
                                    jsonProperty("category", "BLOCK"),
                                    jsonProperty("config", jsonObject(
                                        jsonProperty("text", "Continue")
                                    )),
                                    jsonProperty("id", "next_button_3FbA"),
                                    jsonProperty("type", "NEXT_BUTTON")
                                )
                            )),
                            jsonProperty("next_node", "$ending")
                        )),
                        jsonProperty("coordinates", jsonObject(
                            jsonProperty("x", 500),
                            jsonProperty("y", 0)
                        )),
                        jsonProperty("id", "step_ggeX"),
                        jsonProperty("type", "STEP")
                    ))))
                .ending(serializeJson(
                    jsonObject(
                        jsonProperty("after_submit", jsonObject(
                            jsonProperty("flow_id", "<my_flow_id>")
                        )),
                        jsonProperty("coordinates", jsonObject(
                            jsonProperty("x", 1250),
                            jsonProperty("y", 0)
                        )),
                        jsonProperty("resume_flow", true)
                    )))
                .style(serializeJson(
                    jsonObject(
                        jsonProperty("css", """
    h1 {
      color: white;
      text-align: center;
    }                    """)
                    )))
                .translations(serializeJson(
                    jsonObject(
                        jsonProperty("es", jsonObject(
                            jsonProperty("components", jsonObject(
                                jsonProperty("rich_text_uctu", jsonObject(
                                    jsonProperty("config", jsonObject(
                                        jsonProperty("content", "<h2>Help us verify your personal information</h2><p>We want to learn more about you so that we can validate and protect your account...</p>")
                                    ))
                                ))
                            )),
                            jsonProperty("messages", jsonObject(
                                jsonProperty("custom", jsonObject(
    
                                )),
                                jsonProperty("errors", jsonObject(
                                    jsonProperty("ERR_ACCEPTANCE_REQUIRED", "Por favor, marca este campo para continuar.")
                                ))
                            ))
                        ))
                    )))
                .languages(FormLanguageArgs.builder()
                    .default_("en")
                    .primary("en")
                    .build())
                .build());
    
        }
    }
    
    resources:
      # Example:
      myForm:
        type: auth0:Form
        name: my_form
        properties:
          name: My KYC Form
          start:
            fn::toJSON:
              coordinates:
                x: 0
                y: 0
              next_node: step_ggeX
          nodes:
            fn::toJSON:
              - alias: New step
                config:
                  components:
                    - category: FIELD
                      config:
                        max_length: 50
                        min_length: 1
                        multiline: false
                      id: full_name
                      label: Your Name
                      required: true
                      sensitive: false
                      type: TEXT
                    - category: BLOCK
                      config:
                        text: Continue
                      id: next_button_3FbA
                      type: NEXT_BUTTON
                  next_node: $ending
                coordinates:
                  x: 500
                  y: 0
                id: step_ggeX
                type: STEP
          ending:
            fn::toJSON:
              after_submit:
                flow_id: <my_flow_id>
              coordinates:
                x: 1250
                y: 0
              resume_flow: true
          style:
            fn::toJSON:
              css: |-
                h1 {
                  color: white;
                  text-align: center;
                }            
          translations:
            fn::toJSON:
              es:
                components:
                  rich_text_uctu:
                    config:
                      content: <h2>Help us verify your personal information</h2><p>We want to learn more about you so that we can validate and protect your account...</p>
                messages:
                  custom: {}
                  errors:
                    ERR_ACCEPTANCE_REQUIRED: Por favor, marca este campo para continuar.
          languages:
            - default: en
              primary: en
    

    Create Form Resource

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

    Constructor syntax

    new Form(name: string, args?: FormArgs, opts?: CustomResourceOptions);
    @overload
    def Form(resource_name: str,
             args: Optional[FormArgs] = None,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Form(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             ending: Optional[str] = None,
             languages: Optional[Sequence[FormLanguageArgs]] = None,
             messages: Optional[Sequence[FormMessageArgs]] = None,
             name: Optional[str] = None,
             nodes: Optional[str] = None,
             start: Optional[str] = None,
             style: Optional[str] = None,
             translations: Optional[str] = None)
    func NewForm(ctx *Context, name string, args *FormArgs, opts ...ResourceOption) (*Form, error)
    public Form(string name, FormArgs? args = null, CustomResourceOptions? opts = null)
    public Form(String name, FormArgs args)
    public Form(String name, FormArgs args, CustomResourceOptions options)
    
    type: auth0:Form
    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 FormArgs
    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 FormArgs
    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 FormArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FormArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FormArgs
    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 formResource = new Auth0.Form("formResource", new()
    {
        Ending = "string",
        Languages = new[]
        {
            new Auth0.Inputs.FormLanguageArgs
            {
                Primary = "string",
                Default = "string",
            },
        },
        Messages = new[]
        {
            new Auth0.Inputs.FormMessageArgs
            {
                Custom = "string",
                Errors = "string",
            },
        },
        Name = "string",
        Nodes = "string",
        Start = "string",
        Style = "string",
        Translations = "string",
    });
    
    example, err := auth0.NewForm(ctx, "formResource", &auth0.FormArgs{
    	Ending: pulumi.String("string"),
    	Languages: auth0.FormLanguageArray{
    		&auth0.FormLanguageArgs{
    			Primary: pulumi.String("string"),
    			Default: pulumi.String("string"),
    		},
    	},
    	Messages: auth0.FormMessageArray{
    		&auth0.FormMessageArgs{
    			Custom: pulumi.String("string"),
    			Errors: pulumi.String("string"),
    		},
    	},
    	Name:         pulumi.String("string"),
    	Nodes:        pulumi.String("string"),
    	Start:        pulumi.String("string"),
    	Style:        pulumi.String("string"),
    	Translations: pulumi.String("string"),
    })
    
    var formResource = new Form("formResource", FormArgs.builder()
        .ending("string")
        .languages(FormLanguageArgs.builder()
            .primary("string")
            .default_("string")
            .build())
        .messages(FormMessageArgs.builder()
            .custom("string")
            .errors("string")
            .build())
        .name("string")
        .nodes("string")
        .start("string")
        .style("string")
        .translations("string")
        .build());
    
    form_resource = auth0.Form("formResource",
        ending="string",
        languages=[{
            "primary": "string",
            "default": "string",
        }],
        messages=[{
            "custom": "string",
            "errors": "string",
        }],
        name="string",
        nodes="string",
        start="string",
        style="string",
        translations="string")
    
    const formResource = new auth0.Form("formResource", {
        ending: "string",
        languages: [{
            primary: "string",
            "default": "string",
        }],
        messages: [{
            custom: "string",
            errors: "string",
        }],
        name: "string",
        nodes: "string",
        start: "string",
        style: "string",
        translations: "string",
    });
    
    type: auth0:Form
    properties:
        ending: string
        languages:
            - default: string
              primary: string
        messages:
            - custom: string
              errors: string
        name: string
        nodes: string
        start: string
        style: string
        translations: string
    

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

    Ending string
    Submission configuration of the form. (JSON encoded)
    Languages List<FormLanguage>
    Language specific configuration for the form.
    Messages List<FormMessage>
    Message specific configuration for the form.
    Name string
    Name of the form.
    Nodes string
    Nodes of the form. (JSON encoded)
    Start string
    Input setup of the form. (JSON encoded)
    Style string
    Style specific configuration for the form. (JSON encoded)
    Translations string
    Translations of the form. (JSON encoded)
    Ending string
    Submission configuration of the form. (JSON encoded)
    Languages []FormLanguageArgs
    Language specific configuration for the form.
    Messages []FormMessageArgs
    Message specific configuration for the form.
    Name string
    Name of the form.
    Nodes string
    Nodes of the form. (JSON encoded)
    Start string
    Input setup of the form. (JSON encoded)
    Style string
    Style specific configuration for the form. (JSON encoded)
    Translations string
    Translations of the form. (JSON encoded)
    ending String
    Submission configuration of the form. (JSON encoded)
    languages List<FormLanguage>
    Language specific configuration for the form.
    messages List<FormMessage>
    Message specific configuration for the form.
    name String
    Name of the form.
    nodes String
    Nodes of the form. (JSON encoded)
    start String
    Input setup of the form. (JSON encoded)
    style String
    Style specific configuration for the form. (JSON encoded)
    translations String
    Translations of the form. (JSON encoded)
    ending string
    Submission configuration of the form. (JSON encoded)
    languages FormLanguage[]
    Language specific configuration for the form.
    messages FormMessage[]
    Message specific configuration for the form.
    name string
    Name of the form.
    nodes string
    Nodes of the form. (JSON encoded)
    start string
    Input setup of the form. (JSON encoded)
    style string
    Style specific configuration for the form. (JSON encoded)
    translations string
    Translations of the form. (JSON encoded)
    ending str
    Submission configuration of the form. (JSON encoded)
    languages Sequence[FormLanguageArgs]
    Language specific configuration for the form.
    messages Sequence[FormMessageArgs]
    Message specific configuration for the form.
    name str
    Name of the form.
    nodes str
    Nodes of the form. (JSON encoded)
    start str
    Input setup of the form. (JSON encoded)
    style str
    Style specific configuration for the form. (JSON encoded)
    translations str
    Translations of the form. (JSON encoded)
    ending String
    Submission configuration of the form. (JSON encoded)
    languages List<Property Map>
    Language specific configuration for the form.
    messages List<Property Map>
    Message specific configuration for the form.
    name String
    Name of the form.
    nodes String
    Nodes of the form. (JSON encoded)
    start String
    Input setup of the form. (JSON encoded)
    style String
    Style specific configuration for the form. (JSON encoded)
    translations String
    Translations of the form. (JSON encoded)

    Outputs

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

    Get an existing Form 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?: FormState, opts?: CustomResourceOptions): Form
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ending: Optional[str] = None,
            languages: Optional[Sequence[FormLanguageArgs]] = None,
            messages: Optional[Sequence[FormMessageArgs]] = None,
            name: Optional[str] = None,
            nodes: Optional[str] = None,
            start: Optional[str] = None,
            style: Optional[str] = None,
            translations: Optional[str] = None) -> Form
    func GetForm(ctx *Context, name string, id IDInput, state *FormState, opts ...ResourceOption) (*Form, error)
    public static Form Get(string name, Input<string> id, FormState? state, CustomResourceOptions? opts = null)
    public static Form get(String name, Output<String> id, FormState 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:
    Ending string
    Submission configuration of the form. (JSON encoded)
    Languages List<FormLanguage>
    Language specific configuration for the form.
    Messages List<FormMessage>
    Message specific configuration for the form.
    Name string
    Name of the form.
    Nodes string
    Nodes of the form. (JSON encoded)
    Start string
    Input setup of the form. (JSON encoded)
    Style string
    Style specific configuration for the form. (JSON encoded)
    Translations string
    Translations of the form. (JSON encoded)
    Ending string
    Submission configuration of the form. (JSON encoded)
    Languages []FormLanguageArgs
    Language specific configuration for the form.
    Messages []FormMessageArgs
    Message specific configuration for the form.
    Name string
    Name of the form.
    Nodes string
    Nodes of the form. (JSON encoded)
    Start string
    Input setup of the form. (JSON encoded)
    Style string
    Style specific configuration for the form. (JSON encoded)
    Translations string
    Translations of the form. (JSON encoded)
    ending String
    Submission configuration of the form. (JSON encoded)
    languages List<FormLanguage>
    Language specific configuration for the form.
    messages List<FormMessage>
    Message specific configuration for the form.
    name String
    Name of the form.
    nodes String
    Nodes of the form. (JSON encoded)
    start String
    Input setup of the form. (JSON encoded)
    style String
    Style specific configuration for the form. (JSON encoded)
    translations String
    Translations of the form. (JSON encoded)
    ending string
    Submission configuration of the form. (JSON encoded)
    languages FormLanguage[]
    Language specific configuration for the form.
    messages FormMessage[]
    Message specific configuration for the form.
    name string
    Name of the form.
    nodes string
    Nodes of the form. (JSON encoded)
    start string
    Input setup of the form. (JSON encoded)
    style string
    Style specific configuration for the form. (JSON encoded)
    translations string
    Translations of the form. (JSON encoded)
    ending str
    Submission configuration of the form. (JSON encoded)
    languages Sequence[FormLanguageArgs]
    Language specific configuration for the form.
    messages Sequence[FormMessageArgs]
    Message specific configuration for the form.
    name str
    Name of the form.
    nodes str
    Nodes of the form. (JSON encoded)
    start str
    Input setup of the form. (JSON encoded)
    style str
    Style specific configuration for the form. (JSON encoded)
    translations str
    Translations of the form. (JSON encoded)
    ending String
    Submission configuration of the form. (JSON encoded)
    languages List<Property Map>
    Language specific configuration for the form.
    messages List<Property Map>
    Message specific configuration for the form.
    name String
    Name of the form.
    nodes String
    Nodes of the form. (JSON encoded)
    start String
    Input setup of the form. (JSON encoded)
    style String
    Style specific configuration for the form. (JSON encoded)
    translations String
    Translations of the form. (JSON encoded)

    Supporting Types

    FormLanguage, FormLanguageArgs

    Primary string
    Primary language for the form.
    Default string
    Default language for the form.
    Primary string
    Primary language for the form.
    Default string
    Default language for the form.
    primary String
    Primary language for the form.
    default_ String
    Default language for the form.
    primary string
    Primary language for the form.
    default string
    Default language for the form.
    primary str
    Primary language for the form.
    default str
    Default language for the form.
    primary String
    Primary language for the form.
    default String
    Default language for the form.

    FormMessage, FormMessageArgs

    Custom string
    Custom message for the form. (JSON encoded)
    Errors string
    Error message for the form. (JSON encoded)
    Custom string
    Custom message for the form. (JSON encoded)
    Errors string
    Error message for the form. (JSON encoded)
    custom String
    Custom message for the form. (JSON encoded)
    errors String
    Error message for the form. (JSON encoded)
    custom string
    Custom message for the form. (JSON encoded)
    errors string
    Error message for the form. (JSON encoded)
    custom str
    Custom message for the form. (JSON encoded)
    errors str
    Error message for the form. (JSON encoded)
    custom String
    Custom message for the form. (JSON encoded)
    errors String
    Error message for the form. (JSON encoded)

    Import

    This resource can be imported using the form ID.

    Example:

    $ pulumi import auth0:index/form:Form my_form "ap_ojkKbiPMG6J5E5VCKdeCzK"
    

    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