Invitation template types
Parameter |
Description |
Example value |
Template name |
input box |
template name |
Description |
input box |
description for better recognizing the template in the onboarding process |
Onboard type |
options:
|
EXT |
Enrollment type |
options:
|
SELF |
Require email address within onboarding |
The checkbox for managing the collecting of contact details neccessary for successful invitation. The behaviour is partially driven by the type of enrollment (see above):
|
|
Require phone number within onboarding |
The checkbox for managing the collecting of contact details neccessary for successful invitation. The behaviour is partially driven by the type of enrollment (see above):
|
|
Authentication type |
options:
|
OTP |
OTP Address type |
options for the OTP code receive within the onboarding process
|
SMS |
Request expiration hours |
Validity of the invitation ticket (in hours). After this time the invitation ticket wil be expired and user will lose the opportunity make onboarding process. |
24 |
Set password |
Checkbox - whether to create password within the onboarding process or not - in case of passwordless approach the password creation is not needed |
- |
External resource |
LDAP resource where the users will be created at within the onboarding process - available resources are defined within the Admin console and the Resources feature. |
defined resource |
Organization unit |
The optional specification of the AD OU attribute |
- |
Maximum validity if the invitation in days |
Validity of the onboading itself (in days). Validity of the identity of onboarded user will be expired - after this period user won't be able to access the ANT ID system. |
365 (for a year) |
Allow adjustments if the maximum validity of the invitation in days |
Possibility to edit validity within the creation of the invitation. |
- |
Username mask |
mask for the user name - will be displayed as a placeholder on the invitation form.
|
ext-demo-pk |
Username regex |
regular expression for the mask value (has to start with ^ and end with $ |
^ext-demo-[a-zA-Z]{2}$ |
Upn domain |
LDAP domain |
company_name |
Upn type |
User principal name (AD attribute) - must be unique within LDAP resource structure. Options:
|
USERNAME |
Upn display |
Approach for the display of the UPN on the invitation form, options:
|
HIDDEN |
Cn type |
Common name (AD attribute) - must be unique within LDAP resource structure. Options:
|
USERNAME |
Cn display |
Approach for the display of the CN on the invitation form, options:
|
HIDDEN |
Can add groups |
future attribute |
- |
Can create group |
future attribute |
- |
Can choose groups |
future attribute |
- |
Display invitation detail |
The additional information - Display name - will be displayed on the invitation form (form will be simplyfied) |
- |
Parameter |
Description |
Example value |
Template name |
input box |
template name |
Description |
input box |
description for better recognizing the template in the onboarding process |
Onboard type |
options:
|
LDAP |
Enrollment type |
options:
|
SELF |
Require email address within onboarding |
The checkbox for managing the collecting of contact details neccessary for successful invitation. The behaviour is partially driven by the type of enrollment (see above):
|
|
Require phone number within onboarding |
The checkbox for managing the collecting of contact details neccessary for successful invitation. The behaviour is partially driven by the type of enrollment (see above):
|
|
Authentication type |
options:
|
OTP |
OTP Address type |
options for the OTP code receive within the onboarding process
|
SMS |
External resource |
LDAP resource where the users are created (to obtain stored information necessary for the onboarding process) |
defined resource |