Aller au contenu principal

resources/trust.ts

Source : sdks/typescript/packages/sdk/src/resources/trust.ts. Retour à l'index de la référence du SDK TypeScript.

remarque

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 LicenseResource​

Licences. Licence de l'installation : activation d'une licence signée, état courant et historique.

Resource

LicenseResource.activate​

activate(body: { token: string }, opts?: CallOptions)

Activer une licence. Vérifie localement une licence signée puis l'enregistre. Demande le rôle platform_admin et la décision de politique license.activate.

Route : /v1/license/activations (POST).

NomTypeDéfautRequisDescription
body{ token: string }ouiLa licence signée reçue de l'éditeur.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

LicenseResource.get​

get(opts?: CallOptions)

Lire l'état de la licence. État non sensible de la licence de l'installation : état, édition, produit, durée, dates de validité et de grâce, jours restants, renouvellement planifié ou non, actions restreintes à cet instant, fonctions qu'une licence ne restreint jamais, et bandeau affiché par le portail (niveau none, info, warning ou critical, avec un message en anglais et en français). Aucun identifiant client, aucune référence de support ni aucun jeton n'est renvoyé. Tout principal authentifié peut l'appeler, sous réserve de la décision de politique license.read (403 policy_denied).

Route : /v1/license (GET).

NomTypeDéfautRequisDescription
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

LicenseResource.history​

history(params?: ListParams, opts?: CallOptions)

Lister l'historique des licences. Historique des licences de l'installation, de l'événement le plus récent au plus ancien : activations, activations refusées, actions refusées après la grâce et avis d'expiration. La réponse donne aussi l'identité de l'installation (identifiant, groupe d'installations, date et auteur de la liaison), chaque licence enregistrée avec son identifiant client, sa référence de support et ses environnements, ainsi que les contrats de support. Demande le rôle platform_admin (403 forbidden) et la décision de politique license.history.read. Un curseur mal formé répond 400 invalid_cursor.

Route : /v1/license/history (GET).

NomTypeDéfautRequisDescription
paramsListParamsnonChamps supplémentaires fusionnés dans la requête.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Interface DelegationRestrict​

Corps de DelegationsResource.create et restrict : le délégataire et les limites de la délégation.

Champs :

NomTypeRequisDescription
delegatestringouiPrincipal qui reçoit la délégation.
audiencestringnonAudience pour laquelle la délégation est valable.
data_classification_maxstringnonClassification de données la plus élevée accessible au délégataire.
expires_atstringnonDate et heure (ISO 8601, UTC) après lesquelles l'élément n'est plus valide.
max_depthnumbernonLongueur maximale de la chaîne de délégation.
purposestringnonUsage de la cible. backup par défaut.
redelegation_allowedbooleannonIndique si le délégataire peut déléguer à son tour.
resourcesstring[]nonRessources couvertes par la délégation.
scopesstring[]nonPortées demandées ; doivent comprendre openid. Par défaut openid, profile, email.
ttl_secondsnumbernonDurée de vie en secondes. Une fois écoulée, l'élément expire et n'est plus accepté.

Interface DelegationAuthorize​

Corps de DelegationsResource.authorize (POST /v1/delegations/authorize) : l'action à décider sous une délégation.

Champs :

NomTypeRequisDescription
actionstringouiAction à autoriser.
audiencestringnonAudience à laquelle l'action est destinée.
data_classificationstringnonClassification des données touchées par l'action.
delegation_idstringnonDélégation à vérifier ; verify la renseigne à partir de son argument.
relationstringnonRelation vérifiée sur la ressource.
resourcestringnonRessource visée par l'action.
run_idstringnonRun auquel appartient l'action.
scopestringnonCe qui est sauvegardé (clusters, services, jeux de données), sous forme d'objet.

Classe DelegationsResource​

Délégation, mandats et accès d'urgence. Comment un agent, une application ou un sous-agent agit pour le compte de quelqu'un, et comment des droits exceptionnels sont accordés.

Resource

DelegationsResource.authorize​

authorize(body: DelegationAuthorize, opts?: CallOptions)

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).

