@osmit-gmbh/pulumi-authentik/flow.d.ts

A Pulumi package for creating and managing authentik cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as authentik from "@osmit-gmbh/pulumi-authentik";
 *
 * // Create a flow with a stage attached
 * const name = new authentik.StageDummy("name", {name: "test-stage"});
 * const flow = new authentik.Flow("flow", {
 *     name: "test-flow",
 *     title: "Test flow",
 *     slug: "test-flow",
 *     designation: "authorization",
 * });
 * const dummy_flow = new authentik.FlowStageBinding("dummy-flow", {
 *     target: flow.uuid,
 *     stage: name.id,
 *     order: 0,
 * });
 * ```
 */
export declare class Flow extends pulumi.CustomResource {
    /**
     * Get an existing Flow resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FlowState, opts?: pulumi.CustomResourceOptions): Flow;
    /**
     * Returns true if the given object is an instance of Flow.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Flow;
    /**
     * Allowed values: - `none` - `requireAuthenticated` - `requireUnauthenticated` - `requireSuperuser` - `requireOutpost`
     */
    readonly authentication: pulumi.Output<string | undefined>;
    /**
     * Optional URL to an image which will be used as the background during the flow.
     */
    readonly background: pulumi.Output<string | undefined>;
    readonly compatibilityMode: pulumi.Output<boolean | undefined>;
    readonly deniedAction: pulumi.Output<string | undefined>;
    /**
     * Allowed values: - `authentication` - `authorization` - `invalidation` - `enrollment` - `unenrollment` - `recovery` -
     * `stageConfiguration`
     */
    readonly designation: pulumi.Output<string>;
    /**
     * Allowed values: - `stacked` - `contentLeft` - `contentRight` - `sidebarLeft` - `sidebarRight`
     */
    readonly layout: pulumi.Output<string | undefined>;
    readonly name: pulumi.Output<string>;
    /**
     * Allowed values: - `all` - `any`
     */
    readonly policyEngineMode: pulumi.Output<string | undefined>;
    readonly slug: pulumi.Output<string>;
    readonly title: pulumi.Output<string>;
    readonly uuid: pulumi.Output<string>;
    /**
     * Create a Flow resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: FlowArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Flow resources.
 */
export interface FlowState {
    /**
     * Allowed values: - `none` - `requireAuthenticated` - `requireUnauthenticated` - `requireSuperuser` - `requireOutpost`
     */
    authentication?: pulumi.Input<string>;
    /**
     * Optional URL to an image which will be used as the background during the flow.
     */
    background?: pulumi.Input<string>;
    compatibilityMode?: pulumi.Input<boolean>;
    deniedAction?: pulumi.Input<string>;
    /**
     * Allowed values: - `authentication` - `authorization` - `invalidation` - `enrollment` - `unenrollment` - `recovery` -
     * `stageConfiguration`
     */
    designation?: pulumi.Input<string>;
    /**
     * Allowed values: - `stacked` - `contentLeft` - `contentRight` - `sidebarLeft` - `sidebarRight`
     */
    layout?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    /**
     * Allowed values: - `all` - `any`
     */
    policyEngineMode?: pulumi.Input<string>;
    slug?: pulumi.Input<string>;
    title?: pulumi.Input<string>;
    uuid?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Flow resource.
 */
export interface FlowArgs {
    /**
     * Allowed values: - `none` - `requireAuthenticated` - `requireUnauthenticated` - `requireSuperuser` - `requireOutpost`
     */
    authentication?: pulumi.Input<string>;
    /**
     * Optional URL to an image which will be used as the background during the flow.
     */
    background?: pulumi.Input<string>;
    compatibilityMode?: pulumi.Input<boolean>;
    deniedAction?: pulumi.Input<string>;
    /**
     * Allowed values: - `authentication` - `authorization` - `invalidation` - `enrollment` - `unenrollment` - `recovery` -
     * `stageConfiguration`
     */
    designation: pulumi.Input<string>;
    /**
     * Allowed values: - `stacked` - `contentLeft` - `contentRight` - `sidebarLeft` - `sidebarRight`
     */
    layout?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    /**
     * Allowed values: - `all` - `any`
     */
    policyEngineMode?: pulumi.Input<string>;
    slug: pulumi.Input<string>;
    title: pulumi.Input<string>;
}