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

Get User スクリプトは、Auth0 がユーザーの存在状況を確認する必要があるときに実行されます。

Get User スクリプトは、ユーザーの存在状況を確認する際に実行される関数を実装します。この関数には getUser という名前を付けることをお勧めします。

このスクリプトは、Auth0 への自動移行に必要です。また、移行が有効でない場合は、接続に設定された操作に応じて必要になることがあります。Auth0 では、重複ユーザーの作成を避けるため、返されるユーザープロファイルに永続的な user_id を設定することを推奨します。

Import Users to Auth0 が有効な場合、ユーザーがサインアップを試みると、外部ユーザーストアにそのユーザーがすでに存在するかどうかを確認するために Get User スクリプトが実行されます。

ユーザーが以下を試みる場合も、Get User スクリプトが実行されます。

• メールアドレスを変更する (Change Email スクリプト)
• ログインする (Login スクリプト)
• パスワードを変更する (Change Password スクリプト)

Import Users to Auth0 が無効な場合も、ユーザーがサインアップを試みると、外部ユーザーストアにそのユーザーがすでに存在するかどうかを確認するために Get User スクリプトが実行されます。ユーザーがすでに外部ユーザーストアに存在する場合、Create スクリプトは実行されません。

ユーザーが以下を試みる場合も、Get User スクリプトが実行されます。

• サインアップする  (Create スクリプト)
• メールアドレスを変更する  (Change Email スクリプト)
• パスワードを変更またはリセットする  (Change Password スクリプト)

​

Get User 関数

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

• ユーザーの識別子を外部データベースの API に送信する。
• ユーザーが見つかった場合は、そのユーザーのプロファイルデータを返す。
• ユーザーが存在するかどうかの判定時に問題が発生した場合は、エラーを返す。

​

定義

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

getUser(email, callback): function

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

これは、getUser 関数の実装方法を示した擬似Javascriptの例です。

function getUser(email, callback) {
  // 外部データベースAPIにユーザー識別子を送信する
  let options = {
    url: "https://example.com/api/search-users",
    body: {
      email: email
    }
  };

  send(options, (err, profileData) => {
    // ユーザーの検索中に問題が発生した場合、コールバックでエラーを返す
    if (err) {
      return callback(new Error("Could not determine if user exists or not."));
    } else {
      // ユーザーが見つからなかった場合はコールバックでnullを返し、見つかった場合はプロファイルデータを返す
      if (!profileData) {
        return callback(null);
      } else {
        let profile = {
          email: profileData.email,
          user_id: profileData.userId
        };

        return callback(null, profile);
      }
    }
  });
}

​

コールバック関数

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

​

定義

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

callback(error[,profile]): function

パラメータ	型	必須	説明
error	オブジェクト	必須	エラーデータが含まれます。
profile	オブジェクト	任意	ユーザーのプロファイルデータが含まれます。

​

ユーザープロファイルを返す (ユーザーが見つかった場合)

ユーザーについて Get User スクリプトが返すプロファイルデータは、Login スクリプトが返すプロファイルデータと一致している必要があります。

ユーザーが見つかった場合は、error パラメータに null を渡し、profile パラメータには正規化された形式のユーザーのプロファイルデータを渡します。

return callback(null, {
    username: "username",
    user_id: "my-custom-db|[e-mail]",
    email: "[e-mail]",
    email_verified: false,
    user_metadata: {
        language: "en"
    },
    app_metadata: {
        plan: "full"
    },
    mfa_factors: [
      {
        phone: {
          value: "[phone]"
        }
      },
    ]
});

標準フィールドに加えて、user_metadata、app_metadata、mfa_factors フィールドを含めることもできます。

​

ユーザープロファイルを返さない (ユーザーが見つからない場合)

ユーザーが見つからない場合は、error パラメータには null を渡し、profile パラメータは省略します：

return callback(null);

​

エラーを返す

エラーが発生した場合は、問題の内容がわかる関連情報とともに、エラーデータを error パラメータに渡します。

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

詳しくは、カスタムデータベースのトラブルシューティングを参照してください。

​

言語別のスクリプト例

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

Javascript

function getByEmail(email, callback) {
  // このスクリプトは、ユーザーを認証せずに既存のデータベースから
  // ユーザープロファイルを取得する必要があります。
  // 認証を必要としないフロー（サインアップおよびパスワードリセット）を実行する前に、
  // ユーザーが存在するかどうかを確認するために使用されます。
  //
  // このスクリプトは、次の3通りの方法で終了します。
  // 1. ユーザーが正常に見つかった場合。プロファイルは次の形式にする必要があります。
  // https://auth0.com/docs/users/normalized/auth0/normalized-user-profile-schema.
  //     callback(null, profile);
  // 2. ユーザーが見つからなかった場合
  //     callback(null);
  // 3. データベースへの接続を試みる際に問題が発生した場合：
  //     callback(new Error("my error message"));
  const msg = 'Please implement the Get User script for this database connection ' +
    'at https://manage.auth0.com/#/connections/database';
  return callback(new Error(msg));
}