Velocityテンプレート言語

カスタムメールテンプレートでは、Velocityテンプレート原語(VTL)が使用されます。VTLは、次の点で式言語(EL)構文とは異なります。

  • 変数名の中括弧は省略できます。ほとんどの言語で省略表記を使用できます。
  • フォーマットが単純化されています。テンプレートに追加する変数の前にドル記号を追加し、サブオブジェクトにはドット表記を使用します。
  • ほとんどの速度変数をどこででも使用できますが、一部の変数が特定のテンプレートに制限されています。詳細については、「テンプレートを利用可能な列」を参照してください。

詳細については、Velocityのユーザーガイドを参照してください。

変数

テンプレートの可用性

${user.profile.login}

すべてのテンプレートで利用可能

${user.profile.email}

すべてのテンプレートで利用可能

${user.profile.secondEmail}

すべてのテンプレートで利用可能

${user.profile.firstName}

すべてのテンプレートで利用可能

${user.profile.lastName}

すべてのテンプレートで利用可能

${user.profile.locale}

すべてのテンプレートで利用可能

${user.profile.mobilePhone}

すべてのテンプレートで利用可能

${user.profile.primaryPhone}

すべてのテンプレートで利用可能

${user.profile.username}

すべてのテンプレートで利用可能

${user.profile.fullName}

すべてのテンプレートで利用可能

${user.profile.city}

すべてのテンプレートで利用可能

${user.profile.state}

すべてのテンプレートで利用可能

${user.profile.streetAddress}

すべてのテンプレートで利用可能

${user.profile.zipCode}

すべてのテンプレートで利用可能

${user.profile.countryCode}

すべてのテンプレートで利用可能

${user.groups.names}

すべてのテンプレートで利用可能

${user.groups.ids}

すべてのテンプレートで利用可能

${app.id}

すべてのテンプレートで利用可能

${app.name}

すべてのテンプレートで利用可能

${app.label}

すべてのテンプレートで利用可能

${org.name}

すべてのテンプレートで利用可能

${org.locale}

すべてのテンプレートで利用可能

${org.subDomain}

すべてのテンプレートで利用可能

${org.activationTokenExpirationHours}

すべてのテンプレートで利用可能

${baseURL}

すべてのテンプレートで利用可能

${oktaLogoUrl}

すべてのテンプレートで利用可能

${activationLink}

以下のテンプレートで利用可能:

  • ユーザーアクティベーション

  • Active Directoryユーザーアクティベーション
  • 登録 - アクティベーション
${activationToken}

以下のテンプレートで利用可能:

  • ユーザーアクティベーション

  • Active Directoryユーザーアクティベーション
  • 登録 - アクティベーション
${samAccountName}

以下のテンプレートで利用可能:

  • Active Directoryユーザーアクティベーション

  • Active Directoryパスワードリセット

  • セルフサービスによるActive Directoryアカウントロック解除

  • Active Directoryパスワードのロック解除

  • セルフサービスによるActive Directoryアカウントロック解除

${technicalContact.login}

以下のテンプレートで利用可能:

  • ユーザーアクティベーション

  • 管理者によるパスワードリセット
${technicalContact.email}

以下のテンプレートで利用可能:

  • ユーザーアクティベーション

  • 管理者によるパスワードリセット
${technicalContact.secondEmail}

以下のテンプレートで利用可能:

  • ユーザーアクティベーション

  • 管理者によるパスワードリセット
${technicalContact.firstName}

以下のテンプレートで利用可能:

  • ユーザーアクティベーション

  • 管理者によるパスワードリセット
${technicalContact.lastName}

以下のテンプレートで利用可能:

  • ユーザーアクティベーション

  • 管理者によるパスワードリセット
${technicalContact.locale}

以下のテンプレートで利用可能:

  • ユーザーアクティベーション

  • 管理者によるパスワードリセット
${technicalContact.fullName}

「管理者によるパスワードリセット」で利用可能

${pushVerifyActivationLink}

「プッシュ認証アクティベーションリンクを送信」で利用可能

${androidOktaVerifyAppLink}

「プッシュ認証アクティベーションリンクを送信」で利用可能

${iosOktaVerifyAppLink}

