OTPByCMSMSValve
Note
Valve for delivering one-time passwords by SMS via CM.
Properties
| Name | Description | Default value | Mandatory | Supports property expansion |
|---|---|---|---|---|
| generated_otp_name | Item property containing the generated otp. | generated_otp | No | No |
| recipient_param_name | Property containing the recipient mobile number. | mobile | No | Yes |
| userid_param_name | Property containing the username. | User-Name | No | Yes |
| cm_product_token | The product token (i.e. username) for the CM account. | Yes | No | |
| cm_sender | The sender value. Example: 'PhenixID' | PhenixID | No | No |
| use_flash | If the SMS message should be sent as flash. | true | No | No |
| wash_recipient_number | If the mobile number should be washed (i.e. removal of whitespaces, - and other non-number characters). | true | No | No |
| remove_leading_plus | If the leading + character should be removed from the mobile number. | false | No | No |
| recipient_prefix | If the mobile number should be prepended with a country prefix, (example: +46). | No | No | |
| message_key | Locale key for the sms message. Found in lang/*/strings.xml. | valves.otp.cm.sms.message | No | No |
| message | Static, non localizeable message. Overrides message_key parameter. | No | No |
Example Configuration
{
"name": "OTPByCMSMSValve",
"config": {
"generated_otp_name":"generated_otp",
"recipient_param_name":"othermobile",
"userid_param_name":"{{request.username}}",
"cm_product_token":"2dbc36f7-484a-4c2a-a17a-d6f084689xxx",
"cm_sender":"Company",
"use_flash":"false",
"recipient_prefix":"+46"
}
}
In the example above the value for attribute othermobile has been picked up earlier in the flow.
The value for userid_param_name has been picked up from the request. Most common values are {{request.User-Name}} for RADIUS and {{request.username}} for HTTP.
Requirements
Item set must have at least one entry.