This documentation is for WSO2 Identity Server 5.3.0 . View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

This topic provides instructions on how to configure the SMS OTP connector and the WSO2 Identity Server (WSO2 IS) to integrate using a sample app. This is configured so that SMSOTP is a second authentication factor for the sample application. See the following sections for more information.

To know more about the WSO2 Identity Server versions supported by this connector, see the WSO2 store.

This connector is supported by default from WSO2 Identity Server 5.4.0 onwards. For more information, see Configuring SMS OTP.

Note: These configurations work with 2.0.9 to 2.0.12 version of the connector. If you have a older version, upgrade the connector and artifacts to the latest version from the connector store.

The connector that is shipped OOTB with WSO2 Identity Server 5.3.0 is connector version 2.0.6. Therefore, if you are using WSO2 IS 5.3.0, upgrade the connector and artifacts to version 2.0.9 before you begin. Also the connector that is shipped OOTB with WSO2 Identity Server 5.7.0 is connector version 2.0.15.

Deploying SMS OTP artifacts

The artifacts can be obtained from the store for this authenticator.

  1. Place the smsotpauthenticationendpoint.war file inside the <IS_HOME>/repository/deployment/server/webapps directory.
  2. Place the org.wso2.carbon.extension.identity.authenticator.smsotp.connector-2.X.X.jar file inside the <IS_HOME>/repository/components/dropins directory.

    If you want to upgrade the SMS OTP Authenticator in your existing WSO2 IS pack, please refer upgrade instructions.

  3. Add the following configurations in the <IS_HOME>/repository/conf/identity/application-authentication.xml file under the <AuthenticatorConfigs> section.

    <AuthenticatorConfig name="SMSOTP" enabled="true">
        <Parameter name="SMSOTPAuthenticationEndpointURL">https://localhost:9443/smsotpauthenticationendpoint/smsotp.jsp</Parameter>
        <Parameter name="SMSOTPAuthenticationEndpointErrorPage">https://localhost:9443/smsotpauthenticationendpoint/smsotpError.jsp</Parameter>
        <Parameter name="MobileNumberRegPage">https://localhost:9443/smsotpauthenticationendpoint/mobile.jsp</Parameter>
        <Parameter name="RetryEnable">true</Parameter>
        <Parameter name="ResendEnable">true</Parameter>
        <Parameter name="BackupCode">true</Parameter>
        <Parameter name="SMSOTPEnableByUserClaim">false</Parameter>
        <Parameter name="SMSOTPMandatory">false</Parameter>
        <Parameter name="usecase">association</Parameter>
        <Parameter name="secondaryUserstore">primary</Parameter>
        <Parameter name="CaptureAndUpdateMobileNumber">true</Parameter>
        <Parameter name="SendOTPDirectlyToMobile">false</Parameter>

    The following table includes the definition of the parameters and the various values you can configure.

    This field makes it possible to retry the code if the user uses the wrong code. This value can be true or false.
    This parameter makes it possible to resend the code in the same page if user enters the wrong code. This value can be true or false.
    This field makes it possible to disable the 'SMS OTP disabling by user' functionality. The value can be true or false. If the value is true, the user can enable and disable the SMS OTP according to what the admin selects (SMSOTPMandatory parameter value).
    The backup code is used instead of the actual SMS code. The value can be true or false. If you do not want backup codes, set this as false. You can skip the steps 6.a and 7 in the Configuring claims section.
    If the value is true, the second step is enabled by the admin. The user cannot be authenticated without the SMS OTP authentication. This parameter is used for both the super tenant and tenant in the configuration. The value can be true or false.
    In the SMSOTPMandatory case, if the user does not exist in user store and if the admin enables SendOTPDirectlyToMobile as true, then the user can enter the mobile number during the time of authentication and the OTP will directly send to that mobile number.
    In the SMSOTPMandatory case, if the user or admin forgets to update the mobile number in the user's profile and this property is true, then the user can update a mobile claim during the time of authentication (logging in for the first time) and ask the user to enter the mobile number to send the OTP.
    This update functionality happen when logging in for the first time only. Once the user updates the mobile number, the next time the user logs in the mobile number is taken from specific user's profile.
    usecaseThis field can take one of the following values: local, association, userAttribute, subjectUri. If you do not specify any usecase, the default value is local.

    The user store configuration is maintained per tenant as comma separated values. For example, <Parameter name="secondaryUserstore">jdbcabc, and xyz</Parameter>.

    screenUserAttributeIf you need to show n digits of mobile number or any other user attribute value in the User Interface (UI), This parameter is used to pick the claim URI.
    orderDefine the order of the n numbers you provide, such as the from the first or last or vice versa. The possible values for this property is backward or forward.
    noOfDigitsThe number of digits of claim value to show in UI. If the mobile claim selected for the property screenUserAttribute and if the noOfDigitsproperty has the value 4 then we can show the mobile number according to the property order. If the order is backward, then we can show the last 4 digits of mobile claim in the UI.

    An admin can change the priority of the SMSOTP authenticator by changing the  SMSOTPMandatory value (true or false). 

    • If the Admin specifies that SMS OTP is mandatory (<Parameter name="SMSOTPMandatory">true</Parameter>), you must enable SMS OTP in the user’s profile by adding the claim value as true in order to authenticate the user. If this is not done, the SMSOTP error page appears.  
    • If  the Admin specifies that SMSOTP is optional (<Parameter name="SMSOTPMandatory">false</Parameter>)and you enable SMS OTP in the user's profile, the authenticator allows the user to login with the SMS OTP authentication as a second step (multi-step authentication). If the Admin specifies that the SMS OTP is optional and you do not enable SMS OTP in the user's profile, the SMSOTP authenticator proceeds to log the user in as the first step (basic authentication).           

    The first step may be a local authenticator (basic) or a federated authenticator (e.g., Facebook, Twitter, etc.) . In federated authenticator support in first step, the following parameters are used according to the scenario.  

         <Parameter name="usecase">association</Parameter>
         <Parameter name="secondaryUserstore">jdbc</Parameter>

    The usecase value can be local, association, userAttribute or subjectUri.


    This is based on the federated username. This is the default value. You must set the federated username in the localuserstore. Basically, the federated username must be the same as the local username.


    The federated username must be associated with the local account in advance in the Dashboard. So the local username is retrieved from the association. To associate the user, log into the end user dashboard and go to Associated Account by clicking View details.


    The name of the  federatedauthenticator's user attribute. That is,the local user namewhich is contained in a federated user's attribute. When using this, add the following parameter under the <AuthenticatorConfig name="SMSOTP" enabled="true"> section in the <IS_HOME>/repository/conf/identity/application-authentication.xml file and put the value (e.g., email, screen_name, id, etc.).

    <Parameter name="userAttribute">email</Parameter>

    If you use, OpenID Connect supported authenticators such as LinkedIn, Foursquare, etc., or in the case of multiple social login options as the first step and SMSOTP as secondstep , you need to add similar configuration for the specific authenticator in the <IS_HOME>/repository/conf/identity/application-authentication.xml file under the <AuthenticatorConfigs> section as follows (the following shows the configuration forFoursquare,LinkedIn and Facebook authenticator respectively).

    Inside the AuthenticatorConfig (i.e., Foursquare), add the specific userAttribute with a prefix of the (current step) authenticator name (i.e., SMSOTP-userAttribute).

    <AuthenticatorConfig name="Foursquare" enabled="true">
           <Parameter name="SMSOTP-userAttribute"></Parameter>
    <AuthenticatorConfig name="LinkedIn" enabled="true">
       <Parameter name="SMSOTP-userAttribute"></Parameter>
    <AuthenticatorConfig name="FacebookAuthenticator" enabled="true">
    	<Parameter name="SMSOTP-userAttribute">email</Parameter>

    Likewise, you can add the AuthenticatorConfig forAmazon,Google,Twitterand Instagram with relevant values.


    When configuring the federated authenticator, select the attribute in the subject identifier under the service provider section in UI, this is used as the username of the SMSOTP authenticator.

    If you use the secondary userstore, enter all the userstore values for the particular tenant as comma separated values. 

    The user store configuration is maintained per tenant:

    • If you use a super tenant, put all the parameter values into the <IS_HOME>/repository/conf/identity/application-authentication.xml file under the AuthenticatorConfigs section.
    • If you use a tenant, upload the same XML file (application-authentication.xml) into a specific registry location (/_system/governance/SMSOTP). Create the collection named SMSOTP, add the resource and upload the application-authentication.xml file into theregistry). While doing the authentication, first it checks whether there is an XML file uploaded to the registry. If that is so, it reads it from the registry but does not take the local file. If there is no file in the registry, then it only takes the property values from the local file. This is how theuserstore configuration is maintained per tenant. You can use the registry or local file to get the property values.

    If you need to show last n digits of mobile number or any other user attribute value in UI,  the following parameters can be used  according to the scenario. For example, we can use the following parameters to get last 4 digits from mobile number.

     <Parameter name="screenUserAttribute"></Parameter>
     <Parameter name="noOfDigits">4</Parameter>
     <Parameter name="order">backward</Parameter>

