enterprise_ai.evidence
Source : sdks/python/src/enterprise_ai/evidence/__init__.py. Retour à l'index de la référence du SDK Python.
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 EvidenceClient
Preuves. Couche de preuve du journal d'audit : sceaux signés, paquets vérifiables hors ligne, moniteur d'intégrité, Audit Gateway, charges utiles chiffrées, accès audités, gels juridiques et preuves de purge, et configuration d'exécution des exécutions d'agents.
Resource
EvidenceClient.access_log
access_log(limit: int | None = None) -> Any
Lire le journal d'accès à l'audit. Renvoie les derniers accès au journal d'audit, les plus récents d'abord : acteur, rôles, type (read, search, verify, export, payload_decrypt, seal_read), requête, nombre de résultats, raison et événement d'audit écrit. Exige auditor ou security_officer. La lecture du journal est elle-même enregistrée.
Route : /v1/evidence/access-log (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
limit | int | None | None | non | Nombre maximal d'entrées (200 par défaut, 1000 au maximum). |
Retour : Any. Réponse JSON décodée de l'opération « Lire le journal d'accès à l'audit ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.alerts
alerts(status: str | None = None) -> Any
Lister les alertes d'intégrité. Liste les alertes d'intégrité du tenant ouvertes par le moniteur : chain_broken, sequence_gap, seal_invalid, outbox_missing ou clock_skew, rafraîchies tant que le problème persiste. Exige auditor, security_officer ou tenant_admin.
Route : /v1/evidence/alerts (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
status | str | None | None | non | Uniquement les alertes open ou acknowledged. |
Retour : Any. Réponse JSON décodée de l'opération « Lister les alertes d'intégrité ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.bundle
bundle() -> Any
Exporter un paquet de preuves hors ligne. Renvoie bundle (événements, sceaux et clés publiques du tenant) et manifest (format, nombres, SHA-256 du paquet canonique, alg: Ed25519, identifiant de clé, clé publique et signature par la clé de scellement). Un auditeur externe le vérifie hors ligne avec python -m eai.domains.evidence.verify. Exige auditor ou security_officer. Répond 503 audit_seal_key_unavailable sans clé de signature. L'export est inscrit dans le journal d'accès.
Route : /v1/evidence/bundle (GET).
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse JSON décodée de l'opération « Exporter un paquet de preuves hors ligne ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.create_hold
create_hold(case_id: str, reason: str, time_from: str | None = None, time_to: str | None = None) -> Any
Poser un gel juridique de preuves. Pose un gel juridique sur les charges utiles du tenant pour un dossier et une période facultative de date d'événement : tant qu'il est actif, la purge des charges utiles et les effacements ignorent les événements qu'il couvre. time_to doit suivre time_from (400 invalid_request). Exige auditor, security_officer ou tenant_admin. Écrit l'événement d'audit audit.legal_hold.create. Répond 201 avec le gel.
Route : /v1/evidence/holds (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
case_id | str | oui | Référence du dossier, 1 à 200 caractères. | |
reason | str | oui | Raison du gel, 3 à 1000 caractères. | |
time_from | str | None | None | non | Début de la période de date d'événement couverte (ISO 8601). Null : pas de borne basse. |
time_to | str | None | None | non | Fin de la période couverte (ISO 8601), après time_from. Null : pas de borne haute. |
Retour : Any. Réponse JSON décodée de l'opération « Poser un gel juridique de preuves ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.create_seal
create_seal() -> Any
Sceller la chaîne d'audit maintenant. Écrit un sceau sur les événements écrits depuis le sceau précédent (jusqu'au maximum par sceau de la plateforme) et le renvoie (201). Exige security_officer ou auditor. Répond 409 audit_nothing_to_seal quand aucun événement n'attend, 503 audit_seal_key_unavailable sans clé de signature.
Route : /v1/evidence/seals (POST).
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse JSON décodée de l'opération « Sceller la chaîne d'audit maintenant ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.gateway
gateway() -> Any
Lire l'état de l'Audit Gateway. Renvoie l'état de livraison des événements d'audit du tenant vers le SIEM : targets configurées, nombres pending et delivered, max_attempts d'un événement en attente et oldest_pending. Exige auditor, security_officer ou tenant_admin.
Route : /v1/evidence/gateway (GET).
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse JSON décodée de l'opération « Lire l'état de l'Audit Gateway ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.list_holds
list_holds() -> Any
Lister les gels juridiques de preuves. Liste les gels juridiques du tenant avec leur dossier, leur période, leur raison, leur statut et leurs approbations de levée. Exige auditor, security_officer ou tenant_admin.
Route : /v1/evidence/holds (GET).
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse JSON décodée de l'opération « Lister les gels juridiques de preuves ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.list_seals
list_seals() -> Any
Lister les sceaux d'audit. Liste les sceaux de la chaîne du tenant : numéro, plage de séquences, racine de Merkle, premières et dernières empreintes, empreinte du sceau précédent, identifiant de clé, signature et date. Exige auditor, security_officer ou tenant_admin. La lecture est inscrite dans le journal d'accès.
Route : /v1/evidence/seals (GET).
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse JSON décodée de l'opération « Lister les sceaux d'audit ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.payload
payload(event_id: str, reason: str) -> Any
Déchiffrer la charge utile d'un événement d'audit. Renvoie dans payload les champs sensibles déchiffrés d'un événement, avec access_event_id, l'événement d'audit qui enregistre cet accès. Uniquement auditor ou security_officer détenus explicitement : platform_admin ne suffit pas (403 forbidden). Une reason est obligatoire. Erreurs : 404 not_found (pas de charge utile), 410 audit_payload_purged (expirée ou effacée), 409 audit_payload_tampered (empreinte du chiffré différente), 503 audit_payload_key_unavailable.
Route : /v1/evidence/events/{event_id}/payload (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
event_id | str | oui | Identifiant (UUID) de l'événement d'audit. | |
reason | str | oui | Raison de la lecture, 5 à 500 caractères. Inscrite dans le journal d'accès. |
Retour : Any. Réponse JSON décodée de l'opération « Déchiffrer la charge utile d'un événement d'audit ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.record_components
record_components(run_id: str, components: list[dict[str, Any]], step_seq: int | None = None) -> Any
Enregistrer les composants d'une exécution. Enregistre, en ajout seul, les versions des composants utilisés par une exécution d'agent, ou par l'une de ses étapes avec step_seq (appel d'outil, appel de modèle). Chaque déclaration est auditée avec le champ versions de l'événement d'audit. Exige tenant_admin, agent_operator ou developer. Répond 201 avec les éléments enregistrés, ou 404 not_found pour une exécution inconnue.
Route : /v1/evidence/runs/{run_id}/components (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
run_id | str | oui | Identifiant (UUID) de l'exécution d'agent. | |
components | list[dict[str, Any]] | oui | Composants utilisés, de 1 à 100. | |
step_seq | int | None | None | non | Numéro de séquence de l'étape (1 ou plus) ; omettez-le pour l'exécution entière. |
Retour : Any. Réponse JSON décodée de l'opération « Enregistrer les composants d'une exécution ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.release_hold
release_hold(hold_id: str, reason: str) -> Any
Approuver la levée d'un gel juridique. Enregistre une approbation de levée avec sa raison. Le gel est levé à la seconde approbation par un approbateur distinct ; la même personne deux fois répond 409 audit_hold_same_approver, un gel qui n'est plus actif 409 audit_hold_not_active, un gel inconnu 404. Exige auditor, security_officer ou tenant_admin. Écrit audit.legal_hold.release_approve, puis audit.legal_hold.release.
Route : /v1/evidence/holds/{hold_id}/release (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
hold_id | str | oui | Identifiant (UUID) du gel juridique. | |
reason | str | oui | Raison pour laquelle le gel peut être levé, 3 à 1000 caractères. |
Retour : Any. Réponse JSON décodée de l'opération « Approuver la levée d'un gel juridique ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.retention
retention() -> Any
Lister les preuves de purge. Liste les preuves de purge du tenant : type, date limite, nombres purgés et gelés, séquences purgées et racine de Merkle des empreintes des chiffrés purgés, jamais les contenus. Exige auditor, security_officer ou tenant_admin.
Route : /v1/evidence/retention/evidence (GET).
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse JSON décodée de l'opération « Lister les preuves de purge ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.run_configuration
run_configuration(run_id: str) -> Any
Lire la configuration d'exécution d'une exécution. Reconstitue la configuration d'exécution d'une exécution d'agent : version de l'agent et empreinte du manifeste, composants déclarés par type (modèle, prompt, outil, compétence, plugin) avec leurs versions et empreintes, et décisions de politique enregistrées pour l'exécution. Exige auditor, security_officer ou tenant_admin, agent_operator ou developer. La lecture est inscrite dans le journal d'accès. Répond 404 not_found pour une exécution inconnue.
Route : /v1/evidence/runs/{run_id}/configuration (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
run_id | str | oui | Identifiant (UUID) de l'exécution d'agent. |
Retour : Any. Réponse JSON décodée de l'opération « Lire la configuration d'exécution d'une exécution ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.run_retention
run_retention(kind: str | None = None, cutoff: str | None = None, event_ids: list[str] | None = None, dry_run: bool | None = None) -> Any
Purger les charges utiles d'audit expirées. Supprime des charges utiles d'audit chiffrées ; les événements, la chaîne et les sceaux restent et continuent de se vérifier.
Route : /v1/evidence/retention/run (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
kind | str | None | None | non | retention (par défaut, par ancienneté) ou erasure (événements listés). |
cutoff | str | None | None | non | Pour retention : les charges utiles des événements antérieurs à cette date sont purgées (ISO 8601). Par défaut : maintenant moins la durée de conservation des charges utiles. |
event_ids | list[str] | None | None | non | Pour erasure : événements dont les charges utiles sont effacées, 1000 au plus. Obligatoire pour un effacement. |
dry_run | bool | None | None | non | Si vrai, indique ce qui serait purgé sans rien supprimer (faux par défaut). |
Retour : Any. Réponse JSON décodée de l'opération « Purger les charges utiles d'audit expirées ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.verify
verify() -> Any
Vérifier la chaîne et tous les sceaux. Vérifie toute la chaîne du tenant et tous ses sceaux et renvoie tenant_id, valid, chain (résultat de la chaîne de hachage), seals (nombre et échecs), clock (échecs d'horodatage) et events (nombre vérifié). Exige auditor, security_officer ou tenant_admin. La vérification est inscrite dans le journal d'accès.
Route : /v1/evidence/verify (GET).
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse JSON décodée de l'opération « Vérifier la chaîne et tous les sceaux ».
Erreurs levées : les erreurs typées du transport (Erreurs).
EvidenceClient.verify_seal
verify_seal(seal_id: str) -> Any
Vérifier un sceau d'audit. Recalcule le sceau à partir des événements qu'il couvre et des sceaux qui le précèdent et vérifie sa signature. Renvoie seal, valid et failures. Exige auditor, security_officer ou tenant_admin. Répond 404 not_found pour un sceau inconnu. La vérification est inscrite dans le journal d'accès.
Route : /v1/evidence/seals/{seal_id}/verify (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
seal_id | str | oui | Identifiant (UUID) du sceau. |
Retour : Any. Réponse JSON décodée de l'opération « Vérifier un sceau d'audit ».
Erreurs levées : les erreurs typées du transport (Erreurs).