> ## Documentation Index
> Fetch the complete documentation index at: https://translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

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

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

export const AuthCodeGroup = ({children, dropdown}) => {
  const [processedChildren, setProcessedChildren] = useState(children);
  useEffect(() => {
    let unsubscribe = null;
    function init() {
      unsubscribe = window.autorun(() => {
        const processChildren = node => {
          if (typeof node === "string") {
            let processedNode = node;
            for (const [key, value] of window.rootStore.variableStore.values.entries()) {
              const escapedKey = key.replaceAll(/[.*+?^${}()|[\]\\]/g, (String.raw)`\$&`);
              processedNode = processedNode.replaceAll(new RegExp(escapedKey, "g"), value);
            }
            return processedNode;
          } else if (Array.isArray(node)) {
            return node.map(processChildren);
          } else if (node && node.props && node.props.children) {
            return {
              ...node,
              props: {
                ...node.props,
                children: processChildren(node.props.children)
              }
            };
          }
          return node;
        };
        setProcessedChildren(processChildren(children));
      });
    }
    if (window.rootStore) {
      init();
    } else {
      window.addEventListener("adu:storeReady", init);
    }
    return () => {
      window.removeEventListener("adu:storeReady", init);
      unsubscribe?.();
    };
  }, [children]);
  return <CodeGroup dropdown={dropdown}>{processedChildren}</CodeGroup>;
};

export const AuthCodeBlock = ({filename, icon, language, highlight, children}) => {
  const [displayText, setDisplayText] = useState(children);
  const [copyText, setCopyText] = useState(children);
  const wrapperRef = React.useRef(null);
  useEffect(() => {
    let unsubscribe = null;
    function init() {
      if (!window.autorun || !window.rootStore) {
        return;
      }
      unsubscribe = window.autorun(() => {
        let processedChildrenForDisplay = children;
        let processedChildrenForCopy = children;
        for (const [key, value] of window.rootStore.variableStore.values.entries()) {
          const escapedKey = key.replaceAll(/[.*+?^${}()|[\]\\]/g, (String.raw)`\$&`);
          let displayValue = value;
          if (key === "{yourClientSecret}" && value !== "{yourClientSecret}") {
            displayValue = value.substring(0, 3) + "*****MASKED*****";
          }
          processedChildrenForDisplay = processedChildrenForDisplay.replaceAll(new RegExp(escapedKey, "g"), displayValue);
          processedChildrenForCopy = processedChildrenForCopy.replaceAll(new RegExp(escapedKey, "g"), value);
        }
        setDisplayText(processedChildrenForDisplay);
        setCopyText(processedChildrenForCopy);
      });
    }
    if (window.rootStore) {
      init();
    } else {
      window.addEventListener("adu:storeReady", init);
    }
    return () => {
      window.removeEventListener("adu:storeReady", init);
      unsubscribe?.();
    };
  }, [children]);
  useEffect(() => {
    if (!wrapperRef.current) return;
    const originalWriteText = navigator.clipboard.writeText.bind(navigator.clipboard);
    let isOverriding = false;
    const handleClick = e => {
      const button = e.target.closest('[data-testid="copy-code-button"]');
      if (!button || !wrapperRef.current.contains(button)) return;
      isOverriding = true;
      navigator.clipboard.writeText = text => {
        if (isOverriding) {
          isOverriding = false;
          navigator.clipboard.writeText = originalWriteText;
          return originalWriteText(copyText);
        }
        return originalWriteText(text);
      };
      setTimeout(() => {
        if (isOverriding) {
          isOverriding = false;
          navigator.clipboard.writeText = originalWriteText;
        }
      }, 100);
    };
    const wrapper = wrapperRef.current;
    wrapper.addEventListener('click', handleClick, true);
    return () => {
      wrapper.removeEventListener('click', handleClick, true);
      if (navigator.clipboard.writeText !== originalWriteText) {
        navigator.clipboard.writeText = originalWriteText;
      }
    };
  }, [copyText]);
  return <div ref={wrapperRef}>
      <CodeBlock filename={filename} icon={icon} language={language} lines highlight={highlight}>
        {displayText}
      </CodeBlock>
    </div>;
};

Auth0 からユーザーデータを一括エクスポートできます。エクスポート可能なユーザープロファイルのフィールド一覧については、[User Profile Structure](/docs/ja-jp/manage-users/user-accounts/user-profiles/user-profile-structure)をご覧ください。

<div id="supported-file-formats">
  ## サポート対象のファイル形式
</div>

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

