Abrufen von Audit-Ereignissen

Sie können eine Aufzeichnung aller Audit-Ereignisse abrufen, die mit Ihrem Vonage Account verbunden sind. Sie können diese Liste auch nach Datum, Schlüsselwort, Benutzer und Ereignistyp filtern.

In diesem Lernprogramm

Sie werden sehen, wie Sie eine gefilterte Liste von Audit-Ereignissen abrufen können:

Voraussetzungen

Um dieses Tutorial durchzuarbeiten, benötigen Sie:

  • A Vonage-Konto.
  • Eine Terminal-Anwendung, in die Sie Curl-Befehle eingeben oder einfügen können. Alternativ können Sie auch Paw, Postman oder eine ähnliche Anwendung verwenden.
  • Sie müssen wissen, dass Ihr VONAGE_API_KEY und VONAGE_API_SECRET die Sie bei Ihrem Dashboard.

Sie können sich auch auf die Audit-API-Dokumentation.

HINWEIS: In den folgenden Beispielen ersetzen Sie bitte VONAGE_API_KEY und VONAGE_API_SECRET mit den tatsächlichen Werten, die Sie von Ihrem Dashboard.

Abrufen einer Liste von Audit-Ereignissen

Um eine Liste aller Audit-Ereignisse zu erhalten, geben Sie Folgendes in Ihr Terminal ein:

curl "https://api.nexmo.com/beta/audit/events" \ -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

Wenn Sie diesen Befehl ausführen, erhalten Sie eine Liste mit allen Audit-Ereignissen.

Abrufen einer gefilterten Liste von Audit-Ereignissen

Die Liste der Audit-Ereignisse, die Sie im vorangegangenen Schritt erhalten haben, kann sehr umfangreich sein, vor allem, wenn Sie Ihren Vonage Account bereits seit einiger Zeit nutzen. Sie können diese Liste anhand mehrerer Parameter filtern:

Abfrage Parameter Beschreibung
event_type Die Art des Audit-Ereignisses, zum Beispiel: APP_CREATE, NUMBER_ASSIGNund so weiter. Sie können eine kommagetrennte Liste von Ereignistypen hier.
search_text JSON-kompatible Suchzeichenfolge. Suchen Sie nach einem bestimmten Text in einem Audit-Ereignis.
date_from Abrufen von Audit-Ereignissen ab diesem Datum (im ISO-8601-Format).
date_to Abrufen von Audit-Ereignissen bis zu diesem Datum (im ISO-8601-Format).
page Seitenzahl beginnend mit Seite 1.
size Anzahl der Elemente pro Seite (zwischen 1 und 100, Standardwert 30).

Um zum Beispiel nach dem Datum zu filtern, können Sie den folgenden Befehl eingeben:

$ curl "https://api.nexmo.com/beta/audit/events?date_from=2018-08-01&date_to=2018-08-31" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

Hier finden Sie alle Audit-Ereignisse, die im August 2018 stattgefunden haben.

Sie können dies auf verschiedene Weise weiter eingrenzen. Sie können zum Beispiel auch nach folgenden Kriterien filtern Audit-Ereignisart.

Um zum Beispiel Audit-Ereignisse im August vom Typ NUMBER_ASSIGN könnten Sie Folgendes eingeben:

$  curl "https://api.nexmo.com/beta/audit/events?date_from=2018-08-01&date_to=2018-08-31&event_type=NUMBER_ASSIGN" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

Sie können weiter filtern auf der Basis von search_text. Um zum Beispiel alle Audit-Ereignisse zu finden, die den Text "password" enthalten, können Sie den folgenden Befehl eingeben:

$  curl "https://api.nexmo.com/beta/audit/events?search_text=password" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

Ein bestimmtes Audit-Ereignis abrufen

Wenn Sie die UUID für ein bestimmtes Audit-Ereignis kennen, können Sie die Informationen für dieses Audit-Ereignisobjekt abrufen. Wenn die UUID des Ereignisses zum Beispiel aaaaaaaa-bbbb-cccc-dddd-0123456789ab würden Sie eingeben:

$ curl "https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

Dies würde dann das Audit-Ereignisobjekt JSON für das angegebene Audit-Ereignis zurückgeben.

Schlussfolgerung

Mit den Filterfunktionen der Audit-API haben Sie die vollständige Kontrolle über die abgerufenen Audit-Ereignisse.

Ressourcen