ユーザーデータの一括エクスポート

Auth0 からサポート対象のユーザープロファイルデータを JSON互換または CSV 形式のファイルにエクスポートします。

Auth0 からユーザーデータを一括エクスポートできます。エクスポート可能なユーザープロファイルのフィールド一覧については、User Profile Structureをご覧ください。

​

サポート対象のファイル形式

JSON互換形式およびCSV形式でのユーザーデータのエクスポートをサポートしています。

• エクスポートファイルのサイズが大きいため、JSON互換のエクスポートファイルはNDJSON形式です。

• CSVエクスポートファイルでは、CSVインジェクションを防ぐため、OWASP標準に準拠してStringデータ型をエスケープします。

  • 二重引用符 (”) の前には、二重引用符が追加されます。
  • 各文字列の先頭には、一重引用符 (’) が追加されます。
  • 各文字列は二重引用符で囲まれます。

  これは、Auth0が生成するISO 8601形式の日付には適用されません。

​

前提条件

Auth0 Dashboard

• 次のいずれかのテナントメンバーのロールが必要です。
  • Admin
  • Editor - Users
  • Dashboard Viewer - Users

Management API

• Create export users job endpointへのジョブエンドポイントリクエストに必要なscopeを持つManagement API トークンを用意するか、作成する必要があります。

​

1. ユーザーエクスポート ジョブ を送信する

Auth0 Dashboard

Auth0 Dashboard を使用してユーザーデータをエクスポートするには:

1. Dashboard > User Management > Users に移動します。

2. ページ右上の Import/Export Users を選択して、Import/Export Users ページに移動します。

3. Export Users を選択して、Export Users ページに移動します。

   

4. Export Settings セクションで:

   • Connection のドロップダウンメニューを開き、ユーザーデータのエクスポート元となるデータベース接続を選択します。

   • Export Format のドロップダウンメニューを開き、データの形式 (JSON または CSV) を選択します。

5. Export Fields セクションで、エクスポートに含めるフィールドを選択します:

   • Include default fields をオンにすると、Auth0 正規化ユーザープロファイルスキーマのフィールドが追加されます。

   • Add Fields を選択し、User Attribute と Field Name を入力して特定のフィールドを追加します。

6. 必要に応じて、Export Fields セクションで Export as Sample をオンにすると、エクスポート対象を10人のユーザーに制限できます。これは、エクスポートファイルの構造を検証する際に役立ちます。

7. ジョブを送信するには、Export Users を選択します。

Management API

Management API を使用してユーザーデータをエクスポートするには、ユーザーエクスポートジョブ作成エンドポイント (POST /jobs/users-exports) を呼び出します。リクエスト本文のパラメータとレスポンススキーマの詳細については、エンドポイントのドキュメントを参照してください。

connection_id を省略した場合、このエンドポイントはテナント内のすべての接続に属するユーザーのデータをエクスポートします。

Auth0 Dashboardでデータベース接続のIDを確認するか、Management APIのすべての接続を取得するエンドポイントを使用して取得できます。

以下の例を使用するには、プレースホルダー変数を実際の値に置き換えてください。

job の作成に成功すると、戻り値には job ID を含む job の情報が含まれます。

​

2. ジョブのステータスを確認してエクスポートをダウンロードする

Auth0 Dashboard

ジョブのステータスを確認するには：

1. Auth0 Dashboard > User Management > Usersに移動します。

2. ページ右上のImport/Export Usersを選択して、Import/Export Usersページに移動します。1つ以上のジョブを開始すると、このページに送信済みのジョブが一覧表示されます。

3. 各ジョブの横で、次の操作を選択できます：

   • Check Status：ジョブの進行状況を確認します。

   • Download export：結果を取得します。

   • More info：エラーまたはジョブのメタデータを確認します。

Management API

ジョブのステータスを確認するには、ジョブのIDを指定してGet a job endpoint (GET /jobs) を呼び出します。エンドポイントのパラメータとレスポンススキーマの詳細については、エンドポイントのドキュメントを参照してください。

テナント名はファイル名にも使用されます。たとえば、テナント名がauth0docsの場合、ファイル名はauth0docs.csvまたはauth0docs.jsonです。

locationパラメータの値として提供されるURLを使用して、エクスポートファイルにアクセスできます。URLにアクセスすると、ファイルのダウンロードが自動的に開始されます。

ダウンロードリンクの有効期限は60秒です。この期間を過ぎた場合でも、ジョブの有効期限が切れるまでの24時間以内であれば、再度呼び出すことができます。

​

制限

• すべてのジョブ関連データは、24時間後に自動的に削除されます。

• CSV形式でエクスポートできるデータは30フィールドまでです。

• CSV形式のデータエクスポートでは、app_metadata または user_metadata を単一のobjectとして含めることはできません。代わりに、メタデータobjectのフィールドを明示的に指定するか、メタデータを単一のobjectとして扱えるJSON互換形式でデータをエクスポートしてください。

  JSON互換形式のリクエスト本文

  {
    "format": "json",
    "fields": [
      { "name": "user_metadata.example" }
    ]
  }
  

  CSV形式のリクエスト本文

  {
    "format": "csv",
    "fields": [
      { "name": "user_metadata.example.field_one" },
      { "name": "user_metadata.example.field_two" },
      { "name": "user_metadata.example.field_three" }
    ]
  }