NomTypeDéfautRequisDescription
bodyDelegationAuthorizeouiAction, délégation ou exécution, et la portée, la ressource, la relation, l'audience et la classification à vérifier.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

DelegationsResource.create​

create(body: DelegationRestrict & { session_id?: string }, opts?: CallOptions)

Créer une délégation. Crée une délégation racine de l'appelant vers un délégataire. Ouvert aux membres du tenant ; un agent ne peut pas créer seul une délégation racine (403 delegation_root_forbidden).

Route : /v1/delegations (POST).

NomTypeDéfautRequisDescription
bodyDelegationRestrict & { session_id?: string }ouiDélégataire, droits, limites et expiration de la délégation.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

DelegationsResource.get​

get(id: string, opts?: CallOptions)

Lire une délégation. Renvoie la délégation avec la vérification de sa chaîne depuis la racine (chaque maillon actif, non expiré, du même tenant, couvert par son parent). Visible par sa racine, son créateur et la personne représentée, ainsi que par tenant_admin, security_officer, auditor et agent ; sinon 404 delegation_not_found.

Route : /v1/delegations/{delegation_id} (GET).

NomTypeDéfautRequisDescription
idstringouiIdentifiant (UUID) de la délégation.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

DelegationsResource.iterate​

iterate(params?: ListParams & { root_principal_id?: string; status?: string }, opts?: CallOptions)

Lister les délégations. Liste les délégations, les plus récentes d'abord, paginées : toutes pour tenant_admin, security_officer et auditor, sinon celles dont l'appelant est la racine, le créateur ou la personne représentée. Un statut inconnu répond 400.

Route : /v1/delegations (GET).

NomTypeDéfautRequisDescription
paramsListParams & { root_principal_id?: string; status?: string }nonChamps supplémentaires fusionnés dans la requête.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

DelegationsResource.list​

list(params?: ListParams & { root_principal_id?: string; status?: string }, opts?: CallOptions)

Lister les délégations. Liste les délégations, les plus récentes d'abord, paginées : toutes pour tenant_admin, security_officer et auditor, sinon celles dont l'appelant est la racine, le créateur ou la personne représentée. Un statut inconnu répond 400.

Route : /v1/delegations (GET).

NomTypeDéfautRequisDescription
paramsListParams & { root_principal_id?: string; status?: string }nonChamps supplémentaires fusionnés dans la requête.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

DelegationsResource.restrict​

restrict(id: string, body: DelegationRestrict, opts?: CallOptions)

Restreindre une délégation pour un sous-délégataire. Crée une délégation enfant, toujours couverte par son parent : un sous-agent n'obtient jamais de droits plus larges. Autorisé à la racine ou au créateur du parent, à un agent, à un tenant_admin ou à un security_officer (403 forbidden).

Route : /v1/delegations/{delegation_id}/restrict (POST).

NomTypeDéfautRequisDescription
idstringouiIdentifiant (UUID) de la délégation parente.
bodyDelegationRestrictouiSous-délégataire et droits plus étroits.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

DelegationsResource.revoke​

revoke(id: string, body: { reason?: string } = {}, opts?: CallOptions)

Révoquer une délégation. Révoque la délégation et tous ses descendants ; leurs contextes d'exécution sont révoqués avec eux, avec effet à l'action suivante. Autorisé à sa racine, à son créateur ou à la personne représentée, ainsi qu'à tenant_admin et security_officer (403 forbidden). Écrit l'événement d'audit delegation.revoke.

Route : /v1/delegations/{delegation_id}/revoke (POST).

NomTypeDéfautRequisDescription
idstringouiIdentifiant (UUID) de la délégation.
body{ reason?: string }{}nonRaison facultative.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

DelegationsResource.revokePrincipal​

