Aller au contenu principal

io.enterpriseai.resources.ApplicationsClient

Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/ApplicationsClient.java. Retour à l'index de la référence du SDK Java.

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

Applications gouvernées : déploiements, activation, statut et agents tiers.

Constructeur ApplicationsClient​

ApplicationsClient(Transport transport)

Crée le client sur le transport partagé ; EnterpriseAIClient le construit, on y accède par l'accesseur du même nom.

NomTypeDéfautRequisDescription
transportTransportouiTransport partagé par les sous-clients d'un même client.

ApplicationsClient.activateDeployment​

JsonNode activateDeployment(String appId, String deploymentId)

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.

Retour : JsonNode. Réponse JSON décodée de l'opération « Activer un déploiement approuvé ».

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

ApplicationsClient.activateDeployment​

JsonNode activateDeployment(String appId, String deploymentId, RequestOptions options)

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.
optionsRequestOptionsouiOptions 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 « Activer un déploiement approuvé ».

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

ApplicationsClient.create​

JsonNode create(Object body)

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
bodyObjectouiNom, type, origine, propriétaire, projet, environnements, niveau de risque et ressources accordées.

Retour : JsonNode. Réponse JSON décodée de l'opération « Enregistrer une application ».

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

ApplicationsClient.create​

JsonNode create(Object body, RequestOptions options)

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
bodyObjectouiNom, type, origine, propriétaire, projet, environnements, niveau de risque et ressources accordées.
optionsRequestOptionsouiOptions 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 une application ».

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

ApplicationsClient.createDeployment​

JsonNode createDeployment(String appId, Object body)

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.
bodyObjectouiVersion, environnement et raison montrée aux approbateurs.

Retour : JsonNode. Réponse JSON décodée de l'opération « Demander un déploiement ».

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

ApplicationsClient.createDeployment​

JsonNode createDeployment(String appId, Object body, RequestOptions options)

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.
bodyObjectouiVersion, environnement et raison montrée aux approbateurs.
optionsRequestOptionsouiOptions 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 « Demander un déploiement ».

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

ApplicationsClient.developerKit​

JsonNode developerKit(java.util.Map<String, ?> query)

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
queryjava.util.Map<String, ?>ouiParamètres de la chaîne de requête de la route.

Retour : JsonNode. Réponse JSON décodée de l'opération « Obtenir le kit du développeur ».

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

ApplicationsClient.get​

JsonNode get(String appId)

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.

Retour : JsonNode. Réponse JSON décodée de l'opération « Lire une application ».

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

ApplicationsClient.list​

JsonNode list()

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

Cet élément ne prend aucun paramètre.

Retour : JsonNode. Réponse JSON décodée de l'opération « Lister les applications ».

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

ApplicationsClient.registerExternalAgent​

JsonNode registerExternalAgent(String appId, Object body)

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.
bodyObjectouiNom de l'identité et scopes supplémentaires.

Retour : JsonNode. Réponse JSON décodée de l'opération « Enregistrer l'identité d'un agent tiers ».

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

ApplicationsClient.registerExternalAgent​

JsonNode registerExternalAgent(String appId, Object body, RequestOptions options)

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.
bodyObjectouiNom de l'identité et scopes supplémentaires.
optionsRequestOptionsouiOptions 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 l'identité d'un agent tiers ».

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

ApplicationsClient.setStatus​

JsonNode setStatus(String appId, Object body)

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.
bodyObjectouiStatut visé et raison.

Retour : JsonNode. Réponse JSON décodée de l'opération « Suspendre ou retirer une application ».

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

ApplicationsClient.setStatus​

JsonNode setStatus(String appId, Object body, RequestOptions options)

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.
bodyObjectouiStatut visé et raison.
optionsRequestOptionsouiOptions 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 « Suspendre ou retirer une application ».

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