BETTER-AUTH. UI
API Reference

AuthLocalization

You can customize the text and messages displayed by the authentication components by providing an AuthLocalization object to the <AuthUIProvider> component.

PropTypeDefault
SLUG_DOES_NOT_MATCH?
string
"The slug does not match"
SLUG_REQUIRED?
string
"Organization slug is required"
DELETE_ORGANIZATION_INSTRUCTIONS?
string
"Enter the organization slug to continue:"
DELETE_ORGANIZATION_SUCCESS?
string
"Organization deleted successfully"
DELETE_ORGANIZATION_DESCRIPTION?
string
"Permanently remove your organization and all of its contents. This action is not reversible — please continue with caution."
DELETE_ORGANIZATION?
string
"Delete Organization"
INVITATION_EXPIRED?
string
"This invitation has expired"
REJECT?
string
"Reject"
ACCEPT?
string
"Accept"
INVITATION_REJECTED?
string
"Invitation rejected successfully"
INVITATION_ACCEPTED?
string
"Invitation accepted successfully"
ACCEPT_INVITATION_DESCRIPTION?
string
"You have been invited to join an organization."
ACCEPT_INVITATION?
string
"Accept Invitation"
INVITATION_CANCELLED?
string
"Invitation cancelled successfully"
CANCEL_INVITATION?
string
"Cancel Invitation"
PENDING_INVITATIONS_DESCRIPTION?
string
"Manage pending invitations to your organization."
PENDING_INVITATIONS?
string
"Pending Invitations"
SEND_INVITATION_SUCCESS?
string
"Invitation sent successfully"
SEND_INVITATION?
string
"Send Invitation"
MEMBER_ROLE_UPDATED?
string
"Member role updated successfully"
UPDATE_ROLE?
string
"Update Role"
UPDATE_ROLE_DESCRIPTION?
string
"Update the role for this member"
OWNER?
string
"Owner"
GUEST?
string
"Guest"
MEMBER?
string
"Member"
ADMIN?
string
"Admin"
SELECT_ROLE?
string
"Select a role"
ROLE?
string
"Role"
INVITE_MEMBER_DESCRIPTION?
string
"Send an invitation to add a new member to your organization."
MEMBERS_INSTRUCTIONS?
string
"Invite new members to your organization."
MEMBERS_DESCRIPTION?
string
"Add or remove members and manage their roles."
MEMBERS?
string
"Members"
INVITE_MEMBER?
string
"Invite Member"
REMOVE_MEMBER_SUCCESS?
string
"Member removed successfully"
REMOVE_MEMBER_CONFIRM?
string
"Are you sure you want to remove this member from the organization?"
REMOVE_MEMBER?
string
"Remove Member"
MANAGE_ORGANIZATION?
string
"Manage Organization"
LEAVE_ORGANIZATION_SUCCESS?
string
"You have successfully left the organization."
LEAVE_ORGANIZATION_CONFIRM?
string
"Are you sure you want to leave this organization?"
LEAVE_ORGANIZATION?
string
"Leave Organization"
ORGANIZATIONS_INSTRUCTIONS?
string
"Create an organization to collaborate with other users."
ORGANIZATIONS_DESCRIPTION?
string
"Manage your organizations and memberships."
ORGANIZATIONS?
string
"Organizations"
USER?
string
"User"
BY_CONTINUING_YOU_AGREE?
string
"By continuing, you agree to the"
PROTECTED_BY_RECAPTCHA?
string
"This site is protected by reCAPTCHA."
TERMS_OF_SERVICE?
string
"Terms of Service"
PRIVACY_POLICY?
string
"Privacy Policy"
DELETE_LOGO?
string
"Delete Logo"
UPLOAD_LOGO?
string
"Upload Logo"
UPLOAD?
string
"Upload"
LOGO_INSTRUCTIONS?
string
"A logo is optional but strongly recommended."
LOGO_DESCRIPTION?
string
"Click on the logo to upload a custom one from your files."
LOGO?
string
"Logo"
UPLOAD_AVATAR?
string
"Upload Avatar"
SESSION_NOT_FRESH?
string
"Your session is not fresh. Please sign in again."
GO_BACK?
string
"Go back"
VERIFY_YOUR_EMAIL_DESCRIPTION?
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."
VERIFY_YOUR_EMAIL?
string
"Verify Your Email"
SIGN_IN_USERNAME_PLACEHOLDER?
string
"Username or email"
USERNAME_PLACEHOLDER?
string
"Username"
USERNAME_INSTRUCTIONS?
string
"Please use 32 characters at maximum."
USERNAME_DESCRIPTION?
string
"Enter the username you want to use to log in."
USERNAME?
string
"Username"
UPDATED_SUCCESSFULLY?
string
"Updated successfully"
UNLINK?
string
"Unlink"
SEND_VERIFICATION_CODE?
string
"Send verification code"
TWO_FACTOR_TOTP_LABEL?
string
"Scan the QR Code with your Authenticator"
TWO_FACTOR_PROMPT?
string
"Two-Factor Authentication"
TWO_FACTOR_DISABLED?
string
"Two-Factor Authentication has been disabled"
TWO_FACTOR_ENABLED?
string
"Two-factor authentication has been enabled"
TWO_FACTOR_ENABLE_INSTRUCTIONS?
string
"Please enter your password to enable 2FA"
TWO_FACTOR_DISABLE_INSTRUCTIONS?
string
"Please enter your password to disable 2FA."
TWO_FACTOR_CARD_DESCRIPTION?
string
"Add an extra layer of security to your account."
TWO_FACTOR_DESCRIPTION?
string
"Please enter your one-time password to continue"
TWO_FACTOR_ACTION?
string
"Verify code"
TWO_FACTOR?
string
"Two-Factor"
TRUST_DEVICE?
string
"Trust this device"
SWITCH_ACCOUNT?
string
"Switch Account"
SECURITY?
string
"Security"
SAVE?
string
"Save"
SETTINGS?
string
"Settings"
SET_PASSWORD_DESCRIPTION?
string
"Click the button below to receive an email to set up a password for your account."
SET_PASSWORD?
string
"Set Password"
SESSIONS_DESCRIPTION?
string
"Manage your active sessions and revoke access."
SESSIONS?
string
"Sessions"
SIGN_UP_EMAIL?
string
"Check your email for the verification link."
SIGN_UP_DESCRIPTION?
string
"Enter your information to create an account"
SIGN_UP_ACTION?
string
"Create an account"
SIGN_UP?
string
"Sign Up"
SIGN_OUT?
string
"Sign Out"
SIGN_IN_WITH?
string
"Sign in with"
SIGN_IN_USERNAME_DESCRIPTION?
string
"Enter your username or email below to login to your account"
SIGN_IN_DESCRIPTION?
string
"Enter your email below to login to your account"
SIGN_IN_ACTION?
string
"Login"
SIGN_IN?
string
"Sign In"
API_KEY?
string
"API Key"
DELETE_API_KEY_CONFIRM?
string
"Are you sure you want to delete this API key?"
DELETE_API_KEY?
string
"Delete API Key"
REVOKE?
string
"Revoke"
REQUEST_FAILED?
string
"Request failed"
RESET_PASSWORD_SUCCESS?
string
"Password reset successfully"
RESET_PASSWORD_DESCRIPTION?
string
"Enter your new password below"
RESET_PASSWORD_ACTION?
string
"Save new password"
RESET_PASSWORD?
string
"Reset Password"
RESEND_VERIFICATION_EMAIL?
string
"Resend verification email"
RESEND_CODE?
string
"Resend code"
REMEMBER_ME?
string
"Remember me"
RECOVER_ACCOUNT_DESCRIPTION?
string
"Please enter a backup code to access your account"
RECOVER_ACCOUNT_ACTION?
string
"Recover account"
RECOVER_ACCOUNT?
string
"Recover Account"
PROVIDERS_DESCRIPTION?
string
"Connect your account with a third-party service."
PROVIDERS?
string
"Providers"
PASSWORDS_DO_NOT_MATCH?
string
"Passwords do not match"
PASSWORD_REQUIRED?
string
"Password is required"
PASSWORD_PLACEHOLDER?
string
"Password"
PASSWORD?
string
"Password"
CREATE_ORGANIZATION_SUCCESS?
string
"Organization created successfully"
ORGANIZATION_SLUG_PLACEHOLDER?
string
"acme-inc"
ORGANIZATION_SLUG_INSTRUCTIONS?
string
"Please use 48 characters at maximum."
ORGANIZATION_SLUG_DESCRIPTION?
string
"This is your organization's URL namespace."
ORGANIZATION_SLUG?
string
"Slug URL"
ORGANIZATION_NAME_INSTRUCTIONS?
string
"Please use 32 characters at maximum."
ORGANIZATION_NAME_DESCRIPTION?
string
"This is your organization's visible name."
ORGANIZATION_NAME_PLACEHOLDER?
string
"Acme Inc."
ORGANIZATION_NAME?
string
"Name"
ORGANIZATION?
string
"Organization"
CREATE_ORGANIZATION?
string
"Create Organization"
NO_EXPIRATION?
string
"No Expiration"
EXPIRES?
string
"Expires"
NEVER_EXPIRES?
string
"Never Expires"
CREATE_API_KEY_SUCCESS?
string
"Please copy your API key and store it in a safe place. For security reasons we cannot show it again."
API_KEY_CREATED?
string
"API Key Created"
API_KEY_NAME_PLACEHOLDER?
string
"New API Key"
CREATE_API_KEY_DESCRIPTION?
string
"Enter a unique name for your API key to differentiate it from other keys."
CREATE_API_KEY?
string
"Create API Key"
API_KEYS_INSTRUCTIONS?
string
"Generate API keys to access your account programmatically."
API_KEYS_DESCRIPTION?
string
"Manage your API keys for secure access."
API_KEYS?
string
"API Keys"
PERSONAL_ACCOUNT?
string
"Personal Account"
PASSKEYS_INSTRUCTIONS?
string
"Securely access your account without a password."
PASSKEYS_DESCRIPTION?
string
"Manage your passkeys for secure access."
PASSKEYS?
string
"Passkeys"
PASSKEY?
string
"Passkey"
OR_CONTINUE_WITH?
string
"Or continue with"
ONE_TIME_PASSWORD?
string
"One-Time Password"
NEW_PASSWORD_REQUIRED?
string
"New password is required"
NEW_PASSWORD_PLACEHOLDER?
string
"New Password"
NEW_PASSWORD?
string
"New Password"
NAME_PLACEHOLDER?
string
"Name"
NAME_INSTRUCTIONS?
string
"Please use 32 characters at maximum."
NAME_DESCRIPTION?
string
"Please enter your full name, or a display name."
NAME?
string
"Name"
EMAIL_OTP_VERIFICATION_SENT?
string
"Please check your email for the verification code."
EMAIL_OTP_DESCRIPTION?
string
"Enter your email to receive a code"
EMAIL_OTP_VERIFY_ACTION?
string
"Verify code"
EMAIL_OTP_SEND_ACTION?
string
"Send code"
EMAIL_OTP?
string
"Email Code"
MAGIC_LINK_EMAIL?
string
"Check your email for the magic link"
MAGIC_LINK_DESCRIPTION?
string
"Enter your email to receive a magic link"
MAGIC_LINK_ACTION?
string
"Send magic link"
MAGIC_LINK?
string
"Magic Link"
LINK?
string
"Link"
FORGOT_PASSWORD_LINK?
string
"Forgot your password?"
FORGOT_PASSWORD_EMAIL?
string
"Check your email for the password reset link."
FORGOT_PASSWORD_DESCRIPTION?
string
"Enter your email to reset your password"
FORGOT_PASSWORD_ACTION?
string
"Send reset link"
FORGOT_PASSWORD?
string
"Forgot Password"
FORGOT_AUTHENTICATOR?
string
"Forgot authenticator?"
IS_THE_SAME?
string
"is the same"
IS_REQUIRED?
string
"is required"
IS_INVALID?
string
"is invalid"
ENABLE_TWO_FACTOR?
string
"Enable Two-Factor"
EMAIL_VERIFICATION?
string
"Please check your email for the verification link."
EMAIL_VERIFY_CHANGE?
string
"Please check your email to verify the change."
EMAIL_REQUIRED?
string
"Email address is required"
EMAIL_PLACEHOLDER?
string
"m@example.com"
EMAIL_IS_THE_SAME?
string
"Email is the same"
EMAIL_INSTRUCTIONS?
string
"Please enter a valid email address."
EMAIL_DESCRIPTION?
string
"Enter the email address you want to use to log in."
EMAIL?
string
"Email"
DONE?
string
"Done"
DONT_HAVE_AN_ACCOUNT?
string
"Don't have an account?"
DISABLED_CREDENTIALS_DESCRIPTION?
string
"Choose a provider to login to your account"
DISABLE_TWO_FACTOR?
string
"Disable Two-Factor"
DELETE_ACCOUNT_SUCCESS?
string
"Your account has been deleted."
DELETE_ACCOUNT_VERIFY?
string
"Please check your email to verify the deletion of your account."
DELETE_ACCOUNT_INSTRUCTIONS?
string
"Please confirm the deletion of your account. This action is not reversible, so please continue with caution."
DELETE_ACCOUNT_DESCRIPTION?
string
"Permanently remove your account and all of its contents. This action is not reversible, so please continue with caution."
DELETE_ACCOUNT?
string
"Delete Account"
DELETE_AVATAR?
string
"Delete Avatar"
DELETE?
string
"Delete"
CURRENT_SESSION?
string
"Current Session"
CURRENT_PASSWORD_PLACEHOLDER?
string
"Current Password"
CURRENT_PASSWORD?
string
"Current Password"
CONTINUE?
string
"Continue"
COPY_ALL_CODES?
string
"Copy all codes"
COPY_TO_CLIPBOARD?
string
"Copy to clipboard"
COPIED_TO_CLIPBOARD?
string
"Copied to clipboard"
CONTINUE_WITH_AUTHENTICATOR?
string
"Continue with Authenticator"
CONFIRM_PASSWORD_REQUIRED?
string
"Confirm password is required"
CONFIRM_PASSWORD_PLACEHOLDER?
string
"Confirm Password"
CONFIRM_PASSWORD?
string
"Confirm Password"
CHANGE_PASSWORD_SUCCESS?
string
"Your password has been changed."
CHANGE_PASSWORD_INSTRUCTIONS?
string
"Please use 8 characters at minimum."
CHANGE_PASSWORD_DESCRIPTION?
string
"Enter your current password and a new password."
CHANGE_PASSWORD?
string
"Change Password"
CANCEL?
string
"Cancel"
BACKUP_CODE?
string
"Backup Code"
BACKUP_CODE_PLACEHOLDER?
string
"Backup Code."
BACKUP_CODES_DESCRIPTION?
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."
BACKUP_CODES?
string
"Backup Codes"
BACKUP_CODE_REQUIRED?
string
"Backup code is required"
AVATAR_INSTRUCTIONS?
string
"An avatar is optional but strongly recommended."
AVATAR_DESCRIPTION?
string
"Click on the avatar to upload a custom one from your files."
AVATAR?
string
"Avatar"
ALREADY_HAVE_AN_ACCOUNT?
string
"Already have an account?"
ADD_PASSKEY?
string
"Add Passkey"
ADD_ACCOUNT?
string
"Add Account"
ACCOUNTS_INSTRUCTIONS?
string
"Sign in to an additional account."
ACCOUNTS_DESCRIPTION?
string
"Manage your currently signed in accounts."
ACCOUNTS?
string
"Accounts"
ACCOUNT?
string
"Account"
USER_ALREADY_HAS_PASSWORD?
string
-
ACCOUNT_NOT_FOUND?
string
-
FAILED_TO_UNLINK_LAST_ACCOUNT?
string
-
SESSION_EXPIRED?
string
-
CREDENTIAL_ACCOUNT_NOT_FOUND?
string
-
EMAIL_CAN_NOT_BE_UPDATED?
string
-
PASSWORD_TOO_LONG?
string
-
PASSWORD_TOO_SHORT?
string
-
USER_EMAIL_NOT_FOUND?
string
-
FAILED_TO_GET_USER_INFO?
string
-
ID_TOKEN_NOT_SUPPORTED?
string
-
INVALID_TOKEN?
string
-
PROVIDER_NOT_FOUND?
string
-
SOCIAL_ACCOUNT_ALREADY_LINKED?
string
-
INVALID_EMAIL_OR_PASSWORD?
string
-
INVALID_PASSWORD?
string
-
FAILED_TO_GET_SESSION?
string
-
FAILED_TO_UPDATE_USER?
string
-
FAILED_TO_CREATE_SESSION?
string
-
BANNED_USER?
string
-
YOU_ARE_NOT_ALLOWED_TO_SET_USERS_PASSWORD?
string
-
YOU_ARE_NOT_ALLOWED_TO_DELETE_USERS?
string
-
YOU_ARE_NOT_ALLOWED_TO_REVOKE_USERS_SESSIONS?
string
-
YOU_ARE_NOT_ALLOWED_TO_IMPERSONATE_USERS?
string
-
YOU_ARE_NOT_ALLOWED_TO_BAN_USERS?
string
-
YOU_ARE_NOT_ALLOWED_TO_LIST_USERS_SESSIONS?
string
-
YOU_ARE_NOT_ALLOWED_TO_LIST_USERS?
string
-
YOU_ARE_NOT_ALLOWED_TO_CREATE_USERS?
string
-
YOU_ARE_NOT_ALLOWED_TO_CHANGE_USERS_ROLE?
string
-
YOU_CANNOT_BAN_YOURSELF?
string
-
USER_ALREADY_EXISTS?
string
-
ANONYMOUS_USERS_CANNOT_SIGN_IN_AGAIN_ANONYMOUSLY?
string
-
COULD_NOT_CREATE_SESSION?
string
-
FAILED_TO_CREATE_USER?
string
-
SERVER_ONLY_PROPERTY?
string
-
INVALID_API_KEY_GETTER_RETURN_TYPE?
string
-
INVALID_USER_ID_FROM_API_KEY?
string
-
INVALID_API_KEY?
string
-
KEY_DISABLED_EXPIRATION?
string
-
NO_VALUES_TO_UPDATE?
string
-
RATE_LIMIT_EXCEEDED?
string
-
METADATA_DISABLED?
string
-
INVALID_NAME_LENGTH?
string
-
INVALID_PREFIX_LENGTH?
string
-
INVALID_REMAINING?
string
-
EXPIRES_IN_IS_TOO_LARGE?
string
-
EXPIRES_IN_IS_TOO_SMALL?
string
-
KEY_NOT_RECOVERABLE?
string
-
USAGE_EXCEEDED?
string
-
KEY_EXPIRED?
string
-
KEY_DISABLED?
string
-
KEY_NOT_FOUND?
string
-
UNAUTHORIZED_SESSION?
string
-
USER_BANNED?
string
-
REFILL_INTERVAL_AND_AMOUNT_REQUIRED?
string
-
REFILL_AMOUNT_AND_INTERVAL_REQUIRED?
string
-
INVALID_METADATA_TYPE?
string
-
UNKNOWN_ERROR?
string
-
MISSING_RESPONSE?
string
-
VERIFICATION_FAILED?
string
-
SERVICE_UNAVAILABLE?
string
-
MISSING_SECRET_KEY?
string
-
TOO_MANY_ATTEMPTS?
string
-
USER_NOT_FOUND?
string
-
INVALID_EMAIL?
string
-
INVALID_OAUTH_CONFIGURATION?
string
-
PASSWORD_COMPROMISED?
string
-
INVALID_SESSION_TOKEN?
string
-
INVITATION_LIMIT_REACHED?
string
-
YOU_ARE_NOT_ALLOWED_TO_DELETE_THIS_TEAM?
string
-
YOU_ARE_NOT_ALLOWED_TO_UPDATE_THIS_TEAM?
string
-
YOU_ARE_NOT_ALLOWED_TO_DELETE_TEAMS_IN_THIS_ORGANIZATION?
string
-
YOU_ARE_NOT_ALLOWED_TO_CREATE_TEAMS_IN_THIS_ORGANIZATION?
string
-
ORGANIZATION_MEMBERSHIP_LIMIT_REACHED?
string
-
YOU_ARE_NOT_ALLOWED_TO_UPDATE_THIS_MEMBER?
string
-
UNABLE_TO_REMOVE_LAST_TEAM?
string
-
YOU_HAVE_REACHED_THE_MAXIMUM_NUMBER_OF_TEAMS?
string
-
FAILED_TO_RETRIEVE_INVITATION?
string
-
YOU_ARE_NOT_ALLOWED_TO_INVITE_USER_WITH_THIS_ROLE?
string
-
INVITER_IS_NO_LONGER_A_MEMBER_OF_THE_ORGANIZATION?
string
-
YOU_ARE_NOT_ALLOWED_TO_CANCEL_THIS_INVITATION?
string
-
YOU_ARE_NOT_THE_RECIPIENT_OF_THE_INVITATION?
string
-
INVITATION_NOT_FOUND?
string
-
USER_IS_ALREADY_INVITED_TO_THIS_ORGANIZATION?
string
-
YOU_ARE_NOT_ALLOWED_TO_INVITE_USERS_TO_THIS_ORGANIZATION?
string
-
YOU_ARE_NOT_ALLOWED_TO_DELETE_THIS_MEMBER?
string
-
YOU_CANNOT_LEAVE_THE_ORGANIZATION_AS_THE_ONLY_OWNER?
string
-
TEAM_NOT_FOUND?
string
-
TEAM_ALREADY_EXISTS?
string
-
YOU_ARE_NOT_ALLOWED_TO_CREATE_A_NEW_TEAM?
string
-
ROLE_NOT_FOUND?
string
-
MEMBER_NOT_FOUND?
string
-
USER_IS_ALREADY_A_MEMBER_OF_THIS_ORGANIZATION?
string
-
NO_ACTIVE_ORGANIZATION?
string
-
YOU_ARE_NOT_ALLOWED_TO_DELETE_THIS_ORGANIZATION?
string
-
YOU_ARE_NOT_ALLOWED_TO_UPDATE_THIS_ORGANIZATION?
string
-
USER_IS_NOT_A_MEMBER_OF_THE_ORGANIZATION?
string
-
ORGANIZATION_NOT_FOUND?
string
-
ORGANIZATION_ALREADY_EXISTS?
string
-
YOU_HAVE_REACHED_THE_MAXIMUM_NUMBER_OF_ORGANIZATIONS?
string
-
YOU_ARE_NOT_ALLOWED_TO_CREATE_A_NEW_ORGANIZATION?
string
-
FAILED_TO_UPDATE_PASSKEY?
string
-
UNABLE_TO_CREATE_SESSION?
string
-
AUTHENTICATION_FAILED?
string
-
PASSKEY_NOT_FOUND?
string
-
FAILED_TO_VERIFY_REGISTRATION?
string
-
YOU_ARE_NOT_ALLOWED_TO_REGISTER_THIS_PASSKEY?
string
-
CHALLENGE_NOT_FOUND?
string
-
PHONE_NUMBER_NOT_VERIFIED?
string
-
INVALID_OTP?
string
-
OTP_EXPIRED?
string
-
OTP_NOT_FOUND?
string
-
INVALID_PHONE_NUMBER_OR_PASSWORD?
string
-
PHONE_NUMBER_EXIST?
string
-
INVALID_PHONE_NUMBER?
string
-
SUBSCRIPTION_NOT_SCHEDULED_FOR_CANCELLATION?
string
-
SUBSCRIPTION_NOT_ACTIVE?
string
-
EMAIL_VERIFICATION_REQUIRED?
string
-
FAILED_TO_FETCH_PLANS?
string
-
UNABLE_TO_CREATE_CUSTOMER?
string
-
ALREADY_SUBSCRIBED_PLAN?
string
-
SUBSCRIPTION_PLAN_NOT_FOUND?
string
-
SUBSCRIPTION_NOT_FOUND?
string
-
INVALID_TWO_FACTOR_COOKIE?
string
-
TOO_MANY_ATTEMPTS_REQUEST_NEW_CODE?
string
-
INVALID_CODE?
string
-
INVALID_BACKUP_CODE?
string
-
BACKUP_CODES_NOT_ENABLED?
string
-
TWO_FACTOR_NOT_ENABLED?
string
-
TOTP_NOT_ENABLED?
string
-
OTP_HAS_EXPIRED?
string
-
OTP_NOT_ENABLED?
string
-
INVALID_USERNAME?
string
-
USERNAME_TOO_LONG?
string
-
USERNAME_TOO_SHORT?
string
-
USERNAME_IS_ALREADY_TAKEN?
string
-
UNEXPECTED_ERROR?
string
-
EMAIL_NOT_VERIFIED?
string
-
INVALID_USERNAME_OR_PASSWORD?
string
-