← Back to plugin index

Alias User Item
Description

Definition of a user alias. An alias is a special context data item that can be used as a login name in the same way as the username.

Note that by definition, all login names (i.e., aliases and usernames) must be unique across all users.

Type name
AliasDefinition
Class
com.airlock.iam.userselfreg.application.configuration.definition.AliasDefinitionConfig
May be used by
User Data Registration Step Email Verification Step Phone Number Verification Step
Properties
Context Data Name (contextDataName)
Description
The string-typed context data item in which the alias is stored.
Attributes
Plugin-Link
Mandatory
Assignable plugins
String Context Data Item Name
Required (required)
Description
Specifies whether this alias must be provided before the step validates successfully.
Attributes
Boolean
Optional
Default value
true
Validators (validators)
Description
The validators for the alias. Additionally, alias names are automatically validated against the global Username Filter Pattern (configured in the Security Settings).
Attributes
Plugin-List
Mandatory
Assignable plugins
Email Address Validator Phone Number Validator Regex String Validator
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
username, nickname, email, tel
YAML Template (with default values) 

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