Third Party Passphrase Provider

Third Party Passphrase Provider provide passphrase provider implementations created in third-party code using the UnboundID server SDK.

Parent Component Properties dsconfig Usage

Parent Component

The Third Party Passphrase Provider component inherits from the Passphrase Provider

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 Passphrase Provider
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 Passphrase Provider 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 Passphrase Provider.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.common.api.PassphraseProvider
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 Passphrase Provider. 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 Passphrase Providers:

dsconfig list-passphrase-providers
     [--property {propertyName}] ...

To view the configuration for an existing Passphrase Provider:

dsconfig get-passphrase-provider-prop
     --provider-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Passphrase Provider:

dsconfig set-passphrase-provider-prop
     --provider-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Third Party Passphrase Provider:

dsconfig create-passphrase-provider
     --provider-name {name}
     --type third-party
     --set enabled:{propertyValue}
     --set extension-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Passphrase Provider:

dsconfig delete-passphrase-provider
     --provider-name {name}