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

authentik.Brand

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 _default = new authentik.Brand("default", {
    brandingTitle: "test",
    "default": true,
    domain: ".",
});

    import pulumi
import pulumi_authentik as authentik

default = authentik.Brand("default",
    branding_title="test",
    default=True,
    domain=".")

    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.NewBrand(ctx, "default", &authentik.BrandArgs{
			BrandingTitle: pulumi.String("test"),
			Default:       pulumi.Bool(true),
			Domain:        pulumi.String("."),
		})
		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 = new Authentik.Brand("default", new()
    {
        BrandingTitle = "test",
        Default = true,
        Domain = ".",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.Brand;
import com.pulumi.authentik.BrandArgs;
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 default_ = new Brand("default", BrandArgs.builder()
            .brandingTitle("test")
            .default_(true)
            .domain(".")
            .build());

    }
}

    resources:
  default:
    type: authentik:Brand
    properties:
      brandingTitle: test
      default: true
      domain: .

    Create Brand Resource

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

    Constructor syntax

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

@overload
def Brand(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          domain: Optional[str] = None,
          default_application: Optional[str] = None,
          flow_authentication: Optional[str] = None,
          branding_logo: Optional[str] = None,
          branding_title: Optional[str] = None,
          default: Optional[bool] = None,
          attributes: Optional[str] = None,
          brand_id: Optional[str] = None,
          branding_favicon: Optional[str] = None,
          flow_device_code: Optional[str] = None,
          flow_invalidation: Optional[str] = None,
          flow_recovery: Optional[str] = None,
          flow_unenrollment: Optional[str] = None,
          flow_user_settings: Optional[str] = None,
          web_certificate: Optional[str] = None)
    func NewBrand(ctx *Context, name string, args BrandArgs, opts ...ResourceOption) (*Brand, error)
    public Brand(string name, BrandArgs args, CustomResourceOptions? opts = null)
    public Brand(String name, BrandArgs args)
public Brand(String name, BrandArgs args, CustomResourceOptions options)

    type: authentik:Brand
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 BrandArgs
    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 BrandArgs
    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 BrandArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BrandArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BrandArgs
    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 brandResource = new Authentik.Brand("brandResource", new()
{
    Domain = "string",
    DefaultApplication = "string",
    FlowAuthentication = "string",
    BrandingLogo = "string",
    BrandingTitle = "string",
    Default = false,
    Attributes = "string",
    BrandId = "string",
    BrandingFavicon = "string",
    FlowDeviceCode = "string",
    FlowInvalidation = "string",
    FlowRecovery = "string",
    FlowUnenrollment = "string",
    FlowUserSettings = "string",
    WebCertificate = "string",
});

    example, err := authentik.NewBrand(ctx, "brandResource", &authentik.BrandArgs{
	Domain:             pulumi.String("string"),
	DefaultApplication: pulumi.String("string"),
	FlowAuthentication: pulumi.String("string"),
	BrandingLogo:       pulumi.String("string"),
	BrandingTitle:      pulumi.String("string"),
	Default:            pulumi.Bool(false),
	Attributes:         pulumi.String("string"),
	BrandId:            pulumi.String("string"),
	BrandingFavicon:    pulumi.String("string"),
	FlowDeviceCode:     pulumi.String("string"),
	FlowInvalidation:   pulumi.String("string"),
	FlowRecovery:       pulumi.String("string"),
	FlowUnenrollment:   pulumi.String("string"),
	FlowUserSettings:   pulumi.String("string"),
	WebCertificate:     pulumi.String("string"),
})

    var brandResource = new Brand("brandResource", BrandArgs.builder()
    .domain("string")
    .defaultApplication("string")
    .flowAuthentication("string")
    .brandingLogo("string")
    .brandingTitle("string")
    .default_(false)
    .attributes("string")
    .brandId("string")
    .brandingFavicon("string")
    .flowDeviceCode("string")
    .flowInvalidation("string")
    .flowRecovery("string")
    .flowUnenrollment("string")
    .flowUserSettings("string")
    .webCertificate("string")
    .build());

    brand_resource = authentik.Brand("brandResource",
    domain="string",
    default_application="string",
    flow_authentication="string",
    branding_logo="string",
    branding_title="string",
    default=False,
    attributes="string",
    brand_id="string",
    branding_favicon="string",
    flow_device_code="string",
    flow_invalidation="string",
    flow_recovery="string",
    flow_unenrollment="string",
    flow_user_settings="string",
    web_certificate="string")

    const brandResource = new authentik.Brand("brandResource", {
    domain: "string",
    defaultApplication: "string",
    flowAuthentication: "string",
    brandingLogo: "string",
    brandingTitle: "string",
    "default": false,
    attributes: "string",
    brandId: "string",
    brandingFavicon: "string",
    flowDeviceCode: "string",
    flowInvalidation: "string",
    flowRecovery: "string",
    flowUnenrollment: "string",
    flowUserSettings: "string",
    webCertificate: "string",
});

    type: authentik:Brand
