← Back to plugin index

International Phone Number User Profile Item
Description
Plugin to hold a configurable user profile item of type international phone number.

Phone numbers must be entered in international format. Phone numbers in international format start with a plus sign (+) and the country code. When parsing the phone number, punctuation and white-space as well as any text before the number is ignored (for example, a leading "Tel: "). To persist the phone number, it is formatted according to the ITU-T phone number format E.164.

This profile item 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.
Type name
InternationalPhoneNumberUserProfileItem
Class
com.airlock.iam.common.application.configuration.userprofile.InternationalPhoneNumberUserProfileItemConfig
May be used by
User Group Configuration Users Configuration Users Configuration Administrators Management Administrators Management
Properties
Validation Level (validationLevel)
Description
This property controls the level of validation that is performed.
  • Default: Full validation of a phone number in international format using length and prefix information. Verifies whether the parsed, canonicalised number is valid. It is not verified, whether a particular series of digits entered by the user can actually be dialled from the region provided. For example, the number +41 (0) 78 927 2696 can be parsed into a number with country code '41' and national significant number '789272696'. This is valid, while the original string cannot be dialled.
  • Lenient: Quickly guesses whether a number is a possible phone number by using only the length information. So, validation is performed more lenient. In particular, phone numbers that have the correct lenght but may otherwise be invalid (for example, because the carrier code is invalid) are considered valid. Phone numbers must still be in international format with valid country codes.
  • Minimal: This is the most lenient form of validation. All inputs that can be parsed to a phone number are accepted. For example, phone numbers that are otherwise considered too short or too long up (but only to a certain extent) are accepted. Phone numbers must still be in international format with valid country codes.
Attributes
Enum
Optional
Default value
DEFAULT
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: InternationalPhoneNumberUserProfileItem
id: InternationalPhoneNumberUserProfileItem-xxxxxx
displayName: 
comment: 
properties:
  modifiable: true
  optional: true
  propertyName:
  sortable: true
  stringResourceKey:
  validateOnlyChangedValues: true
  validationLevel: DEFAULT