Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update account_security.md #1658

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions docs/getting_started/account_security.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Set up account security
## Two-factor authentication

Two-Factor Authentication (2FA) provides an extra layer of security for your Sekoia.io account by introducing an additional step during the login process. In addition to your username and password, you will be required to provide a 6-digit verification code generated on your phone. This ensures enhanced protection against unauthorized access to your account.
Two-Factor Authentication (2FA) provides an extra layer of security for your Sekoia.io account by introducing an additional step during the login process. In addition to your username and password (aka credentials), you will be required to provide a 6-digit verification code generated on your phone. This ensures enhanced protection against unauthorized access to your account.

### How do I enable two-factor authentication?
## How do I enable two-factor authentication?

## Enabling Two-Factor Authentication
### Enabling Two-Factor Authentication

To enhance the security of your Sekoa.io account, you can enable Two-Factor Authentication (2FA) by following these instructions:

Expand All @@ -14,21 +14,24 @@ To enhance the security of your Sekoa.io account, you can enable Two-Factor Auth
3. Within your Account page, scroll down until you find the section labeled `Register Two-Factor Authentication`. Click on the `Enable` button associated with it
4. You will be asked to enter your password for verification purposes
5. Follow the steps below to complete the setup process for 2FA on your account:
1. Visit either the App Store (for iOS) or the Play Store (for Android) to download and install an Authenticator app such as Lastpass, Authenticator, or Authy. Follow the instructions provided by the app to set up an account
1. Visit either the App Store (for iOS) or the Google Play (for Android) to download and install an Authenticator app such as Lastpass, Authenticator, or Authy. Follow the instructions provided by the app to set up an account
2. Use the authentication app you installed to either scan the QR code displayed on app.sekoia.io or manually enter the token provided
3. Enter the `6-digit code` generated by the authentication app
6. Lastly, ensure that you generate and securely save your backup codes. These codes serve as a backup method to access your account in case you are unable to use the authentication app

### Generate backup codes
### Generate recovery codes

If you lose your mobile device or cannot use your authenticator app, you can use backup codes provided by Sekoia.io to access your account. **Ten backup codes** are generated. Each code can only be used **once**.
When you cannot use your authenticator app (e.g. changed phone / phone lost), you can use recovery codes provided by Sekoia.io to access your account. **Ten backup codes** are generated.

When enabling two-factor authentication, backup codes are generated automatically and you can either `copy` them or `download` them as a text file.

You can also generate new backup codes but keep in mind that your old codes will not work anymore.

We recommend you print off and store your codes in a safe location.

!!! Note
Each code can only be used **once**.

### Log in with backup codes

To log in with your backup codes, you will need to:
Expand All @@ -40,7 +43,7 @@ To log in with your backup codes, you will need to:

### How to disable two-factor authentication

To disable two-factor authentication on your SEKOIA account:
To disable two-factor authentication on your Sekoia account:

1. Log in to app.sekoia.io
2. Click on your profile picture and select `Account settings` to access the User center
Expand Down