enterprise_ai.security
Source : sdks/python/src/enterprise_ai/security/__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 SecurityClient
/v1/security/posture et /v1/security/settings.
Resource
SecurityClient.cancel_run
cancel_run(run_id: str, reason: str | None = None) -> Any
Annuler un run. Fait passer le run à cancelled avec l'erreur cancelled ; ses runs de sous-agents actifs sont aussi annulés. Demande tenant_admin, developer, agent ou security_officer. Un run déjà terminé répond 409 invalid_transition. Audité sous run.transition.
Route : /v1/runs/{run_id}/cancel (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
run_id | str | oui | Identifiant (UUID) du run. | |
reason | str | None | None | non | Raison de l'action. Inscrite dans le journal d'audit avec l'acteur et l'heure. |
Retour : Any. Réponse JSON décodée de l'opération « Annuler un run ».
Erreurs levées : les erreurs typées du transport (Erreurs).
SecurityClient.check_state
check_state() -> Any
Lire la posture de sécurité. Renvoie environment, generated_at, protections (méthodes d'authentification et autres protections en vigueur), checks (chacun avec son statut pass, warn ou fail, sa gravité et son message) et summary (nombre de contrôles par statut). Pour un appelant rattaché à un tenant, renvoie aussi tenant avec les réglages de sécurité du tenant, dont certains contrôles tiennent compte. Exige security_officer ou tenant_admin. En lecture seule.
Route : /v1/security/posture (GET).
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse JSON décodée de l'opération « Lire la posture de sécurité ».
Erreurs levées : les erreurs typées du transport (Erreurs).
SecurityClient.get_settings
get_settings() -> Any
Lire les réglages de sécurité. Renvoie tenant_id et settings : les réglages de sécurité du tenant, valeurs par défaut comprises. Exige tenant_admin ou security_officer et un tenant (403 tenant_required).
Route : /v1/security/settings (GET).
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse JSON décodée de l'opération « Lire les réglages de sécurité ».
Erreurs levées : les erreurs typées du transport (Erreurs).
SecurityClient.posture
posture() -> Any
Lire la posture de sécurité. Renvoie environment, generated_at, protections (méthodes d'authentification et autres protections en vigueur), checks (chacun avec son statut pass, warn ou fail, sa gravité et son message) et summary (nombre de contrôles par statut). Pour un appelant rattaché à un tenant, renvoie aussi tenant avec les réglages de sécurité du tenant, dont certains contrôles tiennent compte. Exige security_officer ou tenant_admin. En lecture seule.
Route : /v1/security/posture (GET).
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse JSON décodée de l'opération « Lire la posture de sécurité ».
Erreurs levées : les erreurs typées du transport (Erreurs).
SecurityClient.report_incident
report_incident(title: str, severity: str, **extra: Any) -> Any
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 |
|---|---|---|---|---|
title | str | oui | Titre, 3 à 300 caractères. | |
severity | str | oui | sev1 (le plus grave) à sev4 ; les alias critical, high, medium et low sont acceptés. sev3 par défaut. | |
**extra | Any | non | Champs supplémentaires fusionnés dans le corps de la requête. |
Retour : Any. Réponse JSON décodée de l'opération « Ouvrir un incident ».
Erreurs levées : les erreurs typées du transport (Erreurs).
SecurityClient.update_settings
update_settings(settings: dict[str, Any] | None = None, **fields: Any) -> Any
Modifier les réglages de sécurité. Mise à jour partielle : seuls les réglages envoyés changent, les autres gardent leur valeur. Exige tenant_admin ou security_officer et un tenant.
Route : /v1/security/settings (PUT).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
settings | dict[str, Any] | None | None | non | Réglages à modifier ; les arguments nommés y sont fusionnés par-dessus. |
**fields | Any | non | Champs de la méthode (par exemple utilisateur et mot de passe), jusqu'à 16 valeurs texte. |
Retour : Any. Réponse JSON décodée de l'opération « Modifier les réglages de sécurité ».
Erreurs levées : les erreurs typées du transport (Erreurs).