authentik 2025.2.0, Mar 24 25

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

authentik.StagePromptField

Explore with Pulumi AI

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

Example Usage

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

const field = new authentik.StagePromptField("field", {
    fieldKey: "username",
    label: "Username",
    type: "username",
});

import pulumi
import pulumi_authentik as authentik

field = authentik.StagePromptField("field",
    field_key="username",
    label="Username",
    type="username")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2025/authentik"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := authentik.NewStagePromptField(ctx, "field", &authentik.StagePromptFieldArgs{
			FieldKey: pulumi.String("username"),
			Label:    pulumi.String("Username"),
			Type:     pulumi.String("username"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var field = new Authentik.StagePromptField("field", new()
    {
        FieldKey = "username",
        Label = "Username",
        Type = "username",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.StagePromptField;
import com.pulumi.authentik.StagePromptFieldArgs;
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 field = new StagePromptField("field", StagePromptFieldArgs.builder()
            .fieldKey("username")
            .label("Username")
            .type("username")
            .build());

    }
}

resources:
  field:
    type: authentik:StagePromptField
    properties:
      fieldKey: username
      label: Username
      type: username

Create StagePromptField Resource

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

Constructor syntax

new StagePromptField(name: string, args: StagePromptFieldArgs, opts?: CustomResourceOptions);

@overload
def StagePromptField(resource_name: str,
                     args: StagePromptFieldArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def StagePromptField(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     field_key: Optional[str] = None,
                     label: Optional[str] = None,
                     type: Optional[str] = None,
                     initial_value: Optional[str] = None,
                     initial_value_expression: Optional[bool] = None,
                     name: Optional[str] = None,
                     order: Optional[float] = None,
                     placeholder: Optional[str] = None,
                     placeholder_expression: Optional[bool] = None,
                     required: Optional[bool] = None,
                     stage_prompt_field_id: Optional[str] = None,
                     sub_text: Optional[str] = None)

func NewStagePromptField(ctx *Context, name string, args StagePromptFieldArgs, opts ...ResourceOption) (*StagePromptField, error)

public StagePromptField(string name, StagePromptFieldArgs args, CustomResourceOptions? opts = null)

public StagePromptField(String name, StagePromptFieldArgs args)
public StagePromptField(String name, StagePromptFieldArgs args, CustomResourceOptions options)

type: authentik:StagePromptField
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 StagePromptFieldArgs: 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 StagePromptFieldArgs: 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 StagePromptFieldArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args StagePromptFieldArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args StagePromptFieldArgs: 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 stagePromptFieldResource = new Authentik.StagePromptField("stagePromptFieldResource", new()
{
    FieldKey = "string",
    Label = "string",
    Type = "string",
    InitialValue = "string",
    InitialValueExpression = false,
    Name = "string",
    Order = 0,
    Placeholder = "string",
    PlaceholderExpression = false,
    Required = false,
    StagePromptFieldId = "string",
    SubText = "string",
});

example, err := authentik.NewStagePromptField(ctx, "stagePromptFieldResource", &authentik.StagePromptFieldArgs{
	FieldKey:               pulumi.String("string"),
	Label:                  pulumi.String("string"),
	Type:                   pulumi.String("string"),
	InitialValue:           pulumi.String("string"),
	InitialValueExpression: pulumi.Bool(false),
	Name:                   pulumi.String("string"),
	Order:                  pulumi.Float64(0),
	Placeholder:            pulumi.String("string"),
	PlaceholderExpression:  pulumi.Bool(false),
	Required:               pulumi.Bool(false),
	StagePromptFieldId:     pulumi.String("string"),
	SubText:                pulumi.String("string"),
})

var stagePromptFieldResource = new StagePromptField("stagePromptFieldResource", StagePromptFieldArgs.builder()
    .fieldKey("string")
    .label("string")
    .type("string")
    .initialValue("string")
    .initialValueExpression(false)
    .name("string")
    .order(0)
    .placeholder("string")
    .placeholderExpression(false)
    .required(false)
    .stagePromptFieldId("string")
    .subText("string")
    .build());

stage_prompt_field_resource = authentik.StagePromptField("stagePromptFieldResource",
    field_key="string",
    label="string",
    type="string",
    initial_value="string",
    initial_value_expression=False,
    name="string",
    order=0,
    placeholder="string",
    placeholder_expression=False,
    required=False,
    stage_prompt_field_id="string",
    sub_text="string")

const stagePromptFieldResource = new authentik.StagePromptField("stagePromptFieldResource", {
    fieldKey: "string",
    label: "string",
    type: "string",
    initialValue: "string",
    initialValueExpression: false,
    name: "string",
    order: 0,
    placeholder: "string",
    placeholderExpression: false,
    required: false,
    stagePromptFieldId: "string",
    subText: "string",
});

type: authentik:StagePromptField
properties:
    fieldKey: string
    initialValue: string
    initialValueExpression: false
    label: string
    name: string
    order: 0
    placeholder: string
    placeholderExpression: false
    required: false
    stagePromptFieldId: string
    subText: string
    type: string

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

FieldKey string
Label string
Type string: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale
InitialValue string
InitialValueExpression bool: Defaults to false.
Name string
Order double
Placeholder string
PlaceholderExpression bool: Defaults to false.
Required bool: Defaults to false.
StagePromptFieldId string
SubText string: Defaults to ``.

FieldKey string
Label string
Type string: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale
InitialValue string
InitialValueExpression bool: Defaults to false.
Name string
Order float64
Placeholder string
PlaceholderExpression bool: Defaults to false.
Required bool: Defaults to false.
StagePromptFieldId string
SubText string: Defaults to ``.

fieldKey String
label String
type String: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale
initialValue String
initialValueExpression Boolean: Defaults to false.
name String
order Double
placeholder String
placeholderExpression Boolean: Defaults to false.
required Boolean: Defaults to false.
stagePromptFieldId String
subText String: Defaults to ``.

fieldKey string
label string
type string: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale
initialValue string
initialValueExpression boolean: Defaults to false.
name string
order number
placeholder string
placeholderExpression boolean: Defaults to false.
required boolean: Defaults to false.
stagePromptFieldId string
subText string: Defaults to ``.

field_key str
label str
type str: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale
initial_value str
initial_value_expression bool: Defaults to false.
name str
order float
placeholder str
placeholder_expression bool: Defaults to false.
required bool: Defaults to false.
stage_prompt_field_id str
sub_text str: Defaults to ``.

fieldKey String
label String
type String: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale
initialValue String
initialValueExpression Boolean: Defaults to false.
name String
order Number
placeholder String
placeholderExpression Boolean: Defaults to false.
required Boolean: Defaults to false.
stagePromptFieldId String
subText String: Defaults to ``.

Outputs

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

Get an existing StagePromptField 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?: StagePromptFieldState, opts?: CustomResourceOptions): StagePromptField

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        field_key: Optional[str] = None,
        initial_value: Optional[str] = None,
        initial_value_expression: Optional[bool] = None,
        label: Optional[str] = None,
        name: Optional[str] = None,
        order: Optional[float] = None,
        placeholder: Optional[str] = None,
        placeholder_expression: Optional[bool] = None,
        required: Optional[bool] = None,
        stage_prompt_field_id: Optional[str] = None,
        sub_text: Optional[str] = None,
        type: Optional[str] = None) -> StagePromptField

func GetStagePromptField(ctx *Context, name string, id IDInput, state *StagePromptFieldState, opts ...ResourceOption) (*StagePromptField, error)

public static StagePromptField Get(string name, Input<string> id, StagePromptFieldState? state, CustomResourceOptions? opts = null)

public static StagePromptField get(String name, Output<String> id, StagePromptFieldState state, CustomResourceOptions options)

resources:  _:    type: authentik:StagePromptField    get:      id: ${id}

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:

FieldKey string
InitialValue string
InitialValueExpression bool: Defaults to false.
Label string
Name string
Order double
Placeholder string
PlaceholderExpression bool: Defaults to false.
Required bool: Defaults to false.
StagePromptFieldId string
SubText string: Defaults to ``.
Type string: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale

FieldKey string
InitialValue string
InitialValueExpression bool: Defaults to false.
Label string
Name string
Order float64
Placeholder string
PlaceholderExpression bool: Defaults to false.
Required bool: Defaults to false.
StagePromptFieldId string
SubText string: Defaults to ``.
Type string: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale

fieldKey String
initialValue String
initialValueExpression Boolean: Defaults to false.
label String
name String
order Double
placeholder String
placeholderExpression Boolean: Defaults to false.
required Boolean: Defaults to false.
stagePromptFieldId String
subText String: Defaults to ``.
type String: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale

fieldKey string
initialValue string
initialValueExpression boolean: Defaults to false.
label string
name string
order number
placeholder string
placeholderExpression boolean: Defaults to false.
required boolean: Defaults to false.
stagePromptFieldId string
subText string: Defaults to ``.
type string: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale

field_key str
initial_value str
initial_value_expression bool: Defaults to false.
label str
name str
order float
placeholder str
placeholder_expression bool: Defaults to false.
required bool: Defaults to false.
stage_prompt_field_id str
sub_text str: Defaults to ``.
type str: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale

fieldKey String
initialValue String
initialValueExpression Boolean: Defaults to false.
label String
name String
order Number
placeholder String
placeholderExpression Boolean: Defaults to false.
required Boolean: Defaults to false.
stagePromptFieldId String
subText String: Defaults to ``.
type String: Allowed values: - text - text_area - text_read_only - text_area_read_only - username - email - password - number - checkbox - radio-button-group - dropdown - date - date-time - file - separator - hidden - static - ak-locale

Package Details

Repository: authentik goauthentik/terraform-provider-authentik
License
Notes: This Pulumi package is based on the authentik Terraform Provider.

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

authentik.StagePromptField

On this page

On this page

Example Usage

Create StagePromptField Resource

Constructor syntax

Parameters

Constructor example

StagePromptField Resource Properties

Inputs

Outputs

Look up Existing StagePromptField Resource

Package Details

On this page

On this page