ユーザー移行

Logto は、他のプラットフォームから既存ユーザーを手動で移行することをサポートしています。このガイドでは、Management API を使って既存ユーザーをインポートする方法と、移行前に考慮すべき点について説明します。

ユーザースキーマ

始める前に、Logto のユーザースキーマを見てみましょう。ユーザースキーマには、次の 3 つの部分があります：

基本データ：ユーザープロファイルからの基本情報で、既存のユーザープロファイルのデータとマッチさせることができます。
カスタムデータ：追加のユーザー情報を保存します。基本データにマッチしないファイルなどを保存するのに利用できます。
ソーシャルアイデンティティ：ソーシャルサインインから取得したユーザー情報を保存します。

既存のユーザープロファイルから 基本データ および カスタムデータ へ情報をマッピングするためのマップを作成できます。ソーシャルサインインの場合は、ソーシャルアイデンティティをインポートするために追加の手順が必要です。詳細はソーシャルアイデンティティをユーザーにリンクする API を参照してください。

パスワードハッシュ化

Logto は Argon2 を使ってユーザーのパスワードをハッシュ化していますが、移行の利便性のために MD5、SHA1、SHA256、Bcrypt など他のアルゴリズムもサポートしています。これらのアルゴリズムは安全ではないと考えられており、該当するパスワードハッシュはユーザーが初めてサインインに成功した際に Argon2 へ移行されます。

他のハッシュアルゴリズムやソルトを使用している場合は、passwordAlgorithm を Legacy に設定できます。これにより、Node.js でサポートされている任意のハッシュアルゴリズムを利用できます。サポートされているアルゴリズムの一覧は Node.js crypto ドキュメントで確認できます。この場合、passwordDigest はハッシュアルゴリズムやその他のアルゴリズム固有のパラメータを含む JSON 文字列となります。

一般的な Legacy フォーマット

JSON 文字列のフォーマットは次の通りです：

["hash_algorithm", ["argument1", "argument2", ...], "expected_hashed_value"]

引数内で実際のパスワード値のプレースホルダーとして @ を使用できます。

例えば、SHA256 とソルトを使っている場合、パスワードは次のような形式で保存できます：

["sha256", ["salt123", "@"], "c465f66c6ac481a7a17e9ed5b4e2e7e7288d892f12bf1c95c140901e9a70436e"]

これは次のコードと同等です：

const hash = crypto.createHash('sha256');
hash.update('salt123' + 'password123');
const expectedHashedValue = hash.digest('hex');

PBKDF2 サポート

Logto は PBKDF2 を特別にサポートしています。

PBKDF2 でハッシュ化されたパスワードを移行するには、passwordAlgorithm を Legacy に設定し、passwordDigest を次のようにフォーマットします：

["pbkdf2", ["salt", "1000", "20", "sha512", "@"], "expected_hashed_value"]

各パラメータの意味は以下の通りです：

salt：元のハッシュ化で使用したソルト値
iterations：イテレーション回数（例: "1000"）
keylen：導出キーのバイト長（例: "20"）
digest：使用したハッシュ関数（例: "sha512"、"sha256"、"sha1"）
@：実際のパスワード値のプレースホルダー
expected_hashed_value：16 進数文字列としての期待されるハッシュ結果

移行ペイロード例：

{
  "username": "john_doe",
  "primaryEmail": "[email protected]",
  "passwordAlgorithm": "Legacy",
  "passwordDigest": "[\"pbkdf2\", [\"mySalt123\", \"1000\", \"20\", \"sha512\", \"@\"], \"c465f66c6ac481a7a17e9ed5b4e2e7e7288d892f12bf1c95c140901e9a70436e\"]"
}

移行手順

ユーザーデータの準備 まず既存プラットフォームからユーザーデータをエクスポートし、Logto のユーザースキーマに情報をマッピングします。マッピング済みデータは JSON 形式で準備することを推奨します。ユーザーデータの例は以下の通りです：
```
[
  {
    "username": "user1",
    "passwordDigest": "password-encrypted",
    "passwordAlgorithm": "SHA256"
  },
  {
    "username": "user2",
    "passwordDigest": "password-encrypted",
    "passwordAlgorithm": "SHA256"
  }
]
```
Logto テナントの作成 Logto でテナントをセットアップする必要があります。Logto Cloud または Logto OSS のいずれかを利用できます。まだセットアップしていない場合は、Logto Cloud のセットアップガイドを参照してください。
Management API の接続設定 Management API を使ってユーザーデータをインポートします。開発環境での接続方法は Management API を参照してください。

ユーザーデータのインポート ユーザーデータを 1 件ずつインポートするスクリプトを用意することを推奨します。create user API を呼び出してユーザーデータをインポートします。スクリプト例は以下の通りです：

const users = require('./users.json');

const importUsers = async () => {
  for (const user of users) {
    try {
      await fetch('https://[tenant_id].logto.app/api/users', {
        method: 'POST',
        headers: {
          'Content-Type': 'application/json',
          Authorization: 'Bearer [your-access-token]',
        },
        body: JSON.stringify(user),
      });
      // レートリミット回避のため少し待機
      await new Promise((resolve) => setTimeout(resolve, 200));
    } catch (error) {
      console.error(`ユーザー ${user.username} のインポートに失敗しました: ${error.message}`);
    }
  }
};

importUsers();

API エンドポイントにはレートリミットがあるため、各リクエストの間にスリープを入れてレートリミットを回避してください。詳細はレートリミットページをご確認ください。

大量のユーザーデータ（10 万件以上）がある場合は、こちらからお問い合わせください。レートリミットの引き上げが可能です。

既存のユーザーデータベースを Logto へ移行するための一般的なガイドライン

ユーザースキーマ​

パスワードハッシュ化​

一般的な Legacy フォーマット​

PBKDF2 サポート​

移行手順​

関連リソース​

ユーザースキーマ

パスワードハッシュ化

一般的な Legacy フォーマット

PBKDF2 サポート

移行手順

関連リソース