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

Create スクリプトは、ユーザーが Universal Login からサインアップしたとき、または Auth0 Dashboard か Management API を通じてユーザーを作成したときに実行されます。

Create スクリプトでは、ユーザー作成時に呼び出される定義済み関数を実装します。この関数名は create にすることを推奨します。

このスクリプトは任意です。有効にすると、ユーザーが Universal Login からサインアップした場合、または Auth0 Dashboard か Auth0 Management API を通じて作成された場合に、Auth0 は外部データベース内に対応するユーザーレコードを作成するため、このスクリプトを実行します。

Auth0 でユーザーが作成されると、Auth0 は一連のスクリプトを呼び出します。

1. Get User: ユーザーが Auth0 または外部データベースにまだ存在しないことを確認します。
2. Create: 外部データベースにユーザーを作成します。
3. Login: ユーザーが正常に作成されたことを確認します。

​

Create 関数

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

• ユーザーのユーザープロファイルデータを外部データベースのAPIに送信する。
• ユーザーの作成処理が失敗した場合は、エラーを返す。

​

定義

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

create(user, callback): function

パラメータ	説明
user	オブジェクト。ユーザー作成プロセスから取得したユーザープロファイルデータが含まれます。
callback	関数。パイプラインを通じてエラー情報を渡すために使用します。

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

function create(user, callback) {
  // ユーザープロファイルデータを外部データベースAPIに送信する
  let hashedPassword = hash(user.password);

  let options = {
    url: "https://example.com/api/create",
    body: {
      email: user.email,
      username: user.username,
      password: hashedPassword
    }
  };

  send(options, err => {
    // ユーザーがすでに存在する場合はコールバックでエラーを返す
    if (err && err.id === "USER_ALREADY_EXISTS") {
      return callback(new ValidationError("user_exists", "My custom error message."));
    } else if (err) {
      // エラーが発生した場合はコールバックでエラーを返す
      return callback(new Error("My custom error message."));
    }

    // ユーザー作成が成功した場合はコールバックで`null`を返す
    return callback(null);
  });
}

​

暗号化

データ漏洩のリスクを防ぐため、bcrypt などの暗号学的ハッシュライブラリを使用してパスワード値をハッシュ化します。暗号化されていないパスワード認証情報をログに記録、保存、転送しないでください。

例:

bcrypt.hash(password, 10, function (err, hash) {
    if (err) {
        return callback(err);
    } else {
        // ハッシュ化されたパスワードを返す
    }
});

​

コールバック関数

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

​

定義

callback(error): function

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

​

ValidationError 型オブジェクト

ValidationError カスタムエラー型オブジェクトを使用すると、テナントログに表示されるデータを渡すことができます。

ValidationError コンストラクタは、最大 2 つのパラメータを受け取ります。

new ValidationError(errorCode[, message]): ValidationError

パラメータ	説明
errorCode	(必須) String。エラーの種類を指定します。
message	(任意) String。エラーに関する情報が含まれます。

​

成功を返す

ユーザー作成処理が成功した場合は、コールバック関数を呼び出し、error パラメータに null を渡します：

return callback(null);

​

エラーを返す

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

たとえば、errorCode パラメータに user_exists を指定してエラーを返すことができます。

return callback(new ValidationError("user_exists", "My custom error message."));

その場合、Auth0 は fs テナントログイベントを記録します。

テナントログイベントの項目	値
コード	fs
イベント	サインアップ失敗
説明	My custom error message.

​

User オブジェクトのパラメータ

user オブジェクト パラメータには、ユーザー作成プロセスに由来する、あらかじめ定義された一連のプロパティが含まれます。

プロパティ	説明
client_id	ユーザーが Universal Login 経由でサインアップした場合は Auth0 アプリケーションのクライアント ID、Auth0 Dashboard または Management API 経由で作成された場合は API キーです。
tenant	Auth0 テナント名です。
email	ユーザーのメールアドレスです。
password	ユーザーのパスワード (平文) です。
username	ユーザーのユーザー名です。Requires Username 設定がカスタムデータベース接続で有効になっている場合にのみ必須です。
connection	Auth0 接続名です。
user_metadata	ユーザーの Auth0 プロファイルに user_metadata オブジェクトが存在する場合は、その user_metadata オブジェクトのプロパティが含まれます。
app_metadata	ユーザーの Auth0 プロファイルに app_metadata オブジェクトが存在する場合は、その app_metadata オブジェクトのプロパティが含まれます。

​

username プロパティ

カスタムデータベース接続で Requires Username 設定が有効になっている場合、Login スクリプトと Get User スクリプトは username プロパティに対応している必要があるため、これを外部データベースに保存しておく必要があります。

​

ユーザーとアプリのメタデータ

user_metadata と app_metadata のプロパティは、外部データベースに保存する必要はありません。Auth0 が内部的に作成するユーザープロファイルのレコードの一部として、これらの値は自動的に保存されます。

​

カスタムのサインアップフィールド

サインアップ時にカスタムフィールドを作成して使用すると、それらはuserオブジェクトに含まれます。例：

{
    client_id: "8tkMo6n1QkKOazqPcSQd8wU7LzXYibgK",
    tenant: "{yourAuth0Tenant}",
    email: "[e-mail]",
    password: "mySuperSecretPassword123",
    username: "username456",
    user_metadata: {
        "language": "en"
    },
    app_metadata: {
        "plan": "full"
    }
}

​

言語別のスクリプト例

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

JavaScript

function create(user, callback) {
  // このスクリプトでは、既存のデータベースにユーザーエントリを作成します。スクリプトは、
  // ユーザーがサインアップを試みたとき、または Auth0 ダッシュボードや Management API を通じて
  // ユーザーが作成されたときに実行されます。
  // このスクリプトの実行が完了すると、ユーザーが正常に作成されたことを確認するために、
  // 直後に Login スクリプトが実行されます。
  //
  // ユーザーオブジェクトには常に次のプロパティが含まれます:
  // * email: ユーザーのメールアドレス
  // * password: ユーザーが入力した平文のパスワード
  // * tenant: この Auth0 アカウントの名前
  // * client_id: ユーザーがサインアップしたアプリケーションのクライアントID、または
  //              Management API または Auth0 ダッシュボードを通じて作成された場合の API キー
  // * connection: このデータベース接続の名前
  //
  // このスクリプトの終了方法は3通りあります:
  // 1. ユーザーが正常に作成された
  //     callback(null);
  // 2. このユーザーは既にデータベースに存在する
  //     callback(new ValidationError("user_exists", "my error message"));
  // 3. データベースに接続しようとした際に問題が発生した
  //     callback(new Error("my error message"));
  const msg = 'Please implement the Create script for this database connection ' +
    'at https://manage.auth0.com/#/connections/database';
  return callback(new Error(msg));
}

​

トラブルシューティング

外部ユーザーストアまたは Auth0 のいずれかでユーザーを作成できない場合:

1. Actions リアルタイムログ で console.log() の出力を確認します。
2. レガシーデータベースでユーザーを見つけ、必要に応じて削除します。Auth0 に不完全なユーザー状態が残っている場合は、Management API の ユーザーを削除 エンドポイントまたは 接続ユーザーを削除 エンドポイントを使用します。
3. インポートモードが無効になっていることを確認してから、Create スクリプトを設定します。