1. Packages
  2. FusionAuth
  3. API Docs
  4. getForm
FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity

fusionauth.getForm

Explore with Pulumi AI

fusionauth logo
FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity

    # 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.

    Forms API

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Fusionauth = Pulumi.Fusionauth;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = Fusionauth.GetForm.Invoke(new()
        {
            Name = "Default User Self Service provided by FusionAuth",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/theogravity/pulumi-fusionauth/sdk/v3/go/fusionauth"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := fusionauth.GetForm(ctx, &fusionauth.GetFormArgs{
    			Name: pulumi.StringRef("Default User Self Service provided by FusionAuth"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fusionauth.FusionauthFunctions;
    import com.pulumi.fusionauth.inputs.GetFormArgs;
    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) {
            final var default = FusionauthFunctions.getForm(GetFormArgs.builder()
                .name("Default User Self Service provided by FusionAuth")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_fusionauth as fusionauth
    
    default = fusionauth.get_form(name="Default User Self Service provided by FusionAuth")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as fusionauth from "@pulumi/fusionauth";
    
    const default = fusionauth.getForm({
        name: "Default User Self Service provided by FusionAuth",
    });
    
    variables:
      default:
        fn::invoke:
          Function: fusionauth:getForm
          Arguments:
            name: Default User Self Service provided by FusionAuth
    

    Using getForm

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getForm(args: GetFormArgs, opts?: InvokeOptions): Promise<GetFormResult>
    function getFormOutput(args: GetFormOutputArgs, opts?: InvokeOptions): Output<GetFormResult>
    def get_form(data: Optional[Mapping[str, Any]] = None,
                 form_id: Optional[str] = None,
                 name: Optional[str] = None,
                 steps: Optional[Sequence[GetFormStep]] = None,
                 type: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFormResult
    def get_form_output(data: Optional[pulumi.Input[Mapping[str, Any]]] = None,
                 form_id: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 steps: Optional[pulumi.Input[Sequence[pulumi.Input[GetFormStepArgs]]]] = None,
                 type: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetFormResult]
    func GetForm(ctx *Context, args *GetFormArgs, opts ...InvokeOption) (*GetFormResult, error)
    func GetFormOutput(ctx *Context, args *GetFormOutputArgs, opts ...InvokeOption) GetFormResultOutput

    > Note: This function is named GetForm in the Go SDK.

    public static class GetForm 
    {
        public static Task<GetFormResult> InvokeAsync(GetFormArgs args, InvokeOptions? opts = null)
        public static Output<GetFormResult> Invoke(GetFormInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFormResult> getForm(GetFormArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: fusionauth:index/getForm:getForm
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Data Dictionary<string, object>

    An object that can hold any information about the Form that should be persisted.

    FormId string

    The unique id of the Form. Either form_id or name must be specified.

    Name string

    The name of the Form. Either form_id or name must be specified.

    Steps List<theogravity.Fusionauth.Inputs.GetFormStep>

    An ordered list of objects containing one or more Form Fields.

    Type string

    The form type. The possible values are:

    Data map[string]interface{}

    An object that can hold any information about the Form that should be persisted.

    FormId string

    The unique id of the Form. Either form_id or name must be specified.

    Name string

    The name of the Form. Either form_id or name must be specified.

    Steps []GetFormStep

    An ordered list of objects containing one or more Form Fields.

    Type string

    The form type. The possible values are:

    data Map<String,Object>

    An object that can hold any information about the Form that should be persisted.

    formId String

    The unique id of the Form. Either form_id or name must be specified.

    name String

    The name of the Form. Either form_id or name must be specified.

    steps List<GetFormStep>

    An ordered list of objects containing one or more Form Fields.

    type String

    The form type. The possible values are:

    data {[key: string]: any}

    An object that can hold any information about the Form that should be persisted.

    formId string

    The unique id of the Form. Either form_id or name must be specified.

    name string

    The name of the Form. Either form_id or name must be specified.

    steps GetFormStep[]

    An ordered list of objects containing one or more Form Fields.

    type string

    The form type. The possible values are:

    data Mapping[str, Any]

    An object that can hold any information about the Form that should be persisted.

    form_id str

    The unique id of the Form. Either form_id or name must be specified.

    name str

    The name of the Form. Either form_id or name must be specified.

    steps Sequence[GetFormStep]

    An ordered list of objects containing one or more Form Fields.

    type str

    The form type. The possible values are:

    data Map<Any>

    An object that can hold any information about the Form that should be persisted.

    formId String

    The unique id of the Form. Either form_id or name must be specified.

    name String

    The name of the Form. Either form_id or name must be specified.

    steps List<Property Map>

    An ordered list of objects containing one or more Form Fields.

    type String

    The form type. The possible values are:

    getForm Result

    The following output properties are available:

    FormId string
    Id string

    The provider-assigned unique ID for this managed resource.

    Data Dictionary<string, object>

    An object that can hold any information about the Form that should be persisted.

    Name string

    The unique name of the Form.

    Steps List<theogravity.Fusionauth.Outputs.GetFormStep>

    An ordered list of objects containing one or more Form Fields.

    Type string

    The form type. The possible values are:

    FormId string
    Id string

    The provider-assigned unique ID for this managed resource.

    Data map[string]interface{}

    An object that can hold any information about the Form that should be persisted.

    Name string

    The unique name of the Form.

    Steps []GetFormStep

    An ordered list of objects containing one or more Form Fields.

    Type string

    The form type. The possible values are:

    formId String
    id String

    The provider-assigned unique ID for this managed resource.

    data Map<String,Object>

    An object that can hold any information about the Form that should be persisted.

    name String

    The unique name of the Form.

    steps List<GetFormStep>

    An ordered list of objects containing one or more Form Fields.

    type String

    The form type. The possible values are:

    formId string
    id string

    The provider-assigned unique ID for this managed resource.

    data {[key: string]: any}

    An object that can hold any information about the Form that should be persisted.

    name string

    The unique name of the Form.

    steps GetFormStep[]

    An ordered list of objects containing one or more Form Fields.

    type string

    The form type. The possible values are:

    form_id str
    id str

    The provider-assigned unique ID for this managed resource.

    data Mapping[str, Any]

    An object that can hold any information about the Form that should be persisted.

    name str

    The unique name of the Form.

    steps Sequence[GetFormStep]

    An ordered list of objects containing one or more Form Fields.

    type str

    The form type. The possible values are:

    formId String
    id String

    The provider-assigned unique ID for this managed resource.

    data Map<Any>

    An object that can hold any information about the Form that should be persisted.

    name String

    The unique name of the Form.

    steps List<Property Map>

    An ordered list of objects containing one or more Form Fields.

    type String

    The form type. The possible values are:

    Supporting Types

    GetFormStep

    Fields List<string>
    Fields []string
    fields List<String>
    fields string[]
    fields Sequence[str]
    fields List<String>

    Package Details

    Repository
    fusionauth theogravity/pulumi-fusionauth
    License
    MIT
    Notes

    This Pulumi package is based on the fusionauth Terraform Provider.

    fusionauth logo
    FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity