Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Onelogin Provider
  4. API Docs
  5. Brands
Viewing docs for onelogin 1.5.0
published on Friday, Aug 28, 2026 by onelogin
Schema (JSON)
onelogin/terraform-provider-onelogin

onelogin.Brands

onelogin logo onelogin logo
Viewing docs for onelogin 1.5.0
published on Friday, Aug 28, 2026 by onelogin
Schema (JSON)
onelogin/terraform-provider-onelogin

    Import

    $ pulumi import onelogin:index/brands:Brands engineering 7844

    Create Brands Resource

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

    Constructor syntax

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

@overload
def Brands(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           background: Optional[str] = None,
           brands_id: Optional[str] = None,
           custom_accent_color: Optional[str] = None,
           custom_color: Optional[str] = None,
           custom_label_text_for_login_screen: Optional[str] = None,
           custom_masking_color: Optional[str] = None,
           custom_masking_opacity: Optional[float] = None,
           custom_support_enabled: Optional[bool] = None,
           enable_custom_label_for_login_screen: Optional[bool] = None,
           enabled: Optional[bool] = None,
           hide_onelogin_footer: Optional[bool] = None,
           login_instruction: Optional[str] = None,
           login_instruction_title: Optional[str] = None,
           logo: Optional[str] = None,
           mfa_enrollment_message: Optional[str] = None,
           name: Optional[str] = None)
    func NewBrands(ctx *Context, name string, args *BrandsArgs, opts ...ResourceOption) (*Brands, error)
    public Brands(string name, BrandsArgs? args = null, CustomResourceOptions? opts = null)
    public Brands(String name, BrandsArgs args)
public Brands(String name, BrandsArgs args, CustomResourceOptions options)

    type: onelogin:Brands
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "onelogin_brands" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args BrandsArgs
    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 BrandsArgs
    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 BrandsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BrandsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BrandsArgs
    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 brandsResource = new Onelogin.Brands("brandsResource", new()
{
    Background = "string",
    BrandsId = "string",
    CustomAccentColor = "string",
    CustomColor = "string",
    CustomLabelTextForLoginScreen = "string",
    CustomMaskingColor = "string",
    CustomMaskingOpacity = 0.0,
    CustomSupportEnabled = false,
    EnableCustomLabelForLoginScreen = false,
    Enabled = false,
    HideOneloginFooter = false,
    LoginInstruction = "string",
    LoginInstructionTitle = "string",
    Logo = "string",
    MfaEnrollmentMessage = "string",
    Name = "string",
});

    example, err := onelogin.NewBrands(ctx, "brandsResource", &onelogin.BrandsArgs{
	Background:                      pulumi.String("string"),
	BrandsId:                        pulumi.String("string"),
	CustomAccentColor:               pulumi.String("string"),
	CustomColor:                     pulumi.String("string"),
	CustomLabelTextForLoginScreen:   pulumi.String("string"),
	CustomMaskingColor:              pulumi.String("string"),
	CustomMaskingOpacity:            pulumi.Float64(0),
	CustomSupportEnabled:            pulumi.Bool(false),
	EnableCustomLabelForLoginScreen: pulumi.Bool(false),
	Enabled:                         pulumi.Bool(false),
	HideOneloginFooter:              pulumi.Bool(false),
	LoginInstruction:                pulumi.String("string"),
	LoginInstructionTitle:           pulumi.String("string"),
	Logo:                            pulumi.String("string"),
	MfaEnrollmentMessage:            pulumi.String("string"),
	Name:                            pulumi.String("string"),
})

    resource "onelogin_brands" "brandsResource" {
  lifecycle {
    create_before_destroy = true
  }
  background                           = "string"
  brands_id                            = "string"
  custom_accent_color                  = "string"
  custom_color                         = "string"
  custom_label_text_for_login_screen   = "string"
  custom_masking_color                 = "string"
  custom_masking_opacity               = 0
  custom_support_enabled               = false
  enable_custom_label_for_login_screen = false
  enabled                              = false
  hide_onelogin_footer                 = false
  login_instruction                    = "string"
  login_instruction_title              = "string"
  logo                                 = "string"
  mfa_enrollment_message               = "string"
  name                                 = "string"
}

    var brandsResource = new Brands("brandsResource", BrandsArgs.builder()
    .background("string")
    .brandsId("string")
    .customAccentColor("string")
    .customColor("string")
    .customLabelTextForLoginScreen("string")
    .customMaskingColor("string")
    .customMaskingOpacity(0.0)
    .customSupportEnabled(false)
    .enableCustomLabelForLoginScreen(false)
    .enabled(false)
    .hideOneloginFooter(false)
    .loginInstruction("string")
    .loginInstructionTitle("string")
    .logo("string")
    .mfaEnrollmentMessage("string")
    .name("string")
    .build());

    brands_resource = onelogin.Brands("brandsResource",
    background="string",
    brands_id="string",
    custom_accent_color="string",
    custom_color="string",
    custom_label_text_for_login_screen="string",
    custom_masking_color="string",
    custom_masking_opacity=float(0),
    custom_support_enabled=False,
    enable_custom_label_for_login_screen=False,
    enabled=False,
    hide_onelogin_footer=False,
    login_instruction="string",
    login_instruction_title="string",
    logo="string",
    mfa_enrollment_message="string",
    name="string")

    const brandsResource = new onelogin.Brands("brandsResource", {
    background: "string",
    brandsId: "string",
    customAccentColor: "string",
    customColor: "string",
    customLabelTextForLoginScreen: "string",
    customMaskingColor: "string",
    customMaskingOpacity: 0,
    customSupportEnabled: false,
    enableCustomLabelForLoginScreen: false,
    enabled: false,
    hideOneloginFooter: false,
    loginInstruction: "string",
    loginInstructionTitle: "string",
    logo: "string",
    mfaEnrollmentMessage: "string",
    name: "string",
});

    type: onelogin:Brands
