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

authentik.Blueprint

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

const instance = new authentik.Blueprint("instance", {
    path: "default/flow-default-authentication-flow.yaml",
    context: JSON.stringify({
        foo: "bar",
    }),
});

    import pulumi
import json
import pulumi_authentik as authentik

instance = authentik.Blueprint("instance",
    path="default/flow-default-authentication-flow.yaml",
    context=json.dumps({
        "foo": "bar",
    }))

    package main

import (
	"encoding/json"

	"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 {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"foo": "bar",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = authentik.NewBlueprint(ctx, "instance", &authentik.BlueprintArgs{
			Path:    pulumi.String("default/flow-default-authentication-flow.yaml"),
			Context: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var instance = new Authentik.Blueprint("instance", new()
    {
        Path = "default/flow-default-authentication-flow.yaml",
        Context = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["foo"] = "bar",
        }),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.Blueprint;
import com.pulumi.authentik.BlueprintArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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) {
        var instance = new Blueprint("instance", BlueprintArgs.builder()
            .path("default/flow-default-authentication-flow.yaml")
            .context(serializeJson(
                jsonObject(
                    jsonProperty("foo", "bar")
                )))
            .build());

    }
}

    resources:
  instance:
    type: authentik:Blueprint
    properties:
      path: default/flow-default-authentication-flow.yaml
      context:
        fn::toJSON:
          foo: bar

    Create Blueprint Resource

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

    Constructor syntax

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

@overload
def Blueprint(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              blueprint_id: Optional[str] = None,
              content: Optional[str] = None,
              context: Optional[str] = None,
              enabled: Optional[bool] = None,
              name: Optional[str] = None,
              path: Optional[str] = None)
    func NewBlueprint(ctx *Context, name string, args *BlueprintArgs, opts ...ResourceOption) (*Blueprint, error)
    public Blueprint(string name, BlueprintArgs? args = null, CustomResourceOptions? opts = null)
    public Blueprint(String name, BlueprintArgs args)
public Blueprint(String name, BlueprintArgs args, CustomResourceOptions options)

    type: authentik:Blueprint
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 BlueprintArgs
    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 BlueprintArgs
    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 BlueprintArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BlueprintArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BlueprintArgs
    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 blueprintResource = new Authentik.Blueprint("blueprintResource", new()
{
    BlueprintId = "string",
    Content = "string",
    Context = "string",
    Enabled = false,
    Name = "string",
    Path = "string",
});

    example, err := authentik.NewBlueprint(ctx, "blueprintResource", &authentik.BlueprintArgs{
	BlueprintId: pulumi.String("string"),
	Content:     pulumi.String("string"),
	Context:     pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Name:        pulumi.String("string"),
	Path:        pulumi.String("string"),
})

    var blueprintResource = new Blueprint("blueprintResource", BlueprintArgs.builder()
    .blueprintId("string")
    .content("string")
    .context("string")
    .enabled(false)
    .name("string")
    .path("string")
    .build());

    blueprint_resource = authentik.Blueprint("blueprintResource",
    blueprint_id="string",
    content="string",
    context="string",
    enabled=False,
    name="string",
    path="string")

    const blueprintResource = new authentik.Blueprint("blueprintResource", {
    blueprintId: "string",
    content: "string",
    context: "string",
    enabled: false,
    name: "string",
    path: "string",
});

    type: authentik:Blueprint
properties:
    blueprintId: string
    content: string
    context: string
    enabled: false
    name: string
    path: string

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

    BlueprintId string
    The ID of this resource.
    Content string
    Context string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    Enabled bool
    Defaults to true.
    Name string
    Path string
    BlueprintId string
    The ID of this resource.
    Content string
    Context string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    Enabled bool
    Defaults to true.
    Name string
    Path string
    blueprintId String
    The ID of this resource.
    content String
    context String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    enabled Boolean
    Defaults to true.
    name String
    path String
    blueprintId string
    The ID of this resource.
    content string
    context string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    enabled boolean
    Defaults to true.
    name string
    path string
    blueprint_id str
    The ID of this resource.
    content str
    context str
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    enabled bool
    Defaults to true.
    name str
    path str
    blueprintId String
    The ID of this resource.
    content String
    context String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    enabled Boolean
    Defaults to true.
    name String
    path String

    Outputs

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

    Get an existing Blueprint 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?: BlueprintState, opts?: CustomResourceOptions): Blueprint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        blueprint_id: Optional[str] = None,
        content: Optional[str] = None,
        context: Optional[str] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        path: Optional[str] = None) -> Blueprint
    func GetBlueprint(ctx *Context, name string, id IDInput, state *BlueprintState, opts ...ResourceOption) (*Blueprint, error)
    public static Blueprint Get(string name, Input<string> id, BlueprintState? state, CustomResourceOptions? opts = null)
    public static Blueprint get(String name, Output<String> id, BlueprintState state, CustomResourceOptions options)
    resources:  _:    type: authentik:Blueprint    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:
    BlueprintId string
    The ID of this resource.
    Content string
    Context string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    Enabled bool
    Defaults to true.
    Name string
    Path string
    BlueprintId string
    The ID of this resource.
    Content string
    Context string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    Enabled bool
    Defaults to true.
    Name string
    Path string
    blueprintId String
    The ID of this resource.
    content String
    context String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    enabled Boolean
    Defaults to true.
    name String
    path String
    blueprintId string
    The ID of this resource.
    content string
    context string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    enabled boolean
    Defaults to true.
    name string
    path string
    blueprint_id str
    The ID of this resource.
    content str
    context str
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    enabled bool
    Defaults to true.
    name str
    path str
    blueprintId String
    The ID of this resource.
    content String
    context String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    enabled Boolean
    Defaults to true.
    name String
    path 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