diff --git a/use-timescale/page-index/page-index.js b/use-timescale/page-index/page-index.js index af995e7a77..5e83b71e3d 100644 --- a/use-timescale/page-index/page-index.js +++ b/use-timescale/page-index/page-index.js @@ -846,7 +846,7 @@ module.exports = [ excerpt: "SAML / SSO authentication for your Timescale account", }, { - title: "Multi-factor Authentication", + title: "Multi-factor authentication", href: "multi-factor-authentication", excerpt: "Multi-factor authentication for your Timescale account", }, diff --git a/use-timescale/security/multi-factor-authentication.md b/use-timescale/security/multi-factor-authentication.md index 6075e1b095..42b46f78e3 100644 --- a/use-timescale/security/multi-factor-authentication.md +++ b/use-timescale/security/multi-factor-authentication.md @@ -8,38 +8,36 @@ tags: [two-factor user authentication] # Multi-factor user authentication -You can use two-factor authentication to log in to your Timescale account. -Two-factor authentication, also known as two-step verification or 2FA, enables -secure logins that requires an authentication code in addition to your user -password. The code is provided by an app on your mobile device, such as Google -Authenticator. +You can use two-factor authentication to log in to your $COMPANY account. Two-factor authentication, also known as two-step verification or 2FA, enables +secure logins that require an authentication code in addition to your user +password. The code is provided by an authenticator app on your mobile device. There are multiple authenticator apps available. -## Configure two-factor authentication with Google Authenticator +![Timescale Console 2FA](https://assets.timescale.com/docs/images/timescale-console-2fa.png) + +This page describes how to configure two-factor authentication with Google Authenticator. -Google Authenticator is a useful app for keeping track of your two-factor -authentication keys. However, there are other authenticators available to suit -your needs. +## Prerequisites Before you begin, make sure you have: * Installed the [Google Authenticator application][install-google-authenticator] - on your mobile device. + on your mobile device. - +## Configure two-factor authentication with Google Authenticator -### Configuring two-factor authentication with Google Authenticator +Take the following steps to configure two-factor authentication: -1. [Log in to your Timescale account][cloud-login]. -1. Click the `User name` icon in the top-right of the console and select `Account`. -1. In the `Account` page, click `Add two-factor authentication`. + + +1. Log in to [$CONSOLE][cloud-login]. +1. Click the `User name` icon in the bottom left of $CONSOLE and select `Account`. +1. In `Account`, click `Add two-factor authentication`. 1. On your mobile device, open Google Authenticator, tap `+`, and select `Scan a QR code`. -1. On your mobile device, scan the QR code provided by Timescale in the - `Connect to an authenticator app` dialog and click `Next`. -1. In the dashboard, type the verification code provided by Google - Authenticator, and click `Next`. -1. In the `Save your recovery codes` dialog, copy, download, or print the - recovery codes, and save them in a safe place. These are used to recover +1. Scan the QR code provided by $CONSOLE in `Connect to an authenticator app` and click `Next`. +1. In $CONSOLE, enter the verification code provided by Google Authenticator, and click `Next`. +1. In `Save your recovery codes`, copy, download, or print the + recovery codes. These are used to recover your account if you lose your device. 1. Verify that you have saved your recovery codes, by clicking `OK, I saved my recovery codes`. @@ -48,37 +46,32 @@ Before you begin, make sure you have: - + If you lose access to the mobile device you use for multi-factor authentication, and you do not have access to your recovery codes, you cannot sign in to your -Timescale account. To regain access to your account +$COMPANY account. To regain access to your account, contact [support@timescale.com](mailto:support@timescale.com). ## Regenerate recovery codes If you do not have access to your authenticator app and need to log in to -Timescale you can use your recovery codes. After you use a recovery code -to regain access to your account, it cannot be reused. If you've used all 10 -recovery codes, you can generate another list of codes. Generating a new set of -recovery codes invalidates all previously generated codes. You can also -regenerate your codes if you lose access to your previous codes. +$CONSOLE, you can use your recovery codes. Recovery codes are single-use. If you've used all 10 +recovery codes, or lost access to them, you can generate another list. Generating a new list invalidates all previously generated codes. -### Regenerating recovery codes - -1. [Log in to your Timescale account][cloud-login]. -1. Click the `User name` icon in the top-right of the console and select `Account`. -1. In the `Account` page, navigate to the `Two-factor authentication` section. +1. Log in to [$CONSOLE][cloud-login]. +1. Click the `User name` icon in the bottom left and select `Account`. +1. In `Account`, navigate to `Two-factor authentication`. 1. Click `Regenerate recovery codes`. -1. In the `Two-factor authentication` dialog, type the verification code from - your authenticator application. - Alternatively, if you do not have access to the authenticator application, - click `Use recovery code instead` to type the recovery code. +1. In `Two-factor authentication`, enter the verification code from + your authenticator app. + Alternatively, if you do not have access to the authenticator app, + click `Use recovery code instead` to enter a recovery code. 1. Click `Next`. -1. In the `Save your recovery codes` dialog, copy, download, or print the - recovery codes, and save them in a safe place. These are used to recover +1. In `Save your recovery codes`, copy, download, or print the + recovery codes. These are used to recover your account if you lose your device. 1. Verify that you have saved your recovery codes, by clicking `OK, I saved my recovery codes`. @@ -92,15 +85,11 @@ again with your new device. -### Removing two-factor authentication - -1. [Log in to your Timescale account][cloud-login]. -1. Click the `User name` icon in the top-right of the console and select `Account`. -1. In the `Account` page, navigate to the `Two-factor authentication` section. +1. Log in to [$CONSOLE][cloud-login]. +1. Click the `User name` icon in the bottom left of $CONSOLE and select `Account`. +1. In `Account`, navigate to `Two-factor authentication`. 1. Click `Remove two-factor authentication`. -1. In the `Are you sure` dialog, type the verification code from your - authenticator application. Alternatively, if you do not have access to the - authenticator application, click `Use recovery code instead` to type the +1. Enter the verification code from your authenticator app to confirm. Alternatively click `Use recovery code instead` to type the recovery code. 1. Click `Remove`.