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

authentik.FlowStageBinding

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

// 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,
});
Copy
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)
Copy
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
	})
}
Copy
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,
    });

});
Copy
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());

    }
}
Copy
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
Copy

Create FlowStageBinding Resource

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

Constructor syntax

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

@overload
def FlowStageBinding(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     order: Optional[float] = None,
                     stage: Optional[str] = None,
                     target: Optional[str] = None,
                     evaluate_on_plan: Optional[bool] = None,
                     flow_stage_binding_id: Optional[str] = None,
                     invalid_response_action: Optional[str] = None,
                     policy_engine_mode: Optional[str] = None,
                     re_evaluate_policies: Optional[bool] = None)
func NewFlowStageBinding(ctx *Context, name string, args FlowStageBindingArgs, opts ...ResourceOption) (*FlowStageBinding, error)
public FlowStageBinding(string name, FlowStageBindingArgs args, CustomResourceOptions? opts = null)
public FlowStageBinding(String name, FlowStageBindingArgs args)
public FlowStageBinding(String name, FlowStageBindingArgs args, CustomResourceOptions options)

type: authentik:FlowStageBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FlowStageBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FlowStageBindingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FlowStageBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FlowStageBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FlowStageBindingArgs
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 flowStageBindingResource = new Authentik.FlowStageBinding("flowStageBindingResource", new()
{
    Order = 0,
    Stage = "string",
    Target = "string",
    EvaluateOnPlan = false,
    FlowStageBindingId = "string",
    InvalidResponseAction = "string",
    PolicyEngineMode = "string",
    ReEvaluatePolicies = false,
});
Copy
example, err := authentik.NewFlowStageBinding(ctx, "flowStageBindingResource", &authentik.FlowStageBindingArgs{
	Order:                 pulumi.Float64(0),
	Stage:                 pulumi.String("string"),
	Target:                pulumi.String("string"),
	EvaluateOnPlan:        pulumi.Bool(false),
	FlowStageBindingId:    pulumi.String("string"),
	InvalidResponseAction: pulumi.String("string"),
	PolicyEngineMode:      pulumi.String("string"),
	ReEvaluatePolicies:    pulumi.Bool(false),
})
Copy
var flowStageBindingResource = new FlowStageBinding("flowStageBindingResource", FlowStageBindingArgs.builder()
    .order(0)
    .stage("string")
    .target("string")
    .evaluateOnPlan(false)
    .flowStageBindingId("string")
    .invalidResponseAction("string")
    .policyEngineMode("string")
    .reEvaluatePolicies(false)
    .build());
Copy
flow_stage_binding_resource = authentik.FlowStageBinding("flowStageBindingResource",
    order=0,
    stage="string",
    target="string",
    evaluate_on_plan=False,
    flow_stage_binding_id="string",
    invalid_response_action="string",
    policy_engine_mode="string",
    re_evaluate_policies=False)
Copy
const flowStageBindingResource = new authentik.FlowStageBinding("flowStageBindingResource", {
    order: 0,
    stage: "string",
    target: "string",
    evaluateOnPlan: false,
    flowStageBindingId: "string",
    invalidResponseAction: "string",
    policyEngineMode: "string",
    reEvaluatePolicies: false,
});
Copy
type: authentik:FlowStageBinding
properties:
    evaluateOnPlan: false
    flowStageBindingId: string
    invalidResponseAction: string
    order: 0
    policyEngineMode: string
    reEvaluatePolicies: false
    stage: string
    target: string
Copy

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

Order This property is required. double
Stage This property is required. string
Target This property is required. string
EvaluateOnPlan bool
Evaluate policies during the Flow planning process. Defaults to true.
FlowStageBindingId string
InvalidResponseAction string
Allowed values: - retry - restart - restart_with_context Defaults to retry.
PolicyEngineMode string
Allowed values: - all - any Defaults to any.
ReEvaluatePolicies bool
Evaluate policies when the Stage is present to the user. Defaults to false.
Order This property is required. float64
Stage This property is required. string
Target This property is required. string
EvaluateOnPlan bool
Evaluate policies during the Flow planning process. Defaults to true.
FlowStageBindingId string
InvalidResponseAction string
Allowed values: - retry - restart - restart_with_context Defaults to retry.
PolicyEngineMode string
Allowed values: - all - any Defaults to any.
ReEvaluatePolicies bool
Evaluate policies when the Stage is present to the user. Defaults to false.
order This property is required. Double
stage This property is required. String
target This property is required. String
evaluateOnPlan Boolean
Evaluate policies during the Flow planning process. Defaults to true.
flowStageBindingId String
invalidResponseAction String
Allowed values: - retry - restart - restart_with_context Defaults to retry.
policyEngineMode String
Allowed values: - all - any Defaults to any.
reEvaluatePolicies Boolean
Evaluate policies when the Stage is present to the user. Defaults to false.
order This property is required. number
stage This property is required. string
target This property is required. string
evaluateOnPlan boolean
Evaluate policies during the Flow planning process. Defaults to true.
flowStageBindingId string
invalidResponseAction string
Allowed values: - retry - restart - restart_with_context Defaults to retry.
policyEngineMode string
Allowed values: - all - any Defaults to any.
reEvaluatePolicies boolean
Evaluate policies when the Stage is present to the user. Defaults to false.
order This property is required. float
stage This property is required. str
target This property is required. str
evaluate_on_plan bool
Evaluate policies during the Flow planning process. Defaults to true.
flow_stage_binding_id str
invalid_response_action str
Allowed values: - retry - restart - restart_with_context Defaults to retry.
policy_engine_mode str
Allowed values: - all - any Defaults to any.
re_evaluate_policies bool
Evaluate policies when the Stage is present to the user. Defaults to false.
order This property is required. Number
stage This property is required. String
target This property is required. String
evaluateOnPlan Boolean
Evaluate policies during the Flow planning process. Defaults to true.
flowStageBindingId String
invalidResponseAction String
Allowed values: - retry - restart - restart_with_context Defaults to retry.
policyEngineMode String
Allowed values: - all - any Defaults to any.
reEvaluatePolicies Boolean
Evaluate policies when the Stage is present to the user. Defaults to false.

Outputs

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

Get an existing FlowStageBinding 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?: FlowStageBindingState, opts?: CustomResourceOptions): FlowStageBinding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        evaluate_on_plan: Optional[bool] = None,
        flow_stage_binding_id: Optional[str] = None,
        invalid_response_action: Optional[str] = None,
        order: Optional[float] = None,
        policy_engine_mode: Optional[str] = None,
        re_evaluate_policies: Optional[bool] = None,
        stage: Optional[str] = None,
        target: Optional[str] = None) -> FlowStageBinding
func GetFlowStageBinding(ctx *Context, name string, id IDInput, state *FlowStageBindingState, opts ...ResourceOption) (*FlowStageBinding, error)
public static FlowStageBinding Get(string name, Input<string> id, FlowStageBindingState? state, CustomResourceOptions? opts = null)
public static FlowStageBinding get(String name, Output<String> id, FlowStageBindingState state, CustomResourceOptions options)
resources:  _:    type: authentik:FlowStageBinding    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
EvaluateOnPlan bool
Evaluate policies during the Flow planning process. Defaults to true.
FlowStageBindingId string
InvalidResponseAction string
Allowed values: - retry - restart - restart_with_context Defaults to retry.
Order double
PolicyEngineMode string
Allowed values: - all - any Defaults to any.
ReEvaluatePolicies bool
Evaluate policies when the Stage is present to the user. Defaults to false.
Stage string
Target string
EvaluateOnPlan bool
Evaluate policies during the Flow planning process. Defaults to true.
FlowStageBindingId string
InvalidResponseAction string
Allowed values: - retry - restart - restart_with_context Defaults to retry.
Order float64
PolicyEngineMode string
Allowed values: - all - any Defaults to any.
ReEvaluatePolicies bool
Evaluate policies when the Stage is present to the user. Defaults to false.
Stage string
Target string
evaluateOnPlan Boolean
Evaluate policies during the Flow planning process. Defaults to true.
flowStageBindingId String
invalidResponseAction String
Allowed values: - retry - restart - restart_with_context Defaults to retry.
order Double
policyEngineMode String
Allowed values: - all - any Defaults to any.
reEvaluatePolicies Boolean
Evaluate policies when the Stage is present to the user. Defaults to false.
stage String
target String
evaluateOnPlan boolean
Evaluate policies during the Flow planning process. Defaults to true.
flowStageBindingId string
invalidResponseAction string
Allowed values: - retry - restart - restart_with_context Defaults to retry.
order number
policyEngineMode string
Allowed values: - all - any Defaults to any.
reEvaluatePolicies boolean
Evaluate policies when the Stage is present to the user. Defaults to false.
stage string
target string
evaluate_on_plan bool
Evaluate policies during the Flow planning process. Defaults to true.
flow_stage_binding_id str
invalid_response_action str
Allowed values: - retry - restart - restart_with_context Defaults to retry.
order float
policy_engine_mode str
Allowed values: - all - any Defaults to any.
re_evaluate_policies bool
Evaluate policies when the Stage is present to the user. Defaults to false.
stage str
target str
evaluateOnPlan Boolean
Evaluate policies during the Flow planning process. Defaults to true.
flowStageBindingId String
invalidResponseAction String
Allowed values: - retry - restart - restart_with_context Defaults to retry.
order Number
policyEngineMode String
Allowed values: - all - any Defaults to any.
reEvaluatePolicies Boolean
Evaluate policies when the Stage is present to the user. Defaults to false.
stage String
target String

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