Identity Data Store Documentation Index
Configuration Reference Home

Scripted Password Generator

Note: this is an abstract component that cannot be instantiated.

Scripted Password Generator provide password generator implementations defined in a dynamically-loaded script which implements the ScriptedPasswordGenerator class defined in the UnboundID server SDK.

↓Direct Subcomponents
↓Parent Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Scripted Password Generators are available in the server :

These Scripted Password Generators inherit from the properties described below.

Parent Component

The Scripted Password Generator component inherits from the Password Generator

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ java-class
↓ script-argument

Basic Properties

description

Description
A description for this Password Generator
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 Password Generator 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

java-class (Read-Only)

Description
Specifies the fully-qualified name of the Java class that provides the Password Generator implementation.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.PasswordGenerator
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

script-argument

Description
The set of arguments used to customize the behavior for the Scripted Password Generator. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
An argument in the form 'name=value'. Argument names are allowed to contain only ASCII alphabetic characters, numeric digits, dashes, and underscores.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Password Generators:

dsconfig list-password-generators
     [--property {propertyName}] ...

To view the configuration for an existing Password Generator:

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

To update the configuration for an existing Password Generator:

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

To delete an existing Password Generator:

dsconfig delete-password-generator
     --generator-name {name}