io.enterpriseai.resources.AuditClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/AuditClient.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 AuditClient
Audit. Le journal d'audit infalsifiable du tenant.
Constructeur AuditClient
AuditClient(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. |
AuditClient.correlations
JsonNode correlations()
Corréler les événements par trace, exécution ou session. Avec trace_id, run_id ou session_id (le premier donné l'emporte), renvoie tout ce qui partage cette clé : audit_events, usage_events des LLM, runs, spans de télémétrie, multimodal_jobs (jusqu'à 1000 de chaque, 200 pour les exécutions et les tâches), les trace_ids rencontrés et counts.
Route : /v1/audit/correlations (GET).
Cet élément ne prend aucun paramètre.
Retour : JsonNode. Réponse JSON décodée de l'opération « Corréler les événements par trace, exécution ou session ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuditClient.correlations
JsonNode correlations(Map<String, ?> query)
Corréler les événements par trace, exécution ou session. Avec trace_id, run_id ou session_id (le premier donné l'emporte), renvoie tout ce qui partage cette clé : audit_events, usage_events des LLM, runs, spans de télémétrie, multimodal_jobs (jusqu'à 1000 de chaque, 200 pour les exécutions et les tâches), les trace_ids rencontrés et counts.
Route : /v1/audit/correlations (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Corréler les événements par trace, exécution ou session ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuditClient.event
JsonNode event(String id)
Lire un événement d'audit. Renvoie un événement d'audit avec sa séquence, ses empreintes, son acteur, sa ressource, sa décision et ses preuves. Exige auditor, security_officer ou tenant_admin. La lecture est inscrite dans le journal d'accès aux preuves. Répond 404 not_found.
Route : /v1/audit/events/{event_id} (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) de l'événement d'audit. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lire un événement d'audit ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuditClient.events
Page<JsonNode> events()
Rechercher les événements d'audit. Recherche les événements d'audit du tenant, les plus récents d'abord (séquence la plus haute d'abord), paginés. Tous les filtres se combinent. Exige auditor, security_officer ou tenant_admin. La recherche elle-même est inscrite dans le journal d'accès aux preuves (qui, quelle requête, combien de résultats).
Route : /v1/audit/events (GET).
Cet élément ne prend aucun paramètre.
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Rechercher les événements d'audit ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuditClient.events
Page<JsonNode> events(Map<String, ?> query)
Rechercher les événements d'audit. Recherche les événements d'audit du tenant, les plus récents d'abord (séquence la plus haute d'abord), paginés. Tous les filtres se combinent. Exige auditor, security_officer ou tenant_admin. La recherche elle-même est inscrite dans le journal d'accès aux preuves (qui, quelle requête, combien de résultats).
Route : /v1/audit/events (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 « Rechercher les événements d'audit ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuditClient.export
JsonNode export(Object body)
Exporter le journal d'audit. Écrit les événements de la période (bornes incluses) dans un stockage à écriture unique, en NDJSON ou en CSV, avec un manifeste. Exige auditor, security_officer ou tenant_admin.
Route : /v1/audit/export (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Période, rétention et format de l'export. Un corps vide exporte tout en NDJSON conservé 365 jours. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Exporter le journal d'audit ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuditClient.export
JsonNode export(Object body, RequestOptions options)
Exporter le journal d'audit. Écrit les événements de la période (bornes incluses) dans un stockage à écriture unique, en NDJSON ou en CSV, avec un manifeste. Exige auditor, security_officer ou tenant_admin.
Route : /v1/audit/export (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Période, rétention et format de l'export. Un corps vide exporte tout en NDJSON conservé 365 jours. | |
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 « Exporter le journal d'audit ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuditClient.record
JsonNode record(Object body)
Enregistrer un événement d'audit applicatif. Ajoute un événement applicatif à la chaîne de hachage du tenant. L'acteur vient de l'authentification ; la séquence, les empreintes et occurred_at viennent du serveur ; les details du client sont conservés sous evidence.details.attributes, à côté de stream: sdk. L'événement est scellé et exporté vers la boîte d'envoi et le SIEM comme les événements de la plateforme.
Route : /v1/audit/events (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | L'événement applicatif. Les champs hors du schéma sont refusés. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Enregistrer un événement d'audit applicatif ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuditClient.record
JsonNode record(Object body, RequestOptions options)
Enregistrer un événement d'audit applicatif. Ajoute un événement applicatif à la chaîne de hachage du tenant. L'acteur vient de l'authentification ; la séquence, les empreintes et occurred_at viennent du serveur ; les details du client sont conservés sous evidence.details.attributes, à côté de stream: sdk. L'événement est scellé et exporté vers la boîte d'envoi et le SIEM comme les événements de la plateforme.
Route : /v1/audit/events (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | L'événement applicatif. Les champs hors du schéma sont refusés. | |
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 « Enregistrer un événement d'audit applicatif ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuditClient.verify
JsonNode verify()
Vérifier la chaîne d'audit. Recalcule la chaîne de hachage du tenant depuis le premier événement et renvoie tenant_id, valid, count, last_hash, broken_at, reason et verified_at. Quand la chaîne est rompue, broken_at est la séquence du premier événement fautif et reason en donne la cause : sequence gap, prev_hash mismatch ou hash mismatch. Exige auditor, security_officer ou tenant_admin. La vérification est inscrite dans le journal d'accès aux preuves.
Route : /v1/audit/verify (GET).
Cet élément ne prend aucun paramètre.
Retour : JsonNode. Réponse JSON décodée de l'opération « Vérifier la chaîne d'audit ».
Erreurs levées : les erreurs typées du transport (Erreurs).