How it Works?


ADSS Web RA uses SMS to send OTP tokens to the users mobile devices for authentication on various sensitive actions like second factor of login authentication, certificate creation, renewal and revocation requests. 


An SMS gateway connector is configured to connect with an SMS service. This SMS connector is configured in the service plan, allowing enterprise to use the SMS service for their communication. Furthermore, each service plan can have their own SMS gateway or they can share the same SMS gateway.


The ADSS Web RA provides a generic configuration to configure the SMS Gateway. Any SMS Gateway that provides the RESTful implementation can be configured in the Web RA. To configure an SMS Gateway, you need to provide the following information:


  • URL of the SMS Gateway to send an HTTP request
  • Authorization type
  • HTTP method, i.e. POST or GET
  • Dynamic key value pair of attributes that are sent in the HTTP request 


Create an SMS Gateway Connector


  1. Click External Services from the left menu.
  2. Click Connectors.
  3. Click  from the grid header. 
  4. A dialog will appear to add the connector details. The connector dialog is comprised of two screens, i.e. Basic Information and Details. Specify the basic information and click Next to provide the respective connector details. See the below table for fields description.
  5. A Send Message button will appear at the bottom. Click this button to ensure that you have entered the correct details. If the configurations are correct an SMS will be sent to the mobile. 
  6. Click Finish. A new connector will be saved and displayed in the list.


Basic Information

Field

Description

Name

Specify a unique name for this connector, i.e. My SMS Gateway. This connector will be used in the configuration of service plans. 

Provider

Select the provider for this connector, i.e. "SMS Gateway".

Active

Tick this check box to make this connector active. Inactive connectors cannot be configured in the service plans.



 Details

Field

Description

URL

Specify the server URL on which system will request to send SMS.
If you specify {}, then system will look for AccountSid in the Request parameter and will replace the URL with AccountSid.

Method

Choose a method for this SMS connector as required, i.e. GET or POST.

  • GET is used to send the Request Parameters in the query string.
  • POST is used to send the Request Parameters in the body.




Details > Request Headers

Field

Description

Authorization

Choose an authorization header while sending the request, i.e.:

  • No Auth - this will not add any authorization in the request.
  • Basic Auth - this will require user name and password of the SMS Gateway.
  • Bearer Token - this will require the authentication token of the SMS Gateway. 

Content Type

Choose a content type for this SMS connector, i.e.:

  • application/json, 
  • application/x-www-form-urlencoded, 
  • multipart/form-data

Add Request Header

Click this button to add more request header fields. A pair of fields will be added, to specify the custom header that will be sent to the URL while sending the request, e.g. "X-Version: 1" is a custom header.




 Details > Request Parameters

Field

Description

Param Number

Param Number is used to identify the Number parameter. The SMS API may treat number differently, e.g. eskon web service calls it PrmMobileNumber.

This parameter is filled in by the server itself while sending OTP to a client. Specify the parameter number that is being used by the SMS Gateway API. 

Param Message

Param Message is used to identify the Message parameter. The SMS API may treat message differently, e.g. eskon web service calls it PrmMessageText.

This parameter is filled in by the server itself while sending OTP to a client. Specify the parameter message that is being used by the SMS Gateway API. 

Add Request Parameter

Click this button to add more request parameter fields. A pair of fields will be added, to specify any additional parameter which is required by the SMS gateway, but is not available in the default request parameters as provided above, e.g. Twillio requires Account SID. So you can add a field pair, and specify "Account SID" in the left field and its corresponding value in the right field.

Send Message

Click this button to validate the provided SMS gateway configurations by sending a test SMS. A dialog will appear, specify your mobile number along with the correct country code and click Send. Based on the server reply, a toaster message of success or failure will be displayed.

In case of successful configurations, you will receive a test SMS on your mobile device. However if you donot receive the message, then revisit your provided SMS gateway configurations.

 

Configure an SMS Connector in Service Plan


  1. Click Service Plan from the left menu.
  2. The "Service Plans" screen will appear.
  3. Click  adjacent to the service plan (from the main grid) in which OTP via SMS is required to configure.
  4. A dialog wizard (consisting of 3 sequential dialog boxes, i.e Basic Information, Profile Settings, and Authentications) will appear in editable mode.
  5. Click the Authentications tab.
  6. Tick OTP via SMS. The following fields will appear:
    • The SMS Gateway field to select an SMS connector for sending OTP message from ADSS Web RA to the users' mobiles. Only the active SMS connectors are listed for selection. 
    • The OTP Length field to select the total number of digits that are required in an OTP message.  ADSS Web RA currently supports 4, 6, and 9 digits OTP.
    • The OTP Retry Interval field to specify the retry interval in seconds (i.e. 10) after which ADSS Web RA should retry to send an OTP message, in case the SMS sending is failed in the first attempt due to any technical glitch.
  1. Click Finish.
  2. Click Publish Changes from the top right corner, to make these configurations effective.