Verify データベースアクションスクリプトとテンプレート

Verify スクリプトは、ユーザーが Auth0 の確認メール内のリンクをたどったときに実行されます。

Verify スクリプトは、外部データベース内でユーザーのメールアドレスのステータスを更新するために実行される関数を実装します。この関数名は verify にすることを推奨します。

このスクリプトはレガシー認証のシナリオでのみ使用され、ユーザーのメールアドレス確認をサポートするために必要です。確認済みメールアドレスは Auth0 のさまざまなワークフローシナリオで重要であり、このスクリプトを実装することで、これらを標準でサポートできるようになります。

有効になっている場合、このスクリプトは、ユーザーが Auth0 から送信された確認メール内のリンクをクリックしたときに実行されます。

​

Verify 関数

verify 関数は、次の処理を行う必要があります。

• 外部データベース内のユーザーのプロファイルにある email_verified (または同等の) 属性を更新する。
• 更新処理が成功した場合は true を返す。
• 更新処理が失敗した場合はエラーを返す。

​

定義

verify関数は2つのパラメータを受け取り、コールバック関数を返します。

verify(email, callback): function

パラメータ	型	説明
email	String	ユーザーのメールアドレス。
callback	Function	エラーまたはプロファイルデータをパイプライン経由で渡すために使用します。

これは、login関数の実装方法を示す疑似JavaScriptの例です：

function verify(email, callback) {
  // 外部データベースAPIにメールを送信する
  let options = {
    url: "https://example.com/api/verify",
    body: {
      email: email
    }
  };

  send(options, (err) => {
    // 更新に失敗した場合はコールバックでエラーを返す
    if (err) {
      return callback(new Error(email, "My custom error message."));
    } else {
      // 更新に成功した場合はコールバックでtrueを返す
      return callback(null, true);
    }
  });
}

​

コールバック関数

callback関数は、ユーザープロファイルデータやエラーデータをパイプライン内で受け渡すために使用されます。

​

定義

コールバック関数は、最大 2 つのパラメータを受け取り、関数を返します。

callback(error, [verified]): function

パラメータ	型	必須	説明
error	オブジェクト	必須	エラーデータが含まれます。
verified	Boolean	任意	外部データベースにおけるユーザーのステータスを表す値 (true または false) が含まれます。true の場合にのみ必要です。

​

成功を返す

外部データベースでユーザーのステータスが正常に更新された場合は、error パラメータに null を、verified パラメータに true を渡します。

callback(null, true);

Verify スクリプトは、callback 関数でどのような値が返されても、ユーザーの Auth0 プロファイル内の email_verified 属性の値を変更しません。

ユーザーの Auth0 プロファイル内の email_verified 属性を更新するには、Login スクリプトと Get User スクリプトで返されるユーザープロファイルオブジェクトに、email_verified 属性とその値を含める必要があります。

​

エラーを返す

エラーが発生した場合、errorパラメータには何が問題だったのかを示す関連情報を含める必要があります：

return callback(new Error("My custom error message."));

​

言語別のスクリプト例

Auth0 は、以下の言語／テクノロジー向けのサンプルスクリプトを提供しています。

JavaScript

function verify(email, callback) {
  // このスクリプトは、現在のユーザーのメールアドレスを
  // データベース内で確認済みとしてマークするべきです。
  // ユーザーがメールで送信された確認リンクをクリックするたびに実行されます。
  // これらのメールは https://manage.auth0.com/#/emails でカスタマイズできます。
  // 確認メールは有効になっている場合、サインアップ成功直後に送信されるため、
  // ユーザーのメールアドレスがすでにデータベースに存在すると仮定して問題ありません。
  //
  // このスクリプトは次の2通りの方法で終了します:
  // 1. ユーザーのメールアドレスが正常に確認された場合
  //     callback(null, true);
  // 2. データベースにアクセスする際に何か問題が発生した場合:
  //     callback(new Error("my error message"));
  //
  // エラーが返されると、確認リンクをクリックした後にユーザーがリダイレクトされるページの
  // クエリ文字列にそのエラーが渡されます。
  // 例えば、`callback(new Error("error"))` を返して
  // https://example.com にリダイレクトすると、次の URL にリダイレクトされます:
  //     https://example.com?email=alice%40example.com&message=error&success=false
  const msg = 'Please implement the Verify script for this database connection ' +
    'at https://manage.auth0.com/#/connections/database';
  return callback(new Error(msg));
}