revokePrincipal(body: { principal_id: string; reason?: string }, opts?: CallOptions)

Révoquer toutes les délégations d'un principal. Révoque toutes les délégations actives dont un principal est la racine ou qui agissent pour lui, avec leurs descendants et leurs contextes d'exécution, par exemple au départ d'un utilisateur ou après la compromission d'un compte. Exige tenant_admin ou security_officer. Écrit l'événement d'audit delegation.revoke_principal.

Route : /v1/delegations/revoke-principal (POST).

NomTypeDéfautRequisDescription
body{ principal_id: string; reason?: string }ouiPrincipal et raison.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

DelegationsResource.verify​

verify(delegationId: string, body: Omit<DelegationAuthorize, "delegation_id">, opts?: CallOptions)

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).

NomTypeDéfautRequisDescription
delegationIdstringouiDélégation à vérifier. Donnez-la, ou run_id.
bodyOmit<DelegationAuthorize, "delegation_id">ouiAction, délégation ou exécution, et la portée, la ressource, la relation, l'audience et la classification à vérifier.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Interface MandateCreate​

Corps de MandatesResource.create (POST /v1/mandates) : l'autorité permanente demandée pour un agent autonome.

Champs :

NomTypeRequisDescription
agentstringouiAgent qui reçoit le mandat.
purposestringouiUsage de la cible. backup par défaut.
service_identity_idstringouiIdentité de service sous laquelle les exécutions agissent ; elle doit être active.
audiencestringnonAudience pour laquelle le mandat est valable.
data_classification_maxstringnonClassification de données la plus élevée accessible à l'agent.
max_depthnumbernonLongueur maximale de la chaîne de délégation sous le mandat.
resourcesstring[]nonRessources couvertes par le mandat.
schedule_idstringnonPlanification unique de l'agent couverte par le mandat ; null pour toutes ses planifications.
scopesstring[]nonPortées demandées ; doivent comprendre openid. Par défaut openid, profile, email.
ttl_daysnumbernonDurée de vie du mandat en jours.

Classe MandatesResource​

Mandats : autorité permanente d'un agent autonome, accordée par une approbation.

Resource

MandatesResource.create​

create(body: MandateCreate, opts?: CallOptions)

Demander un mandat pour un agent. Demande un mandat pour qu'un agent (éventuellement l'une de ses planifications) s'exécute de façon autonome sous une identité de service. Exige tenant_admin, developer ou security_officer.

Route : /v1/mandates (POST).

NomTypeDéfautRequisDescription
bodyMandateCreateouiAgent, identité de service, planification, droits, finalité et durée du mandat.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

MandatesResource.decide​

decide(approvalId: string, body: { decision: "approve" | "reject"; comment?: string }, opts?: CallOptions)

Approuver ou refuser une demande. Enregistre la décision de l'appelant sur une demande en attente.

Route : /v1/approvals/{approval_id}/decide (POST).

NomTypeDéfautRequisDescription
approvalIdstringouiIdentifiant (UUID) de la demande de validation.
body{ decision: "approve" | "reject"; comment?: string }ouiDécision et commentaire facultatif.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

MandatesResource.get​

get(id: string, opts?: CallOptions)

Lire un mandat. Renvoie un mandat : agent, planification, identité de service, portées, audience, ressources, plafond de classification, profondeur, finalité, statut, validation et expiration. Ouvert à tout membre du tenant. Répond 404 mandate_not_found.

Route : /v1/mandates/{mandate_id} (GET).

NomTypeDéfautRequisDescription
idstringouiIdentifiant (UUID) du mandat.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

MandatesResource.list​

list(params?: ListParams & { agent?: string }, opts?: CallOptions)

Lister les mandats. Liste les mandats du tenant, les plus récents d'abord, éventuellement pour un agent, avec leur statut effectif (pending, approved, rejected, revoked ou expired). Ouvert à tout membre du tenant.

Route : /v1/mandates (GET).

