Skip to content

Fix: Correct backup codes usage statement for all affected versions (Product IS issue #25714) #5610

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix: Correct backup codes usage statement for all affected versions (Product IS issue #25714) #5610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@

## Enable SMS OTP for an SP

### Prerequisites

Check failure on line 25 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / lint

Disallow consecutive headings 

en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md:25 no-consecutive-headings Disallow consecutive headings [Consecutive headings are not allowed.] [Context: "### Prerequisites"]

Check failure on line 25 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / lint

Headings should be surrounded by blank lines 

en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md:25 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Prerequisites"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
- You need to [set up the sample]({{base_path}}/guides/adaptive-auth/adaptive-auth-overview/#set-up-the-sample) application.

Check failure on line 26 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / lint

Lists should be surrounded by blank lines 

en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md:26 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- You need to [set up the samp..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
- You need to [configure local claims]({{base_path}}/guides/applications/configure-claims-for-sp/#use-local-claim-dialect) for the application:
1. On the management console, go to the application you created and click **Edit**
2. Expand **Claim configuration**.
Expand All @@ -33,7 +33,7 @@
- You need to [register an Identity Provider]({{base_path}}/guides/identity-federation/add-idp/) named `smsOTP`.
- Set up the SMS OTP provider (example: Vonage, Clickatell, Plivo, Bulksms, Twillio).

### Configure the SMS OTP authenticator

Check failure on line 36 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / lint

Headings should be surrounded by blank lines 

en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md:36 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Configure the SMS OTP authenticator"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
To configure the SMS OTP authenticator:

1. On the management console, go to **Identity Providers > List**.
Expand Down Expand Up @@ -204,7 +204,7 @@

## Additional configurations

### Allow users to disable SMS OTP

Check failure on line 207 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / lint

Disallow consecutive headings 

en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md:207 no-consecutive-headings Disallow consecutive headings [Consecutive headings are not allowed.] [Context: "### Allow users to disable SMS OTP"]

To allow users to disable SMS OTP:

Expand All @@ -222,7 +222,7 @@

### Configure backup codes

Optionally, you can configure backup codes to be used when SMS OTP is disabled.
Optionally, you can configure backup codes to be used as a fallback when SMS OTP is enabled but temporarily inaccessible (for example, when a user cannot receive the SMS).

Check failure on line 225 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'can't' instead of 'cannot'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'can't' instead of 'cannot'.", "location": {"path": "en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 148}}}, "severity": "ERROR"}

Check warning on line 225 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'is'.

Raw Output:
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 82}}}, "severity": "INFO"}

Check warning on line 225 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.", "location": {"path": "en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 82}}}, "severity": "WARNING"}

Check warning on line 225 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Passive] 'is enabled' looks like passive voice.

Raw Output:
{"message": "[Microsoft.Passive] 'is enabled' looks like passive voice.", "location": {"path": "en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 82}}}, "severity": "INFO"}

Check warning on line 225 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'be'.

Raw Output:
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 47}}}, "severity": "INFO"}

Check warning on line 225 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[write-good.Passive] 'be used' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'be used' may be passive voice. Use active voice if you can.", "location": {"path": "en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 47}}}, "severity": "WARNING"}

Check warning on line 225 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Passive] 'be used' looks like passive voice.

Raw Output:
{"message": "[Microsoft.Passive] 'be used' looks like passive voice.", "location": {"path": "en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 47}}}, "severity": "INFO"}

To configure backup SMS OTP codes:

Expand All @@ -238,7 +238,7 @@
| Mapped Attribute | `postalcode` |
| Supported by Default | Selected |

<img name='allow-to-use-back-up-codes' src='{{base_path}}/assets/img/guides/allow-to-use-back-up-codes.png' class='img-zoomable'/>

Check failure on line 241 in en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / lint

Images should have alternate text (alt text) 

en/identity-server/6.0.0/docs/guides/mfa/2fa-sms-otp.md:241:5 MD045/no-alt-text Images should have alternate text (alt text) https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md045.md

3. Click **Add** to add the new local claim.

Expand Down
2 changes: 1 addition & 1 deletion en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@

## Enable SMS OTP for an SP

### Prerequisites

Check failure on line 25 in en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / lint

Disallow consecutive headings 

en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md:25 no-consecutive-headings Disallow consecutive headings [Consecutive headings are not allowed.] [Context: "### Prerequisites"]

Check failure on line 25 in en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / lint

Headings should be surrounded by blank lines 

en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md:25 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Prerequisites"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
- You need to [set up the sample]({{base_path}}/guides/adaptive-auth/adaptive-auth-overview/#set-up-the-sample) application.

Check failure on line 26 in en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / lint

Lists should be surrounded by blank lines 

en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md:26 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- You need to [set up the samp..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
- You need to [configure local claims]({{base_path}}/guides/applications/configure-claims-for-sp/#use-local-claim-dialect) for the application:
1. On the management console, go to the application you created and click **Edit**
2. Expand **Claim configuration**.
Expand All @@ -33,7 +33,7 @@
- You need to [register an Identity Provider]({{base_path}}/guides/identity-federation/add-idp/) named `smsOTP`.
- Set up the SMS OTP provider (example: Vonage, Clickatell, Plivo, Bulksms, Twillio).

### Configure the SMS OTP authenticator

Check failure on line 36 in en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / lint

Headings should be surrounded by blank lines 

en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md:36 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Configure the SMS OTP authenticator"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
To configure the SMS OTP authenticator:

1. On the management console, go to **Identity Providers > List**.
Expand Down Expand Up @@ -222,7 +222,7 @@

### Configure backup codes

Optionally, you can configure backup codes to be used when SMS OTP is disabled.
Optionally, you can configure backup codes to be used as a fallback when SMS OTP is enabled but temporarily inaccessible (for example, when a user cannot receive the SMS).

Check failure on line 225 in en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'can't' instead of 'cannot'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'can't' instead of 'cannot'.", "location": {"path": "en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 148}}}, "severity": "ERROR"}

Check warning on line 225 in en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Passive] 'is enabled' looks like passive voice.

Raw Output:
{"message": "[Microsoft.Passive] 'is enabled' looks like passive voice.", "location": {"path": "en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 82}}}, "severity": "INFO"}

Check warning on line 225 in en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'be'.

Raw Output:
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 47}}}, "severity": "INFO"}

Check warning on line 225 in en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[write-good.Passive] 'be used' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'be used' may be passive voice. Use active voice if you can.", "location": {"path": "en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 47}}}, "severity": "WARNING"}

Check warning on line 225 in en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Passive] 'be used' looks like passive voice.

Raw Output:
{"message": "[Microsoft.Passive] 'be used' looks like passive voice.", "location": {"path": "en/identity-server/6.1.0/docs/guides/mfa/2fa-sms-otp.md", "range": {"start": {"line": 225, "column": 47}}}, "severity": "INFO"}

To configure backup SMS OTP codes:

Expand Down
Loading