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

authentik.getBrand

Explore with Pulumi AI

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

Get brands by domain

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as authentik from "@pulumi/authentik";

const authentik_default = authentik.getBrand({
    domain: "authentik-default",
});
Copy
import pulumi
import pulumi_authentik as authentik

authentik_default = authentik.get_brand(domain="authentik-default")
Copy
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.LookupBrand(ctx, &authentik.LookupBrandArgs{
			Domain: pulumi.StringRef("authentik-default"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;

return await Deployment.RunAsync(() => 
{
    var authentik_default = Authentik.GetBrand.Invoke(new()
    {
        Domain = "authentik-default",
    });

});
Copy
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.GetBrandArgs;
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 authentik-default = AuthentikFunctions.getBrand(GetBrandArgs.builder()
            .domain("authentik-default")
            .build());

    }
}
Copy
variables:
  authentik-default:
    fn::invoke:
      function: authentik:getBrand
      arguments:
        domain: authentik-default
Copy

Using getBrand

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 getBrand(args: GetBrandArgs, opts?: InvokeOptions): Promise<GetBrandResult>
function getBrandOutput(args: GetBrandOutputArgs, opts?: InvokeOptions): Output<GetBrandResult>
Copy
def get_brand(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,
              id: Optional[str] = None,
              web_certificate: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetBrandResult
def get_brand_output(branding_favicon: Optional[pulumi.Input[str]] = None,
              branding_logo: Optional[pulumi.Input[str]] = None,
              branding_title: Optional[pulumi.Input[str]] = None,
              default: Optional[pulumi.Input[bool]] = None,
              default_application: Optional[pulumi.Input[str]] = None,
              domain: Optional[pulumi.Input[str]] = None,
              flow_authentication: Optional[pulumi.Input[str]] = None,
              flow_device_code: Optional[pulumi.Input[str]] = None,
              flow_invalidation: Optional[pulumi.Input[str]] = None,
              flow_recovery: Optional[pulumi.Input[str]] = None,
              flow_unenrollment: Optional[pulumi.Input[str]] = None,
              flow_user_settings: Optional[pulumi.Input[str]] = None,
              id: Optional[pulumi.Input[str]] = None,
              web_certificate: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetBrandResult]
Copy
func LookupBrand(ctx *Context, args *LookupBrandArgs, opts ...InvokeOption) (*LookupBrandResult, error)
func LookupBrandOutput(ctx *Context, args *LookupBrandOutputArgs, opts ...InvokeOption) LookupBrandResultOutput
Copy

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

public static class GetBrand 
{
    public static Task<GetBrandResult> InvokeAsync(GetBrandArgs args, InvokeOptions? opts = null)
    public static Output<GetBrandResult> Invoke(GetBrandInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBrandResult> getBrand(GetBrandArgs args, InvokeOptions options)
public static Output<GetBrandResult> getBrand(GetBrandArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: authentik:index/getBrand:getBrand
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BrandingFavicon string
Generated.
BrandingLogo string
Generated.
BrandingTitle string
Generated.
Default bool
Generated.
DefaultApplication string
Generated.
Domain string
Generated.
FlowAuthentication string
Generated.
FlowDeviceCode string
Generated.
FlowInvalidation string
Generated.
FlowRecovery string
Generated.
FlowUnenrollment string
Generated.
FlowUserSettings string
Generated.
Id string
The ID of this resource.
WebCertificate string
Generated.
BrandingFavicon string
Generated.
BrandingLogo string
Generated.
BrandingTitle string
Generated.
Default bool
Generated.
DefaultApplication string
Generated.
Domain string
Generated.
FlowAuthentication string
Generated.
FlowDeviceCode string
Generated.
FlowInvalidation string
Generated.
FlowRecovery string
Generated.
FlowUnenrollment string
Generated.
FlowUserSettings string
Generated.
Id string
The ID of this resource.
WebCertificate string
Generated.
brandingFavicon String
Generated.
brandingLogo String
Generated.
brandingTitle String
Generated.
defaultApplication String
Generated.
default_ Boolean
Generated.
domain String
Generated.
flowAuthentication String
Generated.
flowDeviceCode String
Generated.
flowInvalidation String
Generated.
flowRecovery String
Generated.
flowUnenrollment String
Generated.
flowUserSettings String
Generated.
id String
The ID of this resource.
webCertificate String
Generated.
brandingFavicon string
Generated.
brandingLogo string
Generated.
brandingTitle string
Generated.
default boolean
Generated.
defaultApplication string
Generated.
domain string
Generated.
flowAuthentication string
Generated.
flowDeviceCode string
Generated.
flowInvalidation string
Generated.
flowRecovery string
Generated.
flowUnenrollment string
Generated.
flowUserSettings string
Generated.
id string
The ID of this resource.
webCertificate string
Generated.
branding_favicon str
Generated.
branding_logo str
Generated.
branding_title str
Generated.
default bool
Generated.
default_application str
Generated.
domain str
Generated.
flow_authentication str
Generated.
flow_device_code str
Generated.
flow_invalidation str
Generated.
flow_recovery str
Generated.
flow_unenrollment str
Generated.
flow_user_settings str
Generated.
id str
The ID of this resource.
web_certificate str
Generated.
brandingFavicon String
Generated.
brandingLogo String
Generated.
brandingTitle String
Generated.
default Boolean
Generated.
defaultApplication String
Generated.
domain String
Generated.
flowAuthentication String
Generated.
flowDeviceCode String
Generated.
flowInvalidation String
Generated.
flowRecovery String
Generated.
flowUnenrollment String
Generated.
flowUserSettings String
Generated.
id String
The ID of this resource.
webCertificate String
Generated.

getBrand Result

The following output properties are available:

BrandingFavicon string
Generated.
BrandingLogo string
Generated.
BrandingTitle string
Generated.
Default bool
Generated.
DefaultApplication string
Generated.
Domain string
Generated.
FlowAuthentication string
Generated.
FlowDeviceCode string
Generated.
FlowInvalidation string
Generated.
FlowRecovery string
Generated.
FlowUnenrollment string
Generated.
FlowUserSettings string
Generated.
Id string
The ID of this resource.
WebCertificate string
Generated.
BrandingFavicon string
Generated.
BrandingLogo string
Generated.
BrandingTitle string
Generated.
Default bool
Generated.
DefaultApplication string
Generated.
Domain string
Generated.
FlowAuthentication string
Generated.
FlowDeviceCode string
Generated.
FlowInvalidation string
Generated.
FlowRecovery string
Generated.
FlowUnenrollment string
Generated.
FlowUserSettings string
Generated.
Id string
The ID of this resource.
WebCertificate string
Generated.
brandingFavicon String
Generated.
brandingLogo String
Generated.
brandingTitle String
Generated.
defaultApplication String
Generated.
default_ Boolean
Generated.
domain String
Generated.
flowAuthentication String
Generated.
flowDeviceCode String
Generated.
flowInvalidation String
Generated.
flowRecovery String
Generated.
flowUnenrollment String
Generated.
flowUserSettings String
Generated.
id String
The ID of this resource.
webCertificate String
Generated.
brandingFavicon string
Generated.
brandingLogo string
Generated.
brandingTitle string
Generated.
default boolean
Generated.
defaultApplication string
Generated.
domain string
Generated.
flowAuthentication string
Generated.
flowDeviceCode string
Generated.
flowInvalidation string
Generated.
flowRecovery string
Generated.
flowUnenrollment string
Generated.
flowUserSettings string
Generated.
id string
The ID of this resource.
webCertificate string
Generated.
branding_favicon str
Generated.
branding_logo str
Generated.
branding_title str
Generated.
default bool
Generated.
default_application str
Generated.
domain str
Generated.
flow_authentication str
Generated.
flow_device_code str
Generated.
flow_invalidation str
Generated.
flow_recovery str
Generated.
flow_unenrollment str
Generated.
flow_user_settings str
Generated.
id str
The ID of this resource.
web_certificate str
Generated.
brandingFavicon String
Generated.
brandingLogo String
Generated.
brandingTitle String
Generated.
default Boolean
Generated.
defaultApplication String
Generated.
domain String
Generated.
flowAuthentication String
Generated.
flowDeviceCode String
Generated.
flowInvalidation String
Generated.
flowRecovery String
Generated.
flowUnenrollment String
Generated.
flowUserSettings String
Generated.
id String
The ID of this resource.
webCertificate String
Generated.

Package Details

Repository
authentik goauthentik/terraform-provider-authentik
License
Notes
This Pulumi package is based on the authentik Terraform Provider.
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik