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

authentik.Flow

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 flow with a stage attached
const name = new authentik.StageDummy("name", {});
const flow = new authentik.Flow("flow", {
    title: "Test flow",
    slug: "test-flow",
    designation: "authorization",
});
const dummy_flow = new authentik.FlowStageBinding("dummy-flow", {
    target: flow.uuid,
    stage: name.stageDummyId,
    order: 0,
});

    import pulumi
import pulumi_authentik as authentik

# Create a flow with a stage attached
name = authentik.StageDummy("name")
flow = authentik.Flow("flow",
    title="Test flow",
    slug="test-flow",
    designation="authorization")
dummy_flow = authentik.FlowStageBinding("dummy-flow",
    target=flow.uuid,
    stage=name.stage_dummy_id,
    order=0)

    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 flow with a stage attached
		name, err := authentik.NewStageDummy(ctx, "name", nil)
		if err != nil {
			return err
		}
		flow, err := authentik.NewFlow(ctx, "flow", &authentik.FlowArgs{
			Title:       pulumi.String("Test flow"),
			Slug:        pulumi.String("test-flow"),
			Designation: pulumi.String("authorization"),
		})
		if err != nil {
			return err
		}
		_, err = authentik.NewFlowStageBinding(ctx, "dummy-flow", &authentik.FlowStageBindingArgs{
			Target: flow.Uuid,
			Stage:  name.StageDummyId,
			Order:  pulumi.Float64(0),
		})
		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 flow with a stage attached
    var name = new Authentik.StageDummy("name");

    var flow = new Authentik.Flow("flow", new()
    {
        Title = "Test flow",
        Slug = "test-flow",
        Designation = "authorization",
    });

    var dummy_flow = new Authentik.FlowStageBinding("dummy-flow", new()
    {
        Target = flow.Uuid,
        Stage = name.StageDummyId,
        Order = 0,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.StageDummy;
import com.pulumi.authentik.Flow;
import com.pulumi.authentik.FlowArgs;
import com.pulumi.authentik.FlowStageBinding;
import com.pulumi.authentik.FlowStageBindingArgs;
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 flow with a stage attached
        var name = new StageDummy("name");

        var flow = new Flow("flow", FlowArgs.builder()
            .title("Test flow")
            .slug("test-flow")
            .designation("authorization")
            .build());

        var dummy_flow = new FlowStageBinding("dummy-flow", FlowStageBindingArgs.builder()
            .target(flow.uuid())
            .stage(name.stageDummyId())
            .order(0)
            .build());

    }
}

    resources:
  # Create a flow with a stage attached
  name:
    type: authentik:StageDummy
  flow:
    type: authentik:Flow
    properties:
      title: Test flow
      slug: test-flow
      designation: authorization
  dummy-flow:
    type: authentik:FlowStageBinding
    properties:
      target: ${flow.uuid}
      stage: ${name.stageDummyId}
      order: 0

    Create Flow Resource

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

    Constructor syntax

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

@overload
def Flow(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         designation: Optional[str] = None,
         slug: Optional[str] = None,
         title: Optional[str] = None,
         authentication: Optional[str] = None,
         background: Optional[str] = None,
         compatibility_mode: Optional[bool] = None,
         denied_action: Optional[str] = None,
         flow_id: Optional[str] = None,
         layout: Optional[str] = None,
         name: Optional[str] = None,
         policy_engine_mode: Optional[str] = None)
    func NewFlow(ctx *Context, name string, args FlowArgs, opts ...ResourceOption) (*Flow, error)
    public Flow(string name, FlowArgs args, CustomResourceOptions? opts = null)
    public Flow(String name, FlowArgs args)
