PingAuthorize Server Documentation Index
Configuration Reference Home

Third Party Cipher Stream Provider

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 Cipher Stream Provider provide cipher stream provider implementations created in third-party code using the UnboundID server SDK.

Parent Component
Properties
dsconfig Usage

Parent Component

The Third Party Cipher Stream Provider component inherits from the Cipher Stream 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 Cipher Stream 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 Cipher Stream Provider is enabled for use in the PingAuthorize 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 Cipher Stream Provider.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.ds.api.CipherStreamProvider
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 Cipher Stream 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 Cipher Stream Providers:

dsconfig list-cipher-stream-providers
     [--property {propertyName}] ...

To view the configuration for an existing Cipher Stream Provider:

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

To update the configuration for an existing Cipher Stream Provider:

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

To create a new Third Party Cipher Stream Provider:

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

To delete an existing Cipher Stream Provider:

dsconfig delete-cipher-stream-provider
     --provider-name {name}