Skip to main content
を使用すると、/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 件というレコード上限とは異なり、制限なく取得できます
チェックポイントごとにログを取得する場合、手動で行う必要があるのは 最初のリクエストだけです。2 回目以降のリクエストはすべて、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 になります

​
検索条件によるログの取得

このメソッドでは、指定した検索条件に一致するログを取得できます。検索条件を指定しない場合は、すべてのログが一覧表示されます。検索条件を使って検索するには、次のパラメーターを使用します。 検索クエリで使用できるフィールドと並べ替えパラメーターの一覧については、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” を含むアプリケーションのログイベントを検索します。

​
詳細