Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.
The Twilio OTP Delivery Mechanism may be used to deliver one-time passwords to users via SMS through the Twilio web service, using a phone number stored in a specified attribute from the user's entry.
↓Parent Component
↓Properties
↓dsconfig Usage
The Twilio OTP Delivery Mechanism component inherits from the OTP Delivery Mechanism
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ twilio-account-sid | |
| ↓ twilio-auth-token | |
| ↓ phone-number-attribute-type | |
| ↓ sender-phone-number | |
| ↓ message-text-before-otp | |
| ↓ message-text-after-otp |
| Description | A description for this OTP Delivery Mechanism |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether this OTP Delivery Mechanism is enabled for use in the server. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The unique identifier assigned to the Twilio account that will be used. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The auth token for the Twilio account that will be used. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The name or OID of the attribute in the user's entry that holds the phone number to which the message should be sent. |
| Default Value | mobile |
| Allowed Values | The name or OID of an attribute type defined in the server schema. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The outgoing phone number to use for the messages. Values must be phone numbers you have obtained for use with your Twilio account. If a high message volume is anticipated, then it may be beneficial to provide multiple sender phone number values, which will be used in a round-robin manner. This may help overcome the Twilio limit of one message per outbound phone number per second. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Any text that should appear in the message before the one-time password value. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Any text that should appear in the message after the one-time password value. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured OTP Delivery Mechanisms:
dsconfig list-otp-delivery-mechanisms
[--property {propertyName}] ...
To view the configuration for an existing OTP Delivery Mechanism:
dsconfig get-otp-delivery-mechanism-prop
--mechanism-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing OTP Delivery Mechanism:
dsconfig set-otp-delivery-mechanism-prop
--mechanism-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Twilio OTP Delivery Mechanism:
dsconfig create-otp-delivery-mechanism
--mechanism-name {name}
--type twilio
--set enabled:{propertyValue}
--set twilio-account-sid:{propertyValue}
--set twilio-auth-token:{propertyValue}
--set sender-phone-number:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing OTP Delivery Mechanism:
dsconfig delete-otp-delivery-mechanism
--mechanism-name {name}