Récupérer les événements d'audit

Vous pouvez récupérer un enregistrement de tous les événements d'audit associés à votre Account Vonage. Vous pouvez également filtrer cette liste en fonction des dates, des mots-clés, des utilisateurs et du type d'événement.

Dans ce tutoriel

Vous verrez comment récupérer une liste filtrée d'événements d'audit :

Conditions préalables

Pour suivre ce tutoriel, vous aurez besoin des éléments suivants

  • A Account Vonage.
  • Une application Terminal dans laquelle vous pouvez taper ou coller des commandes Curl. Vous pouvez également utiliser Paw, Postman ou une application similaire.
  • Vous devez connaître votre VONAGE_API_KEY et VONAGE_API_SECRET que vous pouvez obtenir auprès de votre tableau de bord.

Vous pouvez également vous référer à la Documentation de l'API Audit.

NOTE : Dans les exemples ci-dessous, veuillez remplacer VONAGE_API_KEY et VONAGE_API_SECRET avec les valeurs réelles obtenues à partir de votre tableau de bord.

Récupérer une liste d'événements d'audit

Pour recevoir une liste de tous les événements d'audit, entrez ce qui suit dans votre terminal :

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

Lorsque vous exécutez cette commande, vous obtenez une liste de tous les événements d'audit.

Récupérer une liste filtrée d'événements d'audit

La liste des événements d'audit que vous avez reçue à l'étape précédente risque d'être écrasante, surtout si vous utilisez votre Account Vonage depuis un certain temps. Vous pouvez filtrer cette liste en fonction de plusieurs paramètres :

Paramètre d'interrogation Description
event_type Le type d'événement d'audit, par exemple : APP_CREATE, NUMBER_ASSIGNet ainsi de suite. Vous pouvez spécifier une liste délimitée par des virgules de types d'événements ici.
search_text Chaîne de recherche compatible JSON. Recherche d'un texte spécifique dans un événement d'audit.
date_from Récupérer les événements d'audit à partir de cette date (au format ISO-8601).
date_to Récupérer les événements d'audit jusqu'à cette date (au format ISO-8601).
page Numéro de page à partir de la page 1.
size Nombre d'éléments par page (entre 1 et 100, par défaut 30).

Par exemple, pour filtrer sur la base des dates, vous pouvez entrer la commande suivante :

$ 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'

Cela renverra tous les événements d'audit qui se sont produits au cours du mois d'août 2018.

Il est possible d'affiner ces critères de différentes manières. Par exemple, vous pouvez également filtrer en fonction de type d'événement d'audit.

Ainsi, par exemple, pour trouver les événements d'audit du mois d'août de type NUMBER_ASSIGN vous pourriez entrer ce qui suit :

$  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'

Vous pouvez également filtrer en fonction des éléments suivants search_text. Par exemple, pour trouver tous les événements d'audit contenant le texte "mot de passe", vous pouvez entrer la commande suivante :

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

Récupérer un événement d'audit spécifique

Si vous connaissez l'UUID d'un événement d'audit spécifique, vous pouvez récupérer les informations relatives à cet objet d'événement d'audit. Par exemple, si l'UUID de l'événement est aaaaaaaa-bbbb-cccc-dddd-0123456789ab vous entreriez :

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

Cela renverrait alors l'objet d'audit JSON pour l'événement d'audit spécifié.

Conclusion

En utilisant les capacités de filtrage de l'API Audit, vous avez un contrôle total sur les événements d'audit que vous récupérez.

Ressources