--- title: Manage localization using the API description: Use the Advanced Identity Cloud REST API to view, create, replace, delete, and set the default language set for localization. component: pingoneaic page_id: pingoneaic:tenants:tenant-localize-api canonical_url: https://docs.pingidentity.com/pingoneaic/tenants/tenant-localize-api.html llms_txt: https://docs.pingidentity.com/pingoneaic/llms.txt docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md section_ids: view-all-language-sets-and-default-language-set: View all language sets and default language set view-a-language-set: View a language set create-or-replace-a-language-set: Create or replace a language set create-or-replace-individual-language-set-keys: Create or replace individual language set keys delete-a-language-set: Delete a language set update-the-default-language-set: Update the default language set --- # Manage localization using the API You can find background information on localization in PingOne Advanced Identity Cloud in [Localize tenant admin console and hosted pages](tenant-localize.html). ## View all language sets and default language set 1. Create an [access token](../developer-docs/authenticate-to-rest-api-with-access-token.html#get_an_access_token) in either realm that has the `fr:idm:*` scope. 2. View all language sets using a GET request with a query filter. > **Collapse: Show request** > > ```none > $ curl -G \ > --request GET 'https:///openidm/config/uilocale' \(1) > --header 'Authorization: Bearer ' \(2) > --data-urlencode '_queryFilter=_id sw "uilocale"' > ``` > > | | | > | ----- | ---------------------------------------------------------------------------------------------------------------- | > | **1** | Replace \ with the domain of your environment. For example, `openam-mycompany.forgeblocks.com`. | > | **2** | Replace \ with the access token. | > **Collapse: Show response** > > ```json > { > "result": [ > { > "_id": "uilocale/de", (1) > "_meta": {...}, > "admin": {...}, > "login": {...}, > "shared": {...}, > "enduser": {...} > }, > { > "_id": "uilocale/defaultLocaleCode", (2) > "defaultLocale": "de" (2) > }, > { > "_id": "uilocale/fr", (1) > "_meta": {...}, > "admin": {...}, > "login": {...}, > "shared": {...}, > "enduser": {...} > }, > { > "_id": "uilocale/it", (1) > "_meta": {...}, > "admin": {...}, > "login": {...}, > "shared": {...}, > "enduser": {...} > } > ], > "resultCount": 4, > "pagedResultsCookie": null, > "totalPagedResultsPolicy": "EXACT", > "totalPagedResults": 4, > "remainingPagedResults": -1 > } > ``` > > | | | > | ----- | --------------------------------------------------------------------------------- | > | **1** | The available language sets are German (`de`), French (`fr`), and Italian (`it`). | > | **2** | The default language set is German (`de`). | ## View a language set View a language set using a GET request that specifies a locale. You don't need an access token to view the language set. > **Collapse: Show request** > > ```none > $ curl \ > --request GET 'https:///openidm/config/uilocale/' (1) (2) > ``` > > | | | > | ----- | ---------------------------------------------------------------------------------------------------------------- | > | **1** | Replace \ with the domain of your environment. For example, `openam-mycompany.forgeblocks.com`. | > | **2** | Replace \ with a locale identifier, such as `fr`. | > **Collapse: Show response** > > ```json > { > "_id": "uilocale/fr", > "admin": { > "sideMenu": { > "securityQuestions": "Questions de sécurité" > }, > "overrides": { > "EmailAddress": "Adresse e-mail", > "Name": "Nom", > "Owners": "Les propriétaires", > "AppLogoURI": "URI du logo de l'application" > } > }, > "login": { > "login": { > "next": "Suivant" > }, > "overrides": { > "UserName": "Nom d'utilisateur", > "Password": "Mot de passe", > "UnabletoresumesessionItmayhaveexpired": "Impossible de reprendre la session. Elle a peut-être expiré." > } > }, > "shared": { > "sideMenu": { > "dashboard": "Tableau de bord" > } > }, > "enduser": { > "pages": { > "dashboard": { > "widgets": { > "welcome": { > "greeting": "Bonjour" > } > } > } > }, > "overrides": { > "FirstName": "Prénom", > "LastName": "Nom de famille" > } > } > } > ``` | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | When attempting to view the default `en` translation, no results are returned. To view the default `en` translation, use the UI package files specified in [Language set format](tenant-localize-supplementary-information.html#language-set-format). | ## Create or replace a language set 1. Create an [access token](../developer-docs/authenticate-to-rest-api-with-access-token.html#get_an_access_token) in either realm that has the `fr:idm:*` scope. 2. Create or replace a language set using a PUT request that specifies a locale and includes a JSON payload. > **Collapse: Show request** > > ```none > $ curl \ > --request PUT 'https:///openidm/config/uilocale/' \(1) (2) > --header 'Authorization: Bearer ' \(3) > --header 'Content-Type: application/json' \ > --data-raw '{(4) > "admin": { > "sideMenu": { > "securityQuestions": "Questions de sécurité" > }, > "overrides": { > "EmailAddress": "Adresse e-mail", > "Name": "Nom", > "Owners": "Les propriétaires", > "AppLogoURI": "URI du logo de l'application" > } > }, > "login": { > "login": { > "next": "Suivant" > }, > "overrides": { > "UserName": "Nom d'\''utilisateur", > "Password": "Mot de passe", > "UnabletoresumesessionItmayhaveexpired": "Impossible de reprendre la session. Elle a peut-être expiré." > } > }, > "shared": { > "sideMenu": { > "dashboard": "Tableau de bord" > } > }, > "enduser": { > "pages": { > "dashboard": { > "widgets": { > "welcome": { > "greeting": "Bonjour" > } > } > } > }, > "overrides": { > "FirstName": "Prénom", > "LastName": "Nom de famille" > } > } > }' > ``` > > | | | > | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | > | **1** | Replace \ with the domain of your environment. For example, `openam-mycompany.forgeblocks.com`. | > | **2** | Replace \ with a locale identifier. Some examples are:- `en` (English) > > - `es` (Spanish) > > - `fr` (French) > > - `en-us` (English - United States) > > - `es-ar` (Spanish - Argentina) > > - `fr-ca` (French - Canada) | > | **3** | Replace \ with the access token. | > | **4** | Replace the example translation configuration with your own translation configuration. Refer to [Language set format](tenant-localize-supplementary-information.html#language-set-format) and [Translating enum values](tenant-localize-supplementary-information.html#translating-enum-values) for details on structuring the payload. | > **Collapse: Show response** > > ```json > { > "_id": "uilocale/fr", > "admin": { > "sideMenu": { > "securityQuestions": "Questions de sécurité" > }, > "overrides": { > "EmailAddress": "Adresse e-mail", > "Name": "Nom", > "Owners": "Les propriétaires", > "AppLogoURI": "URI du logo de l'application" > } > }, > "login": { > "login": { > "next": "Suivant" > }, > "overrides": { > "UserName": "Nom d'utilisateur", > "Password": "Mot de passe", > "UnabletoresumesessionItmayhaveexpired": "Impossible de reprendre la session. Elle a peut-être expiré." > } > }, > "shared": { > "sideMenu": { > "dashboard": "Tableau de bord" > } > }, > "enduser": { > "pages": { > "dashboard": { > "widgets": { > "welcome": { > "greeting": "Bonjour" > } > } > } > }, > "overrides": { > "FirstName": "Prénom", > "LastName": "Nom de famille" > } > } > } > ``` ## Create or replace individual language set keys 1. Create an [access token](../developer-docs/authenticate-to-rest-api-with-access-token.html#get_an_access_token) in either realm that has the `fr:idm:*` scope. 2. Create or replace individual language set keys using a PATCH request that specifies a locale and includes a JSON payload containing one or more `operation` objects. > **Collapse: Show request** > > ```none > $ curl \ > --request PATCH '/openidm/config/uilocale/' \(1) (2) > --header 'Authorization: Bearer ' \(3) > --header 'Content-Type: application/json' \ > --data-raw '[ > { > "operation":"add", > "field":"",(4) > "value":""(5) > } > ]' > ``` > > | | | > | ----- | ----------------------------------------------------------------------------------------------------------------------------------- | > | **1** | Replace \ with the domain of your environment. For example, `openam-mycompany.forgeblocks.com`. | > | **2** | Replace \ with a locale identifier. For example, `fr` (French). | > | **3** | Replace \ with the access token. | > | **4** | Replace \ with the translation key name you want to create or replace. For example, `shared/common/activate`. | > | **5** | Replace \ with the translation key value you want to create or replace. For example, `activer`. | > **Collapse: Show response** > > ```json > { > "_id": "uilocale/fr", > "admin": { > "sideMenu": { > "securityQuestions": "Questions de sécurité" > }, > "overrides": { > "EmailAddress": "Adresse e-mail", > "Name": "Nom", > "Owners": "Les propriétaires", > "AppLogoURI": "URI du logo de l'application" > } > }, > "login": { > "login": { > "next": "Suivant" > }, > "overrides": { > "UserName": "Nom d'utilisateur", > "Password": "Mot de passe", > "UnabletoresumesessionItmayhaveexpired": "Impossible de reprendre la session. Elle a peut-être expiré." > } > }, > "shared": { > "common": { > "activate": "activer" (1) > }, > "sideMenu": { > "dashboard": "Tableau de bord" > } > }, > "enduser": { > "pages": { > "dashboard": { > "widgets": { > "welcome": { > "greeting": "Bonjour" > } > } > } > }, > "overrides": { > "FirstName": "Prénom", > "LastName": "Nom de famille" > } > } > } > ``` > > | | | > | ----- | --------------------------------------------------------------------------------- | > | **1** | The response shows the updated language set with a new translation key and value. | ## Delete a language set 1. Create an [access token](../developer-docs/authenticate-to-rest-api-with-access-token.html#get_an_access_token) in either realm that has the `fr:idm:*` scope. 2. Delete the language set using a DELETE request that specifies a locale: > **Collapse: Show request** > > ```none > $ curl \ > --request DELETE 'https:///openidm/config/uilocale/' \(1) (2) > --header 'Authorization: Bearer '(3) > ``` > > | | | > | ----- | ---------------------------------------------------------------------------------------------------------------- | > | **1** | Replace \ with the domain of your environment. For example, `openam-mycompany.forgeblocks.com`. | > | **2** | Replace \ with a locale identifier, such as `fr`. | > | **3** | Replace \ with the access token. | > **Collapse: Show response** > > ```json > { > "_id": "uilocale/fr", > "admin": { > "sideMenu": { > "securityQuestions": "Questions de sécurité" > }, > "overrides": { > "EmailAddress": "Adresse e-mail", > "Name": "Nom", > "Owners": "Les propriétaires", > "AppLogoURI": "URI du logo de l'application" > } > }, > "login": { > "login": { > "next": "Suivant" > }, > "overrides": { > "UserName": "Nom d'utilisateur", > "Password": "Mot de passe", > "UnabletoresumesessionItmayhaveexpired": "Impossible de reprendre la session. Elle a peut-être expiré." > } > }, > "shared": { > "sideMenu": { > "dashboard": "Tableau de bord" > } > }, > "enduser": { > "pages": { > "dashboard": { > "widgets": { > "welcome": { > "greeting": "Bonjour" > } > } > } > }, > "overrides": { > "FirstName": "Prénom", > "LastName": "Nom de famille" > } > } > } > ``` ## Update the default language set 1. Create an [access token](../developer-docs/authenticate-to-rest-api-with-access-token.html#get_an_access_token) in either realm that has the `fr:idm:*` scope. 2. Update the default language set using a PUT request: > **Collapse: Show request** > > ```none > $ curl \ > --request PUT 'https:///openidm/config/uilocale/defaultLocaleCode' \(1) > --header 'Authorization: Bearer ' \(2) > --header 'Content-Type: application/json' \ > --data-raw '{ > "_id": "uilocale/defaultLocaleCode", > "defaultLocale": ""(3) > }' > ``` > > | | | > | ----- | ---------------------------------------------------------------------------------------------------------------- | > | **1** | Replace \ with the domain of your environment. For example, `openam-mycompany.forgeblocks.com`. | > | **2** | Replace \ with the access token. | > | **3** | Replace \ with a locale identifier, such as `fr`. | > **Collapse: Show response** > > ```json > { > "_id": "uilocale/defaultLocaleCode", > "defaultLocale": "fr" > } > ```