Package com.microsoft.graph.models

Class OrganizationalBrandingProperties

java.lang.Object
com.microsoft.graph.models.Entity
com.microsoft.graph.models.OrganizationalBrandingProperties
All Implemented Interfaces:
com.microsoft.kiota.serialization.AdditionalDataHolder, com.microsoft.kiota.serialization.Parsable, com.microsoft.kiota.store.BackedModel
Direct Known Subclasses:
OrganizationalBranding, OrganizationalBrandingLocalization
@Generated("com.microsoft.kiota") public class OrganizationalBrandingProperties extends Entity implements com.microsoft.kiota.serialization.Parsable

  • Constructor Details

  • Method Details

    • createFromDiscriminatorValue

      @Nonnull public static OrganizationalBrandingProperties createFromDiscriminatorValue(@Nonnull com.microsoft.kiota.serialization.ParseNode parseNode)
      Creates a new instance of the appropriate class based on discriminator value
      Parameters:
      parseNode - The parse node to use to read the discriminator value and create the object
      Returns:
      a OrganizationalBrandingProperties

    • getBackgroundColor

      @Nullable public String getBackgroundColor()
      Gets the backgroundColor property value. Color that appears in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF.
      Returns:
      a String

    • getBackgroundImage

      @Nullable public byte[] getBackgroundImage()
      Gets the backgroundImage property value. Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 1080 pixels. A smaller image reduces bandwidth requirements and make the page load faster.
      Returns:
      a
      invalid reference 
      byte[]

    • getBackgroundImageRelativeUrl

      @Nullable public String getBackgroundImageRelativeUrl()
      Gets the backgroundImageRelativeUrl property value. A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only.
      Returns:
      a String

    • getBannerLogo

      @Nullable public byte[] getBannerLogo()
      Gets the bannerLogo property value. A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG not larger than 36 245 pixels. We recommend using a transparent image with no padding around the logo.
      Returns:
      a
      invalid reference 
      byte[]

    • getBannerLogoRelativeUrl

      @Nullable public String getBannerLogoRelativeUrl()
      Gets the bannerLogoRelativeUrl property value. A relative URL for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only.
      Returns:
      a String

    • getCdnList

      @Nullable public List<String> getCdnList()
      Gets the cdnList property value. A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only.
      Returns:
      a List<String>

    • getContentCustomization

      @Nullable public ContentCustomization getContentCustomization()
      Gets the contentCustomization property value. Represents the content options to be customized throughout the authentication flow for a tenant. NOTE: Supported by Microsoft Entra External ID in external tenants only.
      Returns:
      a ContentCustomization

    • getCustomAccountResetCredentialsUrl

      @Nullable public String getCustomAccountResetCredentialsUrl()
      Gets the customAccountResetCredentialsUrl property value. A custom URL for resetting account credentials. This URL must be in ASCII format or non-ASCII characters must be URL encoded, and not exceed 128 characters.
      Returns:
      a String

    • getCustomCannotAccessYourAccountText

      @Nullable public String getCustomCannotAccessYourAccountText()
      Gets the customCannotAccessYourAccountText property value. A string to replace the default 'Can't access your account?' self-service password reset (SSPR) hyperlink text on the sign-in page. This text must be in Unicode format and not exceed 256 characters.
      Returns:
      a String

    • getCustomCannotAccessYourAccountUrl

      @Nullable public String getCustomCannotAccessYourAccountUrl()
      Gets the customCannotAccessYourAccountUrl property value. A custom URL to replace the default URL of the self-service password reset (SSPR) 'Can't access your account?' hyperlink on the sign-in page. This URL must be in ASCII format or non-ASCII characters must be URL encoded, and not exceed 128 characters. DO NOT USE. Use customAccountResetCredentialsUrl instead.
      Returns:
      a String

    • getCustomCSS

      @Nullable public byte[] getCustomCSS()
      Gets the customCSS property value. CSS styling that appears on the sign-in page. The allowed format is .css format only and not larger than 25 KB.
      Returns:
      a
      invalid reference 
      byte[]

    • getCustomCSSRelativeUrl

      @Nullable public String getCustomCSSRelativeUrl()
      Gets the customCSSRelativeUrl property value. A relative URL for the customCSS property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only.
      Returns:
      a String

    • getCustomForgotMyPasswordText

      @Nullable public String getCustomForgotMyPasswordText()
      Gets the customForgotMyPasswordText property value. A string to replace the default 'Forgot my password' hyperlink text on the sign-in form. This text must be in Unicode format and not exceed 256 characters.
      Returns:
      a String

    • getCustomPrivacyAndCookiesText

      @Nullable public String getCustomPrivacyAndCookiesText()
      Gets the customPrivacyAndCookiesText property value. A string to replace the default 'Privacy and Cookies' hyperlink text in the footer. This text must be in Unicode format and not exceed 256 characters.
      Returns:
      a String

    • getCustomPrivacyAndCookiesUrl

      @Nullable public String getCustomPrivacyAndCookiesUrl()
      Gets the customPrivacyAndCookiesUrl property value. A custom URL to replace the default URL of the 'Privacy and Cookies' hyperlink in the footer. This URL must be in ASCII format or non-ASCII characters must be URL encoded, and not exceed 128 characters.
      Returns:
      a String

    • getCustomResetItNowText

      @Nullable public String getCustomResetItNowText()
      Gets the customResetItNowText property value. A string to replace the default 'reset it now' hyperlink text on the sign-in form. This text must be in Unicode format and not exceed 256 characters. DO NOT USE: Customization of the 'reset it now' hyperlink text is currently not supported.
      Returns:
      a String

    • getCustomTermsOfUseText

      @Nullable public String getCustomTermsOfUseText()
      Gets the customTermsOfUseText property value. A string to replace the the default 'Terms of Use' hyperlink text in the footer. This text must be in Unicode format and not exceed 256 characters.
      Returns:
      a String

    • getCustomTermsOfUseUrl

      @Nullable public String getCustomTermsOfUseUrl()
      Gets the customTermsOfUseUrl property value. A custom URL to replace the default URL of the 'Terms of Use' hyperlink in the footer. This URL must be in ASCII format or non-ASCII characters must be URL encoded, and not exceed 128characters.
      Returns:
      a String

    • getFavicon

      @Nullable public byte[] getFavicon()
      Gets the favicon property value. A custom icon (favicon) to replace a default Microsoft product favicon on a Microsoft Entra tenant.
      Returns:
      a
      invalid reference 
      byte[]

    • getFaviconRelativeUrl

      @Nullable public String getFaviconRelativeUrl()
      Gets the faviconRelativeUrl property value. A relative url for the favicon above that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only.
      Returns:
      a String

    • getFieldDeserializers

      @Nonnull public Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>> getFieldDeserializers()
      The deserialization information for the current model
      Specified by:
      getFieldDeserializers in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      getFieldDeserializers in class Entity
      Returns:
      a Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>>

    • getHeaderBackgroundColor

      @Nullable public String getHeaderBackgroundColor()
      Gets the headerBackgroundColor property value. The RGB color to apply to customize the color of the header.
      Returns:
      a String

    • getHeaderLogo

      @Nullable public byte[] getHeaderLogo()
      Gets the headerLogo property value. A company logo that appears in the header of the sign-in page. The allowed types are PNG or JPEG not larger than 36 245 pixels. We recommend using a transparent image with no padding around the logo.
      Returns:
      a
      invalid reference 
      byte[]

    • getHeaderLogoRelativeUrl

      @Nullable public String getHeaderLogoRelativeUrl()
      Gets the headerLogoRelativeUrl property value. A relative URL for the headerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only.
      Returns:
      a String

    • getLoginPageLayoutConfiguration

      @Nullable public LoginPageLayoutConfiguration getLoginPageLayoutConfiguration()
      Gets the loginPageLayoutConfiguration property value. Represents the layout configuration to be displayed on the login page for a tenant.
      Returns:
      a LoginPageLayoutConfiguration

    • getLoginPageTextVisibilitySettings

      @Nullable public LoginPageTextVisibilitySettings getLoginPageTextVisibilitySettings()
      Gets the loginPageTextVisibilitySettings property value. Represents the various texts that can be hidden on the login page for a tenant.
      Returns:
      a LoginPageTextVisibilitySettings

    • getSignInPageText

      @Nullable public String getSignInPageText()
      Gets the signInPageText property value. Text that appears at the bottom of the sign-in box. Use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be in Unicode format and not exceed 1024 characters.
      Returns:
      a String

    • getSquareLogo

      @Nullable public byte[] getSquareLogo()
      Gets the squareLogo property value. A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG not larger than 240 x 240 pixels and not more than 10 KB in size. We recommend using a transparent image with no padding around the logo.
      Returns:
      a
      invalid reference 
      byte[]

    • getSquareLogoDark

      @Nullable public byte[] getSquareLogoDark()
      Gets the squareLogoDark property value. A square dark version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG not larger than 240 x 240 pixels and not more than 10 KB in size. We recommend using a transparent image with no padding around the logo.
      Returns:
      a
      invalid reference 
      byte[]

    • getSquareLogoDarkRelativeUrl

      @Nullable public String getSquareLogoDarkRelativeUrl()
      Gets the squareLogoDarkRelativeUrl property value. A relative URL for the squareLogoDark property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only.
      Returns:
      a String

    • getSquareLogoRelativeUrl

      @Nullable public String getSquareLogoRelativeUrl()
      Gets the squareLogoRelativeUrl property value. A relative URL for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only.
      Returns:
      a String

    • getUsernameHintText

      @Nullable public String getUsernameHintText()
      Gets the usernameHintText property value. A string that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters.
      Returns:
      a String

    • serialize

      public void serialize(@Nonnull com.microsoft.kiota.serialization.SerializationWriter writer)
      Serializes information the current object
      Specified by:
      serialize in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      serialize in class Entity
      Parameters:
      writer - Serialization writer to use to serialize this model

    • setBackgroundColor

      public void setBackgroundColor(@Nullable String value)
      Sets the backgroundColor property value. Color that appears in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF.
      Parameters:
      value - Value to set for the backgroundColor property.

    • setBackgroundImage

      public void setBackgroundImage(@Nullable byte[] value)
      Sets the backgroundImage property value. Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 1080 pixels. A smaller image reduces bandwidth requirements and make the page load faster.
      Parameters:
      value - Value to set for the backgroundImage property.

    • setBackgroundImageRelativeUrl

      public void setBackgroundImageRelativeUrl(@Nullable String value)
      Sets the backgroundImageRelativeUrl property value. A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only.
      Parameters:
      value - Value to set for the backgroundImageRelativeUrl property.

    • setBannerLogo

      public void setBannerLogo(@Nullable byte[] value)
      Sets the bannerLogo property value. A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG not larger than 36 245 pixels. We recommend using a transparent image with no padding around the logo.
      Parameters:
      value - Value to set for the bannerLogo property.

    • setBannerLogoRelativeUrl

      public void setBannerLogoRelativeUrl(@Nullable String value)
      Sets the bannerLogoRelativeUrl property value. A relative URL for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only.
      Parameters:
      value - Value to set for the bannerLogoRelativeUrl property.

    • setCdnList

      public void setCdnList(@Nullable List<String> value)
      Sets the cdnList property value. A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only.
      Parameters:
      value - Value to set for the cdnList property.

    • setContentCustomization

      public void setContentCustomization(@Nullable ContentCustomization value)
      Sets the contentCustomization property value. Represents the content options to be customized throughout the authentication flow for a tenant. NOTE: Supported by Microsoft Entra External ID in external tenants only.
      Parameters:
      value - Value to set for the contentCustomization property.

    • setCustomAccountResetCredentialsUrl

      public void setCustomAccountResetCredentialsUrl(@Nullable String value)
      Sets the customAccountResetCredentialsUrl property value. A custom URL for resetting account credentials. This URL must be in ASCII format or non-ASCII characters must be URL encoded, and not exceed 128 characters.
      Parameters:
      value - Value to set for the customAccountResetCredentialsUrl property.

    • setCustomCannotAccessYourAccountText

      public void setCustomCannotAccessYourAccountText(@Nullable String value)
      Sets the customCannotAccessYourAccountText property value. A string to replace the default 'Can't access your account?' self-service password reset (SSPR) hyperlink text on the sign-in page. This text must be in Unicode format and not exceed 256 characters.
      Parameters:
      value - Value to set for the customCannotAccessYourAccountText property.

    • setCustomCannotAccessYourAccountUrl

      public void setCustomCannotAccessYourAccountUrl(@Nullable String value)
      Sets the customCannotAccessYourAccountUrl property value. A custom URL to replace the default URL of the self-service password reset (SSPR) 'Can't access your account?' hyperlink on the sign-in page. This URL must be in ASCII format or non-ASCII characters must be URL encoded, and not exceed 128 characters. DO NOT USE. Use customAccountResetCredentialsUrl instead.
      Parameters:
      value - Value to set for the customCannotAccessYourAccountUrl property.

    • setCustomCSS

      public void setCustomCSS(@Nullable byte[] value)
      Sets the customCSS property value. CSS styling that appears on the sign-in page. The allowed format is .css format only and not larger than 25 KB.
      Parameters:
      value - Value to set for the customCSS property.

    • setCustomCSSRelativeUrl

      public void setCustomCSSRelativeUrl(@Nullable String value)
      Sets the customCSSRelativeUrl property value. A relative URL for the customCSS property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only.
      Parameters:
      value - Value to set for the customCSSRelativeUrl property.

    • setCustomForgotMyPasswordText

      public void setCustomForgotMyPasswordText(@Nullable String value)
      Sets the customForgotMyPasswordText property value. A string to replace the default 'Forgot my password' hyperlink text on the sign-in form. This text must be in Unicode format and not exceed 256 characters.
      Parameters:
      value - Value to set for the customForgotMyPasswordText property.

    • setCustomPrivacyAndCookiesText

      public void setCustomPrivacyAndCookiesText(@Nullable String value)
      Sets the customPrivacyAndCookiesText property value. A string to replace the default 'Privacy and Cookies' hyperlink text in the footer. This text must be in Unicode format and not exceed 256 characters.
      Parameters:
      value - Value to set for the customPrivacyAndCookiesText property.

    • setCustomPrivacyAndCookiesUrl

      public void setCustomPrivacyAndCookiesUrl(@Nullable String value)
      Sets the customPrivacyAndCookiesUrl property value. A custom URL to replace the default URL of the 'Privacy and Cookies' hyperlink in the footer. This URL must be in ASCII format or non-ASCII characters must be URL encoded, and not exceed 128 characters.
      Parameters:
      value - Value to set for the customPrivacyAndCookiesUrl property.

    • setCustomResetItNowText

      public void setCustomResetItNowText(@Nullable String value)
      Sets the customResetItNowText property value. A string to replace the default 'reset it now' hyperlink text on the sign-in form. This text must be in Unicode format and not exceed 256 characters. DO NOT USE: Customization of the 'reset it now' hyperlink text is currently not supported.
      Parameters:
      value - Value to set for the customResetItNowText property.

    • setCustomTermsOfUseText

      public void setCustomTermsOfUseText(@Nullable String value)
      Sets the customTermsOfUseText property value. A string to replace the the default 'Terms of Use' hyperlink text in the footer. This text must be in Unicode format and not exceed 256 characters.
      Parameters:
      value - Value to set for the customTermsOfUseText property.

    • setCustomTermsOfUseUrl

      public void setCustomTermsOfUseUrl(@Nullable String value)
      Sets the customTermsOfUseUrl property value. A custom URL to replace the default URL of the 'Terms of Use' hyperlink in the footer. This URL must be in ASCII format or non-ASCII characters must be URL encoded, and not exceed 128characters.
      Parameters:
      value - Value to set for the customTermsOfUseUrl property.

    • setFavicon

      public void setFavicon(@Nullable byte[] value)
      Sets the favicon property value. A custom icon (favicon) to replace a default Microsoft product favicon on a Microsoft Entra tenant.
      Parameters:
      value - Value to set for the favicon property.

    • setFaviconRelativeUrl

      public void setFaviconRelativeUrl(@Nullable String value)
      Sets the faviconRelativeUrl property value. A relative url for the favicon above that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only.
      Parameters:
      value - Value to set for the faviconRelativeUrl property.

    • setHeaderBackgroundColor

      public void setHeaderBackgroundColor(@Nullable String value)
      Sets the headerBackgroundColor property value. The RGB color to apply to customize the color of the header.
      Parameters:
      value - Value to set for the headerBackgroundColor property.

    • setHeaderLogo

      public void setHeaderLogo(@Nullable byte[] value)
      Sets the headerLogo property value. A company logo that appears in the header of the sign-in page. The allowed types are PNG or JPEG not larger than 36 245 pixels. We recommend using a transparent image with no padding around the logo.
      Parameters:
      value - Value to set for the headerLogo property.

    • setHeaderLogoRelativeUrl

      public void setHeaderLogoRelativeUrl(@Nullable String value)
      Sets the headerLogoRelativeUrl property value. A relative URL for the headerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only.
      Parameters:
      value - Value to set for the headerLogoRelativeUrl property.

    • setLoginPageLayoutConfiguration

      public void setLoginPageLayoutConfiguration(@Nullable LoginPageLayoutConfiguration value)
      Sets the loginPageLayoutConfiguration property value. Represents the layout configuration to be displayed on the login page for a tenant.
      Parameters:
      value - Value to set for the loginPageLayoutConfiguration property.

    • setLoginPageTextVisibilitySettings

      public void setLoginPageTextVisibilitySettings(@Nullable LoginPageTextVisibilitySettings value)
      Sets the loginPageTextVisibilitySettings property value. Represents the various texts that can be hidden on the login page for a tenant.
      Parameters:
      value - Value to set for the loginPageTextVisibilitySettings property.

    • setSignInPageText

      public void setSignInPageText(@Nullable String value)
      Sets the signInPageText property value. Text that appears at the bottom of the sign-in box. Use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be in Unicode format and not exceed 1024 characters.
      Parameters:
      value - Value to set for the signInPageText property.

    • setSquareLogo

      public void setSquareLogo(@Nullable byte[] value)
      Sets the squareLogo property value. A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG not larger than 240 x 240 pixels and not more than 10 KB in size. We recommend using a transparent image with no padding around the logo.
      Parameters:
      value - Value to set for the squareLogo property.

    • setSquareLogoDark

      public void setSquareLogoDark(@Nullable byte[] value)
      Sets the squareLogoDark property value. A square dark version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG not larger than 240 x 240 pixels and not more than 10 KB in size. We recommend using a transparent image with no padding around the logo.
      Parameters:
      value - Value to set for the squareLogoDark property.

    • setSquareLogoDarkRelativeUrl

      public void setSquareLogoDarkRelativeUrl(@Nullable String value)
      Sets the squareLogoDarkRelativeUrl property value. A relative URL for the squareLogoDark property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only.
      Parameters:
      value - Value to set for the squareLogoDarkRelativeUrl property.

    • setSquareLogoRelativeUrl

      public void setSquareLogoRelativeUrl(@Nullable String value)
      Sets the squareLogoRelativeUrl property value. A relative URL for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only.
      Parameters:
      value - Value to set for the squareLogoRelativeUrl property.

    • setUsernameHintText

      public void setUsernameHintText(@Nullable String value)
      Sets the usernameHintText property value. A string that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters.
      Parameters:
      value - Value to set for the usernameHintText property.