diff --git a/sources/platform/console/images/console-account-two-factor-disabled.png b/sources/platform/console/images/console-account-two-factor-disabled.png deleted file mode 100644 index fac86e9e53..0000000000 Binary files a/sources/platform/console/images/console-account-two-factor-disabled.png and /dev/null differ diff --git a/sources/platform/console/images/console-account-two-factor-enabled.png b/sources/platform/console/images/console-account-two-factor-enabled.png deleted file mode 100644 index ed20c8c376..0000000000 Binary files a/sources/platform/console/images/console-account-two-factor-enabled.png and /dev/null differ diff --git a/sources/platform/console/images/console-setup-two-factor-auth-key.png b/sources/platform/console/images/console-setup-two-factor-auth-key.png deleted file mode 100644 index dd69814a92..0000000000 Binary files a/sources/platform/console/images/console-setup-two-factor-auth-key.png and /dev/null differ diff --git a/sources/platform/console/images/console-two-factor-app-setup.png b/sources/platform/console/images/console-two-factor-app-setup.png deleted file mode 100644 index 204bfcee44..0000000000 Binary files a/sources/platform/console/images/console-two-factor-app-setup.png and /dev/null differ diff --git a/sources/platform/console/images/console-two-factor-auth-disable.png b/sources/platform/console/images/console-two-factor-auth-disable.png deleted file mode 100644 index 3e0f74c10c..0000000000 Binary files a/sources/platform/console/images/console-two-factor-auth-disable.png and /dev/null differ diff --git a/sources/platform/console/images/console-two-factor-authentication.png b/sources/platform/console/images/console-two-factor-authentication.png deleted file mode 100644 index fbdbd6e1b2..0000000000 Binary files a/sources/platform/console/images/console-two-factor-authentication.png and /dev/null differ diff --git a/sources/platform/console/images/console-two-factor-recovery-settings-request.png b/sources/platform/console/images/console-two-factor-recovery-settings-request.png deleted file mode 100644 index fc3b64b7b7..0000000000 Binary files a/sources/platform/console/images/console-two-factor-recovery-settings-request.png and /dev/null differ diff --git a/sources/platform/console/images/console-two-factor-recovery-settings-revealed.png b/sources/platform/console/images/console-two-factor-recovery-settings-revealed.png deleted file mode 100644 index 1898d6f39f..0000000000 Binary files a/sources/platform/console/images/console-two-factor-recovery-settings-revealed.png and /dev/null differ diff --git a/sources/platform/console/images/console-two-factor-recovery-setup.png b/sources/platform/console/images/console-two-factor-recovery-setup.png deleted file mode 100644 index 1ab27f4715..0000000000 Binary files a/sources/platform/console/images/console-two-factor-recovery-setup.png and /dev/null differ diff --git a/sources/platform/console/images/console-two-factor-use-recovery-code.png b/sources/platform/console/images/console-two-factor-use-recovery-code.png deleted file mode 100644 index 11d536b157..0000000000 Binary files a/sources/platform/console/images/console-two-factor-use-recovery-code.png and /dev/null differ diff --git a/sources/platform/console/images/two-factor-authentication.svg b/sources/platform/console/images/two-factor-authentication.svg new file mode 100644 index 0000000000..acb1fd782e --- /dev/null +++ b/sources/platform/console/images/two-factor-authentication.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/sources/platform/console/two-factor-authentication.md b/sources/platform/console/two-factor-authentication.md index 8d88532740..0715634be3 100644 --- a/sources/platform/console/two-factor-authentication.md +++ b/sources/platform/console/two-factor-authentication.md @@ -1,97 +1,116 @@ --- -title: Two-factor authentication setup +title: Two-factor authentication description: Enable two-factor authentication on your Apify Console account using an authenticator app to add a second layer of security against unauthorized access. sidebar_position: 5 category: platform slug: /console/two-factor-authentication --- -If you use your email and password to sign in to Apify Console, you can enable two-factor authentication for your account. This will add an extra layer of security to your account and prevent anyone who gains access to your password from signing in to your account. +Two-factor authentication (2FA) provides an extra layer of security that helps protect your Apify account. With 2FA enabled, logging into your account consists of two steps: -Some organizations might require two-factor authentication (2FA) to access their resources. Members of such an organization, must enable 2FA on their account in order to continue accessing shared resources and maintain compliance with their security policies. +1. Providing your username and password. +1. Providing a unique code generated by an authenticator app installed on your phone or by a browser extension. -## Set up two-factor authentication +Thanks to this additional second step, it’s more difficult for an unauthorized person to gain access to your data even if they know your credentials. -To set up two-factor authentication, go to the [Login & Privacy](https://console.apify.com/settings/security) section of your account settings. There, look for the **Two-factor authentication** section. Currently, there is only one option, which is the **Authenticator app**. If you have two-factor authentication already enabled, there will be a label **enabled** next to it. +## Configure 2FA for your account -![Apify Console two-factor authentication section](./images/console-account-two-factor-disabled.png) +Before you start setting up 2FA, download and configure an authenticator app on your phone. We recommend [Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en_US) or [Authy](https://www.authy.com/). -If it's not enabled, click on the **Enable** button. You should see the two-factor setup view. +![Overview of two-factor authentication settings in Apify Console](./images/two-factor-authentication.svg) -### Authenticator app setup +### 1. Enable 2FA in Apify Console -![Apify Console setup two-factor authentication - app](./images/console-two-factor-app-setup.png) +The first step is to enable two-factor authentication for your account: -In this view, you can use your favorite authenticator app to scan the QR code. We recommend using Google Authenticator ([Google Play Store](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en_US)/[Apple App Store](https://apps.apple.com/us/app/google-authenticator/id388497605)) or [Authy](https://www.authy.com/)([Google Play Store](https://play.google.com/store/apps/details?id=com.authy.authy)/[Apple App Store](https://apps.apple.com/us/app/twilio-authy/id494168017) but any other authenticator app should work as well. +1. Log in to [Apify Console](https://console.apify.com). +1. In the left-side panel, go to **Settings**. +1. Select the **Login & Privacy** tab. +1. In **Two-factor authentication**, select **Enable**. -You can also set up your app/browser extension manually without the QR code. To do that, click on the **Setup key** link below the QR code. This view with the key will pop up: +At this point, you see a modal window with a QR code and a request for a 6-digit code. -![Apify Console setup two-factor authentication - key](./images/console-setup-two-factor-auth-key.png) +### 2. Configure an authenticator app -A new pop-up window will appear where you can copy the two-factor `secret` key, which you can use in your authenticator app to set up the account. You can also use this key to set up your authenticator app on multiple devices. +Next, connect your authenticator app to your Apify account: -After you scan the QR code or set up your app manually, the app will generate a code that you need to enter into the **Verify the code from the app** field. After you enter the code, click on the **Continue** button to get to the next step of the setup process. +1. On your phone, open the authenticator app and tap the option to add a QR code. +1. Use your phone camera to scan the QR code displayed in Apify Console. +1. In the **Verify the code from the app** field, enter the 6-digit code generated by your app. +1. Select **Continue**. -### Set up recovery settings +
+Configure 2FA without a QR code -![Apify Console setup two-factor authentication - recovery codes](./images/console-two-factor-recovery-setup.png) +If you can't scan the QR code or prefer to use a browser extension instead, configure 2FA manually: -In this step, you will see 16 recovery codes. If you ever lose access to your authenticated app, you will be able to use these codes to access Apify Console. We recommend saving these codes in a safe place; ideally, you should store them in a secure password manager or print them out and keep them separate from your device. +1. In the modal window, select the **Setup key** link. +1. Copy the two-factor secret. +1. Use the secret to connect the app or a browser extension to your Apify account. -Under the recovery codes, you will find two fields for your recovery information. These two fields are what the support team will ask you to provide in case you lose access to your authenticator app and also to your recovery codes. We will never use the phone number for anything other than to verify your identity and help you regain access to your account, only as a last resort. Ideally, the personal information you provide will be enough to verify your identity. Always provide both the kind of personal information you provide and the actual information. +You can also use the two-factor secret to set up your authenticator app on multiple devices. -:::info Personal information -What kind of personal information you provide is completely up to you. It does not even have to be personal, as long as it's secure and easy to remember. For example, it can be the name of your pet, the name of your favorite book, some secret code, or anything else. Keep in mind who has access to that information. While you can use the name of your pet, if you share information about your pet on public social media, it's not a good choice because anyone on the internet can access it. The same goes for any other information you provide. -::: +
-You will not be able to enable the two-factor authentication until you click on the **Download** / **Copy** buttons or copy the codes manually. After you do that, the **Continue** button will light up, and you can click on it to enable the two-factor authentication. The authentication process will then enable the two-factor authentication for your account and show a confirmation. +### 3. Save recovery codes -### Confirmation +If you lose access to your authenticator app, you can still log in to your Apify account using a recovery code. To continue the 2FA setup, download or copy the recovery codes. -When you close the setup process, you should see that your two-factor authentication is enabled in the account settings. +We recommend saving the recovery codes in a safe place, for example, in a password manager. You can also print them and store them away from your device. -![Apify Console two-factor authentication section enabled](./images/console-account-two-factor-enabled.png) +### 4. Configure recovery information -## Verification after sign-in +The last step is to configure recovery information. If you lose access to your authenticator app or recovery codes, the support team will ask you for this information to help you recover your account. -After you enable two-factor authentication, the next time you attempt to sign in, you'll need to enter a code before you can get into Apify Console. To do that, open your authenticator app and enter the code for your Apify account into the **Code** field. After you enter the code, click on the **Verify** button, and if the provided code is correct, you will proceed to Apify Console. +To provide recovery information, complete the following fields: -![Apify Console two-factor authentication form](./images/console-two-factor-authentication.png) +- **Phone number**. Apify will only use your phone number to verify your identity during the recovery process. +- **Personal information**. Make sure the information you provide is secure and easy to remember. For example, if you use the name of your pet or the title of your favorite book, make sure that information isn't publicly available, for example on social media. -## Use recovery codes +Once you complete both fields, select **Continue**. You've configured two-factor authentication for your account. -In case you lose access to your authenticator app, you can use the recovery codes to sign in to your account. To do that, click on the **recovery code or begin 2FA account recovery** link below the **Verify** button. This will redirect you to a view similar to the current one, but instead of code from the authenticator app, you will need to enter one of the 16 recovery codes you received during the setup process. +## Log in with 2FA enabled -If the provided recovery code is correct, you will proceed to Apify Console, the same as if you provided the code from the authenticator app. After gaining access to Apify Console, we recommend going to the [Login & Privacy](https://console.apify.com/settings/security) section of your account settings, disabling the two-factor authentication there, and then enabling it again with the new authenticator app. +To log in to Apify Console with 2FA enabled: -:::info Removal of recovery codes -When you successfully use a recovery code, we remove the code from the original list as it's no longer possible to use it again. If you use all of your recovery codes, you will not be able to sign in to your account with them anymore, and you will need to either use your authenticator app or contact Apify support to help you regain access to your account. -::: +1. On the login page, provide your email address and password. +1. Enter the code from your authenticator app. -![Apify Console two-factor authentication with recovery code form](./images/console-two-factor-use-recovery-code.png) +### Use recovery codes -## Disable two-factor authentication +If you lose access to your authenticator app, you can still log in to your account using the recovery codes: -If you no longer want to use the two-factor authentication or lose access to your authenticator app, you can disable the two-factor authentication in the [Login & Privacy](https://console.apify.com/settings/security) section of your. See the **Two-factor authentication** section and click on the **Disable** button. We will ask you to enter either your verification code from the authenticator app or, if you do not have access to it anymore, you can use one of your recovery codes. After entering the code, click on the **Remove app** button to verify the provided code. If it's valid, it will disable the two-factor authentication and remove the configuration from your account. +1. On the login page, provide your email address and password. +1. Select the **recovery code or begin 2FA account recovery** link. +1. Enter one of the 16 recovery codes you received during the setup process. -After you disable the two-factor authentication you will be able to sign in to your account without providing the verification code. +You can use each recovery code only once. After you log in, we recommend that you disable 2FA and enable it again with a new authenticator app. -![Apify Console disable two-factor authentication modal](./images/console-two-factor-auth-disable.png) +### View recovery information -## What to do when you get locked out +To view the recovery information that you provided during the 2FA configuration: -If you lose access to your authenticator app and do not have any recovery codes left, or you lost them as well, you will not be able to sign in to your account. In this case, you will need to contact Apify support. To do that, you can either send an email to [support@apify.com](mailto:support@apify.com?subject='Locked%20out%20of%20account%20with%202FA%20enabled') or you can go to the [sign-in page](https://console.apify.com/sign-in) and sign in with your email and password. Then, on the two-factor authentication page, click on the **recovery code or begin 2FA account recovery** link. On the two-factor recovery page, click on the **Contact our support** link. This link will open up the online chat, and the support team can help you from there. +1. Log in to [Apify Console](https://console.apify.com). +1. In the left-side panel, go to **Settings**. +1. Select the **Login & Privacy** tab. +1. In **Two-factor authentication**, select **Recovery settings**. +1. To reveal the recovery information, provide a code from your authenticator app. -For the support team to help you recover your account, you will need to provide them with the personal information you have configured during the two-factor authentication setup. If you provide the correct information, the support team will help you regain access to your account. +## Disable 2FA -:::caution Support verification -The support team will not give you any clues about the information you provided; they will only verify if it is correct. -::: +To disable 2FA for your account: -You can always check what information you provided by going to the [Login & Privacy](https://console.apify.com/settings/security) section of your account settings, to the **Two-factor authentication** section, and clicking on the **Recovery settings** button, then you should see a view like this: +1. Log in to [Apify Console](https://console.apify.com). +1. In the left-side panel, go to **Settings**. +1. Select the **Login & Privacy** tab. +1. In **Two-factor authentication**, select **Disable**. +1. To confirm your choice, enter the code from your authenticator app or one of your recovery codes. +1. Select **Remove app**. -![Apify Console recovery settings modal request](./images/console-two-factor-recovery-settings-request.png) +After you disable 2FA, logging in to your account will require only your email and password. -After you enter a verification code from your authenticator app, you will see the recovery settings you provided during the two-factor authentication setup. +## Recover access to your account -![Apify Console recovery settings modal response](./images/console-two-factor-recovery-settings-revealed.png) +If you lose access to your authenticator app and have no recovery codes left, you can't log in to your account. To recover access to your account, contact Apify support at [apify.com/contact](https://apify.com/contact). + +During the recovery process, the support team will ask you for the recovery information that you have configured during the 2FA setup.