API de detalles de entidades
La API de detalles de entidad recupera información sobre una entidad concreta utilizando su identificador único de entidad.
Visión general
La API de detalles de la entidad es un punto final RESTful que te permite recuperar información completa sobre una entidad concreta cuando conoces su identificador único. Este punto final resulta especialmente útil cuando se necesita información detallada sobre una entidad conocida, por ejemplo, al investigar incidentes de seguridad o al analizar los patrones de comportamiento de los usuarios.
Se accede a la API a través de la GET /api/entity/<entity_id>.
Parámetros de ruta
La API requiere el siguiente parámetro de ruta:
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| entity_id | entero | Sí | Identificador único de la entidad. Debe ser un número entero positivo. |
Estructura de la respuesta
La API devuelve información detallada sobre la entidad solicitada, entre la que se incluye:
- Identificador de entidad
- Nombre de usuario asociado
- Puntuación de riesgo actual
- Última puntuación de riesgo
- Marcas de tiempo de las actividades de las entidades
- Atributos adicionales relacionados con las entidades
Ejemplo de respuesta
El siguiente ejemplo muestra una respuesta típica de la API para una entidad:
{
"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"
}
]
}
Los campos de respuesta incluyen:
- risk_threshold indica el umbral de riesgo efectivo que se aplica a la consulta.
- «entities» contiene una matriz con los detalles de la entidad solicitada.
- «entity_id» es el identificador único de la entidad.
- El nombre de usuario es el nombre de usuario asociado a la entidad.
- risk_score representa la puntuación de riesgo actual de la entidad.
- «latest_risk» muestra la puntuación de riesgo más reciente calculada para la entidad.
- «first_seen» indica cuándo se observó por primera vez la entidad en el sistema.
- «last_seen» muestra la marca de tiempo de la actividad más reciente de la entidad.
Manejo de errores
La API devuelve códigos de estado estándar de HTTP para indicar el resultado de la solicitud:
| Estado de HTTP | Descripción |
|---|---|
| 400 Bad Request | El identificador de entidad facilitado no es válido. |
| 404 Not Found | No existe ninguna entidad con el identificador indicado. |
| 500 Internal Server Error | Se ha producido un error inesperado al recuperar la entidad. |