properties:
    attributes: string
    brandId: string
    brandingFavicon: string
    brandingLogo: string
    brandingTitle: string
    default: false
    defaultApplication: string
    domain: string
    flowAuthentication: string
    flowDeviceCode: string
    flowInvalidation: string
    flowRecovery: string
    flowUnenrollment: string
    flowUserSettings: string
    webCertificate: string

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

    Domain string
    Attributes string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    BrandId string
    The ID of this resource.
    BrandingFavicon string
    BrandingLogo string
    BrandingTitle string
    Defaults to authentik.
    Default bool
    Defaults to false.
    DefaultApplication string
    FlowAuthentication string
    FlowDeviceCode string
    FlowInvalidation string
    FlowRecovery string
    FlowUnenrollment string
    FlowUserSettings string
    WebCertificate string
    Domain string
    Attributes string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    BrandId string
    The ID of this resource.
    BrandingFavicon string
    BrandingLogo string
    BrandingTitle string
    Defaults to authentik.
    Default bool
    Defaults to false.
    DefaultApplication string
    FlowAuthentication string
    FlowDeviceCode string
    FlowInvalidation string
    FlowRecovery string
    FlowUnenrollment string
    FlowUserSettings string
    WebCertificate string
    domain String
    attributes String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    brandId String
    The ID of this resource.
    brandingFavicon String
    brandingLogo String
    brandingTitle String
    Defaults to authentik.
    defaultApplication String
    default_ Boolean
    Defaults to false.
    flowAuthentication String
    flowDeviceCode String
    flowInvalidation String
    flowRecovery String
    flowUnenrollment String
    flowUserSettings String
    webCertificate String
    domain string
    attributes string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    brandId string
    The ID of this resource.
    brandingFavicon string
    brandingLogo string
    brandingTitle string
    Defaults to authentik.
    default boolean
    Defaults to false.
    defaultApplication string
    flowAuthentication string
    flowDeviceCode string
    flowInvalidation string
    flowRecovery string
    flowUnenrollment string
    flowUserSettings string
    webCertificate string
    domain str
    attributes str
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    brand_id str
    The ID of this resource.
    branding_favicon str
    branding_logo str
    branding_title str
    Defaults to authentik.
    default bool
    Defaults to false.
    default_application str
    flow_authentication str
    flow_device_code str
    flow_invalidation str
    flow_recovery str
    flow_unenrollment str
    flow_user_settings str
    web_certificate str
    domain String
    attributes String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    brandId String
    The ID of this resource.
    brandingFavicon String
    brandingLogo String
    brandingTitle String
    Defaults to authentik.
    default Boolean
    Defaults to false.
    defaultApplication String
    flowAuthentication String
    flowDeviceCode String
    flowInvalidation String
    flowRecovery String
    flowUnenrollment String
    flowUserSettings String
    webCertificate String

    Outputs

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

    Get an existing Brand 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?: BrandState, opts?: CustomResourceOptions): Brand
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attributes: Optional[str] = None,
        brand_id: Optional[str] = None,
        branding_favicon: Optional[str] = None,
        branding_logo: Optional[str] = None,
        branding_title: Optional[str] = None,
        default: Optional[bool] = None,
        default_application: Optional[str] = None,
        domain: Optional[str] = None,
        flow_authentication: Optional[str] = None,
        flow_device_code: Optional[str] = None,
        flow_invalidation: Optional[str] = None,
        flow_recovery: Optional[str] = None,
        flow_unenrollment: Optional[str] = None,
        flow_user_settings: Optional[str] = None,
        web_certificate: Optional[str] = None) -> Brand
    func GetBrand(ctx *Context, name string, id IDInput, state *BrandState, opts ...ResourceOption) (*Brand, error)
    public static Brand Get(string name, Input<string> id, BrandState? state, CustomResourceOptions? opts = null)
    public static Brand get(String name, Output<String> id, BrandState state, CustomResourceOptions options)
    resources:  _:    type: authentik:Brand    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:
    Attributes string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    BrandId string
    The ID of this resource.
    BrandingFavicon string
    BrandingLogo string
    BrandingTitle string
    Defaults to authentik.
    Default bool
    Defaults to false.
    DefaultApplication string
    Domain string
    FlowAuthentication string
    FlowDeviceCode string
    FlowInvalidation string
    FlowRecovery string
    FlowUnenrollment string
    FlowUserSettings string
    WebCertificate string
    Attributes string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    BrandId string
    The ID of this resource.
    BrandingFavicon string
    BrandingLogo string
    BrandingTitle string
    Defaults to authentik.
    Default bool
    Defaults to false.
    DefaultApplication string
    Domain string
    FlowAuthentication string
    FlowDeviceCode string
    FlowInvalidation string
    FlowRecovery string
    FlowUnenrollment string
    FlowUserSettings string
    WebCertificate string
    attributes String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    brandId String
    The ID of this resource.
    brandingFavicon String
    brandingLogo String
    brandingTitle String
    Defaults to authentik.
    defaultApplication String
    default_ Boolean
    Defaults to false.
    domain String
    flowAuthentication String
    flowDeviceCode String
    flowInvalidation String
    flowRecovery String
    flowUnenrollment String
    flowUserSettings String
    webCertificate String
    attributes string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    brandId string
    The ID of this resource.
    brandingFavicon string
    brandingLogo string
    brandingTitle string
    Defaults to authentik.
    default boolean
    Defaults to false.
    defaultApplication string
    domain string
    flowAuthentication string
    flowDeviceCode string
    flowInvalidation string
    flowRecovery string
    flowUnenrollment string
    flowUserSettings string
    webCertificate string
    attributes str
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    brand_id str
    The ID of this resource.
    branding_favicon str
    branding_logo str
    branding_title str
    Defaults to authentik.
    default bool
    Defaults to false.
    default_application str
    domain str
    flow_authentication str
    flow_device_code str
    flow_invalidation str
    flow_recovery str
    flow_unenrollment str
    flow_user_settings str
    web_certificate str
    attributes String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    brandId String
    The ID of this resource.
    brandingFavicon String
    brandingLogo String
    brandingTitle String
    Defaults to authentik.
    default Boolean
    Defaults to false.
    defaultApplication String
    domain String
    flowAuthentication String
    flowDeviceCode String
    flowInvalidation String
    flowRecovery String
    flowUnenrollment String
    flowUserSettings String
    webCertificate 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