Metrics Engine Documentation Index
Configuration Reference Home

UnboundID Certificate Plus Password SASL Mechanism Handler

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.

The UnboundID Certificate Plus Password SASL Mechanism Handler may be used to perform multifactor authentication against the Metrics Engine using both a client certificate (presented during SSL/TLS negotiation) and a static password.

Parent Component
Relations To this Component
Properties
dsconfig Usage

Parent Component

The UnboundID Certificate Plus Password SASL Mechanism Handler component inherits from the SASL Mechanism Handler

Relations from This Component

The following components have a direct aggregation relation from UnboundID Certificate Plus Password SASL Mechanism Handlers:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ certificate-mapper

Basic Properties

description

Description
A description for this SASL Mechanism 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 SASL mechanism handler is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

certificate-mapper

Description
The certificate mapper that will be used to identify the target user based on the certificate that was presented to the server.
Default Value
None
Allowed Values
The DN of any Certificate Mapper. If this UnboundID Certificate Plus Password SASL Mechanism Handler is enabled, then the associated certificate mapper must also be enabled.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured SASL Mechanism Handlers:

dsconfig list-sasl-mechanism-handlers
     [--property {propertyName}] ...

To view the configuration for an existing SASL Mechanism Handler:

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

To update the configuration for an existing SASL Mechanism Handler:

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

To create a new UnboundID Certificate Plus Password SASL Mechanism Handler:

dsconfig create-sasl-mechanism-handler
     --handler-name {name}
     --type unboundid-certificate-plus-password
     --set enabled:{propertyValue}
     --set certificate-mapper:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing SASL Mechanism Handler:

dsconfig delete-sasl-mechanism-handler
     --handler-name {name}