RapidIdentity Product Guide: New UI

SMS

The settings in the SMS configuration screen give administrators control over how RapidIdentity will act when it needs to send an SMS. This is used for SMS authentication and in some Connect features.

Navigate to Configuration > Systems > SMS.

SMS_Configuration.png
  1. The Dial Prefix should be anything the service needs to dial before the user's phone number to send an SMS - this includes country and area codes as needed. More rules are listed in Configuring the Phone Number below.

  2. There are two usable SMS Providers available for selection: Amazon Web Services Simple Notification Service (AWS SNS) and RapidIdentity SMS Gateway.

AWS SNS

AWS SNS allows RapidIdentity to send SMS messages by making API requests to the AWS SNS service. In order to do that, RapidIdentity needs AWS credentials.

AWS_SNS.png

The Use Instance IAM Role option instructs RapidIdentity to pull credentials directly from the EC2 instance it is running on provided the instance was configured with an IAM Role.

If Use Instance IAM Role is not selected, then static AWS keys must be entered. This option also allows RapidIdentity to send SMS messages via SNS when it is not running in AWS.

Note

The EC2 instance must be configured with an IAM Role for this to function properly. Those settings are in the AWS UI.

RapidIdentity SMS Gateway

With a valid RapidIdentity SMS Gateway license installed and this option chosen, RapidIdentity will perform the necessary operations without the user needing to do any further AWS configuration.

RI_SMS_Gateway.png

Note

A RapidIdentity license to use SMS Gateway is required for this feature.

Configuring the Phone Number

The SMS function requires the mobile number to be stored in the format <countrycode><areacode><number> and follows these basic rules:

  • If the mobile number starts with a +, nothing will be added to it when dialing.

  • If the mobile number does not start with a + and the dialPrefix is defined, the dialPrefix will be prepended to the number before dialing.

  • If the mobile number does not start with a + and the dialPrefix is not defined, a + will be prepended to the number before dialing.

  • All other non-numeric characters will be stripped per SMS requirements.