ログを取得

指定した検索条件に一致するログエントリを取得します（条件が指定されていない場合は、すべてのログエントリを取得します）。

q パラメーターを使用してカスタム検索条件を設定するか、特定のログ ID から検索します（“checkpoint から検索”）。

使用可能なすべてのイベントタイプ、その略称、および説明については、Log Event Type Codes を参照してください。

カスタム検索条件を設定するには、次のパラメーターを使用します。

• q: query string 構文を使用した検索条件
• page: 返す結果のページ index。最初のページは 0 です。
• per_page: 1 ページあたりの結果数。
• sort: 並べ替えに使用するフィールド。昇順の場合は :1、降順の場合は :-1 を付加します。例: date:-1
• fields: 結果に含める、または除外する（include_fields に応じて）フィールドのカンマ区切りリスト。空の場合はすべてのフィールドを取得します。
• include_fields: 指定したフィールドを含めるか（true）、除外するか（false）。
• include_totals: 合計結果数を含むオブジェクト内に結果を返すか（true）、結果の array を直接返すか（false、default）。非推奨: このフィールドは非推奨のため、使用しないでください。Search Engine V3 互換性のない変更 を参照してください。

fields と sort で使用できるフィールドの一覧について詳しくは、Searchable Fields を参照してください。

Auth0 では、検索条件で返せるログ数は 1 request あたり 100 件までに制限されています。さらに、ページネーションできる検索結果は 1,000 件までです。この上限を超える場合は、検索条件を見直すか、checkpoint によるログ取得メソッドを使用してください。

checkpoint ログ ID から検索するには、次のパラメーターを使用します。

• from: ログの取得を開始するログイベント ID。返すログ数は take パラメーターで制限できます。from と q を同時に使用した場合は、from が優先され、q は無視されます。
• take: from パラメーターを使用する場合に取得するエントリ数。

重要: checkpoint ログ ID からログを取得する場合、from と take 以外のパラメーターは無視され、日付順は保証されません。

GET https://{tenantDomain}/api/v2/logs

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Logs.ListAsync(
            new ListLogsRequestParameters {
                Page = 1,
                PerPage = 1,
                Sort = "sort",
                Fields = "fields",
                IncludeFields = true,
                IncludeTotals = true,
                Search = "search"
            }
        );
    }

}

200

[
  {
    "audience": "<string>",
    "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
    "client_name": "My application Name",
    "connection": "<string>",
    "connection_id": "<string>",
    "date": "2016-02-23T19:57:29.532Z",
    "description": "<string>",
    "details": {},
    "hostname": "190.257.209.19",
    "ip": "190.257.209.19",
    "isMobile": true,
    "location_info": {
      "city_name": "<string>",
      "continent_code": "<string>",
      "country_code": "<string>",
      "country_code3": "<string>",
      "country_name": "<string>",
      "latitude": 123,
      "longitude": 123,
      "time_zone": "<string>"
    },
    "log_id": "<string>",
    "scope": "",
    "security_context": {
      "ja3": "<string>",
      "ja4": "<string>"
    },
    "strategy": "<string>",
    "strategy_type": "<string>",
    "type": "sapi",
    "user_agent": "<string>",
    "user_id": "auth0|56c75c4e42b6359e98374bc2",
    "user_name": "<string>"
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

クエリパラメータ

page · integer

返す結果のページ index。最初のページは 0 です。

必須範囲: x >= 0

per_page · integer

ページあたりの結果数です。パラメーターが送信されない場合、ページングは無効になります。デフォルト: 50。最大値: 100

必須範囲: 0 <= x <= 100

sort · string

並べ替えに使用するフィールドに、昇順の場合は :1、降順の場合は :-1 を付けます。例: date:-1

fields · string

結果に含める、または結果から除外するフィールドのカンマ区切りリストです（include_fields に指定した値に基づきます）。すべてのフィールドを取得するには空のままにしてください。

include_fields · boolean

指定したフィールドを含める（true）か、除外する（false）か

include_totals · boolean

false（デフォルト）の場合は結果を配列として返します。true の場合は、結果の合計件数も含むオブジェクト内に結果を返します。

from · string

選択を開始する起点となるログイベント ID。

take · integer

from パラメーターを使用する場合に取得するエントリー数です。デフォルトは 50、最大は 100 です

search · string

指定した検索条件に一致するログを取得します。このパラメーターは /api/logs エンドポイントの他のすべてのパラメーターと組み合わせて使用できますが、わかりやすくするために個別に指定されています。 フィールドが指定されていない場合、client_name、connection、user_name の各フィールドに対して、大文字と小文字を区別しない前方一致検索が実行されます。フィールドを指定する場合は、複数のフィールドを指定し、%field%:%search% の形式で検索できます。例: application:node user:"[e-mail]"。 引用符なしで指定された値は、大文字と小文字を区別しない前方一致検索で照合されます。引用符を使用した場合は、大文字と小文字を区別しない完全一致検索が使用されます。複数のフィールドを使用する場合は、句の結合に AND 演算子が使用されます。

レスポンス

200

application/json

ログを正常に取得しました。

object[]

object

audience · string

このイベントが適用されるAPI audience。

client_id · string · デフォルト: AaiyAPdpYdesoKnqjj8HJqRn4T5titww

クライアント（アプリケーション）の ID。

client_name · string · デフォルト: My application Name

クライアント（アプリケーション）の名前。

connection · string

このイベントに関連する接続の名前。

connection_id · string

このイベントに関連する接続の ID。

date · string object · デフォルト: 2016-02-23T19:57:29.532Z

イベントが発生した日時（ISO 8601形式）。

description · string | null

このイベントの説明。

details · object

このイベントに関する追加の有用な詳細情報（構造はイベントタイプによって異なります）。

hostname · string · デフォルト: 190.257.209.19

イベントの対象となるホスト名。

ip · string · デフォルト: 190.257.209.19

ログイベントの発生元の IP アドレス。

isMobile · boolean

クライアントがモバイル端末であったか（true）、またはデスクトップ/ノートPC/サーバーであったか（false）を示します。

location_info · object

ip に基づく、このイベントをトリガーした場所に関する情報。

Show child attributes

log_id · string

イベントの一意のID。

scope · string · デフォルト: ""

イベントに適用されるスコープ権限。

security_context · object

セキュリティ関連シグナルに関する情報。

Show child attributes

strategy · string

イベントに関連するstrategyの名前。

strategy_type · string

イベントに関連するstrategyの種類。

type · string · デフォルト: sapi

イベントの種類。

user_agent · string

このイベントを発生させたクライアント端末のユーザーエージェント文字列。

user_id · string · デフォルト: auth0|56c75c4e42b6359e98374bc2

イベントに関与したユーザーの ID。

user_name · string

イベントに関与したユーザーの名前。