1. Packages
  2. FusionAuth
  3. API Docs
  4. getFormField
Viewing docs for FusionAuth v6.0.2
published on Sunday, Feb 9, 2025 by Theo Gravity
Schema (JSON)
theogravity/pulumi-fusionauth

fusionauth.getFormField

fusionauth logo
Viewing docs for FusionAuth v6.0.2
published on Sunday, Feb 9, 2025 by Theo Gravity
Schema (JSON)
theogravity/pulumi-fusionauth

    # Form Field Resource

    A FusionAuth Form Field is an object that can be customized to receive input within a FusionAuth Form.

    Form Field API

    Example Usage

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

const default = fusionauth.getFormField({
    name: "Email",
});

    import pulumi
import pulumi_fusionauth as fusionauth

default = fusionauth.get_form_field(name="Email")

    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.GetFormField(ctx, &fusionauth.GetFormFieldArgs{
			Name: pulumi.StringRef("Email"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @default = Fusionauth.GetFormField.Invoke(new()
    {
        Name = "Email",
    });

});

    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.GetFormFieldArgs;
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.getFormField(GetFormFieldArgs.builder()
            .name("Email")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      function: fusionauth:getFormField
      arguments:
        name: Email

    Using getFormField

    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 getFormField(args: GetFormFieldArgs, opts?: InvokeOptions): Promise<GetFormFieldResult>
function getFormFieldOutput(args: GetFormFieldOutputArgs, opts?: InvokeOptions): Output<GetFormFieldResult>
    def get_form_field(confirm: Optional[bool] = None,
                   consent_id: Optional[str] = None,
                   control: Optional[str] = None,
                   data: Optional[Mapping[str, str]] = None,
                   description: Optional[str] = None,
                   form_field_id: Optional[str] = None,
                   key: Optional[str] = None,
                   name: Optional[str] = None,
                   options: Optional[Sequence[str]] = None,
                   required: Optional[bool] = None,
                   type: Optional[str] = None,
                   validator: Optional[GetFormFieldValidator] = None,
                   opts: Optional[InvokeOptions] = None) -> GetFormFieldResult
def get_form_field_output(confirm: Optional[pulumi.Input[bool]] = None,
                   consent_id: Optional[pulumi.Input[str]] = None,
                   control: Optional[pulumi.Input[str]] = None,
                   data: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                   description: Optional[pulumi.Input[str]] = None,
                   form_field_id: Optional[pulumi.Input[str]] = None,
                   key: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   options: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   required: Optional[pulumi.Input[bool]] = None,
                   type: Optional[pulumi.Input[str]] = None,
                   validator: Optional[pulumi.Input[GetFormFieldValidatorArgs]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetFormFieldResult]
    func GetFormField(ctx *Context, args *GetFormFieldArgs, opts ...InvokeOption) (*GetFormFieldResult, error)
func GetFormFieldOutput(ctx *Context, args *GetFormFieldOutputArgs, opts ...InvokeOption) GetFormFieldResultOutput

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

    public static class GetFormField 
{
    public static Task<GetFormFieldResult> InvokeAsync(GetFormFieldArgs args, InvokeOptions? opts = null)
    public static Output<GetFormFieldResult> Invoke(GetFormFieldInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFormFieldResult> getFormField(GetFormFieldArgs args, InvokeOptions options)
public static Output<GetFormFieldResult> getFormField(GetFormFieldArgs args, InvokeOptions options)

    fn::invoke:
  function: fusionauth:index/getFormField:getFormField
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Confirm bool
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    ConsentId string
    Control string
    Data Dictionary<string, string>
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    Description string
    FormFieldId string
    The unique id of the Form Field. Either form_field_id or name must be specified.
    Key string
    Name string
    The name of the Form field. Either form_field_id or name must be specified.
    Options List<string>
    A list of options that are applied to checkbox, radio, or select controls.
    Required bool
    Determines if a value is required to complete the form.
    Type string
    The form field type. The possible values are:
    Validator theogravity.Fusionauth.Inputs.GetFormFieldValidator
    Confirm bool
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    ConsentId string
    Control string
    Data map[string]string
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    Description string
    FormFieldId string
    The unique id of the Form Field. Either form_field_id or name must be specified.
    Key string
    Name string
    The name of the Form field. Either form_field_id or name must be specified.
    Options []string
    A list of options that are applied to checkbox, radio, or select controls.
    Required bool
    Determines if a value is required to complete the form.
    Type string
    The form field type. The possible values are:
    Validator GetFormFieldValidator
    confirm Boolean
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    consentId String
    control String
    data Map<String,String>
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    description String
    formFieldId String
    The unique id of the Form Field. Either form_field_id or name must be specified.
    key String
    name String
    The name of the Form field. Either form_field_id or name must be specified.
    options List<String>
    A list of options that are applied to checkbox, radio, or select controls.
    required Boolean
    Determines if a value is required to complete the form.
    type String
    The form field type. The possible values are:
    validator GetFormFieldValidator
    confirm boolean
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    consentId string
    control string
    data {[key: string]: string}
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    description string
    formFieldId string
    The unique id of the Form Field. Either form_field_id or name must be specified.
    key string
    name string
    The name of the Form field. Either form_field_id or name must be specified.
    options string[]
    A list of options that are applied to checkbox, radio, or select controls.
    required boolean
    Determines if a value is required to complete the form.
    type string
    The form field type. The possible values are:
    validator GetFormFieldValidator
    confirm bool
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    consent_id str
    control str
    data Mapping[str, str]
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    description str
    form_field_id str
    The unique id of the Form Field. Either form_field_id or name must be specified.
    key str
    name str
    The name of the Form field. Either form_field_id or name must be specified.
    options Sequence[str]
    A list of options that are applied to checkbox, radio, or select controls.
    required bool
    Determines if a value is required to complete the form.
    type str
    The form field type. The possible values are:
    validator GetFormFieldValidator
    confirm Boolean
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    consentId String
    control String
    data Map<String>
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    description String
    formFieldId String
    The unique id of the Form Field. Either form_field_id or name must be specified.
    key String
    name String
    The name of the Form field. Either form_field_id or name must be specified.
    options List<String>
    A list of options that are applied to checkbox, radio, or select controls.
    required Boolean
    Determines if a value is required to complete the form.
    type String
    The form field type. The possible values are:
    validator Property Map

    getFormField Result

    The following output properties are available:

    Control string
    FormFieldId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Validator theogravity.Fusionauth.Outputs.GetFormFieldValidator
    Confirm bool
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    ConsentId string
    Data Dictionary<string, string>
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    Description string
    Key string
    Name string
    The unique name of the Form Field.
    Options List<string>
    A list of options that are applied to checkbox, radio, or select controls.
    Required bool
    Determines if a value is required to complete the form.
    Type string
    The form field type. The possible values are:
    Control string
    FormFieldId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Validator GetFormFieldValidator
    Confirm bool
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    ConsentId string
    Data map[string]string
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    Description string
    Key string
    Name string
    The unique name of the Form Field.
    Options []string
    A list of options that are applied to checkbox, radio, or select controls.
    Required bool
    Determines if a value is required to complete the form.
    Type string
    The form field type. The possible values are:
    control String
    formFieldId String
    id String
    The provider-assigned unique ID for this managed resource.
    validator GetFormFieldValidator
    confirm Boolean
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    consentId String
    data Map<String,String>
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    description String
    key String
    name String
    The unique name of the Form Field.
    options List<String>
    A list of options that are applied to checkbox, radio, or select controls.
    required Boolean
    Determines if a value is required to complete the form.
    type String
    The form field type. The possible values are:
    control string
    formFieldId string
    id string
    The provider-assigned unique ID for this managed resource.
    validator GetFormFieldValidator
    confirm boolean
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    consentId string
    data {[key: string]: string}
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    description string
    key string
    name string
    The unique name of the Form Field.
    options string[]
    A list of options that are applied to checkbox, radio, or select controls.
    required boolean
    Determines if a value is required to complete the form.
    type string
    The form field type. The possible values are:
    control str
    form_field_id str
    id str
    The provider-assigned unique ID for this managed resource.
    validator GetFormFieldValidator
    confirm bool
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    consent_id str
    data Mapping[str, str]
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    description str
    key str
    name str
    The unique name of the Form Field.
    options Sequence[str]
    A list of options that are applied to checkbox, radio, or select controls.
    required bool
    Determines if a value is required to complete the form.
    type str
    The form field type. The possible values are:
    control String
    formFieldId String
    id String
    The provider-assigned unique ID for this managed resource.
    validator Property Map
    confirm Boolean
    Determines if the user input should be confirmed by requiring the value to be entered twice.

    • consent_id
    • control
    consentId String
    data Map<String>
    An object that can hold any information about the Form Field that should be persisted.

    • description
    • key
    description String
    key String
    name String
    The unique name of the Form Field.
    options List<String>
    A list of options that are applied to checkbox, radio, or select controls.
    required Boolean
    Determines if a value is required to complete the form.
    type String
    The form field type. The possible values are:

    Supporting Types

    GetFormFieldValidator

    Enabled bool
    Determines if user input should be validated.
    Expression string
    A regular expression used to validate user input. Must be a valid regular expression pattern.
    Enabled bool
    Determines if user input should be validated.
    Expression string
    A regular expression used to validate user input. Must be a valid regular expression pattern.
    enabled Boolean
    Determines if user input should be validated.
    expression String
    A regular expression used to validate user input. Must be a valid regular expression pattern.
    enabled boolean
    Determines if user input should be validated.
    expression string
    A regular expression used to validate user input. Must be a valid regular expression pattern.
    enabled bool
    Determines if user input should be validated.
    expression str
    A regular expression used to validate user input. Must be a valid regular expression pattern.
    enabled Boolean
    Determines if user input should be validated.
    expression String
    A regular expression used to validate user input. Must be a valid regular expression pattern.

    Package Details

    Repository
    fusionauth theogravity/pulumi-fusionauth
    License
    MIT
    Notes
    This Pulumi package is based on the fusionauth Terraform Provider.
    fusionauth logo
    Viewing docs for FusionAuth v6.0.2
    published on Sunday, Feb 9, 2025 by Theo Gravity
    Schema (JSON)
    theogravity/pulumi-fusionauth
      Try Pulumi Cloud free. Your team will thank you.