Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthForm
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
theogravity/pulumi-fusionauth

fusionauth.FusionAuthForm

Explore with Pulumi AI

fusionauth logo
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
theogravity/pulumi-fusionauth

    # Form Resource

    A FusionAuth Form is a customizable object that contains one-to-many ordered steps. Each step is comprised of one or more Form Fields.

    Form API

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fusionauth from "pulumi-fusionauth";

const form = new fusionauth.FusionAuthForm("form", {
    data: {
        description: "This form customizes the registration experience.",
    },
    steps: [
        {
            fields: ["91909721-7d4f-b110-8f21-cfdee2a1edb8"],
        },
        {
            fields: [
                "8ed89a31-c325-3156-72ed-6e89183af917",
                "a977cfd4-a9ed-c4cf-650f-f4539268ac38",
            ],
        },
    ],
});

    import pulumi
import theogravity_pulumi_fusionauth as fusionauth

form = fusionauth.FusionAuthForm("form",
    data={
        "description": "This form customizes the registration experience.",
    },
    steps=[
        fusionauth.FusionAuthFormStepArgs(
            fields=["91909721-7d4f-b110-8f21-cfdee2a1edb8"],
        ),
        fusionauth.FusionAuthFormStepArgs(
            fields=[
                "8ed89a31-c325-3156-72ed-6e89183af917",
                "a977cfd4-a9ed-c4cf-650f-f4539268ac38",
            ],
        ),
    ])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/theogravity/pulumi-fusionauth/sdk/go/fusionauth"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fusionauth.NewFusionAuthForm(ctx, "form", &fusionauth.FusionAuthFormArgs{
			Data: pulumi.Map{
				"description": pulumi.Any("This form customizes the registration experience."),
			},
			Steps: fusionauth.FusionAuthFormStepArray{
				&fusionauth.FusionAuthFormStepArgs{
					Fields: pulumi.StringArray{
						pulumi.String("91909721-7d4f-b110-8f21-cfdee2a1edb8"),
					},
				},
				&fusionauth.FusionAuthFormStepArgs{
					Fields: pulumi.StringArray{
						pulumi.String("8ed89a31-c325-3156-72ed-6e89183af917"),
						pulumi.String("a977cfd4-a9ed-c4cf-650f-f4539268ac38"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fusionauth = theogravity.Fusionauth;

return await Deployment.RunAsync(() => 
{
    var form = new Fusionauth.FusionAuthForm("form", new()
    {
        Data = 
        {
            { "description", "This form customizes the registration experience." },
        },
        Steps = new[]
        {
            new Fusionauth.Inputs.FusionAuthFormStepArgs
            {
                Fields = new[]
                {
                    "91909721-7d4f-b110-8f21-cfdee2a1edb8",
                },
            },
            new Fusionauth.Inputs.FusionAuthFormStepArgs
            {
                Fields = new[]
                {
                    "8ed89a31-c325-3156-72ed-6e89183af917",
                    "a977cfd4-a9ed-c4cf-650f-f4539268ac38",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionAuthForm;
import com.pulumi.fusionauth.FusionAuthFormArgs;
import com.pulumi.fusionauth.inputs.FusionAuthFormStepArgs;
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 form = new FusionAuthForm("form", FusionAuthFormArgs.builder()
            .data(Map.of("description", "This form customizes the registration experience."))
            .steps(            
                FusionAuthFormStepArgs.builder()
                    .fields("91909721-7d4f-b110-8f21-cfdee2a1edb8")
                    .build(),
                FusionAuthFormStepArgs.builder()
                    .fields(                    
                        "8ed89a31-c325-3156-72ed-6e89183af917",
                        "a977cfd4-a9ed-c4cf-650f-f4539268ac38")
                    .build())
            .build());

    }
}

    resources:
  form:
    type: fusionauth:FusionAuthForm
    properties:
      data:
        description: This form customizes the registration experience.
      steps:
        - fields:
            - 91909721-7d4f-b110-8f21-cfdee2a1edb8
        - fields:
            - 8ed89a31-c325-3156-72ed-6e89183af917
            - a977cfd4-a9ed-c4cf-650f-f4539268ac38

    Create FusionAuthForm Resource

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

    Constructor syntax

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

@overload
def FusionAuthForm(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   steps: Optional[Sequence[FusionAuthFormStepArgs]] = None,
                   data: Optional[Mapping[str, Any]] = None,
                   form_id: Optional[str] = None,
                   name: Optional[str] = None,
                   type: Optional[str] = None)
    func NewFusionAuthForm(ctx *Context, name string, args FusionAuthFormArgs, opts ...ResourceOption) (*FusionAuthForm, error)
    public FusionAuthForm(string name, FusionAuthFormArgs args, CustomResourceOptions? opts = null)
    public FusionAuthForm(String name, FusionAuthFormArgs args)
public FusionAuthForm(String name, FusionAuthFormArgs args, CustomResourceOptions options)

    type: fusionauth:FusionAuthForm
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 FusionAuthFormArgs
    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 FusionAuthFormArgs
    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 FusionAuthFormArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FusionAuthFormArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FusionAuthFormArgs
    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 fusionAuthFormResource = new Fusionauth.FusionAuthForm("fusionAuthFormResource", new()
{
    Steps = new[]
    {
        new Fusionauth.Inputs.FusionAuthFormStepArgs
        {
            Fields = new[]
            {
                "string",
            },
        },
    },
    Data = 
    {
        { "string", "any" },
    },
    FormId = "string",
    Name = "string",
    Type = "string",
});

    example, err := fusionauth.NewFusionAuthForm(ctx, "fusionAuthFormResource", &fusionauth.FusionAuthFormArgs{
	Steps: fusionauth.FusionAuthFormStepArray{
		&fusionauth.FusionAuthFormStepArgs{
			Fields: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Data: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	FormId: pulumi.String("string"),
	Name:   pulumi.String("string"),
	Type:   pulumi.String("string"),
})

    var fusionAuthFormResource = new FusionAuthForm("fusionAuthFormResource", FusionAuthFormArgs.builder()
    .steps(FusionAuthFormStepArgs.builder()
        .fields("string")
        .build())
    .data(Map.of("string", "any"))
    .formId("string")
    .name("string")
    .type("string")
    .build());

    fusion_auth_form_resource = fusionauth.FusionAuthForm("fusionAuthFormResource",
    steps=[{
        "fields": ["string"],
    }],
    data={
        "string": "any",
    },
    form_id="string",
    name="string",
    type="string")

    const fusionAuthFormResource = new fusionauth.FusionAuthForm("fusionAuthFormResource", {
    steps: [{
        fields: ["string"],
    }],
    data: {
        string: "any",
    },
    formId: "string",
    name: "string",
    type: "string",
});

    type: fusionauth:FusionAuthForm
properties:
    data:
        string: any
    formId: string
    name: string
    steps:
        - fields:
            - string
    type: string

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

    Steps List<theogravity.Fusionauth.Inputs.FusionAuthFormStep>
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    Data Dictionary<string, object>
    An object that can hold any information about the Form Field that should be persisted.
    FormId string
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    Name string
    The unique name of the Form Field.
    Type string
    The type of form being created, a form type cannot be changed after the form has been created.
    Steps []FusionAuthFormStepArgs
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    Data map[string]interface{}
    An object that can hold any information about the Form Field that should be persisted.
    FormId string
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    Name string
    The unique name of the Form Field.
    Type string
    The type of form being created, a form type cannot be changed after the form has been created.
    steps List<FusionAuthFormStep>
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    data Map<String,Object>
    An object that can hold any information about the Form Field that should be persisted.
    formId String
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    name String
    The unique name of the Form Field.
    type String
    The type of form being created, a form type cannot be changed after the form has been created.
    steps FusionAuthFormStep[]
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    data {[key: string]: any}
    An object that can hold any information about the Form Field that should be persisted.
    formId string
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    name string
    The unique name of the Form Field.
    type string
    The type of form being created, a form type cannot be changed after the form has been created.
    steps Sequence[FusionAuthFormStepArgs]
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    data Mapping[str, Any]
    An object that can hold any information about the Form Field that should be persisted.
    form_id str
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    name str
    The unique name of the Form Field.
    type str
    The type of form being created, a form type cannot be changed after the form has been created.
    steps List<Property Map>
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    data Map<Any>
    An object that can hold any information about the Form Field that should be persisted.
    formId String
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    name String
    The unique name of the Form Field.
    type String
    The type of form being created, a form type cannot be changed after the form has been created.

    Outputs

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

    Get an existing FusionAuthForm 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?: FusionAuthFormState, opts?: CustomResourceOptions): FusionAuthForm
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data: Optional[Mapping[str, Any]] = None,
        form_id: Optional[str] = None,
        name: Optional[str] = None,
        steps: Optional[Sequence[FusionAuthFormStepArgs]] = None,
        type: Optional[str] = None) -> FusionAuthForm
    func GetFusionAuthForm(ctx *Context, name string, id IDInput, state *FusionAuthFormState, opts ...ResourceOption) (*FusionAuthForm, error)
    public static FusionAuthForm Get(string name, Input<string> id, FusionAuthFormState? state, CustomResourceOptions? opts = null)
    public static FusionAuthForm get(String name, Output<String> id, FusionAuthFormState 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:
    Data Dictionary<string, object>
    An object that can hold any information about the Form Field that should be persisted.
    FormId string
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    Name string
    The unique name of the Form Field.
    Steps List<theogravity.Fusionauth.Inputs.FusionAuthFormStep>
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    Type string
    The type of form being created, a form type cannot be changed after the form has been created.
    Data map[string]interface{}
    An object that can hold any information about the Form Field that should be persisted.
    FormId string
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    Name string
    The unique name of the Form Field.
    Steps []FusionAuthFormStepArgs
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    Type string
    The type of form being created, a form type cannot be changed after the form has been created.
    data Map<String,Object>
    An object that can hold any information about the Form Field that should be persisted.
    formId String
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    name String
    The unique name of the Form Field.
    steps List<FusionAuthFormStep>
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    type String
    The type of form being created, a form type cannot be changed after the form has been created.
    data {[key: string]: any}
    An object that can hold any information about the Form Field that should be persisted.
    formId string
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    name string
    The unique name of the Form Field.
    steps FusionAuthFormStep[]
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    type string
    The type of form being created, a form type cannot be changed after the form has been created.
    data Mapping[str, Any]
    An object that can hold any information about the Form Field that should be persisted.
    form_id str
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    name str
    The unique name of the Form Field.
    steps Sequence[FusionAuthFormStepArgs]
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    type str
    The type of form being created, a form type cannot be changed after the form has been created.
    data Map<Any>
    An object that can hold any information about the Form Field that should be persisted.
    formId String
    The Id to use for the new Form. If not specified a secure random UUID will be generated.
    name String
    The unique name of the Form Field.
    steps List<Property Map>
    An ordered list of objects containing one or more Form Fields. A Form must have at least one step defined.
    type String
    The type of form being created, a form type cannot be changed after the form has been created.

    Supporting Types

    FusionAuthFormStep, FusionAuthFormStepArgs

    Fields List<string>
    An ordered list of Form Field Ids assigned to this step.
    Fields []string
    An ordered list of Form Field Ids assigned to this step.
    fields List<String>
    An ordered list of Form Field Ids assigned to this step.
    fields string[]
    An ordered list of Form Field Ids assigned to this step.
    fields Sequence[str]
    An ordered list of Form Field Ids assigned to this step.
    fields List<String>
    An ordered list of Form Field Ids assigned to this step.

    Package Details

    Repository
    fusionauth theogravity/pulumi-fusionauth
    License
    MIT
    Notes
    This Pulumi package is based on the fusionauth Terraform Provider.
    fusionauth logo
    FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
    theogravity/pulumi-fusionauth