Localize tenant admin console and hosted pages
Advanced Identity Cloud lets you deliver localized UI text across hosted journey pages, hosted account pages, and the Advanced Identity Cloud admin console. This lets you provide a consistent user experience for tenant administrators and end users in their preferred languages.
Localization is managed through language sets, which are collections of translations tailored to specific browser locales (such as es for Spanish or fr for French).
You can customize built-in UI phrases, translate journey node messages, and add custom key overrides.
You can also compare translations side-by-side against reference languages, switch the default language set, and import or export language sets as JSON files for backups or cross-environment migration.
Create localized content in your mutable tenant environments (development or sandbox[1]). When configured and tested, promote your language sets to production using your deployment pipeline.
You can manage localization using either the Advanced Identity Cloud admin console or the API, although to localize the Advanced Identity Cloud admin console itself, you must use the API:
| Content area | Translate using admin console? | Translate using API? |
|---|---|---|
Hosted journey pages |
Yes |
Yes |
Hosted account pages |
Yes |
Yes |
Advanced Identity Cloud admin console |
No |
Yes |
How localization works
-
Default language: Advanced Identity Cloud uses English (
en) as the initial default language set for hosted journey pages, hosted account pages, and the Advanced Identity Cloud admin console. You can change the default language set to any active language set you create. For example, German (de). -
Automatic detection: When an end user or tenant administrator visits the hosted pages or Advanced Identity Cloud admin console, the platform automatically detects their browser’s preferred locale and displays the matching language set. If no match exists for that locale, the platform serves your configured default language set.
-
English fallback: English acts as the underlying system fallback. If a specific translation key is missing from a custom language set and from your configured default language set, the platform automatically displays the built-in English definition.
-
Global scope: Language sets apply globally across all realms in your environment.
The exact behavior of localization, including JSON format schemas, enum labels, and fallback logic, is covered in Supplementary information for tenant localization.
|
Some Advanced Identity Cloud features such as security questions, terms and conditions, email templates, and authentication nodes contain their own localization options. Learn more in Localize hosted pages related features. |
Suggested workflow
-
Ensure you’re working in a development or sandbox[1] tenant environment.
-
Create a new empty language set for each additional locale you want to support. Learn more in Manage language sets.
-
Update each language set using one of the following methods:
-
To update the language set manually:
-
To bulk-update the language set:
-
Use the exported JSON file as a template to create another language set import file, then reimport it.
-
-
Test localized pages to verify that your translations display correctly across hosted journey pages, hosted account pages, and the admin console.
-
(Optional) Update the default language set to one of your language sets. The English (
en) language set is the out-of-the-box default language set. Set a default language if you want another language set to be used when no matching user locale is available. -
If you created the language sets in a sandbox[1] tenant environment, export each of the language sets to JSON files and import them into your development tenant environment. Learn more in Export and import language sets.
-
Determine the promotion order of your tenant environments. This depends on whether you have a standard promotion group of environments or whether you also have additional UAT environments.
-
In promotion order, for each upper tenant environment in your promotion group, run a promotion to move the configuration to the upper tenant environment from its respective lower tenant environment. Learn more in:
Localization tasks
Use these tasks to manage and verify localization. Where available, links provide more detailed instructions for using the admin console or API. If you’re using the admin console, go to User Experience > Languages to open the Languages page.
Update built-in translation keys
Modify out-of-the-box interface text across hosted journey pages, hosted account pages, and the admin console to match your organization’s terminology.
-
To use the admin console: Select a language set on the Languages page and edit key values directly in the editor. Learn more in Edit a language set.
-
To use the API: Perform a
PUTrequest to/openidm/config/uilocale/<locale>with your updated key values inside the corresponding JSON package blocks (admin,login,shared, orenduser). Learn more in Create or replace a language set.
Add custom translations
Translate unlocalized backend strings, custom journey node messages, server errors, or custom UI elements by creating literal key overrides.
-
To use the admin console: Select a language set on the Languages page, open Custom translations from the vertical menu, and define literal UI text along with its corresponding translation. Learn more in Edit a language set.
-
To use the API: Perform a
PUTrequest to/openidm/config/uilocale/<locale>containing custom key-value pairs inside anoverridesblock (such aslogin.overridesorshared.overrides). Learn more in Create or replace a language set.
Export the built-in English language set
You can export the built-in English language set to a JSON file for reference or to use as a template for creating new language sets.
-
To use the admin console: Use the Export option from the English language set’s overflow menu to download a JSON file.
This option isn’t available using the API.
If you perform a GET request to /openidm/config/uilocale/en, it returns any customized key values for the English language set, but not the built-in English definitions.
|
Update the default language set
Change the primary language set used across hosted journey pages, hosted account pages, and the admin console when a user’s browser locale does not match an active language set.
-
To use the admin console: Select a language set on the Languages page, click its ellipsis icon () menu, and select Make Default. Learn more in Manage language sets.
-
To use the API: Perform a
PUTrequest to/openidm/config/uilocale/defaultLocaleCodesetting thedefaultLocaleproperty to your desired locale identifier (such asdeorfr). Learn more in Update the default language set.
Export and import language sets
Maintain environment backups or migrate language sets across tenant environments using JSON files.
-
To use the admin console: Use the Export option from a language set’s overflow menu to download JSON files, or click Import to upload a new or modified JSON file. Learn more in Import a language set and Manage language sets.
-
To use the API: Perform a
GETrequest to retrieve a language set JSON configuration, or aPUTrequest to upload a language set payload. Learn more in View a language set and Create or replace a language set.
Test localized pages
Verify that your localized translations display correctly across hosted journey pages, hosted account pages, and the admin console.
-
Hosted journey pages: Test your translations by running the Preview URL for each of your journeys in a new incognito browser window as an end user, setting your browser’s language preferences to the target locale.
-
Hosted account pages: Authenticate through your journeys in the incognito window to load and verify your localized hosted account pages.
-
Admin console: Verify admin console translations directly as a tenant administrator by changing your browser’s preferred language settings to match your configured locale.