← Back to plugin index

String User Profile Item
Description
Plugin to hold a configurable user profile item of type string. This will be represented as a text input field and its value is added to the user's context data, provided that the property name matches the property name in the configured user data. A regular expression can be given to check the input, e.g. to ensure that it has the format of an email address.
Type name
StringUserProfileItem
Class
com.airlock.iam.common.application.configuration.userprofile.StringUserProfileItemConfig
May be used by
User Group Configuration Users Configuration Users Configuration Administrators Management Administrators Management
Properties
Validation Pattern (validationPattern)
Description

Pattern for validating the value of the field.

The provided regex is used in Java for server-side validation and potentially in Javascript for client-side validation. The capabilities of these regex interpreters differ. Therefore make sure to only use patterns that are equivalent in both types of interpreters.

Attributes
RegEx
Optional
Check Uniqueness (checkUniqueness)
Description

If defined, the user persister is used to check whether the value is unique by querying the corresponding user iterator plugin.

This user iterator must provide the context data value specified by this profile item.
Usually, the same plugin is used that was used to load the user data to the form this profile item is part of.

Attributes
Plugin-Link
Optional
Assignable plugins
Active Directory Connector Cipher User Persister Combining Extended User Persister Combining User Persister Database User Persister Dummy Extended User Persister LDAP Connector LDAP User Persister Property User Persister
Check Uniqueness Against Username (checkUniquenessAgainstUsername)
Description

If set to true, uniqueness is also checked against the username. The value entered by the user is not allowed to exist neither in the configured property nor as a username. This is mainly used in conjunction with a username transformer, where login is possible with an alias property in addition to the username.

This flag is only checked if checkUniqueness is configured.

Attributes
Boolean
Optional
Default value
false
Prefill (prefill)
Description
If configured, the profile item is prefilled with the provided value. This feature can be used to suggest administrators on possible values or to prefill a common value when creating a user via Adminapp UI. This property only has an effect when creating a user. Furthermore it is only allowed for mandatory items because only mandatory items are displayed in the user create dialog.
Attributes
Plugin-Link
Optional
Assignable plugins
Identity Value Provider Realm Value Provider Static String Value Provider
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: StringUserProfileItem
id: StringUserProfileItem-xxxxxx
displayName: 
comment: 
properties:
  checkUniqueness:
  checkUniquenessAgainstUsername: false
  modifiable: true
  optional: true
  prefill:
  propertyName:
  sortable: true
  stringResourceKey:
  validateOnlyChangedValues: true
  validationPattern: