Localizing the widget

The Advanced Identity Cloud/PingAM Login Widget uses variables with default values for all strings it displays when rendering the user interface.

Show variable names and default values

Default localization values
Variable	Default text
`adminRegInvalidInviteHeader`	Invitation not valid
`adminRegInvalidInviteDescription`	This invitation can’t be used. Please contact your administrator or <a href='https://support.pingidentity.com/' target='_blank' rel='noopener noreferrer'>Ping Support</a> for help.
`adminRegOtpHeader`	Admin Invite Code
`adminRegOtpDescription`	We’ve sent a 6-digit code to your email. Enter it below to continue.
`adminRegOtpError`	That code isn’t correct or may have expired. Please try again.
`adminRegOtpResendPrompt`	Didn’t get a code?
`adminRegOtpResend`	Resend
`adminRegPrivacyPolicyHeader`	Accept Privacy Policy
`adminRegPrivacyPolicyDescription`	Select your region of residence to review the applicable privacy policy.
`adminRegPrivacyPolicySelectRegion`	Region of residence
`adminRegPrivacyPolicyAgreement`	I agree to the Ping Identity <a target='_blank' rel='noopener noreferrer' href='https://www.pingidentity.com/en-us/docs/legal/privacy'>privacy policy</a>.
`adminRegSendVerificationCode`	Send Verification Code
`adminRegWelcomeHeader`	Welcome to PingOne Advanced Identity Cloud
`adminRegWelcomeDescriptionPre`	You’ve been invited to administer the
`adminRegWelcomeDescriptionPost`	tenant in PingOne Advanced Identity Cloud.
`adminRegWelcomeVerification`	Before you can begin, we need to verify your email address. Click the button below and we’ll send you a one-time verification code.
`alreadyHaveAnAccount`	Already have an account? <a href='?journey'>Sign in here!</a>
`backToDefault`	Back to Sign In
`backToLogin`	Back to Sign In
`captchaError`	CAPTCHA verification failed. Please try again.
`closeModal`	Close
`charactersCannotRepeatMoreThan`	Character cannot repeat more than {max} times
`charactersCannotRepeatMoreThanCaseInsensitive`	Character cannot repeat more than {max} times (case insensitive)
`checkYourEmail`	Check your email
`chooseDifferentUsername`	Please choose a different username.
`chooseYourDeviceForIdentityVerification`	Choose your device for identity verification.
`confirmPassword`	Confirm password
`constraintViolationForPassword`	Password does not meet the requirements.
`constraintViolationForValue`	Value does not meet the requirements.
`continueButton`	Continue
`continueWith`	Continue with
`copyAndPasteUrlBelow`	Or, copy and paste the URL below into your authentictor app.
`copyUrl`	Copy URL
`customSecurityQuestion`	Custom security question
`deviceName`	Device name
`doesNotMeetMinimumCharacterLength`	At least {min} character(s)
`downloadTheApp`	Download the app
`dontGetLockedOut`	Don’t get locked out of your account!
`dontHaveAnAccount`	No account? <a href='?journey=Registration'>Register here!</a>
`ensurePasswordIsMoreThan`	Password must contain at least {minPasswordLength} character(s).
`ensurePasswordHasOne`	Password must contain at least 1 capital letter, 1 number, and 1 special character.
`enterVerificationCode`	Enter verification code
`exceedsMaximumCharacterLength`	Exceeds maximum of {max} characters
`fieldCanNotContainFollowingCharacters`	Cannot contain these character(s): {chars}
`fieldCanNotContainFollowingValues`	Cannot contain these value(s): {fields}
`forgotPassword`	Forgot password?
`forgotUsername`	Forgot username?
`getAuthenticatorApp`	Set up the ForgeRock Authenticator
`getAuthenticatorAppDescription`	To get started, you need to register your device using the ForgeRock Authenticator app.
`getAuthenticatorAppLinks`	Get the app from the <a href='https://itunes.apple.com/app/forgerock-authenticator/id1038442926' target='_blank' rel='noopener noreferrer'>Apple App Store</a> or on <a href='https://play.google.com/store/apps/details?id=com.forgerock.authenticator' target='_blank' rel='noopener noreferrer'>Google Play Store</a>
`givenName`	First name
`inputRequiredError`	Value is required
`loading`	Loading …
`loginButton`	Sign in
`loginFailure`	Sign in failed
`loginHeader`	Sign in
`loginSuccess`	Sign in successful!
`mail`	Email address
`minimumNumberOfNumbers`	At least {num} number(s)
`minimumNumberOfLowercase`	At least {num} lowercase letter(s)
`minimumNumberOfUppercase`	At least {num} uppercase letter(s)
`minimumNumberOfSymbols`	At least {num} symbol(s)
`nameCallback`	Username
`nameYourDevice`	Name your device
`next`	Next
`nextButton`	Next
`notToExceedMaximumCharacterLength`	No more than {max} characters
`noLessThanMinimumCharacterLength`	At least {min} character(s)
`onMobileOpenInAuthenticator`	On mobile? Open link in Authenticator.
`optionallyNameDevice`	Optionally name your device
`passwordCallback`	Password
`passwordCannotContainCommonPasswords`	Password cannot contain common passwords
`passwordCannotContainCommonPasswordsOrBeReversible`	Password cannot contain common passwords or reversible text
`passwordCannotContainCommonPasswordsOrBeReversibleStringsLessThan`	Password cannot contain common passwords or reversible text less than {min} characters
`passwordRequirements`	Password requirements:
`pleaseCheckValue`	Please check this value
`pleaseConfirm`	Please confirm
`preferencesMarketing`	Send me special offers and services
`preferencesUpdates`	Send me news and updates
`provideCustomQuestion`	Provide custom security question
`qrCodeNotWorking`	Not working or need an alternative method?
`qrCodeFailedToRender`	QR Code failed to render. Please notify your support administrator. You are welcome to use the alternative methods below.
`qrCodeImportFailure`	We are unable to render your QR Code. Please use one of the alternative methods below.
`redirectingTo`	Redirecting you to
`registerButton`	Register
`registerHeader`	Register
`registerSuccess`	Registration successful!
`requiredField`	Value is required
`registerYourDevice`	Register {name}
`scanQrCodeWithAuthenticator`	Scan the QR code image below with the ForgeRock Authenticator app to register your device with your login.
`securityAnswer`	Security answer
`securityQuestions`	Security question(s)
`securityQuestionsPrompt`	Provide security question(s) and answer(s):
`setupTwoStepVerification`	Set up 2-step verification
`setupTwoStepVerificationButton`	Set up
`setupTwoStepVerificationDescription`	To protect your account, add a second authentication method.
`setupTwoStepVerificationWarning`	Starting April 2, 2024, you must sign in using 2-step verification. <a class='alert-link' href='https://backstage.forgerock.com/docs/idcloud/latest/product-information/migration-dependent-features/tenant-administrator-mandatory-2-step-verification-faq.html' target='_blank' rel='noopener noreferrer'>Learn more</a>.
`shouldContainANumber`	Should contain a number
`shouldContainAnUppercase`	Should contain an uppercase letter
`shouldContainALowercase`	Should contain a lowercase letter
`shouldContainASymbol`	Should contain a symbol
`showPassword`	Show password
`signalsEvaluation`	Evaluating device information.
`skipButton`	Skip
`skipForNow`	Skip for now
`sn`	Last name
`submit`	Submit
`submitButton`	Submit
`successMessage`	Success!
`termsAndConditions`	Please accept our Terms & Conditions
`termsAndConditionsLinkText`	View full Terms & Conditions
`tryAgain`	Please try again
`twoFactorAuthentication`	Two factor authentication
`useThisNewMfaToHelpVerifyYourIdentity`	Use this new device or Multi-Factor Authentication method to help verify your identity.
`useValidEmail`	Please use a valid email address.
`unrecoverableError`	There was an error in the form submission.
`unknownLoginError`	Unknown login failure has occurred.
`unknownNetworkError`	Unknown network request failure has occurred.
`url`	URL:
`useDeviceForIdentityVerification`	Use your device for identity verification.
`useOneOfTheseCodes`	Use one of these codes to authenticate if you lose your device, which has been named: <em>{name}</em>
`userName`	Username
`usernameRequirements`	Username requirements:
`useTheAuthenticatorAppOnYourPhone`	Find the verification code using the authenticator app on your phone.
`validatedCreatePasswordCallback`	Password
`validatedCreateUsernameCallback`	Username
`valueRequirements`	Value requirements:
`verifyYourIdentity`	Verify your identity
`yourDevice`	Your device
`yourMultiFactorAuthIsEnabled`	Your new device or MFA is enabled
`yourRecoveryCodesToAccessAccountForLostDevice`	If you lose your device, or don’t have it with you, a recovery code is the only way to sign in to your account with 2-step verification enabled. It’s strongly recommended that you print and store these codes in a safe place. <b>Each code can only be used once</b>."

You can use the content configuration element to specify custom values for these variables, or to localize text content.

To localize the text the Advanced Identity Cloud/PingAM Login Widget displays, provide the localized strings in the content configuration element when you call configure(). If you don’t override the content strings, the widget uses the default en-us strings.

The content object is passed once during configure(). To select strings based on the user’s browser locale, build the content object first and then pass it to a single await configure() call:

Example content configuration

import { configure } from '@forgerock/login-widget';

const userLang = navigator.language || navigator.userLanguage;

const localizedContent = userLang === 'fr-CA'
  ? {
      userName: 'Identifiant',
      passwordCallback: 'Phrase secrète',
      nextButton: 'Nous allez en route!',
    }
  : {
      userName: 'Identifier',
      passwordCallback: 'Passphrase',
      nextButton: "Let's go!",
    };

await configure({
  wellknown: 'https://openam-forgerock-sdks.forgeblocks.com/am/oauth2/realms/root/realms/alpha/.well-known/openid-configuration',
  content: localizedContent,
});

Figure 1. Custom values displayed when locale is not fr-CA