メインコンテンツへスキップ
を使用すると、/get_logs エンドポイントで、リクエストごとに最大 100 件のログを取得できます。このエンドポイントでは、次の 2 種類の取得方法をサポートしています。
  • チェックポイントによる取得: ログを外部のデータ分析サービスにエクスポートする場合に推奨されます。
  • 検索条件による取得: Dashboard で使用されます。
Auth0 に保存されるログには、Auth0 のサブスクリプションに応じた保存期間が適用されます。詳しくは、ログデータの保持 を参照してください。 ログを検索するには、次のエンドポイントも使用できます。
  • /api/v2/logs/{id}: 指定したログ ID に関連付けられた単一のログエントリを取得します。
  • /api/v2/users/{user_id}/logs: 特定の user ID のログを取得します。

​
チェックポイントでログを取得する

このメソッドでは、指定した log_id より新しいログを取得できます。これは、 Splunk、Datadog、Application Insights、Mixpanel などの外部システムに ログを送信する際によく使用されます。 チェックポイントを指定して取得するには、次のパラメーターを使用します。
パラメーター説明
fromログの取得を開始するログイベント ID。take パラメーターを使用して取得するログ数を制限できます。
takefrom パラメーターの使用時に取得するエントリーの総数。
from と take 以外のパラメーターは無視されます。ログは log_id の順序で返されます。

​
セマンティクス

チェックポイントを指定してログを取得する場合の動作は、次のとおりです。
  • ロールに付与された権限で参照可能なすべてのログが返されます
  • Auth0 システムの遅延によって過去のレコードを取りこぼすことを防ぐため、ログは生成時刻ではなく log_id の順に並べられます
  • ページネーションは無制限です。つまり、検索条件でログを取得する場合にある 1,000 レコードの制限とは異なり、上限はありません
チェックポイントでログを取得する場合、手動で行うのは最初のリクエストだけです。以降の各リクエストは、Link ヘッダー内の next リレーション URL を使用して行う必要があります。これにより、API との統合が容易になり、Auth0 はカスタマーエクスペリエンスに影響を与えることなく最適化を実施できます。

​
例

us のテナント名が acme であると仮定します。チェックポイントを使用してレコードの取得を開始するには、次の手順を実行します。
  1. システム内の任意のログから log_id を取得します。 例: 90020211201185132572079310688835925971249535794074878050。
  2. https://TENANT_NAME.LOCALITY.auth0.com/api/v2/logs?from=LOG_ID&take=100 にリクエストを送信し、指定した LOG_ID より新しい次の 100 件のログを取得します。
  3. HTTP レスポンスには次が含まれます
    1. 指定した LOG_ID より新しい 0 件から 100 件のログを含む JSON 配列
    2. next リレーションを持つ HTTP Link ヘッダー
  4. 結果セットが空の場合は空の配列が返され、next リレーションは直前のリクエストで使用したものと同じ URL になります

​
検索条件でログを取得する

このメソッドを使用すると、指定した検索条件に一致するログを取得できます。検索条件を指定しない場合は、すべてのログが一覧表示されます。条件を指定して検索するには、次のパラメーターを使用します。
パラメーター説明
qQuery String Syntax を使用した検索条件。
page0 から始まるページ番号。
per_page1 ページあたりのエントリー数。
sort並べ替えに使用するフィールドです。field:order を使用します。ここで、order は昇順の場合は 1、降順の場合は -1 です。例: date:-1。
fields結果に含める、または除外する (include_fields に応じて) フィールドのカンマ区切りリストです。すべてのフィールドを取得するには、空のままにします。
include_fields指定したフィールドを結果に含める場合は true、含めない場合は false です。デフォルトは true です。
検索クエリで使用できるフィールドと並べ替えパラメーターの一覧については、Log Search Query Syntax を参照してください。

​
制限事項

ログ取得時の 1 リクエストあたり 100 件という制限に加え、ページネーションでたどれる検索結果は最大 1,000 件までです。 414 Request-URI Too Large エラーが表示された場合は、クエリ文字列がサポートされている長さを超えていることを意味します。この場合は、検索条件を絞り込んでください。

Private Cloud の検索フィールドの制限

以下のフィールドは、Private Cloud でのみ検索できます。
  • user
  • connection
  • application
  • type
  • ip
完全一致で検索するには、ダブルクォーテーションを使用します (例: application:"test" は test という名前のアプリケーションに固有のすべてのログイベントを検索しますが、application:test は名前に “test” を含むアプリケーションのログイベントを検索します。

​
詳細情報