API Reference
AuthLocalization
You can customize the text and messages displayed by the authentication components by providing an AuthLocalization object to the <AuthUIProvider> component.
| Prop | Type | Default |
|---|---|---|
account? | string | "Account" |
accounts? | string | "Accounts" |
accountsDescription? | string | "Manage your currently signed in accounts." |
accountsInstructions? | string | "Sign in to an additional account." |
addAccount? | string | "Add Account" |
addPasskey? | string | "Add Passkey" |
alreadyHaveAnAccount? | string | "Already have an account?" |
avatar? | string | "Avatar" |
avatarDescription? | string | "Click on the avatar to upload a custom one from your files." |
avatarInstructions? | string | "An avatar is optional but strongly recommended." |
backupCodeRequired? | string | "Backup code is required" |
backupCodes? | string | "Backup Codes" |
backupCodesDescription? | string | "Save these backup codes in a secure place. You can use them to access your account if you lose your two-factor authentication method." |
backupCodePlaceholder? | string | "Enter one of your backup codes. Once used, each code can only be used once and will be invalidated after use." |
backupCode? | string | "Backup Code" |
backupCodeAction? | string | "Recover account" |
cancel? | string | "Cancel" |
changePassword? | string | "Change Password" |
changePasswordDescription? | string | "Enter your current password and a new password." |
changePasswordInstructions? | string | "Please use 8 characters at minimum." |
changePasswordSuccess? | string | "Your password has been changed." |
confirmPassword? | string | "Confirm Password" |
confirmPasswordPlaceholder? | string | "Confirm Password" |
confirmPasswordRequired? | string | "Confirm password is required" |
continueWithAuthenticator? | string | "Continue with Authenticator" |
copiedToClipboard? | string | "Copied to clipboard" |
copyAllCodes? | string | "Copy all codes" |
continue? | string | "Continue" |
currentPassword? | string | "Current Password" |
currentPasswordPlaceholder? | string | "Current Password" |
currentSession? | string | "Current Session" |
delete? | string | "Delete" |
deleteAccount? | string | "Delete Account" |
deleteAccountDescription? | string | "Permanently remove your account and all of its contents. This action is not reversible, so please continue with caution." |
deleteAccountInstructions? | string | "Please confirm the deletion of your account. This action is not reversible, so please continue with caution." |
deleteAccountVerify? | string | "Please check your email to verify the deletion of your account." |
deleteAccountSuccess? | string | "Your account has been deleted." |
deleteAccountNotFresh? | string | "You must be recently logged in to delete your account." |
disable? | string | "Disable" |
disabledCredentialsDescription? | string | "Choose a provider to login to your account" |
dontHaveAnAccount? | string | "Don't have an account?" |
email? | string | "Email" |
emailDescription? | string | "Enter the email address you want to use to log in." |
emailInstructions? | string | "Please enter a valid email address." |
emailInvalid? | string | "Email address is invalid" |
emailIsTheSame? | string | "Email is the same" |
emailPlaceholder? | string | "m@example.com" |
emailRequired? | string | "Email address is required" |
emailVerifyChange? | string | "Please check your email to verify the change." |
emailVerification? | string | "Please check your email for the verification link." |
enable? | string | "Enable" |
error? | string | "Error" |
isInvalid? | string | "is invalid" |
isRequired? | string | "is required" |
isTheSame? | string | "is the same" |
forgotAuthenticator? | string | "Forgot authenticator?" |
forgotPassword? | string | "Forgot Password" |
forgotPasswordAction? | string | "Send reset link" |
forgotPasswordDescription? | string | "Enter your email to reset your password" |
forgotPasswordEmail? | string | "Check your email for the password reset link." |
forgotPasswordLink? | string | "Forgot your password?" |
invalidTwoFactorCookie? | string | "Invalid two factor cookie" |
link? | string | "Link" |
magicLink? | string | "Magic Link" |
magicLinkAction? | string | "Send magic link" |
magicLinkDescription? | string | "Enter your email to receive a magic link" |
magicLinkEmail? | string | "Check your email for the magic link" |
name? | string | "Name" |
nameDescription? | string | "Please enter your full name, or a display name." |
nameInstructions? | string | "Please use 32 characters at maximum." |
namePlaceholder? | string | "Name" |
newPassword? | string | "New Password" |
newPasswordPlaceholder? | string | "New Password" |
newPasswordRequired? | string | "New password is required" |
oneTimePassword? | string | "One-Time Password" |
orContinueWith? | string | "Or continue with" |
passkey? | string | "Passkey" |
passkeys? | string | "Passkeys" |
passkeysDescription? | string | "Manage your passkeys for secure access." |
passkeysInstructions? | string | "Securely access your account without a password." |
password? | string | "Password" |
passwordPlaceholder? | string | "Password" |
passwordRequired? | string | "Password is required" |
passwordsDoNotMatch? | string | "Passwords do not match" |
providers? | string | "Providers" |
providersDescription? | string | "Connect your account with a third-party service." |
recoverAccount? | string | "Recover Account" |
recoverAccountAction? | string | "Recover account" |
recoverAccountDescription? | string | "Please enter a backup code to access your account" |
rememberMe? | string | "Remember me" |
resendCode? | string | "Resend code" |
resendVerificationEmail? | string | "Resend verification email" |
resetPassword? | string | "Reset Password" |
resetPasswordAction? | string | "Save new password" |
resetPasswordDescription? | string | "Enter your new password below" |
resetPasswordInvalidToken? | string | "Invalid reset password link" |
resetPasswordSuccess? | string | "Password reset successfully" |
requestFailed? | string | "Request failed" |
revoke? | string | "Revoke" |
signIn? | string | "Sign In" |
signInAction? | string | "Login" |
signInDescription? | string | "Enter your email below to login to your account" |
signInUsernameDescription? | string | "Enter your username or email below to login to your account" |
signInWith? | string | "Sign in with" |
signOut? | string | "Sign Out" |
signUp? | string | "Sign Up" |
signUpAction? | string | "Create an account" |
signUpDescription? | string | "Enter your information to create an account" |
signUpEmail? | string | "Check your email for the verification link." |
sessions? | string | "Sessions" |
sessionsDescription? | string | "Manage your active sessions and revoke access." |
setPassword? | string | "Set Password" |
setPasswordDescription? | string | "Click the button below to receive an email to set up a password for your account." |
settings? | string | "Settings" |
save? | string | "Save" |
security? | string | "Security" |
switchAccount? | string | "Switch Account" |
trustDevice? | string | "Trust this device" |
twoFactor? | string | "Two-Factor" |
twoFactorAction? | string | "Verify code" |
twoFactorDescription? | string | "Please enter your one-time password to continue" |
twoFactorCardDescription? | string | "Add an extra layer of security to your account." |
twoFactorDisableInstructions? | string | "Please enter your password to disable 2FA." |
twoFactorEnableInstructions? | string | "Please enter your password to enable 2FA" |
twoFactorEnabled? | string | "Two-factor authentication has been enabled" |
twoFactorDisabled? | string | "Two-Factor Authentication has been disabled" |
twoFactorPrompt? | string | "Two-Factor Authentication" |
twoFactorTotpLabel? | string | "Scan the QR Code with your Authenticator" |
sendVerificationCode? | string | "Send verification code" |
unlink? | string | "Unlink" |
updatedSuccessfully? | string | "Updated successfully" |
username? | string | "Username" |
usernameDescription? | string | "Enter the username you want to use to log in." |
usernameInstructions? | string | "Please use 32 characters at maximum." |
usernamePlaceholder? | string | "Username" |
signInUsernamePlaceholder? | string | "Username or email" |
verifyYourEmail? | string | "Verify Your Email" |
verifyYourEmailDescription? | string | "Please verify your email address. Check your inbox for the verification email. If you haven't received the email, click the button below to resend." |
goBack? | string | "Go back" |
invalidPassword? | string | "Invalid password" |
passwordTooShort? | string | "Password too short" |