1. Packages
  2. Auth0 Provider
  3. API Docs
  4. getForm
Auth0 v3.8.2 published on Friday, Nov 1, 2024 by Pulumi

auth0.getForm

Explore with Pulumi AI

auth0 logo
Auth0 v3.8.2 published on Friday, Nov 1, 2024 by Pulumi

    Data source to retrieve a specific Auth0 Form by id

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    // An Auth0 form loaded using its ID.
    const myFormData = auth0.getForm({
        id: "ap_31LxRJphZF1Kqzf2zBgmgA",
    });
    
    import pulumi
    import pulumi_auth0 as auth0
    
    # An Auth0 form loaded using its ID.
    my_form_data = auth0.get_form(id="ap_31LxRJphZF1Kqzf2zBgmgA")
    
    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 {
    		// An Auth0 form loaded using its ID.
    		_, err := auth0.LookupForm(ctx, &auth0.LookupFormArgs{
    			Id: "ap_31LxRJphZF1Kqzf2zBgmgA",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Auth0 = Pulumi.Auth0;
    
    return await Deployment.RunAsync(() => 
    {
        // An Auth0 form loaded using its ID.
        var myFormData = Auth0.GetForm.Invoke(new()
        {
            Id = "ap_31LxRJphZF1Kqzf2zBgmgA",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.auth0.Auth0Functions;
    import com.pulumi.auth0.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) {
            // An Auth0 form loaded using its ID.
            final var myFormData = Auth0Functions.getForm(GetFormArgs.builder()
                .id("ap_31LxRJphZF1Kqzf2zBgmgA")
                .build());
    
        }
    }
    
    variables:
      # An Auth0 form loaded using its ID.
      myFormData:
        fn::invoke:
          Function: auth0:getForm
          Arguments:
            id: ap_31LxRJphZF1Kqzf2zBgmgA
    

    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(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFormResult
    def get_form_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetFormResult]
    func LookupForm(ctx *Context, args *LookupFormArgs, opts ...InvokeOption) (*LookupFormResult, error)
    func LookupFormOutput(ctx *Context, args *LookupFormOutputArgs, opts ...InvokeOption) LookupFormResultOutput

    > Note: This function is named LookupForm 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: auth0:index/getForm:getForm
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The id of the Form.
    Id string
    The id of the Form.
    id String
    The id of the Form.
    id string
    The id of the Form.
    id str
    The id of the Form.
    id String
    The id of the Form.

    getForm Result

    The following output properties are available:

    Ending string
    Submission configuration of the form. (JSON encoded)
    Id string
    The id of the Form.
    Languages List<GetFormLanguage>
    Language specific configuration for the form.
    Messages List<GetFormMessage>
    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)
    Id string
    The id of the Form.
    Languages []GetFormLanguage
    Language specific configuration for the form.
    Messages []GetFormMessage
    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)
    id String
    The id of the Form.
    languages List<GetFormLanguage>
    Language specific configuration for the form.
    messages List<GetFormMessage>
    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)
    id string
    The id of the Form.
    languages GetFormLanguage[]
    Language specific configuration for the form.
    messages GetFormMessage[]
    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)
    id str
    The id of the Form.
    languages Sequence[GetFormLanguage]
    Language specific configuration for the form.
    messages Sequence[GetFormMessage]
    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)
    id String
    The id of the Form.
    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

    GetFormLanguage

    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 string
    Primary language for the form.
    default str
    Default language for the form.
    primary str
    Primary language for the form.
    default String
    Default language for the form.
    primary String
    Primary language for the form.

    GetFormMessage

    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)

    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.2 published on Friday, Nov 1, 2024 by Pulumi