ユーザー削除データベースアクションスクリプトとテンプレート

Deleteスクリプトは、外部ユーザーストアから指定したユーザーを削除する必要があるときに実行され、同じ操作でAuth0からもユーザーを削除する場合に必要です。

Deleteスクリプトでは、外部データベースから指定したユーザーを削除するための関数を実装します。この関数名は deleteUser にすることを推奨します。

このスクリプトは、レガシー認証のシナリオでのみ使用され、Auth0 と外部データベースの両方から同じ操作でユーザーを削除する場合に必要です。

​

DeleteUser 関数

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

• 指定されたユーザーを外部データベースから削除すること。
• 削除に成功した場合は null を返すこと。
• 削除に失敗した場合はエラーを返すこと。

​

定義

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

deleteUser(id, callback): function

パラメータ	型	説明
id	String	ユーザーのアイデンティティ user_id。auth0 で始まりません。
callback	Function	パイプラインを通じてエラーまたはプロファイルデータを渡すために使用します。

これは、deleteUser 関数の実装方法を示す擬似的な JavaScript の例です：

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

  send(options, (err, profileData) => {
    // 削除に失敗した場合はコールバックでエラーを返す
    if (err) {
      return callback(new Error("My custom error message."));
    }

    // 削除に成功した場合はコールバックでnull値を返す
    return callback(null);
  });
}

​

コールバック関数

callback コールバック関数は 1 つの引数を受け取り、関数を返します。

​

定義

callback(error): function

パラメーター	型	必須	説明
error	オブジェクト	必須	エラーに関するデータを含みます。

​

成功を返す

ユーザーが外部データベースで正常に削除された場合は、callback コールバック関数を返し、error パラメータには null を渡します：

return callback(null);

​

エラーを返す

エラーが発生した場合は、callback コールバック関数を返し、error パラメータに関連するエラー情報を渡します：

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

​

言語別のスクリプト例

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

JavaScript

function remove (id, callback) {
  // このスクリプトは、既存のデータベースからユーザーを削除します。
  // Management APIまたはAuth0 Dashboardからユーザーが削除されるたびに実行されます。
  //
  // このスクリプトの完了方法は2通りあります。
  // 1. ユーザーが正常に削除された場合:
  //     callback(null);
  // 2. データベースへの接続中に問題が発生した場合:
  //     callback(new Error("my error message"));
  var msg = "Please implement the Delete script for this database " +
       "connection at https://manage.auth0.com/#/connections/database";
  return callback(new Error(msg));
}