← Back to plugin index

Email Item Definition
Description
Item to register an email address. By default, the email address is validated by the "Email Address Validator" plugin but additional configurable validators can further restrict the allowed input values. Once validated, the email address is kept in the session to be verified and persisted later in the flow.
Type name
EmailItemDefinition
Class
com.airlock.iam.flow.shared.application.configuration.item.EmailItemDefinitionConfig
May be used by
User Data Edit Step User Data Registration Step Email Change Verification Step
Properties
Key (key)
Description
The key under which the client is expected to provide the email address.
Attributes
String
Optional
Default value
email
Required (required)
Description
Specifies whether this item is required for the step to validate successfully.
Attributes
Boolean
Optional
Default value
true
Unique (unique)
Description
Specifies whether the email address must be unique across all users.
Attributes
Boolean
Optional
Default value
true
Enable Stealth Mode (enableStealthMode)
Description
Enables stealth mode uniqueness validation. In stealth mode, uniqueness violations are not communicated to the client. Instead, the email verification step will simulate sending the email OTP and all submitted OTPs will be invalid.
Attributes
Boolean
Optional
Default value
true
Maximum Input Length (maximumInputLength)
Description
Maximum length of email addresses. 100 characters is the default IAM email database field limit. IETF accepted errata against RFC 3696 allow up to 254 characters.
Attributes
Integer
Optional
Default value
100
Initial Value Provider (initialValueProvider)
Description
Specifies how to retrieve the user's initial email address.
Attributes
Plugin-Link
Optional
Assignable plugins
Changed Email Address Provider Display Language String Provider Fallback String Value Provider Generic Session Attribute String Provider HTTP Request Cookie Value Provider HTTP Request Header Value Provider Identity Value Provider OAuth 2.0/OIDC Authorization Request Parameter Value Provider OAuth2 Access Token String Value Provider Realm String Provider Static String Value Provider String Context Data Value Provider String From Map Value Provider Template-based String Provider Ticket String Provider Transforming String Value Provider Translated String Provider User Principal Name Provider mTAN Registration Label Provider mTAN Registration Number Provider
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
email, username
Validators (validators)
Description
Validators for the email address. E.g. to restrict the email address to certain domains.

The "Email Address Validator" is automatically applied. A manual configuration is not necessary.

Attributes
Plugin-List
Optional
Assignable plugins
Email Address Validator Phone Number Validator Regex String Validator
YAML Template (with default values) 

type: EmailItemDefinition
id: EmailItemDefinition-xxxxxx
displayName: 
comment: 
properties:
  enableStealthMode: true
  initialValueProvider:
  inputPurpose:
  key: email
  maximumInputLength: 100
  required: true
  unique: true
  validators: