API « Détails de l'entité »

L'API « Entity Details » récupère des informations sur une entité spécifique à l'aide de son identifiant unique.

Présentation

L'API « Détails de l'entité » est un point de terminaison RESTful qui vous permet de récupérer des informations complètes sur une entité spécifique lorsque vous connaissez son identifiant unique. Cette interface est particulièrement utile lorsqu'il est nécessaire d'obtenir des informations détaillées sur une entité connue, par exemple lors d'enquêtes sur des incidents de sécurité ou d'analyses des comportements des utilisateurs.

L'accès à l'API se fait via le GET /api/entity/<entity_id>.

Paramètres de chemin

L'API nécessite le paramètre de chemin suivant :

Paramètre Type Obligatoire Descriptif
ID d'entité entier Oui Identifiant unique de l'entité. Doit être un nombre entier positif.

Structure de la réponse

L'API renvoie des informations détaillées sur l'entité demandée, notamment :

  • Identificateur d'entité
  • Nom d'utilisateur associé
  • Score de risque actuel
  • Dernier score de risque
  • Horodatages des activités des entités
  • Attributs supplémentaires liés aux entités

Exemple de réponse

L'exemple suivant illustre une réponse API typique pour une entité :

{
  "risk_threshold": 50.0,
  "entities": [
    {
      "entity_id": 12345,
      "username": "john.doe",
      "risk_score": 78.5,
      "latest_risk": 82.0,
      "first_seen": "2026-05-10T08:15:00Z",
      "last_seen": "2026-06-15T14:30:00Z"
    }
  ]
}

Les champs de réponse sont les suivants :

  • risk_threshold indique le seuil de risque effectif appliqué à la requête.
  • La variable « entities » contient un tableau renfermant les détails de l'entité demandée.
  • « entity_id » est l'identifiant unique de l'entité.
  • « username » correspond au nom d'utilisateur associé à l'entité.
  • risk_score correspond au score de risque actuel de l'entité.
  • latest_risk indique le dernier score de risque calculé pour l'entité.
  • first_seen indique la date à laquelle l'entité a été observée pour la première fois dans le système.
  • « last_seen » indique l'horodatage de la dernière activité de l'entité.

Traitement des erreurs

L'API renvoie des codes d'état standard de l' HTTP pour indiquer le résultat de la requête :

Statut HTTP Descriptif
400 Bad Request L'identifiant d'entité fourni n'est pas valide.
404 Not Found Aucune entité ne correspond à l'identifiant indiqué.
500 Internal Server Error Une erreur inattendue s'est produite lors de la récupération de l'entité.