Skip to content

Commit 14c17c0

Browse files
authored
Merge pull request #107 from simpleid/features/recovery_auth
Update documentation on recovery codes
2 parents 5d433bf + 44c3cc3 commit 14c17c0

2 files changed

Lines changed: 21 additions & 3 deletions

File tree

docs/2/common-problems.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,13 @@ This is so common there is a [specific page](/docs/1/return_to) for this problem
1717

1818
## Login verification recovery {#otp}
1919

20-
If login verification is enabled and you have lost the device that generates the verification code, you can recover your account using the following steps.
20+
If login verification is enabled and you have lost the device that generates the verification code, you can recover your account either by using recovery codes (if you have saved them) or by manually editing the user file.
21+
22+
### Recovery by recovery codes
23+
24+
See the [Login verification section](/docs/2/login-verification#recovery-codes) for instructions on how to use recovery codes.
25+
26+
### Recovery by editing the user file
2127

2228
1. You will need to edit your user file stored on the server. Open the identity file and add the `otp` section as follows:
2329

docs/2/login-verification.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ For WebAuthn-based authentication, you will need a physical security key such as
4646
3. From the **My Profile** page, go to the **Login Verification** box, then click **Enable**.
4747
4. Enter the key shown on the page into your device. If your device supports scanning QR codes, you can also scan the QR code shown.
4848
5. Enter the 6 digit verification code shown on your device and click **Verify**.
49+
6. If shown, save the [recovery codes](#recovery-codes) in a same place.
4950

5051
Login verification is then enabled. Every time you attempt to log in using this account, you will be prompted to enter the 6 digit verification code shown on your device.
5152

@@ -57,6 +58,7 @@ Login verification is then enabled. Every time you attempt to log in using this
5758
3. From the **My Profile** page, go to the **Passkeys and security keys** box, then click **Add**.
5859
4. Enter a user-friendly name for the key, then click **Add security key**.
5960
5. Follow the instructions on your device and insert your security key.
61+
6. If shown, save the [recovery codes](#recovery-codes) in a same place.
6062

6163
Login verification is then enabled. Every time you attempt to log in using this account, you will be prompted to insert the security key (and enter a PIN if required).
6264

@@ -65,6 +67,16 @@ Login verification is then enabled. Every time you attempt to log in using this
6567
1. [Log in to SimpleID](/docs/2/login)
6668
2. From the **My Profile** page, go to the **Login Verification** box, then click **Disable**.
6769

68-
## How to recover
70+
## Recovery codes {#recovery-codes}
6971

70-
If login verification is enabled and you have lost the device that generates the verification code, you can [recover your account](/docs/2/common-problems#otp).
72+
If you are enabling login verification for the first time, a list of recovery codes will be shown at the conclusion of that process. These recovery codes can be used to recover your account if you have lost the device that generates the verification code.
73+
74+
Make sure you copy and save the recovery codes in a safe place. They are only shown once.
75+
76+
To use a recovery code:
77+
78+
1. When prompted to enter a verification code, click **Use a recovery code**.
79+
2. Enter one of the recovery codes you have saved, and click **Verify**.
80+
3. If successful, you will be logged in normally. Once a recovery code has been used it cannot be used again.
81+
82+
If you have lost your recovery codes or have used all of them up, you can regenerate the recovery codes by going to the **Dashboard**, then the **Recovery codes** box, then click **Reset**.

0 commit comments

Comments
 (0)