Files
supabase/apps/docs/pages/guides/platform/multi-factor-authentication.mdx
T
Joel Leeandjoel@joellee.org 173d53cf41 update mfa platform docs (#18102)
* docs: update MFA guide

* docs: rephrase

* docs: add all

---------

Co-authored-by: joel@joellee.org <joel@joellee.org>
2023-10-11 19:09:50 +08:00

55 lines
2.5 KiB
Plaintext

import Layout from '~/layouts/DefaultGuideLayout'
import { IconCheck } from 'ui'
export const meta = {
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, please 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.
## 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 a MFA code.
<Admonition type="caution">
We strongly recommend that you do not disable MFA to avoid unauthorized access to your user account.
</Admonition>
export const Page = ({ children }) => <Layout meta={meta} children={children} />
export default Page