API für Entitätsdetails

Die Entity-Details-API ruft anhand der eindeutigen Entitäts-ID Informationen zu einer bestimmten Entität ab.

Übersicht

Die Entity-Details-API ist ein RESTful-Endpunkt, über den Sie umfassende Informationen zu einer bestimmten Entität abrufen können, sofern Sie deren eindeutige Kennung kennen. Dieser Endpunkt ist besonders nützlich, wenn detaillierte Informationen zu einer bekannten Entität benötigt werden, beispielsweise bei der Untersuchung von Sicherheitsvorfällen oder der Analyse von Verhaltensmustern der Nutzer.

Der Zugriff auf die API erfolgt über die GET /api/entity/<entity_id>.

Pfadparameter

Die API erfordert den folgenden Pfadparameter:

Parameter Typ Erforderlich Beschreibung
entity_id ganze Zahl Ja Eindeutige Kennung der Entität. Dies muss eine positive ganze Zahl sein.

Antwortstruktur

Die API gibt detaillierte Informationen zur angeforderten Entität zurück, darunter:

  • Entitäts-ID
  • Zugehöriger Benutzername
  • Aktueller Risikowert
  • Aktueller Risikowert
  • Zeitstempel für Entitätsaktivitäten
  • Weitere entitätsbezogene Attribute

Beispielantwort

Das folgende Beispiel zeigt eine typische API-Antwort für eine Entität:

{
  "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"
    }
  ]
}

Zu den Antwortfeldern gehören:

  • risk_threshold gibt den effektiven Risikoschwellenwert an, der auf die Abfrage angewendet wird.
  • „entities“ enthält ein Array mit den Details der angeforderten Entität.
  • „entity_id“ ist die eindeutige Kennung der Entität.
  • „username“ ist der Benutzername, der der Entität zugeordnet ist.
  • risk_score gibt den aktuellen Risikowert für das Unternehmen an.
  • „latest_risk“ gibt den aktuellsten Risikowert an, der für das Unternehmen berechnet wurde.
  • „first_seen“ gibt an, wann die Entität zum ersten Mal im System beobachtet wurde.
  • „last_seen“ zeigt den Zeitstempel der letzten Aktivität für die Entität an.

Fehlerbehandlung

Die API gibt Standard- HTTP -Statuscodes zurück, um das Ergebnis der Anfrage anzuzeigen:

HTTP-Status Beschreibung
400 Bad Request Die angegebene Entitätskennung ist ungültig.
404 Not Found Es gibt keine Entität mit der angegebenen Kennung.
500 Internal Server Error Beim Abrufen der Entität ist ein unerwarteter Fehler aufgetreten.