* エクスポートファイルのサイズが大きいため、JSON互換のエクスポートファイルは[NDJSON形式](https://github.com/ndjson/ndjson-spec)です。

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

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

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

<div id="prerequisites">
  ## 前提条件
</div>

<Tabs>
  <Tab title="Auth0 Dashboard">
    * 次のいずれかの[テナントメンバーのロール](/docs/ja-jp/get-started/manage-dashboard-access/feature-access-by-role)が必要です。
      * **Admin**
      * **Editor - Users**
      * **Dashboard Viewer - Users**
  </Tab>

  <Tab title="Management API">
    * [Create export users job endpoint](/docs/ja-jp/api/management/v2/jobs/post-users-exports)へのジョブエンドポイントリクエストに必要なscopeを持つ[Management API トークン](/docs/ja-jp/secure/tokens/access-tokens/management-api-access-tokens)を用意するか、作成する必要があります。
  </Tab>
</Tabs>

<div id="1-submit-export-users-job">
  ## 1. ユーザーエクスポート ジョブ を送信する
</div>

<Tabs>
  <Tab title="Auth0 Dashboard">
    Auth0 Dashboard を使用してユーザーデータをエクスポートするには:

    1. [**Dashboard > User Management > Users**](https://manage.auth0.com/#/users) に移動します。

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

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

           <Frame>
             <img src="https://mintcdn.com/translations/Dcx0M11uuptU53TX/docs/images/cdy7uua7fh8z/2koXwmAu99VfxJIq49yGGq/394be27431b66cfd09866ef91b0e0cd0/exportusers.png?fit=max&auto=format&n=Dcx0M11uuptU53TX&q=85&s=922096301869f451996de761b508cb76" alt="" width="1999" height="1628" data-path="docs/images/cdy7uua7fh8z/2koXwmAu99VfxJIq49yGGq/394be27431b66cfd09866ef91b0e0cd0/exportusers.png" />
           </Frame>

    4. **Export Settings** セクションで:

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

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

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

       * **Include default fields** をオンにすると、[Auth0 正規化ユーザープロファイルスキーマ](/docs/ja-jp/manage-users/user-accounts/user-profiles/normalized-user-profile-schema)のフィールドが追加されます。

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

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

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

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

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

    <Tip>
      [Auth0 Dashboardでデータベース接続のIDを確認する](/docs/ja-jp/authenticate/identity-providers/locate-the-connection-id)か、Management APIの[すべての接続を取得するエンドポイント](/docs/ja-jp/api/management/v2/connections/get-connections)を使用して取得できます。
    </Tip>

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

    <AuthCodeGroup>
      ```bash cURL theme={null}
      curl --request POST \
        --url 'https://{yourDomain}/api/v2/jobs/users-exports' \
        --header 'authorization: Bearer {yourMgmtAPIAccessToken}' \
        --header 'content-type: application/json' \
        --data '{"connection_id": "{yourConnectionId}", "format": "csv", "limit": 5, "fields": [{"name": "email"}, { "name": "identities[0].connection", "export_as": "provider" }]}'
      ```

      ```csharp C# theme={null}
      var client = new RestClient("https://{yourDomain}/api/v2/jobs/users-exports");
      var request = new RestRequest(Method.POST);
      request.AddHeader("authorization", "Bearer {yourMgmtAPIAccessToken}");
      request.AddHeader("content-type", "application/json");
      request.AddParameter("application/json", "{"connection_id": "{yourConnectionId}", "format": "csv", "limit": 5, "fields": [{"name": "email"}, { "name": "identities[0].connection", "export_as": "provider" }]}", ParameterType.RequestBody);
      IRestResponse response = client.Execute(request);
      ```

      ```go Go theme={null}
      package main

      import (
      	"fmt"
      	"strings"
      	"net/http"
      	"io/ioutil"
      )

      func main() {

      	url := "https://{yourDomain}/api/v2/jobs/users-exports"

      	payload := strings.NewReader("{"connection_id": "{yourConnectionId}", "format": "csv", "limit": 5, "fields": [{"name": "email"}, { "name": "identities[0].connection", "export_as": "provider" }]}")

      	req, _ := http.NewRequest("POST", url, payload)

      	req.Header.Add("authorization", "Bearer {yourMgmtAPIAccessToken}")
      	req.Header.Add("content-type", "application/json")

      	res, _ := http.DefaultClient.Do(req)

      	defer res.Body.Close()
      	body, _ := ioutil.ReadAll(res.Body)

      	fmt.Println(res)
      	fmt.Println(string(body))

      }
      ```

      ```java Java theme={null}
      HttpResponse<String> response = Unirest.post("https://{yourDomain}/api/v2/jobs/users-exports")
        .header("authorization", "Bearer {yourMgmtAPIAccessToken}")
        .header("content-type", "application/json")
        .body("{"connection_id": "{yourConnectionId}", "format": "csv", "limit": 5, "fields": [{"name": "email"}, { "name": "identities[0].connection", "export_as": "provider" }]}")
        .asString();
      ```

      ```javascript Node.JS theme={null}
      var axios = require("axios").default;

      var options = {
        method: 'POST',
        url: 'https://{yourDomain}/api/v2/jobs/users-exports',
        headers: {
          authorization: 'Bearer {yourMgmtAPIAccessToken}',
          'content-type': 'application/json'
        },
        data: {
          connection_id: '{yourConnectionId}',
          format: 'csv',
          limit: 5,
          fields: [{name: 'email'}, {name: 'identities[0].connection', export_as: 'provider'}]
        }
      };

      axios.request(options).then(function (response) {
        console.log(response.data);
      }).catch(function (error) {
        console.error(error);
      });
      ```

      ```php PHP theme={null}
      $curl = curl_init();

      curl_setopt_array($curl, [
        CURLOPT_URL => "https://{yourDomain}/api/v2/jobs/users-exports",
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "{"connection_id": "{yourConnectionId}", "format": "csv", "limit": 5, "fields": [{"name": "email"}, { "name": "identities[0].connection", "export_as": "provider" }]}",
        CURLOPT_HTTPHEADER => [
          "authorization: Bearer {yourMgmtAPIAccessToken}",
          "content-type: application/json"
        ],
      ]);

      $response = curl_exec($curl);
      $err = curl_error($curl);

      curl_close($curl);

      if ($err) {
        echo "cURL Error #:" . $err;
      } else {
        echo $response;
      }
      ```

      ```python Python theme={null}
      import http.client

      conn = http.client.HTTPSConnection("")

      payload = "{"connection_id": "{yourConnectionId}", "format": "csv", "limit": 5, "fields": [{"name": "email"}, { "name": "identities[0].connection", "export_as": "provider" }]}"

      headers = {
          'authorization': "Bearer {yourMgmtAPIAccessToken}",
          'content-type': "application/json"
          }

      conn.request("POST", "/{yourDomain}/api/v2/jobs/users-exports", payload, headers)

      res = conn.getresponse()
      data = res.read()

      print(data.decode("utf-8"))
      ```

      ```ruby Ruby theme={null}
      require 'uri'
      require 'net/http'
      require 'openssl'

      url = URI("https://{yourDomain}/api/v2/jobs/users-exports")

      http = Net::HTTP.new(url.host, url.port)
      http.use_ssl = true
      http.verify_mode = OpenSSL::SSL::VERIFY_PEER

      request = Net::HTTP::Post.new(url)
      request["authorization"] = 'Bearer {yourMgmtAPIAccessToken}'
      request["content-type"] = 'application/json'
      request.body = "{"connection_id": "{yourConnectionId}", "format": "csv", "limit": 5, "fields": [{"name": "email"}, { "name": "identities[0].connection", "export_as": "provider" }]}"

      response = http.request(request)
      puts response.read_body
      ```
    </AuthCodeGroup>

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

<div id="2-check-job-status-and-download-the-export">
  ## 2. ジョブのステータスを確認してエクスポートをダウンロードする
</div>

<Tabs>
  <Tab title="Auth0 Dashboard">
    ジョブのステータスを確認するには：

    1. [**Auth0 Dashboard > User Management > Users**](https://manage.auth0.com/#/users)に移動します。

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

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

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

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

       * **More info**：エラーまたはジョブのメタデータを確認します。
  </Tab>

  <Tab title="Management API">
    ジョブのステータスを確認するには、ジョブのIDを指定して[Get a job endpoint](/docs/ja-jp/api/management/v2/jobs/get-jobs-by-id) (`GET /jobs`) を呼び出します。エンドポイントのパラメータとレスポンススキーマの詳細については、エンドポイントのドキュメントを参照してください。

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

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

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

<div id="limits">
  ## 制限
</div>

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

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

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

  <Columns>
    <Column>
      ```json JSON互換形式のリクエスト本文 theme={null}
      {
        "format": "json",
        "fields": [
          { "name": "user_metadata.example" }
        ]
      }
      ```
    </Column>

    <Column>
      ```json CSV形式のリクエスト本文 theme={null}
      {
        "format": "csv",
        "fields": [
          { "name": "user_metadata.example.field_one" },
          { "name": "user_metadata.example.field_two" },
          { "name": "user_metadata.example.field_three" }
        ]
      }
      ```
    </Column>
  </Columns>
