認証
ユーザー管理
カスタマイズ
Auth0 AI
プラットフォームログを取得
指定した検索条件に一致するログエントリーを取得します（条件を指定しない場合は、すべてのログエントリーを取得します）。
カスタム検索条件は q パラメーターを使用して設定するか、特定のログ ID から検索します（“checkpoint から検索”）。
使用可能なすべてのイベントタイプ、それぞれの略称、および説明の詳細については、Log Event Type Codes を参照してください。
カスタム検索条件を設定するには、次のパラメーターを使用します。
- q: Query String Syntax を使用した検索条件
- page: 返す結果のページインデックス。最初のページは 0 です。
- per_page: ページあたりの結果数。
- sort: ソートに使用するフィールド。昇順の場合は
:1、降順の場合は:-1を付加します。例:date:-1 - fields: 結果に含める、または除外するフィールドのカンマ区切りリスト（
include_fieldsの設定によって決まります）。空の場合はすべてのフィールドを取得します。 - include_fields: 指定したフィールドを含めるか（true）、除外するか（false）。
- include_totals: 合計結果数を含むオブジェクト内に結果を返すか（true）、結果の配列を直接返すか（false、既定）。非推奨: このフィールドは非推奨であり、使用しないでください。Search Engine V3 Breaking Changes を参照してください。
fields と sort で使用できるフィールドの一覧については、Searchable Fields を参照してください。
Auth0 では、検索条件で返せるログ数 は 1 リクエストあたり 100 件に制限されています。さらに、ページネーションできるのは 1,000 件の検索結果までです。このしきい値を超える場合は、検索条件を見直すか、checkpoint によるログ取得メソッド を使用してください。
checkpoint のログ ID から検索するには、次のパラメーターを使用します。
- from: ログの取得を開始するログイベント ID。返されるログ数は
takeパラメーターで制限できます。fromをqと同時に使用した場合、fromが優先され、qは無視されます。 - take:
fromパラメーターを使用する場合に取得するエントリー数。
重要: checkpoint のログ ID からログを取得する場合、from と take 以外のパラメーターはすべて無視され、日付順は保証されません。
承認
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
クエリパラメータ
返す結果のページインデックス。最初のページは 0 です。
x >= 01 ページあたりの結果数。パラメーターが送信されない場合、ページングは無効になります。デフォルト: 50。最大値: 100
0 <= x <= 100並べ替えに使用するフィールドに、昇順の場合は :1、降順の場合は :-1 を付加します。例: date:-1
結果に含める、または結果から除外するフィールドのカンマ区切りリストです（include_fields に指定された値に基づきます）。空のままにすると、すべてのフィールドを取得します。
指定したフィールドを含める（true）か、除外する（false）かを指定します。
false の場合（デフォルト）は、結果を配列として返します。true の場合は、合計結果数も含むオブジェクト内に結果を返します。
選択を開始する起点となるログイベント ID。
from パラメーターを使用する場合に取得するエントリー数です。デフォルトは 50、最大値は 100 です。
指定した検索条件に一致するログを取得します。このパラメーターは /api/logs エンドポイントの他のすべてのパラメーターと組み合わせて使用できますが、明確にするために個別に指定されています。 フィールドが指定されていない場合は、client_name、connection、user_name の各フィールドすべてに対して、大文字と小文字を区別しない「前方一致」検索が実行されます。フィールドが指定されている場合は、複数のフィールドを指定し、%field%:%search% の形式で検索できます。例: application:node user:"John@contoso.com"。 引用符なしで指定した値は、大文字と小文字を区別しない「前方一致」検索で照合されます。引用符を使用した場合は、大文字と小文字を区別しない完全一致検索が使用されます。複数のフィールドを使用する場合、各句は AND 演算子で結合されます。
レスポンス
ログを正常に取得しました。
- object[]
- object
イベントに適用されるAPIオーディエンス。
クライアント（アプリケーション）の ID。
クライアント（アプリケーション）の名前。
このイベントに関連する接続名。
このイベントに関連する接続の ID。
イベントが発生した日時（ISO 8601形式）。
このイベントの説明。
このイベントに関する追加の有用な詳細情報（構造はイベントタイプによって異なります）。
イベントの対象ホスト名。
ログイベントの発生元 IP アドレス。
クライアントがモバイルデバイス（true）か、デスクトップ/ノートPC/サーバー（false）かを示します。
ip に基づく、このイベントをトリガーした場所に関する情報。
イベントの一意のID。
イベントに適用されるスコープ権限。
セキュリティ関連シグナルに関する情報。
イベントに関与したストラテジーの名前。
イベントに関与したストラテジーのタイプ。
イベントの種類。
このイベントの原因となったクライアントデバイスのユーザーエージェント文字列。
イベントに関与したユーザーのID。
イベントに関与したユーザーの名前。