User Import / Export Extension では、次のことができます。
既存のデータベースユーザーを Auth0 に一括インポートする
Auth0 のデータベースユーザーの一部 (またはすべて) を検索してエクスポートする
インポートおよびエクスポートできるユーザープロフィールの属性の一覧については、ユーザープロフィールの属性 を参照してください。
この拡張機能を使用するには、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 ボタンをクリックすると、デフォルトのフィールドが自動的に選択され、それらの列名が入力されます (これは、パラメーターや式がどのように表示されるかを確認するのにも便利です) 。不要な属性や式は、対応する ごみ箱 アイコンをクリックして削除できます。
Settings では、次のことができます。
ユーザーの並び替えに使用する User Attribute を指定して、エクスポートされるユーザーの表示順を設定する (昇順または降順の指定も可能)
Export Format を選択する。JSON ファイルまたは CSV ファイルを選択できます
準備ができたら、Export X Users をクリックします (X はエクスポートするユーザー数です) 。
エクスポートが完了したら、ユーザーを含むファイルをダウンロードできます。Windows 10 以前を使用している場合は、サードパーティ製の展開ツールが必要になることがあります。
Auth0 の Management API user_metadata と app_metadata を一括で更新できます。
上記のエクスポート手順 に従って、すべてのユーザー属性を含む完全なエクスポートファイルを作成します。エクスポート形式として JSON を選択します。
エクスポートが完了したら、ユーザー情報を含むファイルをダウンロードします。
前の手順でダウンロードした JSON ファイルのコピー を作成します。
この操作によりデータが失われるおそれがあります。データ破損に備えて、ユーザーデータベースのバックアップを作成してください。
JSON ファイルのコピーをテキストエディターで開きます。ユーザースキーマは次のようになります。
[ { "Id" : "auth0|626737a9813c000069daf462" , "Nickname" : "testuser1" , "Name" : "testuser1@auth0.com" , "email" : "testuser1@auth0.com" , "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" : "testuser2@auth0.com" , "email" : "testuser2@auth0.com" , "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" : "testuser3@auth0.com" , "email" : "testuser3@auth0.com" , "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" : "testuser1@auth0.com" , "email" : "testuser1@auth0.com" , "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 を使用して、ユーザーごとに個別にブロックする必要があります。 更新したユーザープロフィールデータをインポートする users-import エンドポイントでは、更新済みのユーザープロフィールファイルをアップロードして、1 つのジョブで複数のユーザーを更新できます。Create import users job endpoint に移動します。ユーザーファイルを users パラメーターに追加し、更新対象のデータベースのデータベース接続 ID を指定します。
既存のユーザー情報を更新するには、upsert の値を true にする必要があります。
更新を適用するには、Try を選択するか、Postman を使用してユーザーをインポートします。
job_id を使用して、jobs endpoint でステータスを確認します。 
認証
ユーザー管理
カスタマイズ
Auth0 AI
プラットフォーム