NomTypeDéfautRequisDescription
paramsListParams & { agent?: string }nonChamps supplémentaires fusionnés dans la requête.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

MandatesResource.revoke​

revoke(id: string, body: { reason?: string } = {}, opts?: CallOptions)

Révoquer un mandat. Révoque le mandat et les délégations qui en découlent : la prochaine exécution planifiée de l'agent est refusée (mandate_required). Autorisé au demandeur, à un tenant_admin ou à un security_officer (403 forbidden). Un mandat révoqué ou refusé répond 409 mandate_closed. Écrit l'événement d'audit mandate.revoke.

Route : /v1/mandates/{mandate_id}/revoke (POST).

NomTypeDéfautRequisDescription
idstringouiIdentifiant (UUID) du mandat.
body{ reason?: string }{}nonRaison facultative.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Interface BreakGlassRequest​

Corps de BreakGlassResource.request (POST /v1/break-glass) : un accès d'urgence limité dans le temps.

Champs :

NomTypeRequisDescription
reasonstringouiRaison de l'action. Inscrite dans le journal d'audit avec l'acteur et l'heure.
duration_secondsnumberouiDurée de l'accès d'urgence en secondes.
beneficiarystringnonSujet qui reçoit l'élévation. Par défaut : l'appelant.
incident_refstringnonRéférence de l'incident qui justifie la demande, facultative.
rolesstring[]nonRôles accordés pendant l'accès d'urgence.
scopesstring[]nonPortées demandées ; doivent comprendre openid. Par défaut openid, profile, email.

Classe BreakGlassResource​

Délégation, mandats et accès d'urgence. Comment un agent, une application ou un sous-agent agit pour le compte de quelqu'un, et comment des droits exceptionnels sont accordés.

Resource

BreakGlassResource.get​

get(id: string, opts?: CallOptions)

Lire un accès d'urgence. Renvoie un accès : demandeur, bénéficiaire, rôles, portées, raison, incident, durée, statut, validation et dates. Visible par son demandeur, son bénéficiaire et par tenant_admin, security_officer et auditor ; toute autre personne reçoit 404 break_glass_not_found.

Route : /v1/break-glass/{grant_id} (GET).

NomTypeDéfautRequisDescription
idstringouiIdentifiant (UUID) de l'accès d'urgence.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

BreakGlassResource.issueContext​

issueContext(id: string, body: { audience?: string; ttl_seconds?: number } = {}, opts?: CallOptions)

Obtenir un contexte d'exécution pour un accès d'urgence. Renvoie un ExecutionContext signé portant l'élévation active, dont la durée de vie ne dépasse jamais l'expiration de l'accès. Seul le bénéficiaire peut le demander (403 forbidden) ; l'accès doit être actif (409 break_glass_not_active) ; chaque audience doit être connue (400 context_wrong_audience). Les services en aval le vérifient comme tout contexte d'exécution.

Route : /v1/break-glass/{grant_id}/context (POST).

NomTypeDéfautRequisDescription
idstringouiIdentifiant (UUID) de l'accès d'urgence.
body{ audience?: string; ttl_seconds?: number }{}nonAudiences et durée de vie facultatives du contexte.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

BreakGlassResource.list​

list(params?: ListParams & { status?: string }, opts?: CallOptions)

Lister les accès d'urgence. Liste les accès d'urgence, les plus récents d'abord : tous pour tenant_admin, security_officer et auditor, sinon ceux que l'appelant a demandés ou dont il bénéficie. Les accès actifs dont l'expiration est passée sont marqués expired (audité une fois). Un statut inconnu répond 400.

Route : /v1/break-glass (GET).

NomTypeDéfautRequisDescription
paramsListParams & { status?: string }nonChamps supplémentaires fusionnés dans la requête.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

BreakGlassResource.request​

request(body: BreakGlassRequest, opts?: CallOptions)

