io.enterpriseai.resources.IncidentsClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/IncidentsClient.java. Retour à l'index de la référence du SDK Java.
Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.
Classe IncidentsClient
Incidents. Incidents de sécurité et d'exploitation du tenant : gravité, statut, chronologie, actions de confinement, alertes Alertmanager et transmission au SIEM.
Constructeur IncidentsClient
IncidentsClient(Transport transport)
Crée le client sur le transport partagé ; EnterpriseAIClient le construit, on y accède par l'accesseur du même nom.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
transport | Transport | oui | Transport partagé par les sous-clients d'un même client. |
IncidentsClient.action
JsonNode action(String id, Object body)
Lancer une action de confinement. Lance une action de confinement par le domaine propriétaire de la cible et l'enregistre sur l'incident. Exige tenant_admin ou security_officer.
Route : /v1/incidents/{incident_id}/actions (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) de l'incident. | |
body | Object | oui | Action, cible et raison. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lancer une action de confinement ».
Erreurs levées : les erreurs typées du transport (Erreurs).
IncidentsClient.action
JsonNode action(String id, Object body, RequestOptions options)
Lancer une action de confinement. Lance une action de confinement par le domaine propriétaire de la cible et l'enregistre sur l'incident. Exige tenant_admin ou security_officer.
Route : /v1/incidents/{incident_id}/actions (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) de l'incident. | |
body | Object | oui | Action, cible et raison. | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lancer une action de confinement ».
Erreurs levées : les erreurs typées du transport (Erreurs).
IncidentsClient.create
JsonNode create(Object body)
Ouvrir un incident. Ouvre un incident au statut open, ajoute l'entrée created à la chronologie et le transmet au SIEM. Exige tenant_admin, security_officer, developer ou agent. Une gravité inconnue répond 400 invalid_request. Écrit l'événement d'audit incident.create. La réponse (201) porte l'incident avec sa chronologie.
Route : /v1/incidents (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Titre, gravité, description, catégorie, ressources et responsable. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Ouvrir un incident ».
Erreurs levées : les erreurs typées du transport (Erreurs).
IncidentsClient.create
JsonNode create(Object body, RequestOptions options)
Ouvrir un incident. Ouvre un incident au statut open, ajoute l'entrée created à la chronologie et le transmet au SIEM. Exige tenant_admin, security_officer, developer ou agent. Une gravité inconnue répond 400 invalid_request. Écrit l'événement d'audit incident.create. La réponse (201) porte l'incident avec sa chronologie.
Route : /v1/incidents (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Titre, gravité, description, catégorie, ressources et responsable. | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Ouvrir un incident ».
Erreurs levées : les erreurs typées du transport (Erreurs).
IncidentsClient.get
JsonNode get(String id)
Lire un incident. Renvoie l'incident avec sa timeline (type, message, données, acteur, date) et ses actions de confinement (action, cible, statut, résultat). Ouvert à tout membre du tenant. Répond 404 not_found.
Route : /v1/incidents/{incident_id} (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) de l'incident. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lire un incident ».
Erreurs levées : les erreurs typées du transport (Erreurs).
IncidentsClient.list
Page<JsonNode> list()
Lister les incidents. Liste les incidents du tenant, identifiant le plus récent d'abord, paginés, éventuellement filtrés par statut et gravité. Les éléments ne portent ni la chronologie ni les actions (lisez un incident pour les obtenir). Ouvert à tout membre du tenant.
Route : /v1/incidents (GET).
Cet élément ne prend aucun paramètre.
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les incidents ».
Erreurs levées : les erreurs typées du transport (Erreurs).
IncidentsClient.list
Page<JsonNode> list(Map<String, ?> query)
Lister les incidents. Liste les incidents du tenant, identifiant le plus récent d'abord, paginés, éventuellement filtrés par statut et gravité. Les éléments ne portent ni la chronologie ni les actions (lisez un incident pour les obtenir). Ouvert à tout membre du tenant.
Route : /v1/incidents (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. |
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les incidents ».
Erreurs levées : les erreurs typées du transport (Erreurs).
IncidentsClient.receiveAlerts
JsonNode receiveAlerts(Object body)
Recevoir des alertes Alertmanager. Récepteur webhook de Prometheus Alertmanager (charge utile en version 4). Chaque alerte est identifiée par son fingerprint :
Route : /v1/incidents/alerts (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Charge utile du webhook Alertmanager, 500 alertes au plus. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Recevoir des alertes Alertmanager ».
Erreurs levées : les erreurs typées du transport (Erreurs).
IncidentsClient.receiveAlerts
JsonNode receiveAlerts(Object body, RequestOptions options)
Recevoir des alertes Alertmanager. Récepteur webhook de Prometheus Alertmanager (charge utile en version 4). Chaque alerte est identifiée par son fingerprint :
Route : /v1/incidents/alerts (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Charge utile du webhook Alertmanager, 500 alertes au plus. | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Recevoir des alertes Alertmanager ».
Erreurs levées : les erreurs typées du transport (Erreurs).
IncidentsClient.update
JsonNode update(String id, Object body)
Modifier un incident. Modifie le statut, la gravité ou le responsable et ajoute éventuellement une note. Chaque changement est ajouté à la chronologie et transmis au SIEM ; passer à resolved ou closed renseigne resolved_at. Exige tenant_admin ou security_officer. Un statut ou une gravité inconnus répondent 400 invalid_request. Écrit l'événement d'audit incident.update.
Route : /v1/incidents/{incident_id} (PATCH).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) de l'incident. | |
body | Object | oui | Champs à modifier et note facultative. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Modifier un incident ».
Erreurs levées : les erreurs typées du transport (Erreurs).
IncidentsClient.update
JsonNode update(String id, Object body, RequestOptions options)
Modifier un incident. Modifie le statut, la gravité ou le responsable et ajoute éventuellement une note. Chaque changement est ajouté à la chronologie et transmis au SIEM ; passer à resolved ou closed renseigne resolved_at. Exige tenant_admin ou security_officer. Un statut ou une gravité inconnus répondent 400 invalid_request. Écrit l'événement d'audit incident.update.
Route : /v1/incidents/{incident_id} (PATCH).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) de l'incident. | |
body | Object | oui | Champs à modifier et note facultative. | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Modifier un incident ».
Erreurs levées : les erreurs typées du transport (Erreurs).