Docs Packages
  1. Packages
  2. Auth0
  3. API Docs
  4. getBranding
Auth0 v3.4.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.getBranding

Explore with Pulumi AI

auth0 logo
Auth0 v3.4.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-auth0

    Use this data source to access information about the tenant’s branding settings.

    Example Usage

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

const myBranding = auth0.getBranding({});

    import pulumi
import pulumi_auth0 as auth0

my_branding = auth0.get_branding()

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.LookupBranding(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var myBranding = Auth0.GetBranding.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.Auth0Functions;
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 myBranding = Auth0Functions.getBranding();

    }
}

    variables:
  myBranding:
    fn::invoke:
      Function: auth0:getBranding
      Arguments: {}

    Using getBranding

    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 getBranding(opts?: InvokeOptions): Promise<GetBrandingResult>
function getBrandingOutput(opts?: InvokeOptions): Output<GetBrandingResult>
    def get_branding(opts: Optional[InvokeOptions] = None) -> GetBrandingResult
def get_branding_output(opts: Optional[InvokeOptions] = None) -> Output[GetBrandingResult]
    func LookupBranding(ctx *Context, opts ...InvokeOption) (*LookupBrandingResult, error)
func LookupBrandingOutput(ctx *Context, opts ...InvokeOption) LookupBrandingResultOutput

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

    public static class GetBranding 
{
    public static Task<GetBrandingResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetBrandingResult> Invoke(InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBrandingResult> getBranding(InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: auth0:index/getBranding:getBranding
  arguments:
    # arguments dictionary

    getBranding Result

    The following output properties are available:

    Colors List<GetBrandingColor>
    Configuration settings for colors for branding.
    FaviconUrl string
    URL for the favicon.
    Fonts List<GetBrandingFont>
    Configuration settings to customize the font.
    Id string
    The provider-assigned unique ID for this managed resource.
    LogoUrl string
    URL of logo for branding.
    UniversalLogins List<GetBrandingUniversalLogin>
    Configuration settings for Universal Login.
    Colors []GetBrandingColor
    Configuration settings for colors for branding.
    FaviconUrl string
    URL for the favicon.
    Fonts []GetBrandingFont
    Configuration settings to customize the font.
    Id string
    The provider-assigned unique ID for this managed resource.
    LogoUrl string
    URL of logo for branding.
    UniversalLogins []GetBrandingUniversalLogin
    Configuration settings for Universal Login.
    colors List<GetBrandingColor>
    Configuration settings for colors for branding.
    faviconUrl String
    URL for the favicon.
    fonts List<GetBrandingFont>
    Configuration settings to customize the font.
    id String
    The provider-assigned unique ID for this managed resource.
    logoUrl String
    URL of logo for branding.
    universalLogins List<GetBrandingUniversalLogin>
    Configuration settings for Universal Login.
    colors GetBrandingColor[]
    Configuration settings for colors for branding.
    faviconUrl string
    URL for the favicon.
    fonts GetBrandingFont[]
    Configuration settings to customize the font.
    id string
    The provider-assigned unique ID for this managed resource.
    logoUrl string
    URL of logo for branding.
    universalLogins GetBrandingUniversalLogin[]
    Configuration settings for Universal Login.
    colors Sequence[GetBrandingColor]
    Configuration settings for colors for branding.
    favicon_url str
    URL for the favicon.
    fonts Sequence[GetBrandingFont]
    Configuration settings to customize the font.
    id str
    The provider-assigned unique ID for this managed resource.
    logo_url str
    URL of logo for branding.
    universal_logins Sequence[GetBrandingUniversalLogin]
    Configuration settings for Universal Login.
    colors List<Property Map>
    Configuration settings for colors for branding.
    faviconUrl String
    URL for the favicon.
    fonts List<Property Map>
    Configuration settings to customize the font.
    id String
    The provider-assigned unique ID for this managed resource.
    logoUrl String
    URL of logo for branding.
    universalLogins List<Property Map>
    Configuration settings for Universal Login.

    Supporting Types

    GetBrandingColor

    PageBackground string
    Background color of login pages in hexadecimal.
    Primary string
    Primary button background color in hexadecimal.
    PageBackground string
    Background color of login pages in hexadecimal.
    Primary string
    Primary button background color in hexadecimal.
    pageBackground String
    Background color of login pages in hexadecimal.
    primary String
    Primary button background color in hexadecimal.
    pageBackground string
    Background color of login pages in hexadecimal.
    primary string
    Primary button background color in hexadecimal.
    page_background str
    Background color of login pages in hexadecimal.
    primary str
    Primary button background color in hexadecimal.
    pageBackground String
    Background color of login pages in hexadecimal.
    primary String
    Primary button background color in hexadecimal.

    GetBrandingFont

    Url string
    URL for the custom font.
    Url string
    URL for the custom font.
    url String
    URL for the custom font.
    url string
    URL for the custom font.
    url str
    URL for the custom font.
    url String
    URL for the custom font.

    GetBrandingUniversalLogin

    Body string
    The html template for the New Universal Login Experience.
    Body string
    The html template for the New Universal Login Experience.
    body String
    The html template for the New Universal Login Experience.
    body string
    The html template for the New Universal Login Experience.
    body str
    The html template for the New Universal Login Experience.
    body String
    The html template for the New Universal Login Experience.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.4.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-auth0