← All packages

Auth0

Pulumi Official
Package maintained by Pulumi
v2.9.0 published on Thursday, May 26, 2022 by Pulumi
Source code
  1. Pulumi Registry
  2. Auth0
  3. Auth0
  4. Branding

Branding

This resource allows you to manage branding within your Auth0 tenant.

Auth0 can be customized with a look and feel that aligns with your organization’s brand requirements and user expectations.

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
    public MyStack()
    {
        var myBrand = new Auth0.Branding("myBrand", new Auth0.BrandingArgs
        {
            Colors = new Auth0.Inputs.BrandingColorsArgs
            {
                PageBackground = "#000000",
                Primary = "#0059d6",
            },
            LogoUrl = "https://mycompany.org/logo.png",
            UniversalLogin = new Auth0.Inputs.BrandingUniversalLoginArgs
            {
                Body = "<!DOCTYPE html><html><head>{%- auth0:head -%}</head><body>{%- auth0:widget -%}</body></html>",
            },
        });
    }

}

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-auth0/sdk/v2/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.NewBranding(ctx, "myBrand", &auth0.BrandingArgs{
			Colors: &BrandingColorsArgs{
				PageBackground: pulumi.String("#000000"),
				Primary:        pulumi.String("#0059d6"),
			},
			LogoUrl: pulumi.String("https://mycompany.org/logo.png"),
			UniversalLogin: &BrandingUniversalLoginArgs{
				Body: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v", "<!DOCTYPE html><html><head>{", "%", "- auth0:head -", "%", "}</head><body>{", "%", "- auth0:widget -", "%", "}</body></html>")),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myBrand = new Branding("myBrand", BrandingArgs.builder()        
            .colors(BrandingColorsArgs.builder()
                .pageBackground("#000000")
                .primary("#0059d6")
                .build())
            .logoUrl("https://mycompany.org/logo.png")
            .universalLogin(BrandingUniversalLoginArgs.builder()
                .body("<!DOCTYPE html><html><head>{%- auth0:head -%}</head><body>{%- auth0:widget -%}</body></html>")
                .build())
            .build());

    }
}

import pulumi
import pulumi_auth0 as auth0

my_brand = auth0.Branding("myBrand",
    colors=auth0.BrandingColorsArgs(
        page_background="#000000",
        primary="#0059d6",
    ),
    logo_url="https://mycompany.org/logo.png",
    universal_login=auth0.BrandingUniversalLoginArgs(
        body="<!DOCTYPE html><html><head>{%- auth0:head -%}</head><body>{%- auth0:widget -%}</body></html>",
    ))

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

const myBrand = new auth0.Branding("my_brand", {
    colors: {
        pageBackground: "#000000",
        primary: "#0059d6",
    },
    logoUrl: "https://mycompany.org/logo.png",
    universalLogin: {
        body: "<!DOCTYPE html><html><head>{%- auth0:head -%}</head><body>{%- auth0:widget -%}</body></html>",
    },
});

resources:
  myBrand:
    type: auth0:Branding
    properties:
      colors:
        pageBackground: '#000000'
        primary: '#0059d6'
      logoUrl: https://mycompany.org/logo.png
      universalLogin:
        body: <!DOCTYPE html><html><head>{%- auth0:head -%}</head><body>{%- auth0:widget -%}</body></html>

Create a Branding Resource

new Branding(name: string, args?: BrandingArgs, opts?: CustomResourceOptions);
@overload
def Branding(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             colors: Optional[BrandingColorsArgs] = None,
             favicon_url: Optional[str] = None,
             font: Optional[BrandingFontArgs] = None,
             logo_url: Optional[str] = None,
             universal_login: Optional[BrandingUniversalLoginArgs] = None)
@overload
def Branding(resource_name: str,
             args: Optional[BrandingArgs] = None,
             opts: Optional[ResourceOptions] = None)
func NewBranding(ctx *Context, name string, args *BrandingArgs, opts ...ResourceOption) (*Branding, error)
public Branding(string name, BrandingArgs? args = null, CustomResourceOptions? opts = null)
public Branding(String name, BrandingArgs args)
public Branding(String name, BrandingArgs args, CustomResourceOptions options)

type: auth0:Branding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BrandingArgs
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 BrandingArgs
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 BrandingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BrandingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BrandingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Branding Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Branding resource accepts the following input properties:

Colors BrandingColorsArgs

List(Resource). Configuration settings for colors for branding. See Colors.

FaviconUrl string

String. URL for the favicon.

Font BrandingFontArgs

List(Resource). Configuration settings to customize the font. See Font.

LogoUrl string

String. URL of logo for branding.

UniversalLogin BrandingUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

Colors BrandingColorsArgs

List(Resource). Configuration settings for colors for branding. See Colors.

FaviconUrl string

String. URL for the favicon.

Font BrandingFontArgs

List(Resource). Configuration settings to customize the font. See Font.

LogoUrl string

String. URL of logo for branding.

UniversalLogin BrandingUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

colors BrandingColorsArgs

List(Resource). Configuration settings for colors for branding. See Colors.

faviconUrl String

