Skip to content

Localization in Asgardeo

Asgardeo enables a language picker on the following interfaces exposed to business users, allowing business users to select their preferred language.

  • Interfaces related to the business user registration/sign-up flow, login flows (including MFA), and the account recovery flow.
  • Interfaces of the self-care portal (My Account)

The default language on these interfaces is configured as explained in the language settings section.

Important

When user attributes configured on Asgardeo are displayed to users (during user sign-up and consent management flows), only the default user attributes get translated.

These interfaces are i18n-supported, which allows Asgardeo to update the text content from i18n resource files. This feature allows your business users to experience these use cases in their preferred language. The languages that Asgardeo currently supports are listed below.

Supported languages

Below are the languages currently available for the i18n-supported user interfaces of Asgardeo.

Language Code
English en_US
French fr_FR
Spanish es_ES
Portuguese - Portugal pt_PT
Portuguese - Brazil pt_BR
German de_DE
Chinese zh-CN
Japanese ja-JP
Sinhalese si-LK

Language settings

The following methods can set the language used by Asgardeo interfaces exposed to business users.

Language switcher

The language switcher is available at the footer of the (i18n-supported) Asgardeo interfaces, which allows business users to select the preferred language for Asgardeo.

Note that Asgardeo will remember the language selected from this switcher, and it will be applied to all i18n-supported interfaces.

Browser-level settings

Asgardeo interfaces automatically adapt to the language preference set in the user's browser, as long as the language is supported by Asgardeo. However, the user can still change the language on the Asgardeo interfaces by using the language switcher.

Application-level settings

As an application developer, you can configure the application to send the ui_locales parameter in the sign-in request or authorization request when the user signs in to the application.

Important

The ui_locale parameter is only available for OIDC flows and not for SAML flows.

You can provide a list of strings, separated by a space, to define the locales. Asgardeo will search through the list until an Asgardeo-supported locale is found, and the first Asgardeo-supported locale in the list will be used as the default locale. If a supported locale is not found, Asgardeo will use the browser-level locale.

Consider the following examples:

  • If the ui_locales is sent as fr_FR, French is used as the default locale.
  • If the ui_locales is sent as fr_FR en_US, French will be the default locale since it's the first Asgardeo-support locale in the list.
  • If the ui_locales is sent as it_IT en_US, English (en_US) will be used as the default locale because the first given locale (it_IT) is not supported.

The following examples demonstrate how to set the ui_locales parameter in your application.

  • Example 1: Setting the default locale from the signIn request.

    You can send the ui_locales in the signIn request as a parameter.

    Note

    Learn more about setting the signIn request using the Asgardeo SDKs.

    The following sample illustrates the signIn request using the JS/React SDK.

        <SecureApp
        fallback={<div>Loading</div>}
        overrideSignIn={async () => {
            await signIn({
                'ui_locales': 'fr_FR en_US'
            });
        }}
    >
        <AppContent/>
    </SecureApp>

  • Example 2: Setting the default locale from the authorization request.

If you are sending the locale in the authorization request directly, you can append the ui_locales query parameter with the list of locales as shown below.

https://api.asgardeo.io/t/{organization_name}/oauth2/userinfo?scope={scope}&response_type=code&redirect_uri={redirect_uri}&client_id={client_id}&ui_locales={ locales list }

Privacy policy and Terms of conditions URLs

The privacy policy and terms of conditions URLs are specified in your branding configurations. The ui_locales={ locales list } parameter is appended to these URLs, which allows you to show the translated content for the user from your end.