監査イベント

Audit Event は、ユーザが Vonage API または Vonage Dashboard とやり取りする際に Vonage によって自動的に生成されます。各 Audit Event オブジェクトにはタイプと関連するメタデータがあります。

監査イベントの種類

以下の表は、現在サポートされているAudit Eventのタイプを示しています:

監査イベントの種類 説明
ACCOUNT_UPDATE_SETTINGS アカウント設定を更新
ACCOUNT_UPDATE_SETTINGS_API API経由でアカウント設定を更新
ACCOUNT_SECRET_CREATE シークレット・ローテーション
ACCOUNT_SECRET_DELETE シークレット・ローテーション
APP_CREATE アプリ作成
APP_DELETE アプリ削除
APP_DISABLE アプリ使用不可
APP_ENABLE アプリ対応
APP_UPDATE アプリ更新
AUTORELOAD_DISABLE 自動リロード無効
AUTORELOAD_ENABLE 自動リロードが有効
AUTORELOAD_UPDATE 自動リロード設定を更新
NUMBER_ASSIGN 割り当て番号
NUMBER_USER_CANCELED Numbersはユーザーによってキャンセルされました。
NUMBER_UPDATED 更新数
NUMBER_LINKED VonageアプリケーションにリンクされたNumbers
NUMBER_UNLINKED VonageアプリケーションからリンクされていないNumbers
USER_API_KEYS_UPDATE ユーザーのサブアカウントが更新されました。
USER_BILLING_UPDATE ユーザー課金更新
USER_CREATE ユーザー作成
USER_LOGIN ユーザーログイン (プレミアム・サポートのみ)
USER_LOGOUT ユーザーログアウト (プレミアム・サポートのみ)
USER_PRODUCT_SEARCH 検索に関する CDR またはダッシュボードのログ
USER_STATUS ユーザーステータス更新
USER_UPDATE ユーザー更新
IP_WHITELIST_CREATE ホワイトリストIP追加
IP_WHITELIST_CREATE 削除されたホワイトリストIP

注: サポートされるイベントタイプのリストは時々変更されます。そのため OPTIONS メソッドが提供されている。イベント・タイプの決定的なリストを返す方法は イベントタイプを取得するコード・スニペット

Auditイベントオブジェクト

API経由でAudit Eventsオブジェクトを取得すると、それらはそれぞれ event_type フィールドがある。 event_type は上の表のエントリーになります。さらに、Audit Event オブジェクトには、タイプに応じた他のメタデータが含まれます。

例えば NUMBER_UPDATED イベント・タイプでは、イベント・オブジェクトは以下のようになる:

    {
        "_links": {
          "self": {
            "href": "http://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
          }
        },
        "id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
        "event_type": "NUMBER_UPDATED",
        "event_type_description": "Number updated",
        "created_at": "2018-05-16T16:34:22",
        "user_email": "yourname@example.com",
        "user_id": 1234567,
        "account_id": "VONAGE_API_KEY",
        "source": "CD",
        "source_ip": "1.2.3.4",
        "source_description": "Customer dashboard",
        "source_country": "GB",
        "context": {
          "country": "GB",
          "msisdn": "447700900000",
          "http": "http://example.com:9000/webhooks/inbound-sms",
          "voice-type": "app",
          "voice-value": "VONAGE_APP_ID"
        }
      }