← Back to plugin index

List User Profile Item
Description
Plugin to hold a configurable user profile item of type list. The user can select from a list of items, which can be either strings or resource keys which will be translated to the language selected by the user. The selected value is added to the user's context data, provided that the property name matches the property name in the configured user data. If selected, the item list will be sorted before being presented to the user.
Type name
ListUserProfileItem
Class
com.airlock.iam.common.application.configuration.userprofile.ListUserProfileItemConfig
May be used by
User Group Configuration Users Configuration Users Configuration Administrators Management Administrators Management
Properties
Item List (itemList)
Description
List of items from which the user can select. Each line corresponds to one item (use Shift+Return to move to a new line). Empty lines are ignored, and all items must be unique. The items can either be simple strings that are displayed directly, or resource keys which are first translated to the selected language.
Attributes
String
Mandatory
Multi-line-text
Items Are Resource Keys (itemsAreResourceKeys)
Description
Indicates if the items are resource keys (which are translated to the language selected by the user), or strings, which will be displayed as entered.
Attributes
Boolean
Optional
Default value
false
Resource Key Prefix (resourceKeyPrefix)
Description
If the items are resource keys (i.e. keys for the language-dependent string tables), a common prefix can be defined, which will be used for looking up the keys in the string table, but will not be written into the user record. For instance, if the list are countries, they keys could be prefixed by 'countries', but only the actual country code would be saved for the user. If the items are not resource keys, this attribute is ignored.
The resulting resource key is composed from <resource key prefix>.<value>
Attributes
String
Optional
Sort Items (sortItems)
Description
Indicates if the items are sorted alphabetically when displayed. If the items are resource keys, they are first translated to the selected language and then sorted.
Attributes
Boolean
Optional
Default value
false
String Resource Key (stringResourceKey)
Description
String identifier for the language-specific string tables.
Attributes
String
Mandatory
Example
userdata.label.salutation
Example
userdata.label.firstname
Example
userdata.label.lastname
Example
userdata.label.email
Example
userdata.label.nationality
Example
userdata.label.birthdate
Example
userdata.label.street
Example
userdata.label.street-number
Example
userdata.label.address2
Example
userdata.label.zipcode
Example
userdata.label.town
Example
userdata.label.state
Example
userdata.label.country
Example
userdata.label.company
Example
userdata.label.department
Example
userdata.label.office-phone
Example
userdata.label.mobile-phone
Example
userdata.label.language
Example
userdata.label.correspondence-language
Property Name (propertyName)
Description
Name of the context-data field in which the value is stored.
Attributes
String
Mandatory
Example
surname
Example
givenname
Example
email
Example
mtan_number
Optional (optional)
Description
If this field is optional or mandatory for the user.
Attributes
Boolean
Optional
Default value
true
Modifiable (modifiable)
Description
Indicates if the user is allowed to change this property once it is set. Specifically, if this flag is set to false, then during self-registration the property could be set, but when editing the user data, this property would be read-only.
Attributes
Boolean
Optional
Default value
true
Validate Only Changed Values (validateOnlyChangedValues)
Description
If enabled, only values that have been changed by the user (compared to the data loaded from the data layer) are validated.
Attributes
Boolean
Optional
Default value
true
Sortable (sortable)
Description
If enabled, the attribute is sortable in the user list if the underlying user iterator supports sorting.
Attributes
Boolean
Optional
Default value
true
YAML Template (with default values) 

type: ListUserProfileItem
id: ListUserProfileItem-xxxxxx
displayName: 
comment: 
properties:
  itemList:
  itemsAreResourceKeys: false
  modifiable: true
  optional: true
  propertyName:
  resourceKeyPrefix:
  sortItems: false
  sortable: true
  stringResourceKey:
  validateOnlyChangedValues: true