1. Packages
  2. Authentik Provider
  3. API Docs
  4. getFlow
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

authentik.getFlow

Explore with Pulumi AI

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

    Get flows by Slug and/or designation

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as authentik from "@pulumi/authentik";
    
    const default_authorization_flow = authentik.getFlow({
        slug: "default-provider-authorization-implicit-consent",
    });
    
    import pulumi
    import pulumi_authentik as authentik
    
    default_authorization_flow = authentik.get_flow(slug="default-provider-authorization-implicit-consent")
    
    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.LookupFlow(ctx, &authentik.LookupFlowArgs{
    			Slug: pulumi.StringRef("default-provider-authorization-implicit-consent"),
    		}, 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(() => 
    {
        var default_authorization_flow = Authentik.GetFlow.Invoke(new()
        {
            Slug = "default-provider-authorization-implicit-consent",
        });
    
    });
    
    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.GetFlowArgs;
    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) {
            final var default-authorization-flow = AuthentikFunctions.getFlow(GetFlowArgs.builder()
                .slug("default-provider-authorization-implicit-consent")
                .build());
    
        }
    }
    
    variables:
      default-authorization-flow:
        fn::invoke:
          function: authentik:getFlow
          arguments:
            slug: default-provider-authorization-implicit-consent
    

    Using getFlow

    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 getFlow(args: GetFlowArgs, opts?: InvokeOptions): Promise<GetFlowResult>
    function getFlowOutput(args: GetFlowOutputArgs, opts?: InvokeOptions): Output<GetFlowResult>
    def get_flow(authentication: Optional[str] = None,
                 designation: Optional[str] = None,
                 id: Optional[str] = None,
                 slug: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFlowResult
    def get_flow_output(authentication: Optional[pulumi.Input[str]] = None,
                 designation: Optional[pulumi.Input[str]] = None,
                 id: Optional[pulumi.Input[str]] = None,
                 slug: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetFlowResult]
    func LookupFlow(ctx *Context, args *LookupFlowArgs, opts ...InvokeOption) (*LookupFlowResult, error)
    func LookupFlowOutput(ctx *Context, args *LookupFlowOutputArgs, opts ...InvokeOption) LookupFlowResultOutput

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

    public static class GetFlow 
    {
        public static Task<GetFlowResult> InvokeAsync(GetFlowArgs args, InvokeOptions? opts = null)
        public static Output<GetFlowResult> Invoke(GetFlowInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFlowResult> getFlow(GetFlowArgs args, InvokeOptions options)
    public static Output<GetFlowResult> getFlow(GetFlowArgs args, InvokeOptions options)
    
    fn::invoke:
      function: authentik:index/getFlow:getFlow
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Authentication string
    Generated.
    Designation string
    Generated.
    Id string
    The ID of this resource.
    Slug string
    Generated.
    Authentication string
    Generated.
    Designation string
    Generated.
    Id string
    The ID of this resource.
    Slug string
    Generated.
    authentication String
    Generated.
    designation String
    Generated.
    id String
    The ID of this resource.
    slug String
    Generated.
    authentication string
    Generated.
    designation string
    Generated.
    id string
    The ID of this resource.
    slug string
    Generated.
    authentication str
    Generated.
    designation str
    Generated.
    id str
    The ID of this resource.
    slug str
    Generated.
    authentication String
    Generated.
    designation String
    Generated.
    id String
    The ID of this resource.
    slug String
    Generated.

    getFlow Result

    The following output properties are available:

    Authentication string
    Generated.
    Designation string
    Generated.
    Id string
    The ID of this resource.
    Name string
    Generated.
    Slug string
    Generated.
    Title string
    Generated.
    Authentication string
    Generated.
    Designation string
    Generated.
    Id string
    The ID of this resource.
    Name string
    Generated.
    Slug string
    Generated.
    Title string
    Generated.
    authentication String
    Generated.
    designation String
    Generated.
    id String
    The ID of this resource.
    name String
    Generated.
    slug String
    Generated.
    title String
    Generated.
    authentication string
    Generated.
    designation string
    Generated.
    id string
    The ID of this resource.
    name string
    Generated.
    slug string
    Generated.
    title string
    Generated.
    authentication str
    Generated.
    designation str
    Generated.
    id str
    The ID of this resource.
    name str
    Generated.
    slug str
    Generated.
    title str
    Generated.
    authentication String
    Generated.
    designation String
    Generated.
    id String
    The ID of this resource.
    name String
    Generated.
    slug String
    Generated.
    title 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