メールテンプレートの説明

Auth0で使用されるメールテンプレートについて説明します。

​

確認メール

［Verification Email（確認メール）］ をオンにするとデータベース接続にサインアップするユーザーにメールアドレスが正しいかどうかをたずねる確認メッセージが送られてくるので、メッセージに含まれるURLをクリックしてください。

すべてのメールテンプレートで利用できる共通変数のほかに、 ［Verification Email（確認メール）］ には、ユーザーがクリックしなければならないURLを指すurl変数もあります。これを ［Message（メッセージ）］ フィールドで使用し、ユーザーが従うことができるリンクを作成します。

​

確認メールテンプレートのリダイレクト先の結果

メール確認操作を試行した後に、 Redirect To（リダイレクト先） URLをユーザーに送信するよう構成することができます。デフォルトでは、Auth0には以下のパラメーターが含まれます。

• success（trueまたはfalseの値を持つ）はメール確認が正常に行われたかどうかを示します。

• message（結果に関する追加説明付き）。取り得る値は次のとおりです。

  • Your email was verified.You can continue using the application.（success=trueを含む）
  • This URL can be used only once（success=falseを含む）
  • Access expired.（success=falseを含む）
  • User account does not exist or verification code is invalid.（success=falseを含む）
  • This account is already verified.またはYour email address could not be verified.（success=falseを含む）

一部のエラーは、ユーザーをURLへリダイレクトする代わりに、一般的なエラーページへ送ります。

Management APIでメールテンプレートを更新すると、リダイレクトリンクでメールアドレスを送信するのを防ぐことができます。例：