Demander un accès d'urgence. Demande une élévation exceptionnelle et limitée dans le temps pour le bénéficiaire (l'appelant par défaut). Ouvert à tout membre du tenant.

Route : /v1/break-glass (POST).

NomTypeDéfautRequisDescription
bodyBreakGlassRequestouiRôles, portées, raison, durée, bénéficiaire et référence d'incident.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

BreakGlassResource.revoke​

revoke(id: string, body: { reason?: string } = {}, opts?: CallOptions)

Révoquer un accès d'urgence. Met fin à un accès en attente ou actif et révoque les délégations créées sous lui. Autorisé au demandeur, à un tenant_admin ou à un security_officer (403 forbidden). Un accès déjà clos répond 409 break_glass_closed. Écrit l'événement d'audit break_glass.revoke.

Route : /v1/break-glass/{grant_id}/revoke (POST).

NomTypeDéfautRequisDescription
idstringouiIdentifiant (UUID) de l'accès d'urgence.
body{ reason?: string }{}nonRaison facultative.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Alias de type ApplicationKind​

Type d'application gouvernée : agent_app, assistant, workflow ou external_agent.

Définition : "agent_app" \| "assistant" \| "workflow" \| "external_agent".

Interface ApplicationCreate​

Corps de ApplicationsResource.create (POST /v1/applications) : une application gouvernée et ce qu'elle peut utiliser.

Champs :

NomTypeRequisDescription
namestringouiNom de l'application.
kindApplicationKindouiType d'application : agent_app, assistant, workflow ou external_agent.
origin"internal" | "third_party"noninternal (par défaut) ou third_party ; forcé à third_party pour un external_agent.
risk_level"low" | "medium" | "high"nonNiveau de risque : low, medium ou high.
ownerstringnonPropriétaire de l'application.
projectstringnonIdentifiant du projet auquel les résultats sont limités.
environmentsstring[]nonEnvironnements dans lesquels l'application est déployée.
agentsstring[]nonAgents utilisés par l'application.
modelsstring[]nonModèles utilisés par l'application.
toolsstring[]nonOutils que ses agents externes peuvent invoquer (noms ou motifs comme crm.*).
mcp_serversstring[]nonServeurs MCP que ses agents externes peuvent appeler (noms ou motifs).
pluginsstring[]nonPlugins accordés à l'application (noms ou motifs).

Classe ApplicationsResource​

Applications gouvernées et agents tiers.

Resource

ApplicationsResource.activateDeployment​

activateDeployment(appId: string, deploymentId: string, opts?: CallOptions)

Activer un déploiement approuvé. Active le déploiement une fois son approbation accordée (la séparation des tâches est appliquée par le domaine des approbations ; une approbation manquante est auditée comme refus) : le déploiement actif précédent de l'environnement est retiré et l'application passe à active. 409 application_suspended ; 404 application_deployment_not_found. Demande tenant_admin, developer ou application_owner. Audité sous application.deployment.activate avec l'approbateur.

Route : /v1/applications/{app_id}/deployments/{deployment_id}/activate (POST).

NomTypeDéfautRequisDescription
appIdstringouiIdentifiant (UUID) ou nom de l'application.
deploymentIdstringouiIdentifiant (UUID) du déploiement.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

ApplicationsResource.create​

create(body: ApplicationCreate, opts?: CallOptions)

Enregistrer une application. Crée l'application (201). Un external_agent est toujours d'origine third_party. Le propriétaire est par défaut l'appelant, le projet l'en-tête X-Project. Un nom déjà utilisé répond 409 conflict. Demande tenant_admin, developer ou application_owner. Audité sous application.create.

Route : /v1/applications (POST).

NomTypeDéfautRequisDescription
bodyApplicationCreateouiNom, type, origine, propriétaire, projet, environnements, niveau de risque et ressources accordées.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

ApplicationsResource.createDeployment​

createDeployment(appId: string, body: { version: string; environment: string; reason?: string }, opts?: CallOptions)

