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 Email OTP Delivery Mechanism may be used to deliver one-time passwords to users over e-mail, using an address stored in a specified attribute from the user's entry. Note that in order for this delivery mechanism to work properly, the global configuration must include at least one value for the smtp-server property to indicate which server(s) should be used to send the e-mail messages containing the one-time password values.
↓Parent Component
↓Properties
↓dsconfig Usage
The Email 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 | |
| ↓ email-address-attribute-type | |
| ↓ sender-address | |
| ↓ message-subject | |
| ↓ 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 name or OID of the attribute that holds the email address to which the message should be sent. |
| Default Value | mail |
| 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 e-mail address to use as the sender for the one-time password. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The subject to use for the e-mail message. |
| Default Value | Your one-time password |
| Allowed Values | A string |
| Multi-Valued | No |
| 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 Email OTP Delivery Mechanism:
dsconfig create-otp-delivery-mechanism
--mechanism-name {name}
--type email
--set enabled:{propertyValue}
--set sender-address:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing OTP Delivery Mechanism:
dsconfig delete-otp-delivery-mechanism
--mechanism-name {name}