properties:
    background: string
    brandsId: string
    customAccentColor: string
    customColor: string
    customLabelTextForLoginScreen: string
    customMaskingColor: string
    customMaskingOpacity: 0
    customSupportEnabled: false
    enableCustomLabelForLoginScreen: false
    enabled: false
    hideOneloginFooter: false
    loginInstruction: string
    loginInstructionTitle: string
    logo: string
    mfaEnrollmentMessage: string
    name: string

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

    Background string
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    BrandsId string
    The brand's ID.
    CustomAccentColor string
    Secondary brand colour, as a hex value such as #016B91.
    CustomColor string
    Primary brand colour, as a hex value such as #000000.
    CustomLabelTextForLoginScreen string
    Label for the Username/Email field. Localised, see below.
    CustomMaskingColor string
    Colour of the masking layer drawn over the background image.
    CustomMaskingOpacity double
    Opacity of custom_masking_color. Defaults to 0.
    CustomSupportEnabled bool
    Whether the login page offers a support request link.
    EnableCustomLabelForLoginScreen bool
    Whether the Username/Email field uses a custom label.
    Enabled bool
    Whether the brand is enabled. Defaults to false on create.
    HideOneloginFooter bool
    Whether to hide the OneLogin footer at the bottom of the login page.
    LoginInstruction string
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    LoginInstructionTitle string
    Link text that opens the login instruction screen. Localised, see below.
    Logo string
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    MfaEnrollmentMessage string
    Text replacing the default message on the first screen of MFA registration.
    Name string
    Name of the brand. The API rejects a brand without one.
    Background string
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    BrandsId string
    The brand's ID.
    CustomAccentColor string
    Secondary brand colour, as a hex value such as #016B91.
    CustomColor string
    Primary brand colour, as a hex value such as #000000.
    CustomLabelTextForLoginScreen string
    Label for the Username/Email field. Localised, see below.
    CustomMaskingColor string
    Colour of the masking layer drawn over the background image.
    CustomMaskingOpacity float64
    Opacity of custom_masking_color. Defaults to 0.
    CustomSupportEnabled bool
    Whether the login page offers a support request link.
    EnableCustomLabelForLoginScreen bool
    Whether the Username/Email field uses a custom label.
    Enabled bool
    Whether the brand is enabled. Defaults to false on create.
    HideOneloginFooter bool
    Whether to hide the OneLogin footer at the bottom of the login page.
    LoginInstruction string
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    LoginInstructionTitle string
    Link text that opens the login instruction screen. Localised, see below.
    Logo string
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    MfaEnrollmentMessage string
    Text replacing the default message on the first screen of MFA registration.
    Name string
    Name of the brand. The API rejects a brand without one.
    background string
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    brands_id string
    The brand's ID.
    custom_accent_color string
    Secondary brand colour, as a hex value such as #016B91.
    custom_color string
    Primary brand colour, as a hex value such as #000000.
    custom_label_text_for_login_screen string
    Label for the Username/Email field. Localised, see below.
    custom_masking_color string
    Colour of the masking layer drawn over the background image.
    custom_masking_opacity number
    Opacity of custom_masking_color. Defaults to 0.
    custom_support_enabled bool
    Whether the login page offers a support request link.
    enable_custom_label_for_login_screen bool
    Whether the Username/Email field uses a custom label.
    enabled bool
    Whether the brand is enabled. Defaults to false on create.
    hide_onelogin_footer bool
    Whether to hide the OneLogin footer at the bottom of the login page.
    login_instruction string
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    login_instruction_title string
    Link text that opens the login instruction screen. Localised, see below.
    logo string
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    mfa_enrollment_message string
    Text replacing the default message on the first screen of MFA registration.
    name string
    Name of the brand. The API rejects a brand without one.
    background String
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    brandsId String
    The brand's ID.
    customAccentColor String
    Secondary brand colour, as a hex value such as #016B91.
    customColor String
    Primary brand colour, as a hex value such as #000000.
    customLabelTextForLoginScreen String
    Label for the Username/Email field. Localised, see below.
    customMaskingColor String
    Colour of the masking layer drawn over the background image.
    customMaskingOpacity Double
    Opacity of custom_masking_color. Defaults to 0.
    customSupportEnabled Boolean
    Whether the login page offers a support request link.
    enableCustomLabelForLoginScreen Boolean
    Whether the Username/Email field uses a custom label.
    enabled Boolean
    Whether the brand is enabled. Defaults to false on create.
    hideOneloginFooter Boolean
    Whether to hide the OneLogin footer at the bottom of the login page.
    loginInstruction String
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    loginInstructionTitle String
    Link text that opens the login instruction screen. Localised, see below.
    logo String
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    mfaEnrollmentMessage String
    Text replacing the default message on the first screen of MFA registration.
    name String
    Name of the brand. The API rejects a brand without one.
    background string
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    brandsId string
    The brand's ID.
    customAccentColor string
    Secondary brand colour, as a hex value such as #016B91.
    customColor string
    Primary brand colour, as a hex value such as #000000.
    customLabelTextForLoginScreen string
    Label for the Username/Email field. Localised, see below.
    customMaskingColor string
    Colour of the masking layer drawn over the background image.
    customMaskingOpacity number
    Opacity of custom_masking_color. Defaults to 0.
    customSupportEnabled boolean
    Whether the login page offers a support request link.
    enableCustomLabelForLoginScreen boolean
    Whether the Username/Email field uses a custom label.
    enabled boolean
    Whether the brand is enabled. Defaults to false on create.
    hideOneloginFooter boolean
    Whether to hide the OneLogin footer at the bottom of the login page.
    loginInstruction string
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    loginInstructionTitle string
    Link text that opens the login instruction screen. Localised, see below.
    logo string
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    mfaEnrollmentMessage string
    Text replacing the default message on the first screen of MFA registration.
    name string
    Name of the brand. The API rejects a brand without one.
    background str
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    brands_id str
    The brand's ID.
    custom_accent_color str
    Secondary brand colour, as a hex value such as #016B91.
    custom_color str
    Primary brand colour, as a hex value such as #000000.
    custom_label_text_for_login_screen str
    Label for the Username/Email field. Localised, see below.
    custom_masking_color str
    Colour of the masking layer drawn over the background image.
    custom_masking_opacity float
    Opacity of custom_masking_color. Defaults to 0.
    custom_support_enabled bool
    Whether the login page offers a support request link.
    enable_custom_label_for_login_screen bool
    Whether the Username/Email field uses a custom label.
    enabled bool
    Whether the brand is enabled. Defaults to false on create.
    hide_onelogin_footer bool
    Whether to hide the OneLogin footer at the bottom of the login page.
    login_instruction str
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    login_instruction_title str
    Link text that opens the login instruction screen. Localised, see below.
    logo str
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    mfa_enrollment_message str
    Text replacing the default message on the first screen of MFA registration.
    name str
    Name of the brand. The API rejects a brand without one.
    background String
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    brandsId String
    The brand's ID.
    customAccentColor String
    Secondary brand colour, as a hex value such as #016B91.
    customColor String
    Primary brand colour, as a hex value such as #000000.
    customLabelTextForLoginScreen String
    Label for the Username/Email field. Localised, see below.
    customMaskingColor String
    Colour of the masking layer drawn over the background image.
    customMaskingOpacity Number
    Opacity of custom_masking_color. Defaults to 0.
    customSupportEnabled Boolean
    Whether the login page offers a support request link.
    enableCustomLabelForLoginScreen Boolean
    Whether the Username/Email field uses a custom label.
    enabled Boolean
    Whether the brand is enabled. Defaults to false on create.
    hideOneloginFooter Boolean
    Whether to hide the OneLogin footer at the bottom of the login page.
    loginInstruction String
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    loginInstructionTitle String
    Link text that opens the login instruction screen. Localised, see below.
    logo String
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    mfaEnrollmentMessage String
    Text replacing the default message on the first screen of MFA registration.
    name String
    Name of the brand. The API rejects a brand without one.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Brands resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Master bool
    Whether this is the account's master brand. Read-only.
    Id string
    The provider-assigned unique ID for this managed resource.
    Master bool
    Whether this is the account's master brand. Read-only.
    id string
    The provider-assigned unique ID for this managed resource.
    master bool
    Whether this is the account's master brand. Read-only.
    id String
    The provider-assigned unique ID for this managed resource.
    master Boolean
    Whether this is the account's master brand. Read-only.
    id string
    The provider-assigned unique ID for this managed resource.
    master boolean
    Whether this is the account's master brand. Read-only.
    id str
    The provider-assigned unique ID for this managed resource.
    master bool
    Whether this is the account's master brand. Read-only.
    id String
    The provider-assigned unique ID for this managed resource.
    master Boolean
    Whether this is the account's master brand. Read-only.

    Look up Existing Brands Resource

    Get an existing Brands 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?: BrandsState, opts?: CustomResourceOptions): Brands
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        background: Optional[str] = None,
        brands_id: Optional[str] = None,
        custom_accent_color: Optional[str] = None,
        custom_color: Optional[str] = None,
        custom_label_text_for_login_screen: Optional[str] = None,
        custom_masking_color: Optional[str] = None,
        custom_masking_opacity: Optional[float] = None,
        custom_support_enabled: Optional[bool] = None,
        enable_custom_label_for_login_screen: Optional[bool] = None,
        enabled: Optional[bool] = None,
        hide_onelogin_footer: Optional[bool] = None,
        login_instruction: Optional[str] = None,
        login_instruction_title: Optional[str] = None,
        logo: Optional[str] = None,
        master: Optional[bool] = None,
        mfa_enrollment_message: Optional[str] = None,
        name: Optional[str] = None) -> Brands
    func GetBrands(ctx *Context, name string, id IDInput, state *BrandsState, opts ...ResourceOption) (*Brands, error)
    public static Brands Get(string name, Input<string> id, BrandsState? state, CustomResourceOptions? opts = null)
    public static Brands get(String name, Output<String> id, BrandsState state, CustomResourceOptions options)
    resources:  _:    type: onelogin:Brands    get:      id: ${id}
    import {
  to = onelogin_brands.example
  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:
    Background string
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    BrandsId string
    The brand's ID.
    CustomAccentColor string
    Secondary brand colour, as a hex value such as #016B91.
    CustomColor string
    Primary brand colour, as a hex value such as #000000.
    CustomLabelTextForLoginScreen string
    Label for the Username/Email field. Localised, see below.
    CustomMaskingColor string
    Colour of the masking layer drawn over the background image.
    CustomMaskingOpacity double
    Opacity of custom_masking_color. Defaults to 0.
    CustomSupportEnabled bool
    Whether the login page offers a support request link.
    EnableCustomLabelForLoginScreen bool
    Whether the Username/Email field uses a custom label.
    Enabled bool
    Whether the brand is enabled. Defaults to false on create.
    HideOneloginFooter bool
    Whether to hide the OneLogin footer at the bottom of the login page.
    LoginInstruction string
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    LoginInstructionTitle string
    Link text that opens the login instruction screen. Localised, see below.
    Logo string
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    Master bool
    Whether this is the account's master brand. Read-only.
    MfaEnrollmentMessage string
    Text replacing the default message on the first screen of MFA registration.
    Name string
    Name of the brand. The API rejects a brand without one.
    Background string
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    BrandsId string
    The brand's ID.
    CustomAccentColor string
    Secondary brand colour, as a hex value such as #016B91.
    CustomColor string
    Primary brand colour, as a hex value such as #000000.
    CustomLabelTextForLoginScreen string
    Label for the Username/Email field. Localised, see below.
    CustomMaskingColor string
    Colour of the masking layer drawn over the background image.
    CustomMaskingOpacity float64
    Opacity of custom_masking_color. Defaults to 0.
    CustomSupportEnabled bool
    Whether the login page offers a support request link.
    EnableCustomLabelForLoginScreen bool
    Whether the Username/Email field uses a custom label.
    Enabled bool
    Whether the brand is enabled. Defaults to false on create.
    HideOneloginFooter bool
    Whether to hide the OneLogin footer at the bottom of the login page.
    LoginInstruction string
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    LoginInstructionTitle string
    Link text that opens the login instruction screen. Localised, see below.
    Logo string
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    Master bool
    Whether this is the account's master brand. Read-only.
    MfaEnrollmentMessage string
    Text replacing the default message on the first screen of MFA registration.
    Name string
    Name of the brand. The API rejects a brand without one.
    background string
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    brands_id string
    The brand's ID.
    custom_accent_color string
    Secondary brand colour, as a hex value such as #016B91.
    custom_color string
    Primary brand colour, as a hex value such as #000000.
    custom_label_text_for_login_screen string
    Label for the Username/Email field. Localised, see below.
    custom_masking_color string
    Colour of the masking layer drawn over the background image.
    custom_masking_opacity number
    Opacity of custom_masking_color. Defaults to 0.
    custom_support_enabled bool
    Whether the login page offers a support request link.
    enable_custom_label_for_login_screen bool
    Whether the Username/Email field uses a custom label.
    enabled bool
    Whether the brand is enabled. Defaults to false on create.
    hide_onelogin_footer bool
    Whether to hide the OneLogin footer at the bottom of the login page.
    login_instruction string
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    login_instruction_title string
    Link text that opens the login instruction screen. Localised, see below.
    logo string
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    master bool
    Whether this is the account's master brand. Read-only.
    mfa_enrollment_message string
    Text replacing the default message on the first screen of MFA registration.
    name string
    Name of the brand. The API rejects a brand without one.
    background String
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    brandsId String
    The brand's ID.
    customAccentColor String
    Secondary brand colour, as a hex value such as #016B91.
    customColor String
    Primary brand colour, as a hex value such as #000000.
    customLabelTextForLoginScreen String
    Label for the Username/Email field. Localised, see below.
    customMaskingColor String
    Colour of the masking layer drawn over the background image.
    customMaskingOpacity Double
    Opacity of custom_masking_color. Defaults to 0.
    customSupportEnabled Boolean
    Whether the login page offers a support request link.
    enableCustomLabelForLoginScreen Boolean
    Whether the Username/Email field uses a custom label.
    enabled Boolean
    Whether the brand is enabled. Defaults to false on create.
    hideOneloginFooter Boolean
    Whether to hide the OneLogin footer at the bottom of the login page.
    loginInstruction String
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    loginInstructionTitle String
    Link text that opens the login instruction screen. Localised, see below.
    logo String
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    master Boolean
    Whether this is the account's master brand. Read-only.
    mfaEnrollmentMessage String
    Text replacing the default message on the first screen of MFA registration.
    name String
    Name of the brand. The API rejects a brand without one.
    background string
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    brandsId string
    The brand's ID.
    customAccentColor string
    Secondary brand colour, as a hex value such as #016B91.
    customColor string
    Primary brand colour, as a hex value such as #000000.
    customLabelTextForLoginScreen string
    Label for the Username/Email field. Localised, see below.
    customMaskingColor string
    Colour of the masking layer drawn over the background image.
    customMaskingOpacity number
    Opacity of custom_masking_color. Defaults to 0.
    customSupportEnabled boolean
    Whether the login page offers a support request link.
    enableCustomLabelForLoginScreen boolean
    Whether the Username/Email field uses a custom label.
    enabled boolean
    Whether the brand is enabled. Defaults to false on create.
    hideOneloginFooter boolean
    Whether to hide the OneLogin footer at the bottom of the login page.
    loginInstruction string
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    loginInstructionTitle string
    Link text that opens the login instruction screen. Localised, see below.
    logo string
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    master boolean
    Whether this is the account's master brand. Read-only.
    mfaEnrollmentMessage string
    Text replacing the default message on the first screen of MFA registration.
    name string
    Name of the brand. The API rejects a brand without one.
    background str
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    brands_id str
    The brand's ID.
    custom_accent_color str
    Secondary brand colour, as a hex value such as #016B91.
    custom_color str
    Primary brand colour, as a hex value such as #000000.
    custom_label_text_for_login_screen str
    Label for the Username/Email field. Localised, see below.
    custom_masking_color str
    Colour of the masking layer drawn over the background image.
    custom_masking_opacity float
    Opacity of custom_masking_color. Defaults to 0.
    custom_support_enabled bool
    Whether the login page offers a support request link.
    enable_custom_label_for_login_screen bool
    Whether the Username/Email field uses a custom label.
    enabled bool
    Whether the brand is enabled. Defaults to false on create.
    hide_onelogin_footer bool
    Whether to hide the OneLogin footer at the bottom of the login page.
    login_instruction str
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    login_instruction_title str
    Link text that opens the login instruction screen. Localised, see below.
    logo str
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    master bool
    Whether this is the account's master brand. Read-only.
    mfa_enrollment_message str
    Text replacing the default message on the first screen of MFA registration.
    name str
    Name of the brand. The API rejects a brand without one.
    background String
    Base64-encoded JPG or PNG for the login page background, under 5MB. Write-only, and cannot be set to ""; see below.
    brandsId String
    The brand's ID.
    customAccentColor String
    Secondary brand colour, as a hex value such as #016B91.
    customColor String
    Primary brand colour, as a hex value such as #000000.
    customLabelTextForLoginScreen String
    Label for the Username/Email field. Localised, see below.
    customMaskingColor String
    Colour of the masking layer drawn over the background image.
    customMaskingOpacity Number
    Opacity of custom_masking_color. Defaults to 0.
    customSupportEnabled Boolean
    Whether the login page offers a support request link.
    enableCustomLabelForLoginScreen Boolean
    Whether the Username/Email field uses a custom label.
    enabled Boolean
    Whether the brand is enabled. Defaults to false on create.
    hideOneloginFooter Boolean
    Whether to hide the OneLogin footer at the bottom of the login page.
    loginInstruction String
    Text of the login instruction screen, styled in Markdown. Localised, see below.
    loginInstructionTitle String
    Link text that opens the login instruction screen. Localised, see below.
    logo String
    Base64-encoded PNG for the login page logo, under 1MB. Write-only, and cannot be set to ""; see below.
    master Boolean
    Whether this is the account's master brand. Read-only.
    mfaEnrollmentMessage String
    Text replacing the default message on the first screen of MFA registration.
    name String
    Name of the brand. The API rejects a brand without one.

    Package Details

    Repository
    onelogin onelogin/terraform-provider-onelogin
    License
    Notes
    This Pulumi package is based on the onelogin Terraform Provider.
    onelogin logo onelogin logo
    Viewing docs for onelogin 1.5.0
    published on Friday, Aug 28, 2026 by onelogin
    Schema (JSON)
    onelogin/terraform-provider-onelogin

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial