Management APIを使ってログイベントを取得する

Management APIを使用すると、/get_logsエンドポイントを使用して要求ごとに最大100件のログイベントを取得できます。このエンドポイントは、次の2種類の消費をサポートしています。

• チェックポイントの場合：ログイベントを外部データ分析サービスにエクスポートする場合に推奨されます。

• 検索条件の場合：Dashboardにより使用されます。

Auth0によって保存されるログには、Auth0サブスクリプションに基づいた保持期間が適用されます。詳細については、「ログデータ保持」をお読みください。

これらのエンドポイントを使って次のログを探すことができます。

• /api/v2/logs/{id}：指定されたログIDに関連付けられた単一のログエントリを取得します。

• /api/v2/users/{user_id}/logs：特定のユーザーIDのログイベントを取得します。

このメソッドを使用すると、指定されたlog_idよりも新しいログイベントを取得 できます。これは通常、Splunk、Datadog、Application Insights、Mixpanelなどの外部 システムにログを送信するために使用されます。

チェックポイントで検索するには、次のパラメーターを使用します。

fromとtake以外のパラメータは無視されます。ログはlog_id順に並べられます。

チェックポイントによるログの取得には次のセマンティクスがあります。

• ロールの役割の権限で利用可能なすべてのログが返されます

• ログは、Auth0システムの遅延による過去のレコードのスキップを防ぐために、イベント生成時間ではなくlog_idで順序付けられます。

• 検索条件でログを取得する場合の1,000件のレコード制限とは対照的に、ページネーションは無制限であり、制限はありません。

チェックポイントでログを取得する場合は、最初の要求のみを手動で行って ください。後続の各要求は、Linkヘッダー内のnext関係URLを使用して 行う必要があります。これにより、APIとの統合作業が簡素化され、Auth0は 顧客エクスペリエンスに影響を与えることなく最適化を行うことができます。

usのテナント名がacmeであると仮定します。チェックポイントでレコードを取得し始めるには：

1. システム内の任意のログからlog_idを取得します。 例：90020211201185132572079310688835925971249535794074878050

2. 指定されたLOG_IDよりも新しい次の100個のログを要求するには、https://TENANT_NAME.LOCALITY.auth0.com/api/v2/logs?from=LOG_ID&take=100 に要求を送信します。

3. HTTP応答には次が含まれます。

   1. 指定されたLOG_IDより新しい0〜100個のログのJSON配列

   2. next関係を持つHTTPLinkヘッダー

4. 結果セットが空の場合は空の配列が返され、next関係は最新の要求で使用したのと同じURLと一致します。

このメソッドを使用すると、指定された検索条件に一致するログイベントを取得できます。条件が使用されない場合は、すべてのイベントが一覧表示されます。条件で検索するには、次のパラメーターを使用します。

検索クエリで使用できるフィールドと並べ替えパラメーターのリストを確認するには、「ログ検索クエリ構文」をお読みください。

ログを取得する要求ごとに100件のログイベントという制限に加え、最大1,000件の検索結果までしかページ分割できません。

414 Request-URI Too Largeエラーが発生した場合、クエリ文字列がサポートされている長さよりも大きいことを意味します。その場合には、検索を絞り込みます。

• ログイベントタイプのコード
• ログ検索のクエリ構文
• ログデータの保持