Skip to content

Commit cdaf2d7

Browse files
Merge pull request #6127 from DilshanSenarath/totp-qr-doc
Add documentation for enabling QR secret code display during TOTP enrollment
2 parents c3f6f1e + 7bcb52d commit cdaf2d7

2 files changed

Lines changed: 22 additions & 0 deletions

File tree

210 KB
Loading

en/includes/guides/authentication/mfa/add-totp-login.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,28 @@ To disable TOTP enrollment during login:
104104

105105
4. Click **Update** to save your changes.
106106

107+
{% if product_name == "WSO2 Identity Server" and is_version == "7.2.0" %}
108+
109+
## Display the secret key during enrollment
110+
111+
By default, {{ product_name }} only shows the QR code during TOTP enrollment. You can configure {{ product_name }} to also display the TOTP secret key alongside the QR code, allowing users to manually enter it into their authenticator app if QR code scanning is not possible.
112+
113+
To enable the secret key display, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file.
114+
115+
```toml
116+
[authentication.authenticator.totp.parameters]
117+
showSecretKeyInEnrollment = true
118+
```
119+
120+
!!! note
121+
This configuration is available from update level **7.2.0.27** onwards.
122+
123+
When enabled, users will see the secret key alongside the QR code during TOTP enrollment:
124+
125+
![QR code with secret key for TOTP authenticator in {{ product_name }}]({{base_path}}/assets/img/guides/mfa/totp/scan-qr-code-with-secret-key.png){: width="300" style="border: 0.3px solid lightgrey;"}
126+
127+
{% endif %}
128+
107129
## Try it out
108130

109131
Application users can enroll for TOTP authentication when they login to the business application for the first time. Given below are the steps that a user will follow:

0 commit comments

Comments
 (0)