← Back to plugin index

Password Generator

Description

Configures the password generator facility on the user detail page.

The password generator configuration defines the length and alphabet of generated passwords.
If a password renderer is configured, the new password is printed on a "password letter". If not, it is displayed on the user detail page.

Type name
PasswordGenerator
Class
com.airlock.iam.admin.application.configuration.password.PasswordGeneratorConfig
May be used by
Properties
Generator (generator)
Description
Defines the generator plugin that produces random passwords.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Renderer (renderer)
Description

If a renderer plugin is defined, the generated password is rendered using this plugin, i.e. usually printed on a letter.

If no renderer is configured, the generated password is displayed in a pop-up dialog in the Adminapp.

Attributes
Plugin-Link
Optional
Assignable plugins
Delete Old Password Letters (deleteOldPasswordLetters)
Description

Deletes old password letters of a user from the file system when a new one is rendered. Enabling this property results in at most one rendered password letter per user.

If this property is enabled, the application must have permission to delete files from the directory.

Attributes
Boolean
Optional
Default value
true
Working Directory (workingDirectory)
Description
A writable directory used to store partially generated password letters.
If this property is defined, the password letters are not directly generated into the output directory (see other property) but they are generated into this working directory and are moved to the output directory once they are done.
This helps to solve problems with processes automatically reading the rendered password letters and reading password letters during the generation process. Make sure that the working directory and the output directory reside in the same file system (if not, the moving of the generated file will not be atomic).
The directory is either absolute or relative to the JVMs current directory.
Attributes
File/Path
Optional
Output Directory (outputDirectory)
Description
Directory in the file system to put the rendered password letters in. The directory is either absolute or relative to the JVMs current directory.

This property is not required if the renderer plugin (see separate property) does not write on the output stream (e.g. sends it somewhere else). It is required otherwise.

Note: If this property is not defined and the used renderer plugin writes on the output stream, then the result (e.g. a PDF file) is lost.

Attributes
File/Path
Optional
File Name Prefix (fileNamePrefix)
Description
Filename prefix for rendered password letter files. It is important to set this to a unique value for the kind of reports generated by this task. When this task deletes old reports, it looks at this prefix (and the user id) in order to find out what files to delete. Thus, if this prefix is the same as for other reports located in the same directory, other reports may be deleted.
Attributes
String
Optional
Default value
pwd
Suggested values
pwd, password
File Name Suffix (fileNameSuffix)
Description
Filename suffix for rendered password letters.
Attributes
String
Optional
Suggested values
.pdf, .txt
YAML Template (with default values)

type: PasswordGenerator
id: PasswordGenerator-xxxxxx
displayName: 
comment: 
properties:
  deleteOldPasswordLetters: true
  fileNamePrefix: pwd
  fileNameSuffix:
  generator:
  outputDirectory:
  renderer:
  workingDirectory: