Skip to content

Fix: Remove outdated Email OTP configuration steps for versions 6.0.0 and 6.1.0 (Product IS issue #26846) #5922

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
wso2-engineering-bot wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix: Remove outdated Email OTP configuration steps for versions 6.0.0 and 6.1.0 (Product IS issue #26846) #5922

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
33 changes: 1 addition & 32 deletions en/identity-server/6.0.0/docs/guides/mfa/2fa-email-otp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@

- [**Configure email sending module**]({{base_path}}/deploy/configure-email-sending)
- **Configure the email OTP provider**

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

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces 

en/identity-server/6.0.0/docs/guides/mfa/2fa-email-otp.md:15:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
You can use any of the following methods to configure the email OTP provider:

- Identity Server as the email OTP provider

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

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation 

en/identity-server/6.0.0/docs/guides/mfa/2fa-email-otp.md:18:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md

??? "Configure Identity Server as the email OTP provider"
To configure the email OTP provider on the IS:
Expand All @@ -35,7 +35,7 @@

4. Save the configurations.

- Gmail as the email OTP provider

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

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation 

en/identity-server/6.0.0/docs/guides/mfa/2fa-email-otp.md:38:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md

??? "Configure Gmail as the email OTP provider"
**Create a Gmail project**
Expand Down Expand Up @@ -99,43 +99,12 @@

2. Save the configurations and restart the server.

- **Add the email template**

After configuring the email OTP provider of your choice, you need to add an email template for email OTP.

To configure the email template:

1. Add the following email template to the `email-admin-config.xml` file found in the `<IS_HOME>/repository/conf/email`.
```xml
<configuration type="EmailOTP" display="EmailOTP" locale="en_US" emailContentType="text/html">
<targetEpr></targetEpr>
<subject>WSO2 IS Email OTP</subject>
<body>
Hi,
Please use this one-time password {OTPCode} to sign in to your application.
</body>
<footer>
Best Regards,
WSO2 Identity Server Team
http://www.wso2.com
</footer>
<redirectPath></redirectPath>
</configuration>
```

2. Save the configurations and restart the server.

## Enable email OTP for an SP

To enable email OTP for MFA, you need to configure the email OTP as an authenticator and add it to the authentication flow of the application.

### Prerequisites

Check failure on line 106 in en/identity-server/6.0.0/docs/guides/mfa/2fa-email-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-email-otp.md:106 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
- 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**.
3. Select `http://wso2.org/claims/emailaddress` as the **Subject Claim URI**.
4. Click **Update** to save the configurations.
- You need to [set up the sample]({{base_path}}/guides/adaptive-auth/adaptive-auth-overview/#set-up-the-sample) application.

Check failure on line 107 in en/identity-server/6.0.0/docs/guides/mfa/2fa-email-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-email-otp.md:107 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 [update the User Profile]({{base_path}}/guides/identity-lifecycles/update-profile) of the users with an email address to which the user will receive the OTP.
- You need to [register an Identity Provider]({{base_path}}/guides/identity-federation/add-idp/) named `emailOTP`.

Expand Down
33 changes: 1 addition & 32 deletions en/identity-server/6.1.0/docs/guides/mfa/2fa-email-otp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@

- [**Configure email sending module**]({{base_path}}/deploy/configure-email-sending)
- **Configure the email OTP provider**

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

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces 

en/identity-server/6.1.0/docs/guides/mfa/2fa-email-otp.md:15:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
You can use any of the following methods to configure the email OTP provider:

- Identity Server as the email OTP provider

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

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation 

en/identity-server/6.1.0/docs/guides/mfa/2fa-email-otp.md:18:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md

??? "Configure Identity Server as the email OTP provider"
To configure the email OTP provider on the IS:
Expand All @@ -35,7 +35,7 @@

4. Save the configurations.

- Gmail as the email OTP provider

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

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation 

en/identity-server/6.1.0/docs/guides/mfa/2fa-email-otp.md:38:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md

??? "Configure Gmail as the email OTP provider"
**Create a Gmail project**
Expand Down Expand Up @@ -99,43 +99,12 @@

2. Save the configurations and restart the server.

- **Add the email template**

After configuring the email OTP provider of your choice, you need to add an email template for email OTP.

To configure the email template:

1. Add the following email template to the `email-admin-config.xml` file found in the `<IS_HOME>/repository/conf/email`.
```xml
<configuration type="EmailOTP" display="EmailOTP" locale="en_US" emailContentType="text/html">
<targetEpr></targetEpr>
<subject>WSO2 IS Email OTP</subject>
<body>
Hi,
Please use this one-time password {OTPCode} to sign in to your application.
</body>
<footer>
Best Regards,
WSO2 Identity Server Team
http://www.wso2.com
</footer>
<redirectPath></redirectPath>
</configuration>
```

2. Save the configurations and restart the server.

## Enable email OTP for a service provider

To enable email OTP for MFA, you need to configure the email OTP as an authenticator and add it to the authentication flow of the application.

### Prerequisites

Check failure on line 106 in en/identity-server/6.1.0/docs/guides/mfa/2fa-email-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-email-otp.md:106 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
- 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**.
3. Select `http://wso2.org/claims/emailaddress` as the **Subject Claim URI**.
4. Click **Update** to save the configurations.
- You need to [set up the sample]({{base_path}}/guides/adaptive-auth/adaptive-auth-overview/#set-up-the-sample) application.

Check failure on line 107 in en/identity-server/6.1.0/docs/guides/mfa/2fa-email-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-email-otp.md:107 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 [update the User Profile]({{base_path}}/guides/identity-lifecycles/update-profile) of the users with an email address to which the user will receive the OTP.
- You need to [register an Identity Provider]({{base_path}}/guides/identity-federation/add-idp/) named `emailOTP`.

Expand Down