Événements d'audit

Interroger les événements d'audit

/api/v1/audit_events/query

Autorisations requises : Lire les journaux d'audit.

• Bash

  curl -X POST 'https://<my_api_endpoint>/api/v1/audit_events/query' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "filter": {
      "timestamp": {
        "maximum": "2021-07-10T00:00:00Z",
        "minimum": "2021-06-10T00:00:00Z"
      }
    }
  }'
  

• Nœud

  const request = require("request");
  
  request.post(
    {
      url: "https://<my_api_endpoint>/api/v1/audit_events/query",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: {
        filter: {
          timestamp: {
            maximum: "2021-07-10T00:00:00Z",
            minimum: "2021-06-10T00:00:00Z",
          },
        },
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );
  

• Python

  import json
  import os
  
  import requests
  
  response = requests.post(
      "https://<my_api_endpoint>/api/v1/audit_events/query",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={
          "filter": {
              "timestamp": {
                  "minimum": "2021-06-10T00:00:00Z",
                  "maximum": "2021-07-10T00:00:00Z",
              }
          }
      },
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))
  

• Réponse

  {
    "audit_events": [
      {
        "actor_user_id": "e2148a6625225593",
        "dataset_ids": ["1fe230edc85ffc1a"],
        "event_id": "2555880060c23eb5",
        "event_type": "get_datasets",
        "project_ids": ["ce3c61dcf210f425", "274400867ab17af9"],
        "tenant_ids": ["c59b6e209da438a8"],
        "timestamp": "2021-06-10T16:32:53Z"
      }
    ],
    "continuation": "2555880060c23eb5",
    "datasets": [
      {
        "id": "1fe230edc85ffc1a",
        "name": "collateral-sharing",
        "project_id": "ce3c61dcf210f425",
        "title": "Collateral Sharing"
      },
      {
        "id": "274400867ab17af9",
        "name": "Customer-Feedback",
        "project_id": "ce3c61dcf210f425",
        "title": "Customer Feedback"
      }
    ],
    "projects": [
      {
        "id": "ce3c61dcf210f425",
        "name": "bank-collateral",
        "tenant_id": "c59b6e209da438a8"
      }
    ],
    "status": "ok",
    "tenants": [
      {
        "id": "c59b6e209da438a8",
        "name": "acme"
      }
    ],
    "users": [
      {
        "display_name": "Alice",
        "email": "[e-mail]",
        "id": "e2148a6625225593",
        "tenant_id": "c59b6e209da438a8",
        "username": "alice"
      }
    ]
  }
  

Un événement d’audit est l’enregistrement d’une action entreprise par un utilisateur de la plate-forme Communications Mining™. Exemples d'événements auditables :

• Un utilisateur qui se connecte
• Un utilisateur modifiant son mot de passe
• Un utilisateur qui modifie les autorisations d'un autre utilisateur.

Nom	Saisie de texte	Requis	DESCRIPTION
continuation	string	non	Si une requête précédente a renvoyé un continuation dans la réponse, une autre page d'événements est disponible. Définissez la valeur de poursuite renvoyée ici pour extraire la page suivante.
limit	Numérique	non	Le nombre d'événements d'audit à renvoyer par page. La valeur par défaut est 128.
filter	Filtrer (Filter)	non	Un filtre spécifiant les événements d'audit à renvoyer.

Où Filter a le format suivant :

Nom	Saisie de texte	Requis	DESCRIPTION
timestamp	FiltreHorodatage	non	Un filtre spécifiant la plage de temps dans laquelle renvoyer les événements.

Où TimestampFilter a le format suivant :

Nom	Saisie de texte	Requis	DESCRIPTION
minimum	string	non	Un horodatage ISO-8601. Si fourni, renvoie uniquement l'événement d'audit après ou incluant cet horodatage.
maximum	string	non	Un horodatage ISO-8601. Si fourni, renvoie uniquement l'événement d'audit avant cet horodatage.

Format de réponse

La liste des événements d'audit se trouve sous la clé audit_events au niveau supérieur de la réponse. Chaque AuditEvent peut référencer d'autres ressources (telles que des sources, des ensembles de données, des utilisateurs, etc.) par ID. Pour chaque ressource référencée, des informations supplémentaires peuvent être trouvées sous la clé respective (sources, datasets, users, etc.) au niveau supérieur de la réponse.

Un AuditEvent représente une action entreprise par un utilisateur dans la plate-forme et a le format de base suivant. Des clés supplémentaires peuvent être présentes selon la valeur de event_type. Par exemple, un événement d'audit get_datasets contiendra une liste d' dataset_ids lus par l'utilisateur.

Nom	Saisie de texte	DESCRIPTION
event_id	string	ID unique de cet événement.
event_type	string	Type de cet événement. Référez-vous à la liste des types d’événements dans la section suivante.
timestamp	string	L'horodatage ISO-8601 de cet événement, à la seconde la plus proche.
actor_user_id	string	L'ID de l'utilisateur qui a exécuté cette action.
actor_tenant_id	string	L'ID de locataire de l'utilisateur ayant exécuté cette action.

Enfin, si la réponse contient une clé continuation , vous devez récupérer la page d'événements suivante en définissant le champ continuation de la requête sur cette valeur.

Types d'événements d'audit

Événements d'audit d'alerte

Type d'événement	DESCRIPTION
alert_create	Une alerte est créée.
alert_get	Une alerte est affichée.
alert_get_all	Une liste d'alertes s'affiche.
alert_update	La configuration d'une alerte est modifiée.
alert_delete	Une alerte est supprimée.
alert_subscriptions_get	Une liste des abonnements aux alertes s'affiche.
alert_subscriptions_delete	Un abonnement aux alertes est supprimé.

Quota d'événements d'audit

Type d'événement	DESCRIPTION
quotas_get	Les quotas sont consultés.
quotas_set	Un quota est mis à jour.
quotas_reset	Un quota est réinitialisé.

Événements d’audit de flux

Remarque :

Les flux étaient auparavant appelés déclencheurs.

Type d'événement	DESCRIPTION
trigger_create	Un flux est créé.
trigger_get	Un flux est visualisé.
trigger_get_all	Une liste de flux est affichée.
trigger_update	La configuration d'un flux est modifiée.
trigger_delete	Un flux est supprimé.
trigger_fetch	Un flux est interrogé (opération héritée).
trigger_advance	Un flux est avancé.
trigger_reset	Un flux est réinitialisé.
trigger_fetch_gx	Un flux d’extraction génératif est interrogé (opération héritée).
trigger_get_results	Un flux est interrogé.

Événements d’audit de la gestion du modèle

Type d'événement	DESCRIPTION
model_version_published	Lorsqu'un modèle est publié (UCD)/épinglé (CM).
model_version_unpublished	Lorsqu’un modèle publié est supprimé.
model_tag_updated	Lorsqu'une balise de modèle est mise à jour.
model_tag_deleted	Lorsqu'une balise de modèle est supprimée.

Événements d’audit de la gestion des ensembles de données

Type d'événement	DESCRIPTION
get_datasets	Lorsque les ensembles de données sont récupérés.
get_datasets_by_owner	Lorsque les jeux de données sont récupérés par le propriétaire.
get_dataset	Lorsqu’un ensemble de données spécifique est récupéré.
export_dataset	Lorsqu’un ensemble de données est exporté.

Événements d'audit de la gestion des utilisateurs

Type d'événement	DESCRIPTION
create_user	Lorsqu’un nouvel utilisateur est créé.
delete_user	Lorsqu’un utilisateur est supprimé.
get_users	Lorsque les informations de l'utilisateur sont récupérées.
update_user	Lorsque les informations de l'utilisateur sont modifiées.

Événements d'authentification et d'audit de sécurité

Type d'événement	DESCRIPTION
login_success	Connexion de l'utilisateur réussie.
authentication_failed_password	Connexion échouée en raison d'un mot de passe incorrect.
authentication_failed_totp	Connexion échouée en raison d'un code TOTP erroné.
login_failed_ip_address	Connexion échouée en raison de restrictions de l'adresse IP.
revoke_api_tokens	Lorsque les jetons API sont révoqués.
revoke_login_tokens	Lorsque les jetons de connexion sont révoqués.
revoke_current_login_token	Lorsque le jeton de session en cours est révoqué.
replace_api_token	Lorsque le jeton API est remplacé.
authentication_failed_totp_lockout	Connexion échouée en raison du verrouillage de TOTP.

Événements d'audit de réinitialisation du mot de passe

Type d'événement	DESCRIPTION
send_password_reset_success	E-mail de réinitialisation de mot de passe envoyé avec succès.
send_password_reset_failed_ip_address	Réinitialisation du mot de passe bloquée par l’IP.
verify_password_reset_success	Vérification réussie de la réinitialisation du mot de passe.
verify_password_reset_failed_ip_address	Vérification de la réinitialisation du mot de passe bloquée par l’adresse IP.
change_password_success	Modification de mot de passe réussie.
change_password_failed_totp	Échec de la modification du mot de passe en raison de TOTP.
change_password_failed_ip_address	Modification du mot de passe bloquée par l’IP.
verify_password_reset_failed_signature	Signature de réinitialisation de mot de passe non valide.
verify_password_reset_failed_timestamp	Lien de réinitialisation du mot de passe expiré.
change_password_failed_current_password	Mot de passe actuel incorrectement fourni.

Commentaire - Événements d'audit de requête

Type d'événement	DESCRIPTION
comment_query_text	Requêtes de commentaires basées sur du texte.
comment_query_sample	Exemples de requêtes de commentaire.
comment_query_learning	Requêtes de commentaires liées à l'apprentissage.
comment_query_any_label_asc	Requêtes basées sur des libellés (par ordre croissant).
comment_query_recent	Requêtes de commentaires récents.
comment_query_by_label	Requêtes filtrées par des étiquettes spécifiques.
comment_query_diagnostic	Requêtes de commentaires de diagnostic.
comment_query_label_property	Requêtes de propriété d'étiquettes.
comment_query_attachment_text	Requêtes de Text de pièce jointe.
comment_query_check	Requêtes de commentaire de type Check.
comment_query_missed	Requêtes de commentaires manquantes.

Événements d’audit d’annotation

Type d'événement	DESCRIPTION
get_annotations	Lorsque les annotations sont récupérées.
update_annotation	Lorsque les annotations sont modifiées.

Événements d’audit du système et de l’administrateur

Type d'événement	DESCRIPTION
get_deprecated_user_models	Lors de l’accès aux modèles d’utilisateurs obsolètes.
audit_event_query	Lorsque les événements d'audit eux-mêmes sont interrogés.
email_get	Quand les e-mails sont récupérés.