Skip to content

Commit

Permalink
Merge pull request #440 from cobalthq/FND-3177/docs/recovery-codes/ch…
Browse files Browse the repository at this point in the history
…anges

[FND-3177] Recovery codes documentation
  • Loading branch information
mtsuji-cobalt authored Oct 17, 2023
2 parents 3b84d37 + 9c0353e commit 45f694f
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 15 deletions.
4 changes: 4 additions & 0 deletions content/en/Getting started/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,10 @@ Learn more about [assigning a point of contact](/getting-started/planning/#assig

All resources included in your cloud [asset](#asset). For example, [AWS defines a project](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/create-project.html) as a collection of resources associated with an asset.

## Recovery Code

A recovery option, with [2FA](#multi-factor-authentication) enabled, to regain entry into your account if you lose access to your device and/or authenticator app.

## Remediate

To fix a vulnerability identified by a pentest or incident report. Examples:
Expand Down
10 changes: 8 additions & 2 deletions content/en/Platform Deep Dive/Cobalt Account/account-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,17 @@ Follow these instructions if you can't sign in to Cobalt because:

### Lost Access to Your Authenticator

If you lost access to your authenticator and don't have a backup device, ask your [Organization Owner](/platform-deep-dive/collaboration/user-roles/#organization-owner) to [turn off two-factor authentication (2FA)](#turn-off-2fa-for-a-user) on your account. If you're the only Organization Owner, contact {{% csm-support %}} for help.
If you lost access to your authenticator, ask your [Organization Owner](/platform-deep-dive/collaboration/user-roles/#organization-owner) to [turn off two-factor authentication (2FA)](#turn-off-2fa-for-a-user) on your account. If you're the only Organization Owner, contact {{% csm-support %}} for help.

Once your Organization Owner has turned off 2FA, you get an email notification. You can now sign in without a second authentication factor.

To protect your account, [enable 2FA](/platform-deep-dive/cobalt-account/account-settings/#enable-two-factor-authentication). Add one or more backup authenticators to avoid being locked out of your account.
If you have a [recovery code](#recovery-code) enabled:

1. Sign in as usual with your email and password.
2. Under **Verify Your Identity**, select **Try another method**, then **Recovery code**.
3. Enter your saved recovery code. You will be prompted to save a new recovery code for future use before access to your account.

To protect your account, [enable 2FA](/platform-deep-dive/cobalt-account/account-settings/#enable-two-factor-authentication).

#### Turn Off 2FA for a User

Expand Down
23 changes: 10 additions & 13 deletions content/en/Platform Deep Dive/Cobalt Account/account-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,39 +63,36 @@ If you're **signing in with your email and password**, you can enable two-factor
To enable 2FA on your account:

1. Navigate to https://app.cobalt.io/settings/security/2fa.
1. Under **Two-Factor Authentication (2FA)**, select **Manage**, and reauthenticate to your account.
1. To add a new authenticator device, select **Add a new OTP device**.
1. Follow the instructions on the screen to complete the process. Use an authenticator of your choice, such as [Authy](https://authy.com/) or [Google Authenticator](https://support.google.com/accounts/answer/1066447).
1. Add one or more backup devices to avoid being locked out of your account. Select **Add a new OTP device** to proceed.
2. Under **Two-Factor Authentication (2FA)**, select **Manage**, and reauthenticate to your account.
3. To add a new authenticator device, select **Set Up**.
4. Follow the instructions on the screen to complete the process. Use an authenticator of your choice, such as [Authy](https://authy.com/) or [Google Authenticator](https://support.google.com/accounts/answer/1066447).
5. After selecting Continue, you will see your recovery code. Save the code. After you close the overlay, you won’t see the code again.

Now, each time you sign in to Cobalt, you must enter a one-time code from your authenticator app. If you have problems signing in with 2FA, see our [troubleshooting tips](/platform-deep-dive/cobalt-account/account-recovery/#problems-with-two-factor-authentication).

#### Manage 2FA Devices

When you add a new 2FA device, it appears on the account security page<!--under **Current Devices**-->. Here, you can see devices with an authenticator app that generates one-time codes required for authentication to your Cobalt account.
When you add a new 2FA device, it appears on the account security page<!--under **Current Devices**-->. Here, you can see the authenticator app that generates one-time codes required for authentication to your Cobalt account.

- **Add multiple backup devices** to avoid being locked out of your account. Select **Add a new OTP device** to proceed.
- **Remove a device** if it's no longer valid or has been lost or stolen. Select **Delete**, and confirm your action.
- **Remove an app ** if it's no longer valid or has been lost or stolen. Select **Delete**, and confirm your action.

#### Reset Two-Factor Authentication

We don't recommend turning off 2FA on your account. However, you may need to reset your 2FA methods when:

- You believe your [account was compromised](/platform-deep-dive/cobalt-account/account-recovery/#account-was-compromised)—and you still have access to one of your authenticators.
- Your authenticator device was lost or stolen.

You can remove your current 2FA devices and add new ones for added security.
You can remove your current 2FA device and add a new one for added security.

To remove a 2FA device:

1. Navigate to https://app.cobalt.io/settings/security/2fa.
1. Under **Two-Factor Authentication (2FA)**, select **Manage**.
1. Locate the desired device, and select **Remove**.
- Remove other devices if needed.
1. Locate the desired device, and select the trash icon.

Now you can add a new 2FA device to protect your account. Make sure you also add one or more backup devices.
Now you can add a new 2FA device to protect your account.

If you lose access to your authenticator and don't have a backup one, ask your Organization Owner to turn off 2FA. For details, see [Lost Access to Your Authenticator](/platform-deep-dive/cobalt-account/account-recovery/#lost-access-to-your-authenticator).
If you lose access to your authenticator, ask your Organization Owner to turn off 2FA or use your recovery code. For details, see [Lost Access to Your Authenticator](/platform-deep-dive/cobalt-account/account-recovery/#lost-access-to-your-authenticator).

## Create and Manage API Tokens

Expand Down

0 comments on commit 45f694f

Please sign in to comment.