← Back to plugin index

Flow-based Password Reset
Description
Plugin to send a link to the user to perform a password reset in a public self-service flow of the Loginapp. The email link contains a token which will be resolved by the Loginapp. It allows to initialize the correct password reset flow without the user having to enter their username.
Type name
AdminappFlowPasswordReset
Class
com.airlock.iam.admin.application.configuration.password.AdminappFlowPasswordResetConfig
May be used by
Password Token Controller
Properties
Target Flow ID (targetFlowId)
Description
Flow ID of the public self-service flow which will be used to continue the process.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Flow ID
Password Reset URL (passwordResetUrl)
Description
Absolute URL that handles password reset links. The URL should contain the following variables that will be replaced when the link is generated:
  • ${token} - the random continuation token
  • ${flowId} - the ID of the target flow to continue
  • ${language} - the correspondence language of the user (optional)
When using the IAM Loginapp UI, this should be the page for selecting a public self-service flow: https://myhost.com/auth/ui/app/self-service/select/flow/${flowId}?lang=${language}&token=${token}
Attributes
String
Mandatory
Example
https://myhost.com/auth/ui/app/self-service/select/flow/${flowId}?lang=${language}&token=${token}
Example
https://myhost.com/continue/flow/${flowId}?lang=${language}&token=${token}
Recipient Address (recipientAddress)
Description
Context-data field that contains the email address of the user to which the password reset email is sent.
Attributes
Plugin-Link
Mandatory
Assignable plugins
String Context Data Item Name
Email Service (emailService)
Description
Email service for sending emails.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Dummy Email Service SMTP Email Service
Subject Resource Key (subjectResourceKey)
Description
Resource key to select the localized template to generate the subject line. The localized template can contain context-data values as variables (e.g. ${town}).
Attributes
String
Optional
Default value
flow-password-reset.email.subject
Example
flow-password-reset.email.subject
Body Resource Key (bodyResourceKey)
Description
Resource key to select the localized template to generate the email body. The localized template can use context-data values as variables (e.g. ${town}). The template must contain the variable "${LINK}" which will be replaced by the password reset URL.
Attributes
String
Optional
Default value
flow-password-reset.email.body
Example
flow-password-reset.email.body
Repository (repository)
Description
Configures the repository to store flow continuation data, which will be restored to complete the process in the Loginapp.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Flow Continuation Database Repository
Token Validity (tokenValidity)
Description
Determines how long the generated token (and thus the link) is valid.

The duration must be specified in the format "2d 4h 10m 5s" (any part can be omitted).

Attributes
String
Optional
Default value
24h
Example
10d
Example
8h
Example
2d 12h
Send As HTML (sendAsHtml)
Description

If enabled, the password reset email will be sent as an HTML mail. Otherwise it will be sent as plain text.

Security Warning: If e-mails are sent as HTML, make sure to properly escape values originating from untrusted sources (such as user input during self-registration). This can be achieved by enabling the property 'Escape Values in HTML'.

Attributes
Boolean
Optional
Default value
false
Escape Values in HTML (escapeHtmlValues)
Description

HTML-escape all provided values if property Send As HTML is enabled.

Security Warning: If e-mails are sent as HTML, make sure to properly escape values originating from untrusted sources (such as user input during self-registration). This can be achieved by enabling the property 'Escape Values in HTML'.

Attributes
Boolean
Optional
Default value
true
String Resources File (stringResourcesFile)
Description
Specifies the prefix of the file(s) containing the language dependent string resources. Example: If the value of this property is strings, the language dependent files must be strings_de.properties, strings_en.properties, etc.
Attributes
String
Optional
Default value
strings
YAML Template (with default values) 

type: AdminappFlowPasswordReset
id: AdminappFlowPasswordReset-xxxxxx
displayName: 
comment: 
properties:
  bodyResourceKey: flow-password-reset.email.body
  emailService:
  escapeHtmlValues: true
  passwordResetUrl:
  recipientAddress:
  repository:
  sendAsHtml: false
  stringResourcesFile: strings
  subjectResourceKey: flow-password-reset.email.subject
  targetFlowId:
  tokenValidity: 24h