Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Authentik Provider
  3. API Docs
  4. StagePrompt
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

authentik.StagePrompt

Explore with Pulumi AI

authentik logo
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";

// Create a prompt stage with 1 field
const field = new authentik.StagePromptField("field", {
    fieldKey: "username",
    label: "Username",
    type: "username",
});
const name = new authentik.StagePrompt("name", {fields: [resource.authentik_stage_prompt_field.field.id]});

    import pulumi
import pulumi_authentik as authentik

# Create a prompt stage with 1 field
field = authentik.StagePromptField("field",
    field_key="username",
    label="Username",
    type="username")
name = authentik.StagePrompt("name", fields=[resource["authentik_stage_prompt_field"]["field"]["id"]])

    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 {
		// Create a prompt stage with 1 field
		_, err := authentik.NewStagePromptField(ctx, "field", &authentik.StagePromptFieldArgs{
			FieldKey: pulumi.String("username"),
			Label:    pulumi.String("Username"),
			Type:     pulumi.String("username"),
		})
		if err != nil {
			return err
		}
		_, err = authentik.NewStagePrompt(ctx, "name", &authentik.StagePromptArgs{
			Fields: pulumi.StringArray{
				resource.Authentik_stage_prompt_field.Field.Id,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Create a prompt stage with 1 field
    var field = new Authentik.StagePromptField("field", new()
    {
        FieldKey = "username",
        Label = "Username",
        Type = "username",
    });

    var name = new Authentik.StagePrompt("name", new()
    {
        Fields = new[]
        {
            resource.Authentik_stage_prompt_field.Field.Id,
        },
    });

});

    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 com.pulumi.authentik.StagePrompt;
import com.pulumi.authentik.StagePromptArgs;
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) {
        // Create a prompt stage with 1 field
        var field = new StagePromptField("field", StagePromptFieldArgs.builder()
            .fieldKey("username")
            .label("Username")
            .type("username")
            .build());

        var name = new StagePrompt("name", StagePromptArgs.builder()
            .fields(resource.authentik_stage_prompt_field().field().id())
            .build());

    }
}

    resources:
  # Create a prompt stage with 1 field
  field:
    type: authentik:StagePromptField
    properties:
      fieldKey: username
      label: Username
      type: username
  name:
    type: authentik:StagePrompt
    properties:
      fields:
        - ${resource.authentik_stage_prompt_field.field.id}

    Create StagePrompt Resource

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

    Constructor syntax

    new StagePrompt(name: string, args: StagePromptArgs, opts?: CustomResourceOptions);
    @overload
def StagePrompt(resource_name: str,
                args: StagePromptArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def StagePrompt(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                fields: Optional[Sequence[str]] = None,
                name: Optional[str] = None,
                stage_prompt_id: Optional[str] = None,
                validation_policies: Optional[Sequence[str]] = None)
    func NewStagePrompt(ctx *Context, name string, args StagePromptArgs, opts ...ResourceOption) (*StagePrompt, error)
    public StagePrompt(string name, StagePromptArgs args, CustomResourceOptions? opts = null)
    public StagePrompt(String name, StagePromptArgs args)
public StagePrompt(String name, StagePromptArgs args, CustomResourceOptions options)

    type: authentik:StagePrompt
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 StagePromptArgs
    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 StagePromptArgs
    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 StagePromptArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StagePromptArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StagePromptArgs
    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 stagePromptResource = new Authentik.StagePrompt("stagePromptResource", new()
{
    Fields = new[]
    {
        "string",
    },
    Name = "string",
    StagePromptId = "string",
    ValidationPolicies = new[]
    {
        "string",
    },
});

    example, err := authentik.NewStagePrompt(ctx, "stagePromptResource", &authentik.StagePromptArgs{
	Fields: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:          pulumi.String("string"),
	StagePromptId: pulumi.String("string"),
	ValidationPolicies: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var stagePromptResource = new StagePrompt("stagePromptResource", StagePromptArgs.builder()
    .fields("string")
    .name("string")
    .stagePromptId("string")
    .validationPolicies("string")
    .build());

    stage_prompt_resource = authentik.StagePrompt("stagePromptResource",
    fields=["string"],
    name="string",
    stage_prompt_id="string",
    validation_policies=["string"])

    const stagePromptResource = new authentik.StagePrompt("stagePromptResource", {
    fields: ["string"],
    name: "string",
    stagePromptId: "string",
    validationPolicies: ["string"],
});

    type: authentik:StagePrompt
properties:
    fields:
        - string
    name: string
    stagePromptId: string
    validationPolicies:
        - string

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

    Fields List<string>
    Name string
    StagePromptId string
    The ID of this resource.
    ValidationPolicies List<string>
    Fields []string
    Name string
    StagePromptId string
    The ID of this resource.
    ValidationPolicies []string
    fields List<String>
    name String
    stagePromptId String
    The ID of this resource.
    validationPolicies List<String>
    fields string[]
    name string
    stagePromptId string
    The ID of this resource.
    validationPolicies string[]
    fields Sequence[str]
    name str
    stage_prompt_id str
    The ID of this resource.
    validation_policies Sequence[str]
    fields List<String>
    name String
    stagePromptId String
    The ID of this resource.
    validationPolicies List<String>

    Outputs

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

    Get an existing StagePrompt 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?: StagePromptState, opts?: CustomResourceOptions): StagePrompt
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        fields: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        stage_prompt_id: Optional[str] = None,
        validation_policies: Optional[Sequence[str]] = None) -> StagePrompt
    func GetStagePrompt(ctx *Context, name string, id IDInput, state *StagePromptState, opts ...ResourceOption) (*StagePrompt, error)
    public static StagePrompt Get(string name, Input<string> id, StagePromptState? state, CustomResourceOptions? opts = null)
    public static StagePrompt get(String name, Output<String> id, StagePromptState state, CustomResourceOptions options)
    resources:  _:    type: authentik:StagePrompt    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:
    Fields List<string>
    Name string
    StagePromptId string
    The ID of this resource.
    ValidationPolicies List<string>
    Fields []string
    Name string
    StagePromptId string
    The ID of this resource.
    ValidationPolicies []string
    fields List<String>
    name String
    stagePromptId String
    The ID of this resource.
    validationPolicies List<String>
    fields string[]
    name string
    stagePromptId string
    The ID of this resource.
    validationPolicies string[]
    fields Sequence[str]
    name str
    stage_prompt_id str
    The ID of this resource.
    validation_policies Sequence[str]
    fields List<String>
    name String
    stagePromptId String
    The ID of this resource.
    validationPolicies List<String>

    Package Details

    Repository
    authentik goauthentik/terraform-provider-authentik
    License
    Notes
    This Pulumi package is based on the authentik Terraform Provider.
    authentik logo
    authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
    goauthentik/terraform-provider-authentik