mirror of
https://github.com/supabase/supabase.git
synced 2026-05-07 01:10:15 -04:00
Yogeshwaran C
f829c31990
## What kind of change does this PR introduce? Documentation / text fix (grammar) ## What is the current behavior? Several places in the codebase use "a" before acronyms that start with vowel sounds, which is grammatically incorrect: - "enter a MFA code" (MFA is pronounced "em-eff-ay", starting with a vowel sound) - "a SMS with a OTP" (SMS = "ess-em-ess", OTP = "oh-tee-pee") ## What is the new behavior? Corrected to use "an" before acronyms with vowel sounds: - "enter an MFA code" - "an SMS with an OTP" ## Files changed - `apps/studio/data/profile/mfa-challenge-and-verify-mutation.ts` - comment fix - `apps/docs/content/guides/platform/multi-factor-authentication.mdx` - user-facing docs - `apps/docs/docs/ref/javascript/v1/upgrade-guide.mdx` - code comment in example - `apps/docs/docs/ref/dart/v0/upgrade-guide.mdx` - code comment in example ## Additional context The rule: use "an" before acronyms pronounced with an initial vowel sound, regardless of the first letter. "MFA" starts with "em" (vowel sound), "SMS" starts with "ess" (vowel sound), "OTP" starts with "oh" (vowel sound).
50 lines
2.4 KiB
Plaintext
50 lines
2.4 KiB
Plaintext
---
|
|
title: 'Multi-factor Authentication'
|
|
description: 'Enable multi-factor authentication (MFA) to keep your account secure.'
|
|
subtitle: 'Enable multi-factor authentication (MFA) to keep your account secure.'
|
|
---
|
|
|
|
<Admonition type="note">
|
|
|
|
This guide is for adding MFA to your Supabase user account. If you want to enable MFA for users in your Supabase project, refer to [**this guide**](/docs/guides/auth/auth-mfa) instead.
|
|
|
|
</Admonition>
|
|
|
|
Multi-factor authentication (MFA) adds an additional layer of security to your user account, by requiring a second factor to verify your user identity. Supabase allows users to enable MFA on their account and set it as a requirement for subsequent logins.
|
|
|
|
## Supported authentication factors
|
|
|
|
Currently, Supabase supports adding a unique time-based one-time password (TOTP) to your user account as an additional security factor. You can manage your TOTP factor using apps such as 1Password, Authy, Google Authenticator or Apple's Keychain.
|
|
|
|
## Enable MFA
|
|
|
|
You can enable MFA for your user account under your [Supabase account settings](/dashboard/account/security). Enabling MFA will result in all other user sessions to be automatically logged out and forced to sign-in again with MFA.
|
|
|
|
<Admonition type="note">
|
|
|
|
Supabase does not return recovery codes. Instead, we recommend that you register a backup TOTP factor to use in an event that you lose access to your primary TOTP factor. Make sure you use a different device and app, or store the secret in a secure location different than your primary one.
|
|
|
|
</Admonition>
|
|
|
|
<Admonition type="caution">
|
|
|
|
For security reasons, we will not be able to restore access to your account if you lose all your two-factor authentication credentials. Do register a backup factor if necessary.
|
|
|
|
</Admonition>
|
|
|
|
## Login with MFA
|
|
|
|
Once you've enabled MFA for your Supabase user account, you will be prompted to enter your second factor challenge code as seen in your preferred TOTP app.
|
|
|
|
If you are an organization owner and on the Pro, Team or Enterprise plan, you can enforce that all organization members [must have MFA enabled](/docs/guides/platform/mfa/org-mfa-enforcement).
|
|
|
|
## Disable MFA
|
|
|
|
You can disable MFA for your user account under your [Supabase account settings](/dashboard/account/security). On subsequent login attempts, you will not be prompted to enter an MFA code.
|
|
|
|
<Admonition type="caution">
|
|
|
|
We strongly recommend that you do not disable MFA to avoid unauthorized access to your user account.
|
|
|
|
</Admonition>
|