PATCH /api/v2/email-templates/reset_email
{
"includeEmailInRedirect": false
}`または

PATCH /api/v2/email-templates/verify_email
{
"includeEmailInRedirect": false
}

他に考えられるメッセージを適切に処理するために、ターゲットURLハンドラーも準備しておく必要があります。

​

ウェルカムメール

ユーザーがメールアドレスを確認すると、 ウェルカムメール が送られてきます。 確認メール 機能をオフにすると、 ウェルカムメール がユーザーのサインアップ時（または初回ログイン時）にユーザーに送られます。

すべてのメールテンプレートで利用できる共通変数のほかに、 Welcome（ようこそ） テンプレートでは以下の変数も利用することができます。

• ユーザーがOrganization（組織）からログインした場合：

  • organization.id
  • organization.display_name
  • organization.name
  • organization.metadata
  • organization.branding.logo_url
  • organization.branding.colors.primary
  • organization.branding.colors.page_background

​

パスワード変更メール

ユーザーがパスワードの変更を要求すると、URLリンクを含んだ Change Password（パスワードの変更） メールが送られてきます。ユーザーがそのリンクをクリックすると、新しいパスワードを入力するためのパスワードリセットページが表示されます。

すべてのメールテンプレートで利用できる共通変数のほかに、 User Invitation（ユーザー招待） テンプレートでは以下の変数も利用することができます。

• url：URLパスワードを変更するためにユーザーが選択します。これを ［Message（メッセージ）］ フィールドで使用し、次の例に示すように、ユーザーが従うことができるリンクを作成することができます。 <a href="/ja-jp/{{ url }}">Click here to change your password</a>

• ユーザーがOrganization（組織）からログインした場合：

  • organization.id
  • organization.display_name
  • organization.name
  • organization.metadata
  • organization.branding.logo_url
  • organization.branding.colors.primary
  • organization.branding.colors.page_background

​

パスワード変更テンプレートのリダイレクト先の結果

パスワード変更操作を試行した後に、 Redirect To（リダイレクト先） URLをユーザーに送信するよう構成することができます。デフォルトでは、Auth0には以下のパラメーターが含まれます。

• success（trueまたはfalseの値を持つ）はパスワード変更が正常に行われたかどうかを示します。

• message（結果に関する追加説明付き）。取り得る値は次のとおりです。

  • You can now login to the application with the new password.（success=trueを含む）
  • This URL can be used only once（success=falseを含む）
  • Access expired.（success=falseを含む）
  • The operation cannot be completed.Please try again.（success=falseを含む）

他に考えられるメッセージを適切に処理するために、ターゲットURLハンドラーも準備しておく必要があります。

一部のエラーは、ユーザーをURLへリダイレクトする代わりに、一般的なエラーページへ送ります。

​

ブロックされたアカウントメール

ユーザーが同じIPアドレスから10回以上ログインに失敗した場合、ユーザーアカウントはロックされ、 Blocked Account（ブロックされたアカウント） メールが送られてきます。このメールを受け取ったら、メールに含まれるリンクをクリックしないと、そのIPアドレスからログインし直すことはできません。

10回ログインに失敗する前にログインに成功すると、カウントがリセットされます。

すべてのメールテンプレートで利用できる共通変数のほかに、 Blocked Account Email（ブロックされたアカウントメール） テンプレートでは以下の変数も利用することができます。

• user.source_ip

• user.city

• user.country

• ユーザーがOrganization（組織）からログインした場合：

  • organization.id
  • organization.display_name
  • organization.name
  • organization.metadata
  • organization.branding.logo_url
  • organization.branding.colors.primary
  • organization.branding.colors.page_background

このテンプレートには、ユーザーが従う必要があるリンクを作成するのに使用するurl変数もあります。例：

<a href="/ja-jp/{{ url }}">Click here to unblock your account</a>

​

ブロックされたアカウントメールテンプレートのリダイレクト先の結果

アカウントのブロック解除操作を試行した後に、 Redirect To（リダイレクト先） URLをユーザーに送信するよう構成することができます。リダイレクト時に、Auth0には以下のパラメーターが含まれます。

• emailはユーザーのメールを示します。

• success（trueまたはfalseの値を持つ）はアカウントのブロック解除が正常に行われたかどうかを示します。

• message（結果に関する追加説明付き）。取り得る値は次のとおりです。

  • Your account has been unblocked.（success=trueを含む）
  • This URL can be used only once（success=falseを含む）
  • Access expired.（success=falseを含む）

他に考えられるメッセージを適切に処理するために、ターゲットURLハンドラーも準備しておく必要があります。

​

侵害されたパスワードのアラートメール

サードパーティーによって漏洩したパスワードを使ってアプリケーションにアクセスしようとしていることがAuth0で検出されると、このメールタイプが必ず送られてきます。このタイプのメールは、Dashboardの攻撃防御セクションの ［Breached Password Detection（侵害されたパスワードの検出）］ を有効にした後でのみ設定されます。詳細については、「侵害されたパスワードの検出」を参照してください。

すべてのメールテンプレートで利用できる共通変数のほかに、 侵害されたパスワード（侵害されたパスワードのアラート） メールでは以下の変数も利用することができます。

• ユーザーがOrganization（組織）からログインした場合：

  • organization.id
  • organization.display_name
  • organization.name
  • organization.metadata
  • organization.branding.logo_url
  • organization.branding.colors.primary
  • organization.branding.colors.page_background

​

MFAの登録メール

このメールは、MFA登録招待が送信されるときに生成されます。このメッセージにはリンクが含まれており、リンクにアクセスすると、MFA登録エクスペリエンスが表示されます。

すべてのメールテンプレートで利用できる共通変数のほかに、link変数はこのメールタイプで利用することができ、以下の例に示すように、この操作のためのリンク構築に使用するURLが含まれています。

<a href="/ja-jp/{{ link }}">Enroll your MFA device</a>

他のメールテンプレートとは異なり、正しい変数名はlinkであり、urlではありません。また、このメールテンプレートタイプでは、connection.name変数を使用することはできません。

​

MFAの確認コードメール

このメールは、メールをMFA方式に使用し、確認コードを送信するよう要求するときに生成されます。共通変数のほかに、テンプレートではMFA確認用に使用されるコードを表示するためのcode変数も用意されています。例：

<div>Your code is:{{ code }}</div>

​

ユーザー招待メール

ユーザーがOrganization（組織）のメンバーになるよう招待されると、URLリンクを含んだ User Invitation（ユーザー招待） メールが送られてきます。リンクをクリックすると、デフォルトのログインルートにリダイレクトされます。詳細については、「デフォルトのログインルートを設定する」を参照してください。

ユーザーが招待を受け入れると、そのメールアドレスに検証済みのマークが付きます。

ユーザーがフェデレーションログインを通して招待を受け入れた場合、IDプロバイダーが返すメールアドレスは、招待の送信先メールアドレスと一致しなければなりません。メール検証は、後続のログイン時にIDプロバイダーが返した値でオーバライドされません。

期限までにユーザーが招待を受け入れなかった場合は、招待に期限切れのマークが付き、いずれAuth0 Dashboardから削除されます。

すべてのメールテンプレートで利用できる共通変数のほかに、 User Invitation（ユーザー招待） テンプレートでは以下の変数も利用することができます。

• ユーザー招待情報（すべての情報をユーザー招待チケットから取得）

  • inviter.name
  • app_metada
  • user_metadata
  • roles.id
  • roles.name
  • roles.description

• 組織情報：

  • organization.id
  • organization.display_name
  • organization.name
  • organization.metadata
  • organization.branding.logo_url
  • organization.branding.colors.primary
  • organization.branding.colors.page_background

メールをローカライズするには、招待状の作成時にuser_metadataで送信されるlocaleを設定することができます。詳細については、「メールテンプレートをカスタマイズする：多言語のメールテンプレート:」を参照してください。

​

ユーザー招待テンプレートのリダイレクト結果

デフォルトのログインルートを設定しなければなりません。リンクを選択すると、ユーザーはこのルートに送られ、招待を受け入れます。リダイレクト時に、Auth0には以下のパラメーターが含まれます。

• invitation：招待チケットのID
• organization：ユーザーが招待されている組織のID
• organization_name：ユーザーが招待されている組織の名前

たとえば、組織対応のアプリケーションで ［Application Login URI（アプリケーションログインURI）］ がhttps://myapp.com/loginに設定されている場合、エンドユーザーが受け取る招待メールには、以下のリンクが含まれます。https://myapp.com/login?invitation={invitation_ticket_id}&organization={organization_id}&organization_name={organization_name}

対象のログインルートは、用意されたinvitationとorganizationのキー値ペアを含んだ/authorizeへのトランザクションを開始します。また、他に考えられるメッセージを適切に処理するための準備もしておく必要があります。

​

パスワードレスメール

これまでのメールテンプレートタイプとは異なり、このメールテンプレートは「Email Templates（メールテンプレート）」セクションでは構成されておらず、メールのパスワードレス接続の設定の一部となっています。

パスワードレスメールは、パスワードレスアクセスが要求されたときに、コード（アプリケーションに入力されたコードをユーザーに送られてくる）かリンク（リンクをクリックするとユーザーがアプリケーションに直接移動する）のいずれかの方法で送信されます。

すべてのテンプレートで利用できる共通変数のほかに、 Passwordless Email（パスワードレスメール） テンプレート用に特別に定義された以下の変数も使用することができます。

• send：要求されたパスワードレスメールのタイプに応じて、link、link_ios、link_android、またはcodeの値が含まれます。
• code：アプリケーションにアクセスするための1回限りの使用コードが含まれます。
• link：このリンクをクリックすると、ユーザーはアプリケーションにアクセスすることができます（リンクタイプのパスワードレスメール専用）。
• operation：これがパスワードレスメールの変更操作である場合は、change_emailになります。

デフォルトのテンプレートでは、上記の変数を使って、以下のような操作を行います。

<!-- Email change content -->
{% if operation == 'change_email' %}
  <p>Your email address has been updated.</p>
{% else %}
  <!-- Signup email content -->
  {% if send == 'link' or send == 'link_ios' or send == 'link_android' %}
    <p>Click and confirm that you want to sign in to {{ application.name }}. This link will expire in five minutes.</p>
    <a href="/ja-jp/{{ link }}">Sign in to {{ application.name }}</a>
    {% elsif send == 'code' %}
    <p>Your verification code is: <b>{{ code }}</b></p>
  {% endif %}
{% endif %}

Passwordless Email（パスワードレスメール）テンプレートでは、userオブジェクトのemailプロパティのみを使用できます。

​

もっと詳しく

• メールテンプレートをカスタマイズする
• メールのハンドリングをカスタマイズする
• アカウントのブロック通知メールをカスタマイズする