Get Supported OTP Delivery Mechanisms Extended Operation Handler

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.

The Get Supported OTP Delivery Mechanisms Extended Operation Handler provides a mechanism for retrieving information about the set of one-time password delivery mechanisms that are available in the server and which of those are available for use by a specified user.

One-time password delivery mechanisms can be used in conjunction with the deliver one-time password extended operation (to be used in conjunction with the UNBOUNDID-DELIVERED-OTP SASL mechanism), the deliver password reset token extended operation (to be used in conjunction with the password modify extended operation), and the deliver single-use token extended operation (to be used in conjunction with the consume single-use token extended operation).

Parent Component Properties dsconfig Usage

Parent Component

The Get Supported OTP Delivery Mechanisms Extended Operation Handler component inherits from the Extended Operation Handler

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
 description  None
 enabled

Basic Properties

description

Description
A description for this Extended Operation Handler
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 the Extended Operation Handler is enabled (that is, whether the types of extended operations are allowed in the server).
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Extended Operation Handlers:

dsconfig list-extended-operation-handlers
     [--property {propertyName}] ...

To view the configuration for an existing Extended Operation Handler:

dsconfig get-extended-operation-handler-prop
     --handler-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Extended Operation Handler:

dsconfig set-extended-operation-handler-prop
     --handler-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...