interfaces_b93.go (package eai)
Source : sdks/go/interfaces_b93.go. Retour à l'index de la référence du SDK Go.
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.
Modèle AssumeRequest
AssumeRequest est le corps de POST /v1/service-identities/{identity_id}/assume.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
Purpose (purpose) | string | oui | Usage de la cible. backup par défaut. |
Audience (audience) | []string | non | Audience vaut par défaut, côté serveur, le service lui-même. |
TTLSeconds (ttl_seconds) | int | non | Durée de vie en secondes. Une fois écoulée, l'élément expire et n'est plus accepté. |
Scopes (scopes) | []string | non | Portées demandées ; doivent comprendre openid. Par défaut openid, profile, email. |
Modèle AuthzCheck
AuthzCheck est une vérification de relation de POST /v1/authz/check.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
Subject (subject) | string | oui | Sujet dont l'accès est vérifié (subject). |
Relation (relation) | string | oui | Relation à vérifier entre le sujet et l'objet (relation). |
Object (object) | string | oui | Objet vérifié, <type>:<id>, par exemple project:42. |
Modèle AuthzResult
AuthzResult est la réponse confirmée d'une vérification.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
AuthzCheck | embedded | oui | La vérification envoyée, intégrée : Subject, Relation, Object. |
Allowed (allowed) | bool | oui | Décision du serveur, lue dans un booléen allowed explicite ; jamais une autorisation par défaut. |
Engine (engine) | string | oui | Auto (par défaut), HPA ou KEDA. |
Classe Span
Span est un span côté client ; EndSpan l'envoie à POST /v1/telemetry/spans.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
TraceID | string | oui | Identifiant de trace, 32 caractères hexadécimaux aléatoires quand StartSpan n'en a pas reçu. |
SpanID | string | oui | Identifiant aléatoire du span, 16 caractères hexadécimaux. |
ParentSpanID | string | oui | Identifiant du span parent, vide pour un span racine. |
Name | string | oui | Nom du span. |
Start | time.Time | oui | Heure de début du span, en UTC. |
Attributes | map[string]any | oui | Attributs du span, envoyés par EndSpan ; jamais nil après StartSpan. |
Span.RecordEvent
RecordEvent(name string, attributes map[string]any)
RecordEvent ajoute au span un événement horodaté.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | string | oui | Nom de l'événement. | |
attributes | map[string]any | oui | Attributs de l'événement. |
Classe ServiceIdentitiesService
ServiceIdentitiesService regroupe les points d'accès suivants : identités de service (identifiants SPIFFE).
ServiceIdentitiesService.AssumeService
AssumeService(ctx context.Context, identityID string, req AssumeRequest, opts ...CallOption) (json.RawMessage, error)
Endosser une identité de service. Renvoie un ExecutionContext signé et de courte durée dont le sujet est l'identité de service, pour l'appelant. Ce n'est pas un identifiant d'API : les services en aval le vérifient (POST /v1/context/verify ou le JWKS) et l'appelant le révoque avec POST /v1/context/{context_id}/revoke.
Route : /v1/service-identities/{identity_id}/assume (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
identityID | string | oui | Identifiant (UUID) de l'identité de service. | |
req | AssumeRequest | oui | Finalité, audiences, durée de vie et portées du contexte demandé. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Endosser une identité de service ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
ServiceIdentitiesService.Current
Current(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
Afficher l'identité appelante. Renvoie l'identité résolue par la plateforme pour cette requête, quel que soit l'identifiant (jeton OIDC, session du portail, clé d'API, SPIFFE) : id, kind (user, service, agent, system), tenant_id, tenant_slug, roles, scopes, clearance, auth_method et display. En lecture seule, ouvert à tout appelant authentifié, y compris quand un compte local doit encore changer son mot de passe. Utilisez-la pour vérifier un nouveau jeton ou une nouvelle clé.
Route : /v1/identity/whoami (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Afficher l'identité appelante ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
ServiceIdentitiesService.Verify
Verify(ctx context.Context, token string, audience string, opts ...CallOption) (json.RawMessage, error)
Vérifier un contexte d'exécution signé. Contrôle un jeton et renvoie valid, context_id, kid, alg, les revendications et le document de contexte. Contrôles, dans l'ordre : structure et forme canonique (context_malformed), algorithme et signature (context_invalid_signature), clé connue et non révoquée (context_unknown_key), émetteur (context_wrong_issuer), audience (context_wrong_audience), durée de vie (context_expired), tenant de l'appelant (403 context_tenant_mismatch), enregistrement d'émission (context_revoked), empreinte du document et chaîne de délégation (une délégation révoquée donne context_revoked). Les refus répondent 401 sauf mention contraire et sont audités ; un succès rattache l'identité vérifiée aux événements d'audit de la requête.
Route : /v1/context/verify (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
token | string | oui | Le jeton JWS compact (10 à 65536 caractères). | |
audience | string | oui | Audience attendue par le vérificateur (200 caractères au plus). Par défaut : la première audience de la plateforme. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Vérifier un contexte d'exécution signé ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
Classe AuthzService
AuthzService regroupe les points d'accès suivants : autorisation fondée sur les relations (OpenFGA ou moteur intégré).
AuthzService.Allowed
Allowed(ctx context.Context, check AuthzCheck, opts ...CallOption) (AuthzResult, error)
Vérifier une relation. Indique si subject détient relation sur object, en suivant l'héritage. Jusqu'à 20 contextual_tuples sont tenus pour vrais pour cette seule vérification et jamais enregistrés (un tuple invalide répond 422 validation_error). Ouvert à tout membre du tenant. La réponse donne allowed, engine, subject, relation et object. Écrit l'événement d'audit authz.check avec la décision. Quand le moteur ne peut pas répondre, la décision est un refus, elle est auditée et l'API répond 502 authz_backend_error.
Route : /v1/authz/check (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
check | AuthzCheck | oui | Sujet, relation et objet à vérifier. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (AuthzResult, error). Réponse JSON décodée de l'opération « Vérifier une relation ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
AuthzService.CheckBatch
CheckBatch(ctx context.Context, checks []AuthzCheck, opts ...CallOption) ([]AuthzResult, error)
Vérifier une relation. Indique si subject détient relation sur object, en suivant l'héritage. Jusqu'à 20 contextual_tuples sont tenus pour vrais pour cette seule vérification et jamais enregistrés (un tuple invalide répond 422 validation_error). Ouvert à tout membre du tenant. La réponse donne allowed, engine, subject, relation et object. Écrit l'événement d'audit authz.check avec la décision. Quand le moteur ne peut pas répondre, la décision est un refus, elle est auditée et l'API répond 502 authz_backend_error.
Route : /v1/authz/check (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
checks | []AuthzCheck | oui | Vérifications lancées l'une après l'autre ; la première erreur arrête le lot. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : ([]AuthzResult, error). Réponse JSON décodée de l'opération « Vérifier une relation ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
AuthzService.Explain
Explain(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Autoriser une action sous une délégation. Calcule la permission effective d'une action : utilisateur ET agent ET délégation ET restriction de ressource ET relation (OpenFGA ou les tuples intégrés) ET politique (OPA ou intégrée). Donnez delegation_id, ou run_id pour utiliser la délégation d'une exécution (400 invalid_request sans l'un ni l'autre ; 403 delegation_required pour une exécution sans délégation).
Route : /v1/delegations/authorize (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
body | any | oui | Action, délégation ou exécution, et la portée, la ressource, la relation, l'audience et la classification à vérifier. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Autoriser une action sous une délégation ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
Classe ToolsService
ToolsService regroupe les points d'accès suivants : registre des outils et invocations du Tool Gateway.
ToolsService.Discover
Discover(ctx context.Context, opts ...CallOption) (*Page, error)
Lister les outils. Outils du tenant dans l'ordre des noms, éventuellement d'un seul statut. Une seule page.
Route : /v1/tools (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (*Page, error). Réponse JSON décodée de l'opération « Lister les outils ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
ToolsService.Validate
Validate(ctx context.Context, invocation any, opts ...CallOption) (json.RawMessage, error)
Valider un document avec un contrat. Valide le corps avec le contrat, formats compris, sans rien enregistrer. La réponse donne contract, valid et errors, chacune avec le path JSON de la valeur fautive et un message. Ouvert à tout appelant authentifié. Un contrat inconnu répond 404 unknown_contract.
Route : /v1/contracts/{name}/validate (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
invocation | any | oui | Document Tool Invocation à vérifier par le serveur selon le contrat tool-invocation. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Valider un document avec un contrat ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
Classe PrivacyService
Vie privée et protection des données. Services de protection des données du tenant : classification, DLP (prévention des fuites de données), tokenisation et chiffrement par enveloppe.
PrivacyService.Detect
Detect(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Inspecter un texte à la recherche de données sensibles. Applique la DLP au texte avec les règles du tenant, en mode detect sauf si mode en décide autrement. La réponse donne text, findings (type, position, score, classification, court aperçu, action, règle), action (action la plus forte appliquée), classification, mode, engine (builtin ou presidio), blocked et count. Un mode inconnu répond 400. Ouvert à tout membre du tenant. Écrit l'événement d'audit dlp.inspect (nombres et types uniquement).
Route : /v1/dlp/inspect (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
body | any | oui | Texte, mode et langue facultatifs. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Inspecter un texte à la recherche de données sensibles ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
PrivacyService.Detokenize
Detokenize(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Détokeniser des valeurs. Renvoie les valeurs d'origine des jetons donnés dans tokens ou trouvés dans text.
Route : /v1/tokenization/detokenize (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
body | any | oui | Jetons ou texte contenant des jetons, et finalité. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Détokeniser des valeurs ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
PrivacyService.Encrypt
Encrypt(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Chiffrer des données avec une clé du tenant. Chiffre plaintext (texte UTF-8) ou plaintext_base64 (octets) avec la version courante de la clé, lié à aad. Renvoie ciphertext (eaienc1:...), key_id et key_version. L'une des deux entrées est obligatoire, et le base64 doit être valide (400 invalid_request) ; une clé inconnue répond 404 key_not_found. Ouvert à tout membre du tenant. Écrit l'événement d'audit encryption.encrypt (taille uniquement).
Route : /v1/encryption/encrypt (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
body | any | oui | Clé, données à chiffrer et données associées. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Chiffrer des données avec une clé du tenant ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
PrivacyService.Mask
Mask(ctx context.Context, text string, opts ...CallOption) (json.RawMessage, error)
Masquer les données sensibles d'un texte. Comme l'inspection, en mode mask par défaut : chaque constat est remplacé par [TYPE] (par exemple [EMAIL]), ou tokenisé ou bloqué quand une règle du tenant ou mode le demande ; un texte bloqué revient vide avec blocked: true. Ouvert à tout membre du tenant. Écrit l'événement d'audit dlp.redact.
Route : /v1/dlp/redact (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
text | string | oui | Texte à inspecter ou à masquer. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Masquer les données sensibles d'un texte ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
PrivacyService.Tokenize
Tokenize(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Tokeniser des valeurs. Remplace les valeurs sensibles par des jetons déterministes tok_<type>_<hex> du tenant (une même valeur donne toujours le même jeton), les valeurs étant conservées chiffrées dans le coffre. Avec values, renvoie tokens ; avec text, détecte les entités et renvoie le text tokenisé, findings et classification. L'un des deux est obligatoire (400 invalid_request). Ouvert à tout membre du tenant. Écrit l'événement d'audit tokenization.tokenize (nombre uniquement).
Route : /v1/tokenization/tokenize (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
body | any | oui | Valeurs ou texte à tokeniser. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Tokeniser des valeurs ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
Classe ApprovalsService
Validations. Humain dans la boucle : demandes de validation des actions sensibles, avec séparation des tâches, quorum et expiration. Les exécutions d'agents qui atteignent un outil soumis à validation, les promotions de modèles, d'agents, d'outils, de compétences, de serveurs MCP ou de plugins, les accès d'urgence et les mandats créent tous leurs demandes de validation ici.
ApprovalsService.Check
Check(ctx context.Context, id string, opts ...CallOption) (json.RawMessage, error)
Lire une demande de validation. Renvoie une demande de validation avec ses décisions (valideur, décision, commentaire, date) et approvals_count. Une demande en attente dont l'expiration est passée est marquée expired et son exécution en attente échoue. Ouvert à tout membre du tenant. Répond 404 approval_not_found.
Route : /v1/approvals/{approval_id} (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
id | string | oui | Identifiant (UUID) de la demande de validation. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Lire une demande de validation ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
Classe AuditService
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.
AuditService.VerifyEvidence
VerifyEvidence(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
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).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Vérifier la chaîne et tous les sceaux ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
Classe TelemetryService
Télémétrie. Traces, journal des requêtes, flux en direct et objectifs de niveau de service (SLO) de la plateforme.
TelemetryService.EndSpan
EndSpan(ctx context.Context, sp *Span, status string, opts ...CallOption) (json.RawMessage, error)
Ingérer des spans de télémétrie. Accepte jusqu'à 5000 spans et répond 202 avec le nombre accepté, le nombre enregistré (un span déjà connu pour les mêmes identifiants de trace et de span est ignoré) et le résultat de chaque exportateur (ok ou error). Demande un principal de tenant avec tenant_admin, developer ou agent (403 forbidden).
Route : /v1/telemetry/spans (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
sp | *Span | oui | Span ouvert par StartSpan ; un span ne peut être terminé qu'une fois. | |
status | string | oui | Statut final du span, ok ou error. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Ingérer des spans de télémétrie ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
TelemetryService.Logs
Logs(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
Lister le journal des requêtes. Journal des requêtes du tenant tiré des résumés de spans, du plus récent au plus ancien : une ligne par span avec son heure, son niveau (error si le span a échoué, sinon info), son service, son nom, son message (type d'erreur, ou méthode, route et code de statut), sa durée, sa trace, son span, son exécution et ses attributs conservés. Jamais de prompt ni de sortie de modèle. Demande un principal de tenant avec platform_admin, tenant_admin, auditor, viewer ou support_engineer (403 forbidden). Un niveau inconnu ou un from postérieur à to répond 400 invalid_request.
Route : /v1/telemetry/logs (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Lister le journal des requêtes ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
TelemetryService.StartSpan
StartSpan(name string, traceID string, parentSpanID string, attributes map[string]any) *Span
StartSpan ouvre un span (nouvelle trace quand traceID est vide).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | string | oui | Nom du span. | |
traceID | string | oui | Trace à rejoindre ; vide, une nouvelle trace est créée avec un identifiant aléatoire. | |
parentSpanID | string | oui | Identifiant du span parent, vide pour un span racine. | |
attributes | map[string]any | oui | Attributs initiaux du span ; nil donne une table vide. |
Retour : *Span. Un Span : un span côté client ; EndSpan l'envoie à POST /v1/telemetry/spans.
TelemetryService.Stream
Stream(ctx context.Context, opts ...CallOption) (*SSEStream, error)
Suivre la télémétrie en direct. Server-Sent Events (text/event-stream) du tenant : un événement metrics à chaque intervalle (requêtes, erreurs, taux d'erreur et latence p95 de la dernière minute), un événement trace pour chaque nouveau span racine et un événement incident pour chaque incident créé ou modifié. Chaque événement porte un id: (un horodatage) que le client renvoie dans Last-Event-ID ou since pour reprendre. Le flux se ferme après timeout secondes (l'EventSource se reconnecte après 3 secondes) ou après max_events événements. Demande un principal de tenant avec platform_admin, tenant_admin, auditor, viewer ou support_engineer.
Route : /v1/telemetry/stream (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (*SSEStream, error). Réponse JSON décodée de l'opération « Suivre la télémétrie en direct ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
TelemetryService.Traces
Traces(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
Lister les traces récentes. Traces récentes du tenant, de la plus récente à la plus ancienne : une ligne par span racine avec son nom, son service, son début, sa durée, son statut, son exécution, sa session et ses nombres de spans et d'erreurs. Demande un principal de tenant avec platform_admin, tenant_admin, auditor, viewer ou support_engineer (403 forbidden). Un statut inconnu ou un from postérieur à to répond 400 invalid_request.
Route : /v1/telemetry/traces (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Lister les traces récentes ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
Classe SecurityService
SecurityService regroupe les points d'accès suivants : posture de sécurité de la plateforme et réglages de sécurité du tenant.
SecurityService.CancelRun
CancelRun(ctx context.Context, runID string, opts ...CallOption) (json.RawMessage, error)
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 |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
runID | string | oui | Identifiant (UUID) du run. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Annuler un run ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
SecurityService.CheckState
CheckState(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
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).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Lire la posture de sécurité ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
SecurityService.ReportIncident
ReportIncident(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
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 |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
body | any | oui | Titre, gravité, description, catégorie, ressources et responsable. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Ouvrir un incident ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).