「プッシュ認証アクティベーションリンクを送信」で利用可能

${registrationEmailVerificationLink}

以下のテンプレートで利用可能:

  • 登録 - メール確認

  • 登録 - アクティベーション

${registrationEmailVerificationToken}

以下のテンプレートで利用可能:

  • 登録 - メール確認

  • 登録 - アクティベーション

${instanceDisplayName}

以下のテンプレートで利用可能:

  • メール要素の検証

  • 登録 - アクティベーション

  • 登録 - メール確認

${unlockAccountLink}

以下のテンプレートで利用可能:

  • セルフサービスによるアカウントロック解除

  • セルフサービスによるActive Directoryアカウントロック解除

  • Active Directoryパスワードのロック解除

  • LDAPセルフサービスによるアカウントロック解除

  • LDAPセルフサービスによるアカウントロック解除

${recoveryLink}

以下のテンプレートで利用可能:

  • 要素をリセット

  • Active Directoryパスワードリセット

  • 要素のロック解除

${factorDisplayName}

以下のテンプレートで利用可能:

  • 要素をリセット

  • Active Directoryパスワードリセット

  • 要素のロック解除

${orgTechSupportEmail}

以下のテンプレートで利用可能:

  • 要素をリセット

  • Active Directoryパスワードリセット

  • 要素のロック解除

${unlockAccountTokenExpirationDate}

以下のテンプレートで利用可能:

  • セルフサービスによるアカウントロック解除

  • セルフサービスによるActive Directoryアカウントロック解除

  • Active Directoryパスワードのロック解除

  • LDAPセルフサービスによるアカウントロック解除

  • LDAPセルフサービスによるアカウントロック解除

${resetPasswordLink}

以下のテンプレートで利用可能:

  • パスワードを忘れた場合

  • パスワードを忘れた場合(拒否)

  • Active Directoryパスワードリセット

  • LDAPパスワードを忘れた場合

  • LDAPパスワードを忘れた場合(拒否)

  • 管理者によるパスワードリセット

${oneTimePassword}

以下のテンプレートで利用可能:

  • パスワードを忘れた場合

  • Active Directoryパスワードを忘れた場合

  • Active Directoryパスワードリセット

  • LDAPパスワードを忘れた場合

  • セルフサービスによるアカウントロック解除

  • Active Directoryセルフサービスのロック解除

  • LDAPセルフサービスによるアカウントロック解除

  • 登録 - アクティベーション

${resetPasswordTokenExpirationDate}

以下のテンプレートで利用可能:

  • パスワードを忘れた場合

  • パスワードを忘れた場合(拒否)

  • Active Directoryパスワードリセット

  • LDAPパスワードを忘れた場合

  • LDAPパスワードを忘れた場合(拒否)

${request.date}

「オーセンティケーターの登録完了」で利用可能

${request.time}

以下のテンプレート(および[Report suspicious activity(不審なアクティビティのレポート)]ボタンを備えたこれらのテンプレートのバージョン)で利用可能:

  • オーセンティケーターの登録完了

  • オーセンティケーターのリセット

  • 要素の登録完了

  • 要素のリセット

  • 新しいデバイスからのサインイン

${request.location}

「オーセンティケーターの登録完了」で利用可能

${request.performedBySubject}

「オーセンティケーターの登録完了」で利用可能

${request.factor}

「要素の登録完了」で利用可能

${request.factors}

「要素のリセット」で利用可能

${request.ipAddress}

「新しいデバイスからのサインイン」で利用可能

${request.reportSuspiciousActivityToken}

「オーセンティケーターの登録完了」で利用可能([Report suspicious activity(不審なアクティビティのレポート)]ボタン付き)

${request.browser}

「新しいデバイスからのサインイン」で利用可能

${request.relayState}

「パスワードを忘れた場合」で利用可能

${verificationLink}

「メール要素の検証」で利用可能

${verificationToken}

以下のテンプレートで利用可能:

  • メールチャレンジ

  • メール要素の検証

  • アクティブ化

  • 登録 - メール確認

  • メール変更の確認

${emailAuthenticationLink}

「メールチャレンジ」で利用可能

${email}

以下のテンプレートで利用可能:

  • メールチャレンジ

  • メール要素の検証