User Import / Export 拡張機能

アカウントで設定した任意のデータベースとの間でユーザーをインポートおよびエクスポートできる User Import/Export 拡張機能について説明します。

User Import/Export 拡張機能は 2025 年 9 月に非推奨となる予定です。現在は、同じ機能をAuth0 Management Dashboard から直接利用できます。

User Import / Export 拡張機能では、次のことができます。

• 既存のデータベースユーザーを Auth0 に一括インポートする
• Auth0 のデータベースユーザーの一部またはすべてを検索してエクスポートする

インポートおよびエクスポートできるユーザープロファイルのフィールド一覧については、User Profile Attributesを参照してください。

この拡張機能を使用するには、Dashboard Admin である必要があります。

​

拡張機能をインストールする

この拡張機能をインストールするには、Auth0 Dashboard > Extensions に移動し、User Import / Export を選択します。

この拡張機能はインストール前に追加設定を必要としないため、表示される情報ポップアップウィンドウで Install を選択して進めます。

​

拡張機能を使用する

拡張機能をインストールすると、インストール済み拡張機能の一覧に表示されます。起動するには、Import / Export Extension をクリックします。

拡張機能を初めて起動すると、一覧に表示されている操作について、拡張機能が Auth0 アカウントにアクセスするための許可を求められます。

続行するには、チェックマーク をクリックします。

この拡張機能の使い方は 2 通りあります。

• 既存のデータベースユーザーを一括で Auth0 にインポートする
• Auth0 のデータベースユーザーの一部またはすべてを検索してエクスポートする

どちらのユースケースについても、以下で詳しく説明します。

​

ユーザーのインポート

デフォルトでは、拡張機能を開くたびに User Import 画面が表示されます (エクスポート画面が表示されている場合は、左側のナビゲーションバーで Import をクリックするとこの画面に戻れます) 。

ユーザーをインポートするには、有効な JSON ファイル (スキーマと例はこちら) を Drop your file here, or click to select と表示されている領域にドラッグ＆ドロップします。別の方法として、この領域をクリックしてファイルを参照し、該当する JSON ファイルを選択することもできます。JSON ファイルには、インポートする予定のユーザー一覧が含まれている必要があります。

Auth0 テナントからエクスポートしたファイルを使用する場合は、そのファイルを ndjson から JSON に変換する必要があります。同じユーザー ID を維持するには、インポートするすべてのユーザー ID から auth0| プレフィックスを削除する必要があります。

インポート処理では、インポートしたユーザー ID に auth0| プレフィックスが自動的に追加されます。インポート前に auth0| プレフィックスを削除しないと、ユーザー ID は auth0|auth0|... のようになります。

ユーザーのインポート先となるデータベース接続を選択します。選択する接続が、少なくとも 1 つのアプリケーションで有効になっていることを確認してください。

インポートを開始するには、Start Importing Users をクリックします。

完了すると、次の Completed メッセージが表示されます。

ユーザーをインポートした後は、Auth0 Dashboard > User Management > Users で個別に管理できます。

​

ユーザーのエクスポート

Auth0 では、エクスポートファイルのサイズが大きいため、ndjson 形式を使用します。ユーザーをインポートする前に、任意のライブラリ (jq など) を使用して ndjson を json に変換する必要があります。後でインポートするためにユーザーをエクスポートする場合は、ユーザーフィールド名をデフォルトのままにし、Column Name にマッピングしないでください。

データベース接続に関連付けられた既存の Auth0 ユーザーをエクスポートするには、Export を選択します。

User Fields では、エクスポートに含めるユーザー属性または式を選択できます。ユーザー属性には、user.user_metadata.name のような静的な値や、user.user_metadata.name || user.name のような JavaScript 式を指定できます。式はエクスポートの実行時に評価されます。column name の値は、その値がエクスポート内でどのように表されるかを示します。

Add Default Fields ボタンをクリックすると、デフォルトフィールドが自動的に選択され、それらの column name が設定されます (これは、パラメーターや式がどのように表示されるかを確認するのにも役立ちます) 。

不要な属性や式は、対応する ごみ箱 アイコンをクリックして削除できます。

Settings では、次のことができます。

