wso2 / docs-is

Apache License 2.0
63 stars 314 forks source link

[Doc] TOTP configuration guide needs to match IS v5.8.0 defaults #1394

Open jeradrutnam opened 5 years ago

jeradrutnam commented 5 years ago

Purpose

Doc its say to skip 1-3 steps for new product versions but when it comes to step 4 it wont match for IS v5.8.0. as the TOTP authenticator config section is already there in v5.8.0. But with different values.

<AuthenticatorConfig name="totp" enabled="true">
<Parameter name="encodingMethod">Base32</Parameter>
<Parameter name="timeStepSize">30</Parameter>
<Parameter name="windowSize">3</Parameter>
<Parameter name="authenticationMandatory">true</Parameter>
<Parameter name="enrolUserInAuthenticationFlow">true</Parameter>
<Parameter name="usecase">local</Parameter>
<Parameter name="secondaryUserstore">primary</Parameter>
<Parameter name="TOTPAuthenticationEndpointURL">totpauthenticationendpoint/totp.jsp</Parameter>
<Parameter name="TOTPAuthenticationEndpointErrorPage">totpauthenticationendpoint/totpError.jsp</Parameter>
<Parameter name="TOTPAuthenticationEndpointEnableTOTPPage">totpauthenticationendpoint/enableTOTP.jsp</Parameter>
<Parameter name="redirectToMultiOptionPageOnFailure">false</Parameter>
</AuthenticatorConfig>

Field explanation table content should sort to match configuration code block image

Should explain why we need to comment out <module ref="addressing"/> line image

Should elaborate more about the sample app path image E.g. After following sample app build guide you can find the .war file in the path: product-is\modules\samples\sso\sso-agent-sample\target\travelocity.com.war and can be deployed it in the tomcat server as instructed in the previous step.

Cannot find option to enable/disable SaaS Application as guide. That option comes only after you click register image

image

Travelocity screenshot needs to update

Whats there in the doc image

Whats there in v5.8.0 image

Environment

Windows 10

Steps to reproduce

  1. Follow the guide: https://docs.wso2.com/display/ISCONNECTORS/Configuring+TOTP+Authenticator
rksk commented 5 years ago

This information also has to be included in the doc. https://github.com/wso2-extensions/identity-outbound-auth-email-otp/blob/master/docs/html-support.md