ログを取得

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

カスタム検索条件は 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 以外のパラメーターはすべて無視され、日付順は保証されません。

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

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.ListLogsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        Sort: management.String(
            "sort",
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Q: management.String(
            "q",
        ),
    }
    client.Logs.List(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.logs.list({
        page: 1,
        perPage: 1,
        sort: "sort",
        fields: "fields",
        includeFields: true,
        includeTotals: true,
        q: "q",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.logs.list({
        page: 1,
        perPage: 1,
        sort: "sort",
        fields: "fields",
        includeFields: true,
        includeTotals: true,
        q: "q",
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/logs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/logs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/logs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/logs")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/logs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

返す結果のページインデックス。最初のページは 0 です。

必須範囲: x >= 0

per_page · integer

1 ページあたりの結果数。パラメーターが送信されない場合、ページングは無効になります。デフォルト: 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オーディエンス。

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_type · string

イベントに関与したストラテジーのタイプ。

type · string · デフォルト: sapi

イベントの種類。

user_agent · string

このイベントの原因となったクライアントデバイスのユーザーエージェント文字列。

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

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

user_name · string

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