Demander un déploiement. Enregistre le déploiement d'une version dans un environnement de l'application et ouvre une approbation application_deployment pour tenant_admin ou security_officer (201, le déploiement porte approval_id). L'environnement doit être déclaré par l'application (400 invalid_request) ; la même version dans le même environnement répond 409 conflict ; une application suspendue ou retirée répond 409 application_suspended. Demande tenant_admin, developer ou application_owner. Audité sous application.deployment.create.

Route : /v1/applications/{app_id}/deployments (POST).

NomTypeDéfautRequisDescription
appIdstringouiIdentifiant (UUID) ou nom de l'application.
body{ version: string; environment: string; reason?: string }ouiVersion, environnement et raison montrée aux approbateurs.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

ApplicationsResource.createExternalAgent​

createExternalAgent(appId: string, body: { name: string; scopes?: string[] }, opts?: CallOptions)

Enregistrer l'identité d'un agent tiers. Crée une clé d'API avec le rôle agent, liée à l'application et à son projet, avec les scopes tools:invoke, models:invoke plus ceux demandés (201). La clé figure dans api_key et n'est montrée qu'une fois. Demande tenant_admin. Audité sous application.external_agent.register.

Route : /v1/applications/{app_id}/external-agents (POST).

NomTypeDéfautRequisDescription
appIdstringouiIdentifiant (UUID) ou nom de l'application.
body{ name: string; scopes?: string[] }ouiNom de l'identité et scopes supplémentaires.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

ApplicationsResource.developerKit​

developerKit(query: { application_id?: string; agent_id?: string; project?: string }, opts?: CallOptions)

Obtenir le kit du développeur. Kit du développeur d'une application, d'un agent ou d'un projet : valeurs, états et actions, jamais un secret. Indiquez exactement un paramètre parmi application_id, agent_id et project (400 invalid_request sinon). La réponse contient le subject (avec les modèles, outils, serveurs MCP, bases de connaissances et suites d'évaluation qu'il utilise), les neuf rows, les entrées env d'un fichier d'environnement (la clé d'API n'y est qu'un emplacement marqué secret), un summary des lignes prêtes et les next_steps (créer une clé, lancer les tests, lancer le red team). Une application ou un agent inconnu, ou un projet sans application, répond 404 not_found. Demande un principal de tenant (403 tenant_required) avec developer, application_owner ou tenant_admin (403 forbidden).

Route : /v1/developer/kit (GET).

NomTypeDéfautRequisDescription
query{ application_id?: string; agent_id?: string; project?: string }ouiParamètres de la chaîne de requête de la route.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

ApplicationsResource.get​

get(appId: string, opts?: CallOptions)

Lire une application. Renvoie l'application et ses déploiements, du plus ancien au plus récent. 404 application_not_found.

Route : /v1/applications/{app_id} (GET).

NomTypeDéfautRequisDescription
appIdstringouiIdentifiant (UUID) ou nom de l'application.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

ApplicationsResource.list​

list(opts?: CallOptions)

Lister les applications. Applications du tenant dans l'ordre des noms, avec type, origine, statut, environnements et ressources accordées. Une seule page.

Route : /v1/applications (GET).

NomTypeDéfautRequisDescription
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

ApplicationsResource.setStatus​

setStatus(appId: string, body: { status: "suspended" | "retired"; reason: string }, opts?: CallOptions)

Suspendre ou retirer une application. Passe l'application à suspended ou retired, ainsi que ses déploiements actifs ; tout appel de passerelle de ses agents externes est refusé dès lors. Demande tenant_admin ou security_officer. Audité sous application.suspended ou application.retired.

Route : /v1/applications/{app_id}/status (POST).

NomTypeDéfautRequisDescription
appIdstringouiIdentifiant (UUID) ou nom de l'application.
body{ status: "suspended" | "retired"; reason: string }ouiStatut visé et raison.
optsCallOptionsnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).