Table of Contents

Class EntraOrganizationalBrandingSettings

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents the organizational branding settings for an Entra directory.

public class EntraOrganizationalBrandingSettings : BaseTypeSection, IComparable<EntraOrganizationalBrandingSettings>
Inheritance
EntraOrganizationalBrandingSettings
Implements

Constructors

EntraOrganizationalBrandingSettings()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.EntraOrganizationalBrandingSettings class.

public EntraOrganizationalBrandingSettings()

Properties

BackgroundColor

Gets or sets the background color as a hex value.

public string BackgroundColor { get; set; }

Property Value

string

CustomAccountResetCredentialsUrl

Gets or sets the self service password reset URL.

public string CustomAccountResetCredentialsUrl { get; set; }

Property Value

string

CustomCannotAccessYourAccountText

Gets or sets the custom "Cannot Access Your Account" text.

public string CustomCannotAccessYourAccountText { get; set; }

Property Value

string

CustomForgotMyPasswordText

Gets or sets the custom "Forgot My Password" text.

public string CustomForgotMyPasswordText { get; set; }

Property Value

string

CustomPrivacyAndCookiesText

Gets or sets the custom "Privacy and Cookies" text.

public string CustomPrivacyAndCookiesText { get; set; }

Property Value

string

CustomPrivacyAndCookiesUrl

Gets or sets the custom "Privacy and Cookies" URL.

public string CustomPrivacyAndCookiesUrl { get; set; }

Property Value

string

CustomTermsOfUseText

Gets or sets the custom "Terms of Use" text.

public string CustomTermsOfUseText { get; set; }

Property Value

string

CustomTermsOfUseUrl

Gets or sets the custom "Terms of Use" URL.

public string CustomTermsOfUseUrl { get; set; }

Property Value

string

HeaderBackgroundColor

Gets or sets the header background color.

public string HeaderBackgroundColor { get; set; }

Property Value

string

Identifier

Gets or sets the unique identifier for the branding settings. This is for internal use only.

public Guid Identifier { get; set; }

Property Value

Guid

IsBackgroundImageConfigured

Gets or sets whether a background image is configured.

public BooleanOption IsBackgroundImageConfigured { get; set; }

Property Value

BooleanOption

IsBannerLogoConfigured

Gets or sets whether a banner logo is configured.

public BooleanOption IsBannerLogoConfigured { get; set; }

Property Value

BooleanOption

IsCustomCssConfigured

Gets or sets whether custom CSS is configured.

public BooleanOption IsCustomCssConfigured { get; set; }

Property Value

BooleanOption

IsDefault

Gets whether the branding is the default branding.

public bool IsDefault { get; }

Property Value

bool

IsFaviconConfigured

Gets or sets whether a favicon is configured.

public BooleanOption IsFaviconConfigured { get; set; }

Property Value

BooleanOption

IsFooterShown

Gets or sets whether the footer is shown.

public BooleanOption IsFooterShown { get; set; }

Property Value

BooleanOption

IsHeaderLogoConfigured

Gets or sets whether a header logo is configured.

public BooleanOption IsHeaderLogoConfigured { get; set; }

Property Value

BooleanOption

IsHeaderShown

Gets or sets whether the header is shown.

public BooleanOption IsHeaderShown { get; set; }

Property Value

BooleanOption

IsSquareLogoConfigured

Gets or sets whether a square logo is configured for the light theme.

public BooleanOption IsSquareLogoConfigured { get; set; }

Property Value

BooleanOption

IsSquareLogoDarkConfigured

Gets or sets whether a square logo is configured for the dark theme.

public BooleanOption IsSquareLogoDarkConfigured { get; set; }

Property Value

BooleanOption

Language

Gets or sets the branding language.

public string Language { get; set; }

Property Value

string

LanguageIdentifier

Gets or sets the branding language identifier.

public string LanguageIdentifier { get; set; }

Property Value

string

LayoutTemplate

Gets or sets the layout.

public EntraOrganizationalBrandingLayoutTemplate LayoutTemplate { get; set; }

Property Value

EntraOrganizationalBrandingLayoutTemplate

LayoutTemplateString

Gets the layout as a human readable string.

public string LayoutTemplateString { get; set; }

Property Value

string

ShowAccountResetCredentials

Gets or sets whether to show the self-service password reset (SSPR) hyperlinks such as "Can't access your account?", "Forgot my password" and "Reset it now".

public BooleanOption ShowAccountResetCredentials { get; set; }

Property Value

BooleanOption

ShowCannotAccessYourAccount

Gets or sets whether to show the "Cannot Access Your Account" hyperlink.

public BooleanOption ShowCannotAccessYourAccount { get; set; }

Property Value

BooleanOption

ShowForgotMyPassword

Gets or sets whether to show the "Forgot My Password" hyperlink.

public BooleanOption ShowForgotMyPassword { get; set; }

Property Value

BooleanOption

ShowPrivacyAndCookies

Gets or sets whether to show the "Privacy and Cookies" hyperlink.

public BooleanOption ShowPrivacyAndCookies { get; set; }

Property Value

BooleanOption

ShowResetItNow

Gets or sets whether to show the "Reset It Now" hyperlink.

public BooleanOption ShowResetItNow { get; set; }

Property Value

BooleanOption

ShowTermsOfUse

Gets or sets whether to show the "Terms of Use" hyperlink.

public BooleanOption ShowTermsOfUse { get; set; }

Property Value

BooleanOption

SignInPageText

Gets or sets the sign-in page text.

public string SignInPageText { get; set; }

Property Value

string

UsernameHintText

Gets or sets the username hint text.

public string UsernameHintText { get; set; }

Property Value

string

Methods

CompareTo(EntraOrganizationalBrandingSettings)

Compares two CENTREL.XIA.Configuration.Types.EntraOrganizationalBrandingSettings objects to allow sorting alphabetically by language.

public int CompareTo(EntraOrganizationalBrandingSettings other)

Parameters

other EntraOrganizationalBrandingSettings

The CENTREL.XIA.Configuration.Types.EntraOrganizationalBrandingSettings to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.EntraOrganizationalBrandingSettings objects.

ToString()

Returns the CENTREL.XIA.Configuration.Types.EntraOrganizationalBrandingSettings as a human readable string.

public override string ToString()

Returns

string

The CENTREL.XIA.Configuration.Types.EntraOrganizationalBrandingSettings as a human readable string.