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 support in order to understand the potential impact of that change.
Note: this is an abstract component that cannot be instantiated.
OTP Delivery Mechanism are used to deliver one-time passwords to users for use with the UNBOUNDID-DELIVERED-OTP SASL mechanism. Delivery mechanisms should send a one-time password value to the user via some out-of-band mechanism (e.g., e-mail, SMS, voice call, etc.) rather than over LDAP.
OTP Delivery Mechanisms are triggered by a deliver one-time password extended request. See the documentation for the deliver OTP extended operation handler for more information about how this operation will be processed and how the delivery mechanism fits into the entire process.
Note that the name given to the configuration object for an OTP delivery mechanism will be the identifier that should be used to reference the delivery mechanism in deliver OTP extended requests or in the ds-auth-preferred-otp-delivery-mechanism attribute in user entries.
The following OTP Delivery Mechanisms are available in the server :
These OTP Delivery Mechanisms inherit from the properties described below.
The following components have a direct aggregation relation to OTP Delivery Mechanisms:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| enabled |
| 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 |
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 delete an existing OTP Delivery Mechanism:
dsconfig delete-otp-delivery-mechanism
--mechanism-name {name}