Translation and Language Management in Hosted Pages
Overview
Translations and languages appear across many parts of cidaas: emails and SMS, login and registration pages (hosted pages), consents, and fields.
Learn more about Hosted Pages Management.
Hosted page translations are managed through Translation Management in Trustdesk — a centralized system for all localized resources. Instead of editing raw JSON in the hosted pages area, you manage hosted page strings from the Translation Management UI, with schema validation, completion tracking, and support for default translation set.
This gives instance administrators a single place to:
- View and edit hosted page translations across all supported locales
- Override bundled default strings or add fully custom locales
- Track translation completeness (critical, warning, and total missing keys)
At a Glance
System overview
┌──────────────────────────────────────────────────────────────────────────┐
│ ADMIN (Trustdesk) │
│ │
│ Translations UI ──► localization-srv ──► CDN (locale files) │
│ (edit strings) (validate & store) (en.json, de.json, …) │
└──────────────────────────────────────────────────────────────────────────┘
┌──────────────────────────────────────────────────────────────────────────┐
│ RUNTIME (user opens login / register) │
│ │
│ Hosted Pages ──► public-srv ──► app-srv (resolve layout + set) │
│ │ │
│ └────────────► CDN (load locale file for assigned set) │
└──────────────────────────────────────────────────────────────────────────┘
Configuration model — one app, one translation set
Resource: default-hosted-pages-webapp
│
├── Translation set: default Translation set: enterprise
│ ├── locale: en ├── locale: en
│ └── locale: de └── locale: de
│
Hosted Page Layout: layout-consumer-001
└── resources
└── default-hosted-pages-webapp
└── translationSet: "enterprise" ◄── pick which set this layout uses
Application: Consumer Portal (client_id: a1b2…)
└── hosted_pages_layout_id: "layout-consumer-001" ◄── links app to layout above
Runtime flow
User Hosted Pages public-srv app-srv CDN
│ │ │ │ │
│ open login │ │ │ │
│────────────────►│ │ │ │
│ │ GET /public/{requestId} │ │
│ │────────────────►│ │ │
│ │ │ resolve layout │ │
│ │ │ + translationSet│ │
│ │ │────────────────►│ │
│ │ │◄────────────────│ │
│ │◄── page config (branding, providers, …) │
│ │ │ │ │
│ │ GET …/enterprise/de.json (assigned set + locale) │
│ │──────────────────────────────────────────────────►│
│ │◄── translations ──────────────────────────────────│
│◄ localized UI ──│ │ │ │
How It Works
Hosted pages are a static translation resource in the localization platform. At runtime, the hosted pages web app loads translations through public-srv, which resolves the correct translation set for the application's client ID and serves the locale data via CDN.
Typical flow:
- Setup — Hosted pages are registered as a localization resource with a schema and default translation set.
- Edit — An admin edits translations in Translation Management; changes are validated against the schema and published to CDN.
Terminology
| Term | Explanation |
|---|---|
| Resource | A localizable entity in cidaas. Hosted pages are one resource among others (for example, field setup). |
| Translation set | A named collection of translations for a resource (for example, default, enterprise). A resource can have multiple sets for different brands or configurations. |
| Locale | A language code such as en or de. Each translation set supports one or more locales. |
| Bundled translations | Default strings shipped with cidaas hosted pages (English and German). You can override individual keys without providing every string. |
| Custom locale | A language beyond the bundled defaults (for example, French or Italian). All required keys must be translated for that locale. |
| Completion status | Metrics showing missing translations: critical (required keys), warning (optional keys), and total. |
Note: Bundled defaults are available for English (
en) and German (de). For other languages, provide translations for all required keys.
Manage Hosted Page Translations
Step 1: Open Translation Management
- Log in to Trustdesk.
- Navigate to Translations.
From the resource overview you can see all localization resources, their supported locales, translation sets, and completion progress.
Step 2: Select the Hosted Pages Resource
- Open the hosted pages resource (for example, Default Hosted Pages /
default-hosted-pages-webapp). - Review the resource details: supported locales, translation sets, and completion status per locale.
Step 3: Edit Translations
- On the resource details page, select a translation set.
- Click Edit Translations for the locale you want to work on.
- Use one of the editors:
- Table editor — Spreadsheet-style view with reference language, target translation, and missing/translated status. Best for bulk work across many keys.
- Category editor — Keys grouped by page or feature (login, MFA, register, and so on). Best for focused edits within one area.
- Edit translation values only. Do not change translation keys.
- Save your changes. The system validates against the JSON schema before publishing.
Translation keys, descriptions, and UI hints come from the resource schema — you do not need a separate key reference list. Search and category filters in Translation Management help you find the string you need.
:::warning Watch out
Do not edit translation keys or placeholders. Change only the displayed text values. Keys such as GUEST_LOGIN or LOGIN.WELCOME_HEADER must remain unchanged — only their values should be translated.
:::
Step 4: Add a Locale or Translation Set
Add a locale to an existing set when you want to support a new language.
Technical Integration
cidaas provides REST APIs for managing hosted page translations and assigning translation sets to applications. Translation content is managed through the Localization API (localization-srv). Layout and application linking use the Hosted Pages API and App Configuration API.
Translation Management
| API | Description | Link |
|---|---|---|
| List Resources | Lists localization resources, including hosted pages. | View API |
| Get Resource Schema | Retrieves the JSON schema used for validation. | View API |
| List Translation Sets | Lists translation sets for a resource. | View API |
| Get Locale | Reads translations for a locale in a set. | View API |
| Update Locale | Updates translations (PUT full replace, PATCH partial merge). | View API |
| Bulk Update Locales | Updates multiple locales at once. | View API |
API Authentication
Localization APIs require OAuth2 client credentials with the following scopes:
cidaas:localization_read— Read access for localization resourcescidaas:localization_write— Write access for localization resourcescidaas:localization_delete— Delete access for localization resources
For hosted page layout API scopes, see Hosted Pages Management — API Authentication.
For hosted page group and layout details, see Hosted Pages Management.
:::warning Need help implementing this?
Please contact us on our Developer Support Page.
:::