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 UnboundID support in order to understand the potential impact of that change.
Note: this is an abstract component that cannot be instantiated.
Password Generators are used by the password modify extended operation to construct a new password for the user.
The server allows any number of password validators to be defined. This can impose any kinds of restrictions on the characteristics of valid passwords. Therefore, it is not feasible for the server to attempt to generate a password on its own that will meet all the requirements of all the validators. The password generator makes it possible to provide custom logic for creating a new password.
↓Direct Subcomponents
↓Relations From this Component
↓Properties
↓dsconfig Usage
The following Password Generators are available in the server :
These Password Generators inherit from the properties described below.
The following components have a direct aggregation relation to Password Generators:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ java-class |
| 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 |
| 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 |
| 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 |
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}