Read Translation
GET {{apiPath}}/environments/{{envID}}/translations/{{locale}}
The GET /environments/{{envID}}/translations/{{locale}} operation returns the translated strings for the specified locale (see Language Translations). For example, a locale of zh returns the Chinese custom string translations.
Filtering data
You can apply a SCIM filtering expression to the request URL using the query parameters:
module
The interface module key value. Options are flow-ui, my-account, portal, and forms.
block
The key for a logical group of interface strings in the specified module, such as a form or a tab.
Each module is associated with a particular set of blocks:
module | Module Name | block |
|---|---|---|
flow-ui | Sign On Policy | UsernamePasswordValidator |
SocialProviderList | ||
PasswordValidator | ||
UsernameValidator | ||
AccountSelector | ||
ConfirmProfile | ||
DiscoverIdpForm | ||
ForgotPasswordUsernameForm | ||
PasswordEditor | ||
RecoveryCodeAndPasswordForm | ||
RegistrationForm | ||
UpdateProfile | ||
UserCredentialsForm | ||
UserLogin | ||
VerificationCode | ||
Agreement | ||
ErrorView | ||
LicenseTerminationView | ||
ConfirmationTimedOut | ||
DeviceSelectionForm | ||
OnetimePasscodeEditor | ||
OneTimePasscodeForm | ||
PendingAssertionComponent | ||
PendingPushComponent | ||
PushOTPForm | ||
SignedOff | ||
passwordRequirements | ||
errorMessages | ||
DeviceAuthorizationActivationCode | ||
DeviceAuthorizationApplicationConsent | ||
DeviceAuthorization | ||
serverValidationMessages | ||
FidoPolicy | ||
Others | ||
my-account | Self-Service | Profile |
MFA | ||
ChangePasswordForm | ||
AccountAndSessions | ||
ConsentsScreen | ||
errorMessages | ||
FidoPolicy | ||
Others | ||
portal | Application Portal | labels |
errorMessages | ||
appNames | ||
forms | DaVinci Forms | stdFields |
errorMessages | ||
passwordPolicy | ||
customMessages | ||
Others |
For example, the following request returns data for the flow-ui module and the UsernamePasswordValidator block of UI strings:
GET {{apiPath}}/environments/{{envID}}/translations/{{locale}}?block=UsernamePasswordValidator&module=flow-ui
| Parameter | Description |
|---|---|
module | Filters results for the specified UI module. |
block | Filters results for the set of UI strings in the specified module. |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
module | string | Specifies the interface module key value. See documentation for usage. | |
block | string | Specifies a key for a logical group of strings, such as a form or a tab. |
RESPONSES
status: OK
{"_links":{"next":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/translations/fr?cursor=abbeb481-9036-4d78-badb-bdea872f1a5b"},"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/translations/fr"}},"_embedded":{"translations":[{"id":"0d3ccf94-9036-4d78-badb-45017189cb46","key":"flow-ui.button.approve","shortKey":"button.approve","referenceText":"Approve","translatedText":"Approuver"},{"id":"3e90224d-9036-4d78-badb-65e98f4fc944","key":"flow-ui.button.cancel","shortKey":"button.cancel","referenceText":"Cancel","translatedText":"Annuler"},{"id":"3bae9a30-9036-4d78-badb-9f7e5708de67","key":"flow-ui.button.changeDevice","shortKey":"button.changeDevice","referenceText":"Change Device","translatedText":"Changer d'appareil"},{"id":"7799a850-9036-4d78-badb-ee7f507ffec1","key":"flow-ui.button.confirm","shortKey":"button.confirm","referenceText":"Confirm","translatedText":"Confirmer"},{"id":"35bcf2d4-9036-4d78-badb-bd3f4abbddd6","key":"flow-ui.button.continue","shortKey":"button.continue","referenceText":"Continue","translatedText":"Continuer"},{"id":"3ca1024d-9036-4d78-badb-4139789a8c7e","key":"flow-ui.button.createNewAccount","shortKey":"button.createNewAccount","referenceText":"Create new Account","translatedText":"Créer un compte"},{"id":"a8f9fd1a-9036-4d78-badb-a77ac64c7c89","key":"flow-ui.button.decline","shortKey":"button.decline","referenceText":"Decline","translatedText":"Refuser"},{"id":"e7239539-9036-4d78-badb-b198d622d6be","key":"flow-ui.button.retry","shortKey":"button.retry","referenceText":"Retry","translatedText":"Réessayer"},{"id":"af649e62-9036-4d78-badb-cfffc6e737a7","key":"flow-ui.button.save","shortKey":"button.save","referenceText":"Save","translatedText":"Enregistrer"},{"id":"81cf82c5-9036-4d78-badb-50dae4c7ecba","key":"flow-ui.button.signOn","shortKey":"button.signOn","referenceText":"Sign On","translatedText":"Se connecter"},{"id":"9881d684-9036-4d78-badb-d00b52e67d64","key":"flow-ui.button.skip","shortKey":"button.skip","referenceText":"Skip for now","translatedText":"Ignorer pour le moment"},{"id":"ae0d90fb-9036-4d78-badb-3e8e8fa7742b","key":"flow-ui.button.submit","shortKey":"button.submit","referenceText":"Submit","translatedText":"Envoyer"},{"id":"7c43c2d5-9036-4d78-badb-73aa71c9004b","key":"flow-ui.button.tryAgain","shortKey":"button.tryAgain","referenceText":"Try Again","translatedText":"Réessayer"},{"id":"c1e58161-9036-4d78-badb-ccc1a8391788","key":"flow-ui.button.verify","shortKey":"button.verify","referenceText":"Verify","translatedText":"Vérifier"},{"id":"4fed95d8-9036-4d78-badb-fae0bee5a07d","key":"flow-ui.copyright","shortKey":"copyright","referenceText":"© Copyright 2003-{date} Ping Identity. All rights reserved.","translatedText":"©{date} Ping Identity, 2003. Tous droits réservés"},{"id":"92a94c1b-9036-4d78-badb-dca8f35a907a","key":"flow-ui.error.accountInactive","shortKey":"error.accountInactive","referenceText":"Account Inactive","translatedText":"Compte inactif"},{"id":"9578ccc0-9036-4d78-badb-739457a4aa6e","key":"flow-ui.error.accountInactive.message","shortKey":"error.accountInactive.message","referenceText":"This service is no longer active.","translatedText":"Ce service n'est plus actif."},{"id":"7815a324-9036-4d78-badb-bdb991e6cdb0","key":"flow-ui.error.accountLocked","shortKey":"error.accountLocked","referenceText":"Account Locked","translatedText":"Compte verrouillé"},{"id":"720fb3b7-9036-4d78-badb-1d384ee9f927","key":"flow-ui.error.activationCode.required","shortKey":"error.activationCode.required","referenceText":"Activation code cannot be empty","translatedText":"Le code d'activation ne peut pas être vide"},{"id":"aacf0c87-9036-4d78-badb-c0aa749b36fe","key":"flow-ui.error.activationCodeExpired","shortKey":"error.activationCodeExpired","referenceText":"The activation code has expired. Request a new code from the device to continue.","translatedText":"Le code d'activation a expiré Demandez un nouveau code depuis le terminal pour continuer."},{"id":"73067162-9036-4d78-badb-4a665baac0a8","key":"flow-ui.error.appAccessDenied","shortKey":"error.appAccessDenied","referenceText":"Access denied for the application.","translatedText":"Accès refusé à l'application."},{"id":"b1c37c04-9036-4d78-badb-f0f8f8194400","key":"flow-ui.error.assertionFailed","shortKey":"error.assertionFailed","referenceText":"Authentication cancelled","translatedText":"Authentification annulée"},{"id":"b5aa1018-9036-4d78-badb-ca43bd7d0fd2","key":"flow-ui.error.authenticationFailed","shortKey":"error.authenticationFailed","referenceText":"Authentication has failed for unknown reason.","translatedText":"L'authentification a échoué pour une raison inconnue."},{"id":"83484715-9036-4d78-badb-f46d30a43cc4","key":"flow-ui.error.blocked","shortKey":"error.blocked","referenceText":"Blocked","translatedText":"Bloqué"},{"id":"abbeb481-9036-4d78-badb-bdea872f1a5b","key":"flow-ui.error.confirmProfile","shortKey":"error.confirmProfile","referenceText":"There was a problem confirming your profile attributes. Please try again.","translatedText":"Un problème est survenu lors de la confirmation des attributs de votre profil. Veuillez réessayer."}]},"count":757,"size":25}