Velocity Templating Language

This is an Early Access feature. To enable it, use the Early Access Feature Manager as described in Manage Early Access and Beta features.

Custom email templates use Velocity Templating Language (VTL).

VTL is different from Expression Language (EL) syntax in the following ways:

  • You can use the same macros in every template.
  • You don't need curly braces around the variable name. 
  • The format is simplified. Add a dollar sign before the variable that you want add to a template, and use dot notation for sub-objects.

For example, with EL syntax, you reference the first name of the user by using ${user.firstName}. With VTL, you use $user.profile.firstName.

For more information, see the Velocity User Guide.

Velocity macro

Type

$user.profile.login String
$user.profile.email String
$user.profile.secondEmail String
$user.profile.firstName String
$user.profile.lastName String
$user.profile.locale String
$user.profile.mobilePhone String
$user.profile.primaryPhone String
$user.profile.username String
$user.profile.fullName String
$user.profile.city String
$user.profile.state String
$user.profile.streetAddress String
$user.profile.zipCode String
$user.profile.countryCode String
$user.groups.names String
$user.group.ids String
$org.name String
$org.locale String
$org.subDomain String
$org.activationTokenExpirationHours Integer
$baseURL String
$trialEndDate String
$oktaLogoUrl String
$activationLink String
$activationToken String
$samAccountName String
$technicalContact.login String
$technicalContact.email String
$technicalContact.secondEmail String
$technicalContact.firstName String
$technicalContact.lastName String
$technicalContact.locale String
$technicalContact.fullName String
$pushVerifyActivationLink String
$androidOktaVerifyAppLink String
$iosOktaVerifyAppLink String
$registrationEmailVerificationLink String
$registrationEmailVerificationToken String
$instanceDisplayName String
$unlockAccountLink String
$recoveryLink String
$factorDisplayName String
$orgTechSupportEmail String
$unlockAccountTokenExpirationDate String
$resetPasswordLink String
$recoveryToken String
$resetPasswordTokenExpirationDate Integer
$request.date String
$request.time String
$request.location String
$request.performedBySubject String
$request.factor String
$request.factors String
$request.ipAddress String
$request.reportSuspiciousActivityToken String
$request.browser String
$verificationToken String
$emailAuthenticationLink String
$email String
$message String
$htmlListUsersContent String
$txtListUsersContent String