Configure SMS Services
CSAP Admins can now enable Analyst Portal users to receive their login One Time Passwords (OTP) via SMS on their mobile devices or on their configured email addresses. Admins can integrate SMS gateway services with CSAP for sharing OTP through SMS. SMS integrations can be used with authentication methods such as LDAP, SAML 2.0, etc., for two-factor authentication.
SMS Integrations can be used with authentication methods such as LDAP, SAML 2.0, etc., for two-factor authentication.
The SMS configuration module can be used to integrate third-party SMS sender tools that provide a programmable SMS API for the purpose of receiving authentication OTPs. Admins can easily configure API communication parameters required for any SMS sender tool using the default and customizable fields available in this section. You need to have the view and create/update permissions to access the SMS configuration module. Permissions can only be assigned to a role.
Note
If SMS integration is not configured, CSAP will send two-factor authentication OTPs via email to users.
Procedure
To configure SMS services, do the following.
Go to Management > Integrations > SMS Configuration and click Edit.
Select the HTTP Method for the API endpoint provided by the SMS service provider. For example, POST.
Enter the URL endpoint of the SMS service provider. For example, https://sampledomain.com/sms_service
Enter the authentication type. There are two authentication types - Basic Auth or API keys. You can create key-value pairs for the authentication type provided by the service provider. For more information on the authentication configuration, refer to the API documentation provided by the service provider.
Enter the API payload format provided by the SMS service provided. This payload can be either in form data or JSON.
Enter the format of the message through which users receive the OTP. You can configure the text for the same. For example, Use {otp} as one-time password to log in to the application.
Specify prefix values for phone numbers. For example, +. The phone number value available from the user profile will be appended to the prefix provided. Leave this field empty if the prefix does not apply.
Enter the receiver key name. The receiver's details can be extracted through an test SMS API call.
Enter the message name key. The message details are extracted through an API call.
Click Save.
Click Enable SMS Configurations to finish configuration.
Note
Click on the Test Connectivity button to check the success of the SMS configuration. You should receive a confirmation OTP on the entered phone number.