← Back to plugin index

String User Context Data Item
Description
User context data item that stores a string value. This plugin must not be used for aliases.
Type name
StringContextDataItemDefinition
Class
com.airlock.iam.flow.shared.application.configuration.item.StringContextDataItemDefinitionConfig
May be used by
User Data Edit Step User Data Registration Step Email Verification Step User Identification By Data Step (Public Self-Service) Phone Number Verification Step User Self-Registration Flow User Identification By Data Step
Properties
Context Data Name (contextDataName)
Description
The context data item in the context data.
Attributes
Plugin-Link
Mandatory
Assignable plugins
String Context Data Item Name
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
name, honorific-prefix, given-name, additional-name, family-name, honorific-suffix, nickname, organization-title, username, new-password, current-password, organization, street-address, address-line1, address-line2, address-line3, address-level4, address-level3, address-level2, address-level1, country, country-name, postal-code, cc-name, cc-given-name, cc-additional-name, cc-family-name, cc-number, cc-exp, cc-exp-month, cc-exp-year, cc-csc, cc-type, transaction-currency, transaction-amount, language, bday, bday-day, bday-month, bday-year, sex, url, photo, tel, tel-country-code, tel-national, tel-area-code, tel-local, tel-local-prefix, tel-local-suffix, tel-extension, email, impp
Required (required)
Description
Specifies whether this context data item is required for the step to validate successfully.
Attributes
Boolean
Optional
Default value
true
Validators (validators)
Description
The validators for this context data item.
Attributes
Plugin-List
Optional
Assignable plugins
Email Address Validator Phone Number Validator Regex String Validator
YAML Template (with default values) 

type: StringContextDataItemDefinition
id: StringContextDataItemDefinition-xxxxxx
displayName: 
comment: 
properties:
  contextDataName:
  inputPurpose:
  required: true
  validators: