How do you add translations to the globalexception page on Azure AD B2C using custom policies

Josh Jones 30

Hi,

I am make using of Azure custom policies and am unable to find out how to translate the globalexception page.

I would expect to be able to translate the error heading and error description, but there is no mention of how to do this via the official documentation - https://zcusa.951200.xyz/en-us/azure/active-directory-b2c/localization-string-ids

The data contract that is being used is:

urn:com:microsoft:aad:b2c:elements:contract:globalexception:1.2.6

Attempted to use the following translations but does not work:

     <LocalizedResources Id="api.error.en">
        <LocalizedStrings>
          <LocalizedString ElementType="UxElement" StringId="heading">Reset your password</LocalizedString>
          <LocalizedString ElementType="ErrorMessage" StringId="DefaultError">An error occurred. Please try again.</LocalizedString>
        </LocalizedStrings>
      </LocalizedResources>

The Javascript best practices also mentions using the custom policies for translating error messages but does not provide examples of how - https://zcusa.951200.xyz/en-us/azure/active-directory-b2c/javascript-and-page-layout?pivots=b2c-custom-policy#guidelines-for-using-javascript

Example screenshot
Screenshot 2025-01-06 at 17.31.54

James Hamil 26,881 Microsoft Employee

Hi @Josh Jones , have you added the SupportedLanguages element? The SupportedLanguages element is required to specify the list of supported languages and the default language.

<Localization Enabled="true">
  <SupportedLanguages DefaultLanguage="en" MergeBehavior="ReplaceAll">
    <SupportedLanguage>en</SupportedLanguage>
    <SupportedLanguage>es</SupportedLanguage>
  </SupportedLanguages>
  <LocalizedResources Id="api.error.en">
    <LocalizedStrings>
      <LocalizedString ElementType="UxElement" StringId="heading">Reset your password</LocalizedString>
      <LocalizedString ElementType="ErrorMessage" StringId="DefaultError">An error occurred. Please try again.</LocalizedString>
    </LocalizedStrings>
  </LocalizedResources>
</Localization>

Josh Jones 30

Hi James,

Yes I have added the list of supported languages, I have translations working for every other page except for the error page.

      <ContentDefinition Id="api.error">
        <LoadUri>{{blobStorageBaseUrl}}/error.html</LoadUri>
        <RecoveryUri>~/common/default_page_error.html</RecoveryUri>
        <DataUri>urn:com:microsoft:aad:b2c:elements:contract:globalexception:1.2.6</DataUri>
        <Metadata>
          <Item Key="DisplayName">Error page</Item>
        </Metadata>
        <LocalizedResourcesReferences>
          <LocalizedResourcesReference Language="en" LocalizedResourcesReferenceId="api.error.en" />
        </LocalizedResourcesReferences>
      </ContentDefinition>

Are those the expected IDs that I provided for the title and description? As there is no documentation it was just a guess

Adam Woodcock 20 Reputation points

2025-01-09T14:26:56.6166667+00:00

I've been struggling with this too!
James Hamil 26,881 Reputation points Microsoft Employee

2025-01-10T00:10:09.6766667+00:00

Hi @Josh Jones @Adam Woodcock I reached out to the product group about this to find out what's going on. I'll let you know what I find!

1 answer

James Hamil 26,881 Reputation points Microsoft Employee

2025-01-10T19:33:09.04+00:00

Hi @Josh Jones @Adam Woodcock , please add these localized strings in "api.signuporsignin" content definition instead of "api.error":

Please let me know if you have any questions and I can help you further.

If this answer helps you please mark "Accept Answer" so other users can reference it.

Thank you,

James
Please sign in to rate this answer.
Josh Jones 30 Reputation points

2025-01-13T16:21:53.87+00:00

This does not work for the page layout: urn:com:microsoft:aad:b2c:elements:contract:globalexception:1.2.6

Instead have just made use of the selfasserted page layout and passed the correlation id and timestamp using the context claims to the page to replicate the error page.

For example

<Metadata> <Item Key="ContentDefinitionReferenceId">api.error</Item> <Item Key="setting.showContinueButton">false</Item> <Item Key="setting.showCancelButton">false</Item> <Item Key="IncludeClaimResolvingInClaimsHandling">true</Item> </Metadata> <InputClaims> <InputClaim ClaimTypeReferenceId="correlationId" DefaultValue="{Context:CorrelationId}" AlwaysUseDefaultValue="true"/> <InputClaim ClaimTypeReferenceId="timestamp" DefaultValue="{Context:DateTimeInUtc}" AlwaysUseDefaultValue="true"/> </InputClaims> <OutputClaims> <OutputClaim ClaimTypeReferenceId="correlationId"/> <OutputClaim ClaimTypeReferenceId="timestamp"/> </OutputClaims>

Then can make use of the following elementIds for the title translations:

<LocalizedResources Id="api.error.en"> <LocalizedStrings> <LocalizedString ElementType="UxElement" StringId="heading">Oops, something went wrong</LocalizedString> <LocalizedString ElementType="UxElement" StringId="initial_intro">An error has occurred. Please try again.</LocalizedString> </LocalizedStrings> </LocalizedResources>

James Hamil 26,881 Reputation points Microsoft Employee

2025-01-13T23:59:15.9766667+00:00

Hi @Josh Jones , thanks for letting me know. I'll look into this and let you know what I find.

Best,

James
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

How do you add translations to the globalexception page on Azure AD B2C using custom policies

1 answer

Your answer