PrivacyIDEA OTP SMS – integration manual

Here we describe how to set up MFA/2FA (Multi-Factor Authentication) using SMS OTP (One-Time Password) in PrivacyIDEA. The process is easy and should take 10-15 minutes to complete.

SMSEagle is an offline hardware SMS gateway. Therefore no external connection to 3rd party system is required. All notifications are generated on-premise and sent directly to a cellular network. This solution can be used in secure installations without Internet access.

SMSEagle Setup

Before using the API, you’ll need to enable API access on your SMSEagle device by following these steps:

1. Navigate to the Web-GUI and select the Users menu.
2. Create a new user in SMSEagle + Add Users, user access level: “User”.
3. Locate the Access to API option next to your newly created user.
4. Select APIv2 and click the Generate new token button to create your API access token.
5. Set up the appropriate permissions in the APIv2 Permission section:
  - For purpose of this example configuration, add access permissions in section Messages for: Send SMS.

PrivacyIDEA Setup

Below is the example configuration for the Send SMS method from our APIv2, however, you can also use different methods (e.g. Send MMS), more information about our APIv2 can be found here: https://www.smseagle.eu/docs/apiv2/

Go to the Config tab, then System and SMS Gateways.

Here choose Create New SMS Gateway Definition and as Providermodule select HttpSMSProvider.

In the HTTP_METHOD field, choose the POST value.

In the RETURN_FAIL and RETURN_SUCCESS enter the values REJECTED and queued.

As for URL, enter your SMSEagle Gateway address with correct APIv2 endpoint.

In the SEND_DATA_AS_JSON field choose yes.

Now, in Options section add a text and to parameters.
As for the to parameter, set this value: [„{phone}”].
In the text parameter you can enter your personalized sentence,
(for example: “Your OTP code is: {otp}”).
However, it has to be contained inside double-quotes and must include {otp} (which is the placeholder for the one-time password that will be sent).

In Headers section add an access-token parameter and as its value enter the access token of a user from your SMSEagle Gateway.

Save the Gateway Definition, go to Config > Tokens > SMS and choose your saved SMS Gateway configuration.

What is hardware
SMS Gateway?

Learn more about
SMSEagle features

Explore SMSEagle Demo device

SMSEagle is a hardware & software solution that guarantees a swift delivery of your messages to designated recipients, whether it’s for notifications, alerts, or important updates.

After registering to a demo you get a remote access to our physical device NXS-9750.

14-days free trial
Access to over 20 functionalities