Synchronization Server Documentation Index
Configuration Reference Home

Third Party Key Manager Provider

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.

Third Party Key Manager Provider provide key manager provider implementations created in third-party code using the UnboundID server SDK.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Third Party Key Manager Provider component inherits from the Key Manager 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 Key Manager 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 the Key Manager Provider 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

extension-class (Read-Only)

Description
The fully-qualified name of the Java class providing the logic for the Third Party Key Manager Provider.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.common.api.KeyManagerProvider
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 Key Manager 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 Key Manager Providers:

dsconfig list-key-manager-providers
     [--property {propertyName}] ...

To view the configuration for an existing Key Manager Provider:

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

To update the configuration for an existing Key Manager Provider:

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

To create a new Third Party Key Manager Provider:

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

To delete an existing Key Manager Provider:

dsconfig delete-key-manager-provider
     --provider-name {name}