The SMS provider is the entity that is used to send the SMS. The SMSOTP connector has been configured such that it can be used with most types of SMS APIs. Some use the GET method with the client secret and API Key encoded in the URL (e.g., Nexmo), while some may use the POST method when sending the values in the headers and the message and telephone number in the payload (e.g., Clickatell). Note that this could change significantly between different SMS providers. The configuration of the connector in the identity provider would also change based on this.

Deploying sample

The next step is to deploy the sample app in order to use it in this scenario.

Once this is done, the next step is to configure the WSO2 Identity Server by adding an identity provider and a service provider.

Configuring the identity provider

Now you have to configure WSO2 Identity Server by adding a new identity provider.

  1. Download the WSO2 Identity Server from here and run it.
  2. Download the certificate of the SMS provider. Go to the link (eg:- in your browser, and then click the HTTPS trust icon on the address bar (e.g., the padlock next to the URL in Chrome)
  3. Import that certificate into the IS client keystore.   
    keytool -importcert -file <certificate file> -keystore <IS>/repository/resources/security/client-truststore.jks -alias "Nexmo" 

    Default client-truststore.jks password is "wso2carbon"

  4. Log into the management console as an administrator.

  5. In the Identity section under the Main tab of the management console, click Add under Identity Providers.

  6. Give a suitable name (e.g., SMSOTP) as the Identity Provider Name.

  7. Go to the SMSOTP Configuration under Federated Authenticators.

  8. Select both checkboxes to Enable SMSOTP Authenticator and make it the Default.

  9. Enter the SMS URL and the HTTP Method used (e.g., GET or POST). Include the headers and payload if the API uses any. If the text message and the phone number are passed as parameters in any field, then include them as $ctx.num and $ctx.msg respectively. You must also enter the HTTP Response Code the SMS service provider sends when the API is successfully called. Nexmo API and  Bulksms API send 200 as the code, while Clickatell and Plivo send 202. If this value is unknown, leave it blank and the connector checks if the response is 200, 201 or 202. 

    Note: If Nexmo is used as the SMS provider,

    1. Go to and click free signup and register.
    2. Under API Settings in Settings, copy and save the API key and Secret.
    3. The Nexmo API requires the parameters to be encoded in the URL, so the SMS URL would be as follows.      

    Note: If Clickatell is used as the SMS provider,

    1. Go to and create an account.
    2. The auth token is provided when you register with Clickatell.

    3. Clickatell uses a POST method with headers and the text message and phone number are sent as the payload. So the fields would be as follows.

      SMS URL
      HTTP MethodPOST
      HTTP HeadersX-Version: 1,Authorization: bearer ********,Accept: application/json,Content-Type: application/json
      HTTP Payload{"text":" $ctx.msg ","to":[" $ctx.num "]}

    Note: If Plivo is used as the SMS provider,  

    1. Sign up for a free Plivo trial account.
    2. Phone numbers must be verified at the Sandbox Numbers page (add at least two numbers and verify them).

    3. The Plivo API is authenticated with Basic Auth using your AUTH ID and AUTH TOKEN, Your Plivo AUTH ID and AUTH TOKEN can be found when you log in to your dashboard.
    4. Plivo uses a POST method with headers, and the text message and phone number are sent as the payload. So the fields would be as follows.

      SMS URL{auth_id}/Message/

      HTTP MethodPOST
      HTTP HeadersAuthorization: Basic ********,Content-Type: application/json
      HTTP Payload{"src":"+94*********","dst":"$ctx.num","text":"$ctx.msg"}

    Note: If Bulksms is used as the SMS provider,

    1. Go to and create an account.
    2. While registering the account, verify your mobile number and click Claim to get free credits. 

    3. Bulksms API authentication is performed by providing username and password request parameters.
    4. Bulksms uses a POST method and the required parameters are to be encoded in the URL. So the fields would be as follows.

      SMS URL*******&password=******&message=$ctx.msg&msisdn=$ctx.num
      HTTP MethodPOST
      HTTP HeadersContent-Type: application/x-www-form-urlencoded

    Note: If Twilio is used as the SMS provider,

    1. Go to and create an account.
    2. While registering the account, verify your mobile number and click on console home to get free credits (Account SID and Auth Token) 

    3. Twilio uses a POST method with headers and the text message and phone number are sent as the payload. So the fields would be as follows. 

      SMS URL{AccountSID}/SMS/Messages.json
      HTTP MethodPOST
      HTTP HeadersAuthorization: Basic base64{AccountSID:AuthToken}
      HTTP PayloadBody=$ctx.msg&To=$ctx.num&From=urlencode{FROM_NUM}

  10. Click Update and you have now added and configured the Identity provider.

Configuring the service provider

The next step is to configure the service provider.

  1. Return to the management console.

  2. In the Identity section under the Main tab, click Add under Service Providers.

  3. Enter in the Service Provider Name text box and click Register.

  4. In the Inbound Authentication Configuration section, click Configure under the SAML2 Web SSO Configuration section.

  5. Now set the configuration as follows:

    1. Issuer:

    2. Assertion Consumer URLhttp://localhost:8080/

  6. Select the following check-boxes:
    1. Enable Response Signing

    2. Enable Single Logout

    3. Enable Attribute Profile

    4. Include Attributes in the Response Always
  7. Click Update to save the changes. Now you will be sent back to the Service Providers page.

  8. Go to Claim configuration and select the mobile claim.

  9. Go to Local and Outbound Authentication Configuration section.

  10. Select the Advanced configuration radio button option.

  11. Add the basic authentication as first step and SMSOTP authentication as a second step. Adding basic authentication as a first step ensures that the first step of authentication will be done using the user's credentials that are configured with the WSO2 Identity Server. SMSOTP is a second step that adds another layer of authentication and security.

  12. Alternatively, federated authentication as the first step and SMSOTP authentication as the second step and click Update to save the changes.

You have now added and configured the service provider.

Configuring claims

  1. Select List under Users and Roles in the IS Management Console.
  2. Go to the User Profile and update the mobile number (this number must be registered with Nexmo in order to send SMS). 

    Note: If you wish to use the backup codes to authenticate, you can add the following claim, otherwise you can leave it.
  3. In the Main menu, click Add under Claims.
  4. Click Add New Claim.
  5. Select the Dialect from the dropdown provided and enter the required information.
  6. Add the following user claims under ''.
    1. Add the claim Uri - This is an optional claim for SMSOTP.
    2. Add the claim Uri - 
      The backup code claim is an optional.
  7.   Once you add the above claim, Go to Users → admin →User Profile and update the Backup codes and user can disable SMS OTP by clicking "Disable SMS OTP".  

Testing the sample

  1. To test the sample, go to the following URL: http://localhost:8080/ 

  2. Click the link to log in with SAML from WSO2 Identity Server.

  3. The basic authentication page will be visible. Use your WSO2 Identity Server credentials to sign in.

  4. You will get a token to your mobile phone.Type the code to authenticate, You will be taken to the home page of the app

    Note : In case, If you forget the mobile phone number or do not have access to it, you can use the backup codes to authenticate and  you will be taken to the home page of the application.


  • No labels