Third Party OTP Delivery Mechanism

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.

Third Party OTP Delivery Mechanism provide one-time password delivery mechanism implementations created in third-party code using the UnboundID Server SDK.

Parent Component Properties dsconfig Usage

Parent Component

The Third Party OTP Delivery Mechanism component inherits from the OTP Delivery Mechanism

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
 description  None
 enabled
 extension-class
 extension-argument

Basic Properties

description

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

enabled

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

extension-class (Read-Only)

Description
The fully-qualified name of the Java class providing the logic for the Third Party OTP Delivery Mechanism.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.ds.api.OneTimePasswordDeliveryMechanism
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

extension-argument

Description
The set of arguments used to customize the behavior for the Third Party OTP Delivery Mechanism. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

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 Third Party OTP Delivery Mechanism:

dsconfig create-otp-delivery-mechanism
     --mechanism-name {name}
     --type third-party
     --set enabled:{propertyValue}
     --set extension-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing OTP Delivery Mechanism:

dsconfig delete-otp-delivery-mechanism
     --mechanism-name {name}