String. URL for the favicon.

font BrandingFontArgs

List(Resource). Configuration settings to customize the font. See Font.

logoUrl String

String. URL of logo for branding.

universalLogin BrandingUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

colors BrandingColorsArgs

List(Resource). Configuration settings for colors for branding. See Colors.

faviconUrl string

String. URL for the favicon.

font BrandingFontArgs

List(Resource). Configuration settings to customize the font. See Font.

logoUrl string

String. URL of logo for branding.

universalLogin BrandingUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

colors BrandingColorsArgs

List(Resource). Configuration settings for colors for branding. See Colors.

favicon_url str

String. URL for the favicon.

font BrandingFontArgs

List(Resource). Configuration settings to customize the font. See Font.

logo_url str

String. URL of logo for branding.

universal_login BrandingUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

colors Property Map

List(Resource). Configuration settings for colors for branding. See Colors.

faviconUrl String

String. URL for the favicon.

font Property Map

List(Resource). Configuration settings to customize the font. See Font.

logoUrl String

String. URL of logo for branding.

universalLogin Property Map

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

Outputs

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

Get an existing Branding 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?: BrandingState, opts?: CustomResourceOptions): Branding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        colors: Optional[BrandingColorsArgs] = None,
        favicon_url: Optional[str] = None,
        font: Optional[BrandingFontArgs] = None,
        logo_url: Optional[str] = None,
        universal_login: Optional[BrandingUniversalLoginArgs] = None) -> Branding
func GetBranding(ctx *Context, name string, id IDInput, state *BrandingState, opts ...ResourceOption) (*Branding, error)
public static Branding Get(string name, Input<string> id, BrandingState? state, CustomResourceOptions? opts = null)
public static Branding get(String name, Output<String> id, BrandingState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
Colors BrandingColorsArgs

List(Resource). Configuration settings for colors for branding. See Colors.

FaviconUrl string

String. URL for the favicon.

Font BrandingFontArgs

List(Resource). Configuration settings to customize the font. See Font.

LogoUrl string

String. URL of logo for branding.

UniversalLogin BrandingUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

Colors BrandingColorsArgs

List(Resource). Configuration settings for colors for branding. See Colors.

FaviconUrl string

String. URL for the favicon.

Font BrandingFontArgs

List(Resource). Configuration settings to customize the font. See Font.

LogoUrl string

String. URL of logo for branding.

UniversalLogin BrandingUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

colors BrandingColorsArgs

List(Resource). Configuration settings for colors for branding. See Colors.

faviconUrl String

String. URL for the favicon.

font BrandingFontArgs

List(Resource). Configuration settings to customize the font. See Font.

logoUrl String

String. URL of logo for branding.

universalLogin BrandingUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

colors BrandingColorsArgs

List(Resource). Configuration settings for colors for branding. See Colors.

faviconUrl string

String. URL for the favicon.

font BrandingFontArgs

List(Resource). Configuration settings to customize the font. See Font.

logoUrl string

String. URL of logo for branding.

universalLogin BrandingUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

colors BrandingColorsArgs

List(Resource). Configuration settings for colors for branding. See Colors.

favicon_url str

String. URL for the favicon.

font BrandingFontArgs

List(Resource). Configuration settings to customize the font. See Font.

logo_url str

String. URL of logo for branding.

universal_login BrandingUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

colors Property Map

List(Resource). Configuration settings for colors for branding. See Colors.

faviconUrl String

String. URL for the favicon.

font Property Map

List(Resource). Configuration settings to customize the font. See Font.

logoUrl String

String. URL of logo for branding.

universalLogin Property Map

List(Resource). Configuration settings for Universal Login. See Universal Login. This capability can only be used if the tenant has Custom Domains enabled.

Supporting Types

BrandingColors

PageBackground string

String, Hexadecimal. Background color of login pages.

Primary string

String, Hexadecimal. Primary button background color.

PageBackground string

String, Hexadecimal. Background color of login pages.

Primary string

String, Hexadecimal. Primary button background color.

pageBackground String

String, Hexadecimal. Background color of login pages.

primary String

String, Hexadecimal. Primary button background color.

pageBackground string

String, Hexadecimal. Background color of login pages.

primary string

String, Hexadecimal. Primary button background color.

page_background str

String, Hexadecimal. Background color of login pages.

primary str

String, Hexadecimal. Primary button background color.

pageBackground String

String, Hexadecimal. Background color of login pages.

primary String

String, Hexadecimal. Primary button background color.

BrandingFont

Url string

String. URL for the custom font.

Url string

String. URL for the custom font.

url String

String. URL for the custom font.

url string

String. URL for the custom font.

url str

String. URL for the custom font.

url String

String. URL for the custom font.

BrandingUniversalLogin

Body string

String, body of login pages.

Body string

String, body of login pages.

body String

String, body of login pages.

body string

String, body of login pages.

body str

String, body of login pages.

body String

String, body of login pages.

Package Details

Repository
https://github.com/pulumi/pulumi-auth0
License
Apache-2.0
Notes

This Pulumi package is based on the auth0 Terraform Provider.