← Back to plugin index

Password User Item
Description
Definition of a password user item.
Type name
PasswordDefinition
Class
com.airlock.iam.flow.shared.application.configuration.item.PasswordDefinitionConfig
May be used by
User Data Registration Step
Properties
Password Policy (passwordPolicy)
Description

The password policy that the password has to fulfill.

If a UI is configured, the text resource with key registration.data.page.password.requirements must describe the password policy requirements for the configured policy.

If end-to-end encryption is enabled, no policy checks are possible (i.e. the "Null Password Policy" must be used).

Attributes
Plugin-Link
Optional
Assignable plugins
Active Directory Connector Active Directory Password Policy Customizable Password Policy Null Password Policy Simple Password Policy
Required (required)
Description
Specifies whether a password must be provided for the step to validate successfully.
Attributes
Boolean
Optional
Default value
true
Password Attribute Key (passwordAttributeKey)
Description

The optional key under which this password will be available in the flow session, e.g. for identity propagation.

The value can be retrieved from the session using the "User Passwords Map" value map provider.

If no key is configured, the password will not be made available in the flow attributes, and cannot be used by identity propagators.

Important: Multiple password user items with the same value for this property might override each others passwords.

If end-to-end encryption is enabled, the plain password is not available and thus cannot be stored in the flow session.

Attributes
String
Optional
Suggested values
PASSWORD
Input Purpose (inputPurpose)
Description

The input purpose allows labeling data items using standardized values (see https://www.w3.org/TR/WCAG22/#input-purposes).

It is rendered using the HTML attribute "autocomplete". Browsers can use this to automatically fill input fields with data that was previously entered in other fields with the same purpose.

Note that the input purpose provided here will be used in the default Loginapp UI components and is available to custom single-page applications via the REST endpoints */info/retrieve.

If the Loginapp UI is used with configuration-based 'Customized Step UIs', the input purpose has to be defined on the UI elements ('Input UI Element', 'Drop-Down UI Element', 'Date UI Element').

Attributes
String
Optional
Suggested values
new-password, current-password
YAML Template (with default values) 

type: PasswordDefinition
id: PasswordDefinition-xxxxxx
displayName: 
comment: 
properties:
  inputPurpose:
  passwordAttributeKey:
  passwordPolicy:
  required: true