Authorization UI preferences

Client applications can pass optional presentation hints on the OIDC authorization request. Valid hints apply to the hosted authorization flow and subsequent Raha Account portal pages. They do not change scopes, consent, authentication requirements, tokens, or redirect validation.

Parameters

ParameterValuesBehavior
ui_localesSpace-separated locale tags in priority orderUses the first supported locale. Supported languages are English (en), Persian/Dari (fa), and Pashto (ps). Regional tags and aliases such as fa-IR, prs, and ps-AF are normalized.
ui_themelight, dark, systemSelects the hosted color scheme. system clears a saved light/dark override and follows the browser or OS. This is a Raha Account extension rather than a standard OIDC parameter.

Preference precedence

An explicit valid hint becomes the active Raha Account site preference. If a hint is omitted, the existing account-site preference remains. Without a saved preference, locale defaults to English and theme follows the browser or operating system. Users can always change the language or theme from Raha Account.

Unsupported locales and invalid theme values are ignored.

Example

const authorizationUrl = new URL(configuration.authorization_endpoint)
authorizationUrl.searchParams.set('ui_locales', 'fa-IR en')
authorizationUrl.searchParams.set('ui_theme', 'dark')
window.location.assign(authorizationUrl)

Read runtime preferences immediately before starting authorization. Do not put identifiers, tokens, secrets, or other sensitive data in these parameters.

Was this page helpful?