1. Registry
  2. Packages
  3. Authentik Provider
  4. API Docs
  5. getStagePromptField
Viewing docs for authentik 2026.8.0
published on Wednesday, Sep 9, 2026 by goauthentik
Viewing docs for authentik 2026.8.0
published on Wednesday, Sep 9, 2026 by goauthentik

    Get stage prompt fields by id or name

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as authentik from "@pulumi/authentik";
    
    // To get the ID of a prompt field by name
    const defaultUserSettingsFieldEmail = authentik.getStagePromptField({
        name: "default-user-settings-field-email",
    });
    
    import pulumi
    import pulumi_authentik as authentik
    
    # To get the ID of a prompt field by name
    default_user_settings_field_email = authentik.get_stage_prompt_field(name="default-user-settings-field-email")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2026/authentik"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// To get the ID of a prompt field by name
    		_, err := authentik.LookupStagePromptField(ctx, &authentik.LookupStagePromptFieldArgs{
    			Name: pulumi.StringRef("default-user-settings-field-email"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Authentik = Pulumi.Authentik;
    
    return await Deployment.RunAsync(() => 
    {
        // To get the ID of a prompt field by name
        var defaultUserSettingsFieldEmail = Authentik.GetStagePromptField.Invoke(new()
        {
            Name = "default-user-settings-field-email",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.authentik.AuthentikFunctions;
    import com.pulumi.authentik.inputs.GetStagePromptFieldArgs;
    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) {
            // To get the ID of a prompt field by name
            final var defaultUserSettingsFieldEmail = AuthentikFunctions.getStagePromptField(GetStagePromptFieldArgs.builder()
                .name("default-user-settings-field-email")
                .build());
    
        }
    }
    
    variables:
      # To get the ID of a prompt field by name
      defaultUserSettingsFieldEmail:
        fn::invoke:
          function: authentik:getStagePromptField
          arguments:
            name: default-user-settings-field-email
    
    Example coming soon!
    

    Using getStagePromptField

    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 getStagePromptField(args: GetStagePromptFieldArgs, opts?: InvokeOptions): Promise<GetStagePromptFieldResult>
    function getStagePromptFieldOutput(args: GetStagePromptFieldOutputArgs, opts?: InvokeOutputOptions): Output<GetStagePromptFieldResult>
    def get_stage_prompt_field(id: Optional[str] = None,
                               name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetStagePromptFieldResult
    def get_stage_prompt_field_output(id: pulumi.Input[Optional[str]] = None,
                               name: pulumi.Input[Optional[str]] = None,
                               opts: Optional[InvokeOutputOptions] = None) -> Output[GetStagePromptFieldResult]
    func LookupStagePromptField(ctx *Context, args *LookupStagePromptFieldArgs, opts ...InvokeOption) (*LookupStagePromptFieldResult, error)
    func LookupStagePromptFieldOutput(ctx *Context, args *LookupStagePromptFieldOutputArgs, opts ...InvokeOption) LookupStagePromptFieldResultOutput

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

    public static class GetStagePromptField 
    {
        public static Task<GetStagePromptFieldResult> InvokeAsync(GetStagePromptFieldArgs args, InvokeOptions? opts = null)
        public static Output<GetStagePromptFieldResult> Invoke(GetStagePromptFieldInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetStagePromptFieldResult> Invoke(GetStagePromptFieldInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetStagePromptFieldResult> getStagePromptField(GetStagePromptFieldArgs args, InvokeOptions options)
    public static Output<GetStagePromptFieldResult> getStagePromptField(GetStagePromptFieldArgs args, InvokeOptions options)
    public static Output<GetStagePromptFieldResult> getStagePromptField(GetStagePromptFieldArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: authentik:index/getStagePromptField:getStagePromptField
      arguments:
        # arguments dictionary
    data "authentik_get_stage_prompt_field" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Generated.
    Name string
    Generated.
    Id string
    Generated.
    Name string
    Generated.
    id string
    Generated.
    name string
    Generated.
    id String
    Generated.
    name String
    Generated.
    id string
    Generated.
    name string
    Generated.
    id str
    Generated.
    name str
    Generated.
    id String
    Generated.
    name String
    Generated.

    getStagePromptField Result

    The following output properties are available:

    FieldKey string
    Generated.
    Id string
    Generated.
    InitialValue string
    Generated.
    InitialValueExpression bool
    Generated.
    Label string
    Generated.
    Name string
    Generated.
    Order double
    Generated.
    Placeholder string
    Generated.
    PlaceholderExpression bool
    Generated.
    Required bool
    Generated.
    SubText string
    Generated.
    Type string
    Generated.
    FieldKey string
    Generated.
    Id string
    Generated.
    InitialValue string
    Generated.
    InitialValueExpression bool
    Generated.
    Label string
    Generated.
    Name string
    Generated.
    Order float64
    Generated.
    Placeholder string
    Generated.
    PlaceholderExpression bool
    Generated.
    Required bool
    Generated.
    SubText string
    Generated.
    Type string
    Generated.
    field_key string
    Generated.
    id string
    Generated.
    initial_value string
    Generated.
    initial_value_expression bool
    Generated.
    label string
    Generated.
    name string
    Generated.
    order number
    Generated.
    placeholder string
    Generated.
    placeholder_expression bool
    Generated.
    required bool
    Generated.
    sub_text string
    Generated.
    type string
    Generated.
    fieldKey String
    Generated.
    id String
    Generated.
    initialValue String
    Generated.
    initialValueExpression Boolean
    Generated.
    label String
    Generated.
    name String
    Generated.
    order Double
    Generated.
    placeholder String
    Generated.
    placeholderExpression Boolean
    Generated.
    required Boolean
    Generated.
    subText String
    Generated.
    type String
    Generated.
    fieldKey string
    Generated.
    id string
    Generated.
    initialValue string
    Generated.
    initialValueExpression boolean
    Generated.
    label string
    Generated.
    name string
    Generated.
    order number
    Generated.
    placeholder string
    Generated.
    placeholderExpression boolean
    Generated.
    required boolean
    Generated.
    subText string
    Generated.
    type string
    Generated.
    field_key str
    Generated.
    id str
    Generated.
    initial_value str
    Generated.
    initial_value_expression bool
    Generated.
    label str
    Generated.
    name str
    Generated.
    order float
    Generated.
    placeholder str
    Generated.
    placeholder_expression bool
    Generated.
    required bool
    Generated.
    sub_text str
    Generated.
    type str
    Generated.
    fieldKey String
    Generated.
    id String
    Generated.
    initialValue String
    Generated.
    initialValueExpression Boolean
    Generated.
    label String
    Generated.
    name String
    Generated.
    order Number
    Generated.
    placeholder String
    Generated.
    placeholderExpression Boolean
    Generated.
    required Boolean
    Generated.
    subText String
    Generated.
    type String
    Generated.

    Package Details

    Repository
    authentik goauthentik/terraform-provider-authentik
    License
    Notes
    This Pulumi package is based on the authentik Terraform Provider.
    Viewing docs for authentik 2026.8.0
    published on Wednesday, Sep 9, 2026 by goauthentik

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial