ZITADEL Docs
APIsCore ResourcesV2Settings

Get Hosted Login Translation

Returns the translations in the requested locale for the hosted login. The translations returned are based on the input level specified (system, instance or organization).

If the requested level doesn't contain all translations, and ignore_inheritance is set to false, a merging process fallbacks onto the higher levels ensuring all keys in the file have a translation, which could be in the default language if the one of the locale is missing on all levels.

The etag returned in the response represents the hash of the translations as they are stored on DB and its reliable only if ignore_inheritance = true.

Required permissions:

  • iam.policy.read
GET
/v2/settings/hosted_login_translation

Query Parameters

system?boolean
instance?boolean
organizationId?string
locale?string

The locale of the translations to be returned. Needs to be a BCP 47 language tag (e.g. "en", "de", "fr-CH").

ignoreInheritance?boolean

if set to true, higher levels are ignored, if false higher levels are merged into the file

Response Body

application/json

curl -X GET "https://loading/v2/settings/hosted_login_translation"
{
  "etag": "string",
  "translations": {
    "property1": {},
    "property2": {}
  }
}

Was this page helpful?

Get General Settings

Get General Settings: Get basic information of the instance like the default organization, default language and supported languages. Required permissions:

Get Legal and Support Settings

Get Legal and Support Settings: Get the legal and support settings for the requested context. This can be the instance or an organization. In case of an organization, the returned settings will fall back to the instance settings ...