Update-MgOrganizationBrandingLocalization

Module:

Microsoft.Graph.Identity.DirectoryManagement

Update the properties of an organizationalBrandingLocalization object for a specific localization.

Note

To view the beta release of this cmdlet, view Update-MgBetaOrganizationBrandingLocalization

Syntax

Update-MgOrganizationBrandingLocalization
      -OrganizationId <String>
      -OrganizationalBrandingLocalizationId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-BackgroundColor <String>]
      [-BackgroundImageInputFile <String>]
      [-BackgroundImageRelativeUrl <String>]
      [-BannerLogoInputFile <String>]
      [-BannerLogoRelativeUrl <String>]
      [-CdnList <String[]>]
      [-ContentCustomization <IMicrosoftGraphContentCustomization>]
      [-CustomAccountResetCredentialsUrl <String>]
      [-CustomCannotAccessYourAccountText <String>]
      [-CustomCannotAccessYourAccountUrl <String>]
      [-CustomCssInputFile <String>]
      [-CustomCssRelativeUrl <String>]
      [-CustomForgotMyPasswordText <String>]
      [-CustomPrivacyAndCookiesText <String>]
      [-CustomPrivacyAndCookiesUrl <String>]
      [-CustomResetItNowText <String>]
      [-CustomTermsOfUseText <String>]
      [-CustomTermsOfUseUrl <String>]
      [-FaviconInputFile <String>]
      [-FaviconRelativeUrl <String>]
      [-HeaderBackgroundColor <String>]
      [-HeaderLogoInputFile <String>]
      [-HeaderLogoRelativeUrl <String>]
      [-Id <String>]
      [-LoginPageLayoutConfiguration <IMicrosoftGraphLoginPageLayoutConfiguration>]
      [-LoginPageTextVisibilitySettings <IMicrosoftGraphLoginPageTextVisibilitySettings>]
      [-SignInPageText <String>]
      [-SquareLogoDarkInputFile <String>]
      [-SquareLogoDarkRelativeUrl <String>]
      [-SquareLogoInputFile <String>]
      [-SquareLogoRelativeUrl <String>]
      [-UsernameHintText <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgOrganizationBrandingLocalization
      -OrganizationId <String>
      -OrganizationalBrandingLocalizationId <String>
      -BodyParameter <Hashtable>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgOrganizationBrandingLocalization
      -InputObject <IIdentityDirectoryManagementIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-BackgroundColor <String>]
      [-BackgroundImageInputFile <String>]
      [-BackgroundImageRelativeUrl <String>]
      [-BannerLogoInputFile <String>]
      [-BannerLogoRelativeUrl <String>]
      [-CdnList <String[]>]
      [-ContentCustomization <IMicrosoftGraphContentCustomization>]
      [-CustomAccountResetCredentialsUrl <String>]
      [-CustomCannotAccessYourAccountText <String>]
      [-CustomCannotAccessYourAccountUrl <String>]
      [-CustomCssInputFile <String>]
      [-CustomCssRelativeUrl <String>]
      [-CustomForgotMyPasswordText <String>]
      [-CustomPrivacyAndCookiesText <String>]
      [-CustomPrivacyAndCookiesUrl <String>]
      [-CustomResetItNowText <String>]
      [-CustomTermsOfUseText <String>]
      [-CustomTermsOfUseUrl <String>]
      [-FaviconInputFile <String>]
      [-FaviconRelativeUrl <String>]
      [-HeaderBackgroundColor <String>]
      [-HeaderLogoInputFile <String>]
      [-HeaderLogoRelativeUrl <String>]
      [-Id <String>]
      [-LoginPageLayoutConfiguration <IMicrosoftGraphLoginPageLayoutConfiguration>]
      [-LoginPageTextVisibilitySettings <IMicrosoftGraphLoginPageTextVisibilitySettings>]
      [-SignInPageText <String>]
      [-SquareLogoDarkInputFile <String>]
      [-SquareLogoDarkRelativeUrl <String>]
      [-SquareLogoInputFile <String>]
      [-SquareLogoRelativeUrl <String>]
      [-UsernameHintText <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgOrganizationBrandingLocalization
      -InputObject <IIdentityDirectoryManagementIdentity>
      -BodyParameter <Hashtable>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update the properties of an organizationalBrandingLocalization object for a specific localization.

Permissions

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	OrganizationalBranding.ReadWrite.All	Organization.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	OrganizationalBranding.ReadWrite.All	Organization.ReadWrite.All

Examples

Example 1: Update the backgroundColor and signInPageText for the fr-FR localization using PATCH

Import-Module Microsoft.Graph.Identity.DirectoryManagement

$params = @{
	backgroundColor = "#00000F"
	signInPageText = "Welcome to Contoso France"
}

Update-MgOrganizationBrandingLocalization -OrganizationId $organizationId -OrganizationalBrandingLocalizationId $organizationalBrandingLocalizationId -BodyParameter $params

This example will update the backgroundcolor and signinpagetext for the fr-fr localization using patch

Example 2: Override a default branding value with a blank string

Import-Module Microsoft.Graph.Identity.DirectoryManagement

$params = @{
	signInPageText = "Welcome to Contoso France."
	usernameHintText = " "
}

Update-MgOrganizationBrandingLocalization -OrganizationId $organizationId -OrganizationalBrandingLocalizationId $organizationalBrandingLocalizationId -BodyParameter $params

This example will override a default branding value with a blank string

Parameters

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BackgroundColor

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BackgroundImageInputFile

Input File for BackgroundImage (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.)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BackgroundImageRelativeUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BannerLogoInputFile

Input File for BannerLogo (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.)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BannerLogoRelativeUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

organizationalBrandingLocalization

Type:	Hashtable
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-CdnList

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.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContentCustomization

contentCustomization To construct, see NOTES section for CONTENTCUSTOMIZATION properties and create a hash table.

Type:	IMicrosoftGraphContentCustomization
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomAccountResetCredentialsUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomCannotAccessYourAccountText

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomCannotAccessYourAccountUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomCssInputFile

Input File for CustomCss (CSS styling that appears on the sign-in page. The allowed format is .css format only and not larger than 25 KB.)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomCssRelativeUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomForgotMyPasswordText

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomPrivacyAndCookiesText

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomPrivacyAndCookiesUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomResetItNowText

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomTermsOfUseText

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomTermsOfUseUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FaviconInputFile

Input File for Favicon (A custom icon (favicon) to replace a default Microsoft product favicon on a Microsoft Entra tenant.)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FaviconRelativeUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HeaderBackgroundColor

The RGB color to apply to customize the color of the header.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HeaderLogoInputFile

Input File for HeaderLogo (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.)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HeaderLogoRelativeUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Id

The unique identifier for an entity. Read-only.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IIdentityDirectoryManagementIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-LoginPageLayoutConfiguration

loginPageLayoutConfiguration To construct, see NOTES section for LOGINPAGELAYOUTCONFIGURATION properties and create a hash table.

Type:	IMicrosoftGraphLoginPageLayoutConfiguration
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LoginPageTextVisibilitySettings

loginPageTextVisibilitySettings To construct, see NOTES section for LOGINPAGETEXTVISIBILITYSETTINGS properties and create a hash table.

Type:	IMicrosoftGraphLoginPageTextVisibilitySettings
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OrganizationalBrandingLocalizationId

The unique identifier of organizationalBrandingLocalization

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-OrganizationId

The unique identifier of organization

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SignInPageText

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SquareLogoDarkInputFile

Input File for SquareLogoDark (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.)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SquareLogoDarkRelativeUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SquareLogoInputFile

Input File for SquareLogo (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.)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SquareLogoRelativeUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UsernameHintText

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity

System.Collections.Hashtable

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphOrganizationalBrandingLocalization

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

CONTENTCUSTOMIZATION <IMicrosoftGraphContentCustomization>: contentCustomization

• [(Any) <Object>]: This indicates any property can be added to this object.
• [AttributeCollection <IMicrosoftGraphKeyValue- []>]: Represents the content options of External Identities to be customized throughout the authentication flow for a tenant.
  • [Key <String>]: Key for the key-value pair.
  • [Value <String>]: Value for the key-value pair.
• [AttributeCollectionRelativeUrl <String>]: A relative URL for the content options of External Identities to be customized throughout the authentication flow for a tenant.
• [RegistrationCampaign <IMicrosoftGraphKeyValue- []>]: Represents content options to customize during MFA proofup interruptions.
• [RegistrationCampaignRelativeUrl <String>]: The relative URL of the content options to customize during MFA proofup interruptions.

INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter

• [AdministrativeUnitId <String>]: The unique identifier of administrativeUnit
• [AllowedValueId <String>]: The unique identifier of allowedValue
• [AttributeSetId <String>]: The unique identifier of attributeSet
• [CommerceSubscriptionId <String>]: Alternate key of companySubscription
• [CompanySubscriptionId <String>]: The unique identifier of companySubscription
• [ContractId <String>]: The unique identifier of contract
• [CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition
• [DeviceId <String>]: The unique identifier of device
• [DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo
• [DirectoryObjectId <String>]: The unique identifier of directoryObject
• [DirectoryRoleId <String>]: The unique identifier of directoryRole
• [DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate
• [DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord
• [DomainId <String>]: The unique identifier of domain
• [ExtensionId <String>]: The unique identifier of extension
• [IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase
• [InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation
• [OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization
• [OrgContactId <String>]: The unique identifier of orgContact
• [OrganizationId <String>]: The unique identifier of organization
• [OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization
• [ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty
• [RoleTemplateId <String>]: Alternate key of directoryRole
• [ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership
• [SubscribedSkuId <String>]: The unique identifier of subscribedSku
• [UserId <String>]: The unique identifier of user

LOGINPAGELAYOUTCONFIGURATION <IMicrosoftGraphLoginPageLayoutConfiguration>: loginPageLayoutConfiguration

• [(Any) <Object>]: This indicates any property can be added to this object.
• [IsFooterShown <Boolean?>]: Option to show the footer on the sign-in page.
• [IsHeaderShown <Boolean?>]: Option to show the header on the sign-in page.
• [LayoutTemplateType <String>]: layoutTemplateType

LOGINPAGETEXTVISIBILITYSETTINGS <IMicrosoftGraphLoginPageTextVisibilitySettings>: loginPageTextVisibilitySettings

• [(Any) <Object>]: This indicates any property can be added to this object.
• [HideAccountResetCredentials <Boolean?>]: Option to hide the self-service password reset (SSPR) hyperlinks such as 'Can't access your account?', 'Forgot my password' and 'Reset it now' on the sign-in form.
• [HideCannotAccessYourAccount <Boolean?>]: Option to hide the self-service password reset (SSPR) 'Can't access your account?' hyperlink on the sign-in form.
• [HideForgotMyPassword <Boolean?>]: Option to hide the self-service password reset (SSPR) 'Forgot my password' hyperlink on the sign-in form.
• [HidePrivacyAndCookies <Boolean?>]: Option to hide the 'Privacy & Cookies' hyperlink in the footer.
• [HideResetItNow <Boolean?>]: Option to hide the self-service password reset (SSPR) 'reset it now' hyperlink on the sign-in form.
• [HideTermsOfUse <Boolean?>]: Option to hide the 'Terms of Use' hyperlink in the footer.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.identity.directorymanagement/update-mgorganizationbrandinglocalization
• https://learn.microsoft.com/graph/api/organizationalbrandinglocalization-update?view=graph-rest-1.0