Skip to main content

File structure

Blueprints are YAML files, which can use some additional tags to ease blueprint creation.


# The version of this blueprint, currently 1
version: 1
# Optional block of metadata, name is required if metadata is set
# Arbitrary key=value store, special labels are listed below
foo: bar
name: example-blueprint
# Optional default context, instance context is merged over this.
foo: bar
# List of entries (required)
- # Model in app.model notation, possibilities are listed in the schema (required)
model: authentik_flows.flow
# Key:value filters to uniquely identify this object (required)
slug: initial-setup
# Optional ID for use with !KeyOf
id: flow
# Attributes to set on the object. Only explicitly required settings should be stated
# as these values will override existing attributes
denied_action: message_continue
designation: stage_configuration
name: default-oobe-setup
title: Welcome to authentik!

Special Labels

Used by authentik's packaged blueprints to keep globals up-to-date. Should only be removed in special cases.

Configure if this blueprint should automatically be instantiated (defaults to "true"). When set to "false", blueprints are listed and available to be instantiated via API/Browser.