監査を検索

GEThttps://api.omise.co/audits/search

アカウントアクティビティの監査ログを検索します。このエンドポイントを使用して、アクター、アクションタイプ、リソース、期間で監査レコードを検索・フィルタリングします。監査ログはアカウントで実行されたすべてのアクションの包括的な証跡を提供します。

---

リクエストパラメータ

必須 - 1項目必須パラメータ

▼

`scope`STRING(required)

検索するデータタイプ。監査ログ検索の場合は「audit」に設定する必要があります。

Example:"audit"

Default:"audit"

推奨 - 2項目推奨パラメータ

▼

`query`STRING(optional)

全文検索用の検索クエリテキスト。監査の説明、アクター情報、リソース識別子を横断検索します。

Example:"routing_group"

`filters`OBJECT(optional)

結果を絞り込む検索フィルター。作成日、アクターメール、アクタータイプ、監査対象タイプ、監査対象UID、動詞のフィルターが利用可能です。

Example:{"created":"2024/01/01..2024/12/31","actor_email":["admin@example.com"]}

フィルターオプション - 6項目フィルタープロパティ

▼

`filters[created]`DATE-TIME(optional)

作成日でフィルター。日付範囲は YYYY/MM/DD..YYYY/MM/DD 形式をサポートします。

Example:"2024/01/01..2024/12/31"

`filters[actor_email]`ARRAY(optional)

アクターのメールアドレスでフィルター。アクションを実行したユーザーに一致するメール文字列の配列を受け付けます。

Example:["admin@example.com","user@example.com"]

`filters[actor_type]`STRING(optional)

アクタータイプでフィルター。アクションを実行したエンティティのタイプを指定します。

Example:"user"

Values:user

`filters[auditable_type]`STRING(optional)

監査対象リソースタイプでフィルター。アクションの影響を受けたリソースのタイプを指定します。

Example:"routing_group"

Values:routing_group

`filters[auditable_uid]`STRING(optional)

監査対象リソースの一意識別子でフィルター。

Example:"rgrp_test_5xuy4w91xqz7d1w9u0t"

`filters[verb]`STRING(optional)

アクションの動詞でフィルター。実行されたアクションのタイプを指定します。

Example:"rules_switched"

Values:rules_switched

ページネーション - 2項目ページネーションパラメータ

▼

---

レスポンス

200

検索成功

data配列にページネーションされた監査ログ結果を含む検索オブジェクトを返します。

レスポンス構造:

• object - 文字列値「search」
• data - クエリに一致する監査オブジェクトの配列
• page - 現在のページ番号
• per_page - 1ページあたりのレコード数
• total - クエリに一致する総レコード数
• total_pages - 総ページ数
• filters - 適用された検索フィルター
• query - 使用された検索クエリ
• scope - 検索されたリソースタイプ（audit）
• location - APIエンドポイントパス

監査オブジェクトの構造:

• object - 文字列値「audit」
• id - 監査ログの一意識別子
• actor_email - アクションを実行したユーザーのメール
• actor_type - アクターのタイプ（例: user）
• auditable_type - 影響を受けたリソースのタイプ
• auditable_uid - 影響を受けたリソースの一意ID
• verb - 実行されたアクション
• created_at - アクションのタイムスタンプ

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因:

• 必須のscopeパラメータがない
• 無効なscope値（「audit」である必要がある）
• 不正なfiltersオブジェクト
• フィルターの日付形式が無効
• actor_type、auditable_type、verbの無効なenum値

401

認証失敗

認証に失敗しました。無効または欠落したAPIキー。

一般的な原因:

• Authorizationヘッダーがない
• 無効な秘密キー
• 秘密キーの代わりに公開キーを使用
• 不正なHTTP Basic Auth形式

403

禁止

アクセスが拒否されました。アカウントに監査ログへのアクセス権限がありません。

一般的な原因:

• アカウント権限が不十分
• アカウントで監査ログが有効になっていない
• APIキーに監査読み取り権限がない

5xx

サーバーエラー

サーバーサイドエラーが発生しました。これらはまれですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストを再試行
• status.omise.coでサービスインシデントを確認
• 詳細なガイダンスはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/audits/search \
  -X GET \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "scope=audit" \
  -d "filters[created]=2024/01/01..2024/12/31" \
  -d "filters[actor_email][]=admin@example.com" \
  -d "filters[verb]=rules_switched"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

search = Omise::Search.execute(
  'audit',
  filters: {
    created: '2024/01/01..2024/12/31',
    actor_email: ['admin@example.com'],
    verb: 'rules_switched'
  }
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

search = omise.Search.execute(
    'audit',
    filters={
        'created': '2024/01/01..2024/12/31',
        'actor_email': ['admin@example.com'],
        'verb': 'rules_switched'
    }
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const search = await omise.search.list({
  scope: 'audit',
  filters: {
    created: '2024/01/01..2024/12/31',
    actor_email: ['admin@example.com'],
    verb: 'rules_switched'
  }
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$search = OmiseSearch::execute([
    'scope' => 'audit',
    'filters' => [
        'created' => '2024/01/01..2024/12/31',
        'actor_email' => ['admin@example.com'],
        'verb' => 'rules_switched'
    ]
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

SearchResult<Audit> search = client.search()
    .scope(SearchScope.Audit)
    .filter("created", "2024/01/01..2024/12/31")
    .filter("actor_email", Arrays.asList("admin@example.com"))
    .filter("verb", "rules_switched")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var search = await client.Search.Execute(new SearchRequest
{
    Scope = "audit",
    Filters = new Dictionary<string, object>
    {
        { "created", "2024/01/01..2024/12/31" },
        { "actor_email", new[] { "admin@example.com" } },
        { "verb", "rules_switched" }
    }
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

search, _ := client.Search(&operations.SearchOptions{
    Scope: "audit",
    Filters: map[string]interface{}{
        "created":     "2024/01/01..2024/12/31",
        "actor_email": []string{"admin@example.com"},
        "verb":        "rules_switched",
    },
})

---

エラーと結果コード

一般的なフィルターパターン

フィルター構文	説明	例
filters[created]=date..date	日付範囲	2024/01/01..2024/12/31
filters[actor_email][]=value	メール配列	admin@example.com
filters[verb]=value	完全一致	rules_switched
filters[auditable_type]=value	リソースタイプ	routing_group

利用可能なフィルター

フィルター	タイプ	説明
created	date-time	アクションのタイムスタンプでフィルター
actor_email	array	ユーザーメールでフィルター
actor_type	string	アクタータイプでフィルター（user）
auditable_type	string	リソースタイプでフィルター（routing_group）
auditable_uid	string	リソース識別子でフィルター
verb	string	アクションタイプでフィルター（rules_switched）

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

scope(必須)

推奨 - 3項目

▼

追加 - 6項目

▼

あなたのIP: ...読み込み中...