public Flow(String name, FlowArgs args, CustomResourceOptions options)

    type: authentik:Flow
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 FlowArgs
    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 FlowArgs
    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 FlowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FlowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FlowArgs
    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 flowResource = new Authentik.Flow("flowResource", new()
{
    Designation = "string",
    Slug = "string",
    Title = "string",
    Authentication = "string",
    Background = "string",
    CompatibilityMode = false,
    DeniedAction = "string",
    FlowId = "string",
    Layout = "string",
    Name = "string",
    PolicyEngineMode = "string",
});

    example, err := authentik.NewFlow(ctx, "flowResource", &authentik.FlowArgs{
	Designation:       pulumi.String("string"),
	Slug:              pulumi.String("string"),
	Title:             pulumi.String("string"),
	Authentication:    pulumi.String("string"),
	Background:        pulumi.String("string"),
	CompatibilityMode: pulumi.Bool(false),
	DeniedAction:      pulumi.String("string"),
	FlowId:            pulumi.String("string"),
	Layout:            pulumi.String("string"),
	Name:              pulumi.String("string"),
	PolicyEngineMode:  pulumi.String("string"),
})

    var flowResource = new Flow("flowResource", FlowArgs.builder()
    .designation("string")
    .slug("string")
    .title("string")
    .authentication("string")
    .background("string")
    .compatibilityMode(false)
    .deniedAction("string")
    .flowId("string")
    .layout("string")
    .name("string")
    .policyEngineMode("string")
    .build());

    flow_resource = authentik.Flow("flowResource",
    designation="string",
    slug="string",
    title="string",
    authentication="string",
    background="string",
    compatibility_mode=False,
    denied_action="string",
    flow_id="string",
    layout="string",
    name="string",
    policy_engine_mode="string")

    const flowResource = new authentik.Flow("flowResource", {
    designation: "string",
    slug: "string",
    title: "string",
    authentication: "string",
    background: "string",
    compatibilityMode: false,
    deniedAction: "string",
    flowId: "string",
    layout: "string",
    name: "string",
    policyEngineMode: "string",
});

    type: authentik:Flow
properties:
    authentication: string
    background: string
    compatibilityMode: false
    deniedAction: string
    designation: string
    flowId: string
    layout: string
    name: string
    policyEngineMode: string
    slug: string
    title: string

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

    Designation string
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    Slug string
    Title string
    Authentication string
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    Background string
    Optional URL to an image which will be used as the background during the flow.
    CompatibilityMode bool
    Defaults to true.
    DeniedAction string
    Defaults to message_continue.
    FlowId string
    Layout string
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    Name string
    PolicyEngineMode string
    Allowed values: - all - any Defaults to any.
    Designation string
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    Slug string
    Title string
    Authentication string
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    Background string
    Optional URL to an image which will be used as the background during the flow.
    CompatibilityMode bool
    Defaults to true.
    DeniedAction string
    Defaults to message_continue.
    FlowId string
    Layout string
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    Name string
    PolicyEngineMode string
    Allowed values: - all - any Defaults to any.
    designation String
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    slug String
    title String
    authentication String
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    background String
    Optional URL to an image which will be used as the background during the flow.
    compatibilityMode Boolean
    Defaults to true.
    deniedAction String
    Defaults to message_continue.
    flowId String
    layout String
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    name String
    policyEngineMode String
    Allowed values: - all - any Defaults to any.
    designation string
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    slug string
    title string
    authentication string
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    background string
    Optional URL to an image which will be used as the background during the flow.
    compatibilityMode boolean
    Defaults to true.
    deniedAction string
    Defaults to message_continue.
    flowId string
    layout string
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    name string
    policyEngineMode string
    Allowed values: - all - any Defaults to any.
    designation str
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    slug str
    title str
    authentication str
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    background str
    Optional URL to an image which will be used as the background during the flow.
    compatibility_mode bool
    Defaults to true.
    denied_action str
    Defaults to message_continue.
    flow_id str
    layout str
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    name str
    policy_engine_mode str
    Allowed values: - all - any Defaults to any.
    designation String
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    slug String
    title String
    authentication String
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    background String
    Optional URL to an image which will be used as the background during the flow.
    compatibilityMode Boolean
    Defaults to true.
    deniedAction String
    Defaults to message_continue.
    flowId String
    layout String
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    name String
    policyEngineMode String
    Allowed values: - all - any Defaults to any.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Flow resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    Generated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    Generated.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    Generated.
    id string
    The provider-assigned unique ID for this managed resource.
    uuid string
    Generated.
    id str
    The provider-assigned unique ID for this managed resource.
    uuid str
    Generated.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    Generated.

    Look up Existing Flow Resource

    Get an existing Flow 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?: FlowState, opts?: CustomResourceOptions): Flow
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[str] = None,
        background: Optional[str] = None,
        compatibility_mode: Optional[bool] = None,
        denied_action: Optional[str] = None,
        designation: Optional[str] = None,
        flow_id: Optional[str] = None,
        layout: Optional[str] = None,
        name: Optional[str] = None,
        policy_engine_mode: Optional[str] = None,
        slug: Optional[str] = None,
        title: Optional[str] = None,
        uuid: Optional[str] = None) -> Flow
    func GetFlow(ctx *Context, name string, id IDInput, state *FlowState, opts ...ResourceOption) (*Flow, error)
    public static Flow Get(string name, Input<string> id, FlowState? state, CustomResourceOptions? opts = null)
    public static Flow get(String name, Output<String> id, FlowState state, CustomResourceOptions options)
    resources:  _:    type: authentik:Flow    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:
    Authentication string
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    Background string
    Optional URL to an image which will be used as the background during the flow.
    CompatibilityMode bool
    Defaults to true.
    DeniedAction string
    Defaults to message_continue.
    Designation string
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    FlowId string
    Layout string
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    Name string
    PolicyEngineMode string
    Allowed values: - all - any Defaults to any.
    Slug string
    Title string
    Uuid string
    Generated.
    Authentication string
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    Background string
    Optional URL to an image which will be used as the background during the flow.
    CompatibilityMode bool
    Defaults to true.
    DeniedAction string
    Defaults to message_continue.
    Designation string
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    FlowId string
    Layout string
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    Name string
    PolicyEngineMode string
    Allowed values: - all - any Defaults to any.
    Slug string
    Title string
    Uuid string
    Generated.
    authentication String
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    background String
    Optional URL to an image which will be used as the background during the flow.
    compatibilityMode Boolean
    Defaults to true.
    deniedAction String
    Defaults to message_continue.
    designation String
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    flowId String
    layout String
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    name String
    policyEngineMode String
    Allowed values: - all - any Defaults to any.
    slug String
    title String
    uuid String
    Generated.
    authentication string
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    background string
    Optional URL to an image which will be used as the background during the flow.
    compatibilityMode boolean
    Defaults to true.
    deniedAction string
    Defaults to message_continue.
    designation string
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    flowId string
    layout string
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    name string
    policyEngineMode string
    Allowed values: - all - any Defaults to any.
    slug string
    title string
    uuid string
    Generated.
    authentication str
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    background str
    Optional URL to an image which will be used as the background during the flow.
    compatibility_mode bool
    Defaults to true.
    denied_action str
    Defaults to message_continue.
    designation str
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    flow_id str
    layout str
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    name str
    policy_engine_mode str
    Allowed values: - all - any Defaults to any.
    slug str
    title str
    uuid str
    Generated.
    authentication String
    Allowed values: - none - require_authenticated - require_unauthenticated - require_superuser - require_redirect - require_outpost Defaults to none.
    background String
    Optional URL to an image which will be used as the background during the flow.
    compatibilityMode Boolean
    Defaults to true.
    deniedAction String
    Defaults to message_continue.
    designation String
    Allowed values: - authentication - authorization - invalidation - enrollment - unenrollment - recovery - stage_configuration
    flowId String
    layout String
    Allowed values: - stacked - content_left - content_right - sidebar_left - sidebar_right Defaults to stacked.
    name String
    policyEngineMode String
    Allowed values: - all - any Defaults to any.
    slug String
    title String
    uuid String
    Generated.

    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