Configure OTP Provider
OTP Provider Configuration
To enable different delivery types of OTP Codes you will need to define SMS, Voice or Email OTP Provider. For version 4.2.1 and above, The OTP Provider configuration can be done via the _Webconsole portal
There are following providers types are available by default:
- Twilio SMS Provider - to deliver OTP codes using Programmable Messaging provided by Twillio.
- Twilio Voice Call Provider - to deliver OTP codes using Programmable Voice provided by Twillio.
- SMSGlobal SMS Provider - to deliver OTP codes using SMS Gateway provided by SMS Global.
- Email OTP Provider - to deliver OTP code using the Mailbox Configuration.
- Custom OTP Provider - to deliver OTP code using Groovy Scripts implementation (see groovy: /AM/otp/TwillioSMSOTPModule.groovy)
The following providers exist as predefined OTP providers in default OpenIAM Installation:
| OTP Provider Name | OTP Provider Type | Description |
|---|---|---|
| Text OTP by Twilio | Twilio SMS Provider | Send SMS with Twilio |
| Text OTP by SMS Global | SMSGlobal SMS Provider | Send SMS with SMS Global |
| Email Code | Email OTP Provider | To use Configured Mailbox to Send OTP. The Email template with name 'OTP_CODE' is used by default |
| Call OTP by Twilio | Twilio Voice Call Provider | Use Twilio to call using Programmable Voice |
It is possible to configure an existing OTP Providers either using your credentials or by creating a new OTP Provider.
Let's check common OTP provider configuration options.
Common OTP Provider Configuration Options
Name
Choose a user-friendly name of OTP Provider. For example: "Text OTP by Twilio"
Type
The type of the OTP Provider, you can check the list above for possible types. For example: "Text OTP by Twilio"
Failover OTP Provider
The name of another OTP Provider which will be used in case of current Provider will fail sending the OTP code. Current configuration and Failover Configuration MUST have compatible OTP Provider types. It means that the phone related to OTP Provider Types can be failed over only by OTP Provider. See OTP Provider Types compatibility matrix below. For example: "Text OTP by Twilio"
Attributes
The table of the OTP Provider type related configurations. Each attribute has the following properties:
- Attribute Name - the NAME of the attribute. This is HARDCODED name of required Attribute which is used to identify the property
- Stored in Secret - the flag which controls show the value of the attribute stored in secret place (make sense for passwords, usernames and etc...)
- Value of the Attribute
Based on the type of OTP Provider Attributes can be different. Below will be described attributes based on the OTP Provider Type.
Twilio SMS Provider
| Attribute Name | Description | Value |
|---|---|---|
| Message format (internal: TEXT_MESSAGE_FORMAT) | The format of the message that will be sent to user with OTP code. Message must contain %s literal, where OTP code will be placed. | This SMS is generated by the OpenIAM Test SMS OTP Module. Your code is: %s |
| From Number (internal: FROM_ACCOUNT) | Verified Sender Phone Number, related to the Twilio Configuration. | +1234567890 |
| Account Password (internal: ACCOUNT_PASSWORD) | Service account password | qwerty |
| Account Id (internal: ACCOUNT_ID) | Service account name | AC12312312 |
| Length of the OTP code (internal: TOKEN_LEN) | The length of the OTP Code. If the length is less then 3 digits, the system will automatically use 3 characters. If value is set at more that 8, system will cut the length of the code to 8 characters | 6 |
SMSGlobal SMS Provider
| Attribute Name | Description | Value |
|---|---|---|
| Message format (internal: TEXT_MESSAGE_FORMAT) | The format of the message that will be sent to user with OTP code. Message must contain %s literal, where OTP code will be placed. | This SMS is generated by the OpenIAM Test SMS OTP Module. Your code is: %s |
| From Number (internal: FROM_ACCOUNT) | Verified Sender Phone Number, related to the SMS Global Configuration. | +1234567890 |
| Account Password (internal: ACCOUNT_PASSWORD) | Service account password | qwerty |
| Account Id (internal: ACCOUNT_ID) | Service account name | AC12312312 |
| Length of the OTP code (internal: TOKEN_LEN) | The length of the OTP Code. If value is less then 3 letters system will use 3 characters. If value is more that 8, system will use 8 characters | 6 |
Email OTP Provider
| Attribute Name | Description | Value |
|---|---|---|
| Length of the OTP code (internal: TOKEN_LEN) | The length of the OTP Code. If value is less then 3 letters system will use 3 characters. If value is more that 8, system will use 8 characters | 6 |
Twilio Voice Call Provider
| Attribute Name | Description | Value |
|---|---|---|
| Message format (internal: TEXT_MESSAGE_FORMAT) | The format of the message that will be sent to user with OTP code. Message must contain %s literal, where OTP code will be placed. | This SMS is generated by the OpenIAM Test SMS OTP Module. Your code is: %s |
| From Number (internal: FROM_ACCOUNT) | Verified Sender Phone Number, related to the Twilio Configuration. | +1234567890 |
| Account Password (internal: ACCOUNT_PASSWORD) | Service account password | qwerty |
| Account Id (internal: ACCOUNT_ID) | Service account name | AC12312312 |
| Length of the OTP code (internal: TOKEN_LEN) | The length of the OTP Code. If value is less then 3 letters system will use 3 characters. If value is more that 8, system will use 8 characters | 6 |
| Pronunciation Language (internal: LANGUAGE) | There are following Languages are possible | en-US |
OTP Provider Types compatibility matrix
| #/# | Twilio SMS Provider | Twilio Voice Call Provider | SMSGlobal SMS Provider | Email OTP Provider | Custom OTP Provider |
|---|---|---|---|---|---|
| Twilio SMS Provider | X | X | X | X | |
| Twilio Voice Call Provider | X | X | X | X | |
| SMSGlobal SMS Provider | X | X | X | X | |
| Email OTP Provider | X | ||||
| Custom OTP Provider | X | X | X | X |
Authentication Provider Configuration
To apply OTP provider to real usage it should be registered in Authentication Providers. Each Authentication provider may have unique set of OTP providers. The registered OTP Providers will be used to send OTP to the User.
The set of selected OTP Providers will be displayed during "OTP Authentication" authn step.
For instance: a "Supported OTP Providers:" for "Authentication Providers" are selected 'Text OTP by Twilio' and 'Call OTp by Twilio'
The 'Def. OTP Auth Rule' is selected as a 'Supported Authentication Levels' for URI pattern (for example /webconsole/about)
In this case when user hits /webconsole/about URL in the browser the OTP Selector page will be displayed with combobox which contains two options:
- Call to +1****
- Test to +1****
In case only the one OTP provider was select at "Authentication Providers" screen the drop-down will not be displayed and OTP will be sent directly using the single selected OTP Provider.