Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

docs: 2FA v2 (#81962)

Michael Eby94aea9ae2499
diff --git a/docs/people-and-groups/account-settings.md b/docs/people-and-groups/account-settings.md
index c54c8754448..83556f84163 100644
--- a/docs/people-and-groups/account-settings.md
+++ b/docs/people-and-groups/account-settings.md
@@ -45,6 +45,8 @@ If your admin has turned on [two-factor authentication](./two-factor-authenticat
6. Enter the six-digit code from the app.
7. Save your recovery codes. Metabase shows these ten codes only once, so copy them and store them somewhere safe. Each recovery code only works once. If you [regenerate recovery codes](#regenerate-recovery-codes), the old codes will no longer work.
+If your admin requires 2FA, Metabase prompts you to set up 2FA the next time you log in.
+
### Logging in with two-factor authentication
Once you set up two-factor authentication, Metabase will ask for a code every time you log in. After you enter your email and password:
@@ -61,6 +63,8 @@ Recovery codes are single-use, so it's worth generating a fresh set if you're ru
In your account settings, on the **Authentication** tab, click **Disable**. Your account will be protected by your password only, and your recovery codes will stop working.
+If your admin requires 2FA, you can't disable it.
+
## Account login history
The login history lists each login, along with some location information (if available), and some client information (like Browser (Firefox/Windows)). If you see any suspicious login attempts, change your password and notify your administrator.
diff --git a/docs/people-and-groups/two-factor-authentication.md b/docs/people-and-groups/two-factor-authentication.md
index d77fe8ed82c..b85f2c24c53 100644
--- a/docs/people-and-groups/two-factor-authentication.md
+++ b/docs/people-and-groups/two-factor-authentication.md
@@ -13,14 +13,21 @@ Metabase's native 2FA applies to password logins and LDAP logins. 2FA for Single
## Turn on two-factor authentication
-An admin can turn 2FA on for your Metabase:
+To enable two-factor authentication:
-1. Go to **Admin settings** > **Settings** > **Authentication**.
-2. Find the **Two-factor authentication** card.
-3. Toggle it to **Enabled**.
- Once enabled, a **Two-factor authentication** section shows up in each person's account settings under the **Authentication** tab, where they can enroll in 2FA.
+1. Go to **Admin** > **Settings** > **Authentication** > **Overview**.
+2. Scroll to the **Two-factor authentication** card.
+3. Enable the **Allow two-factor authentication** toggle. Once enabled, people who log in with a password or LDAP can enroll in 2FA from the **Authentication** tab in their account settings.
+4. In **Require two-factor authentication**, select an option. You must set up 2FA for your own account before you can require it.
+ - **Don't require**: People can enroll in 2FA, but they don't have to. This is the default.
+ - **Require now**: Metabase logs out everyone who hasn't logged in with 2FA. Anyone who hasn't enrolled sets up 2FA at their next login.
+ - **Require by a certain date**: Under **Enrollment deadline**, select a date. When the deadline passes, 2FA is required for everyone and Metabase logs out anyone who hasn't logged in with 2FA.
-If you configure Metabase through environment variables or a [config file](../configuring-metabase/config-file.md), the matching setting is [`MB_MFA_ENFORCEMENT`](../configuring-metabase/environment-variables.md#mb_mfa_enforcement). Set `MB_MFA_ENFORCEMENT` to `optional` to let people enroll, or `off` to turn 2FA off.
+Requiring 2FA doesn't affect API keys.
+
+If you configure Metabase through environment variables or a [config file](../configuring-metabase/config-file.md), the matching setting is [`MB_MFA_ENFORCEMENT`](../configuring-metabase/environment-variables.md#mb_mfa_enforcement). Set `MB_MFA_ENFORCEMENT` to `optional` to let people enroll, `required` to make enrollment mandatory, or `off` to turn 2FA off.
+
+To set the enrollment deadline, use [`MB_MFA_REQUIREMENT_DEADLINE`](../configuring-metabase/environment-variables.md#mb_mfa_requirement_deadline).
## Supported methods
@@ -44,7 +51,7 @@ Metabase requires people to use an email address as a login, but that doesn't me
## See who's enrolled
-When 2FA is on, go to **Admin settings** > **Settings** > **Authentication** > **Two-factor authentication**. The 2FA card shows how many people have enrolled in 2FA and how many haven't.
+When 2FA is on, go to **Admin** > **Settings** > **Authentication** > **Overview** and scroll to the **Two-factor authentication** card. The card shows how many people have enrolled in 2FA and how many haven't. Click a count to see the list of people.
## Further reading