• ユーザーの並び順の基準となる User Attribute を指定して、エクスポートしたユーザーの表示方法を設定する (昇順または降順も指定できます)

• Export Format を選択する。JSON ファイルまたは CSV ファイルを選択できます

  

準備ができたら、Export X Users をクリックします (X はエクスポートするユーザー数です) 。

エクスポートが完了すると、ユーザーを含むファイルをダウンロードできます。Windows 10 以前を使用している場合は、サードパーティの展開ツールが必要になることがあります。

​

ユーザーの更新

Auth0 の Management API では、User Import/Export 拡張機能 を使用して、user_metadata と app_metadata のユーザープロファイルを一括更新できます。

Auth0 は現在、パスワードレスの一括インポートをサポートしていません。ユーザーを個別に更新するには、Auth0 Management API を使用してください。

​

ユーザーをエクスポートする

上記のエクスポート手順に従って、すべてのユーザー属性を含む完全なエクスポートファイルを作成します。

エクスポート形式として JSON を選択します。

エクスポートが完了したら、ユーザーを含むファイルをダウンロードします。

​

設定を更新する

前の手順でダウンロードした JSON ファイルのコピーを作成します。

この操作によりデータが失われる可能性があります。データが破損した場合に備えて、ユーザーデータベースのバックアップを作成してください。

JSON ファイルのコピーをテキストエディターで開きます。ユーザースキーマは次の例のようになります。

[
   {
      "Id":"auth0|626737a9813c000069daf462",
      "Nickname":"testuser1",
      "Name":"[e-mail]",
      "email":"[e-mail]",
      "Connection":"Username-Password-Authentication",
      "Created At":"2022-04-26T00:07:05.098Z",
      "Updated At":"2022-07-06T14:54:19.214Z"
   },
   {
      "Id":"auth0|62d1a1853bdcf11ff5dca672",
      "Nickname":"testuser2",
      "Name":"[e-mail]",
      "email":"[e-mail]",
      "Connection":"Username-Password-Authentication",
      "Created At":"2022-07-15T17:19:01.531Z",
      "Updated At":"2022-07-15T17:19:01.532Z"
   },
   {
      "Id":"auth0|62d1a1a524f32a4185c9ce23",
      "Nickname":"testuser3",
      "Name":"[e-mail]",
      "email":"[e-mail]",
      "Connection":"Username-Password-Authentication",
      "Created At":"2022-07-15T17:19:33.484Z",
      "Updated At":"2022-07-15T17:19:33.484Z"
   }
]

ユーザーのメールアドレスはデータベース内でユーザーを照合するためのキーであるため、変更しないでください。

Id には一意の connection|id が必要です。同じユーザー Id が複数の接続に存在する場合、更新は失敗します。

属性を追加するには、各ユーザースキーマに新しいフィールドを作成し、その値を指定して更新します。以下の例では、“姓” 属性の値は “Smith” で、新しい属性値の後にコンマが付きます。

email_verified 属性を複数のユーザーに追加し、値を true に設定することもできます。

{
   "Id":"auth0|626737a9813c000069daf462",
   "Nickname":"testuser1",
   "Family Name":"Smith",
   "Name":"[e-mail]",
   "email":"[e-mail]",
   "email_verified":true,
   "Connection":"Username-Password-Authentication",
   "Created At":"2022-04-26T00:07:05.098Z",
   "Updated At":"2022-07-06T14:54:19.214Z"
}

ユーザーファイルの変更を保存します。

このプロセスでは、複数のユーザーをブロックできません。Auth0 Dashboard または Auth0 Management API を使用して、ユーザーを1人ずつブロックする必要があります。

​

更新したユーザープロファイルデータをインポートする

users-import エンドポイントを使用すると、更新したユーザープロファイルファイルをアップロードし、1 つのジョブで複数のユーザーを更新できます。Create import users job endpoint に移動します。

ユーザーファイルを users パラメーターに追加し、更新対象のデータベースのデータベース接続 ID を追加します。

既存のユーザー情報を更新するには、upsert の値を true に設定する必要があります。 更新内容を反映するには、Try を選択するか、Postman を使用してユーザーをインポートします。

job_id を使用して、jobs endpoint でステータスを確認します。