io.enterpriseai.resources.SecretsClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/SecretsClient.java. Retour à l'index de la référence du SDK Java.
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 SecretsClient
Secrets. Magasin en écriture seule des secrets du tenant : clés de fournisseurs, mots de passe de connecteurs, jetons de serveurs MCP. Les valeurs sont chiffrées (dans OpenBao quand il est configuré, sinon en AES-GCM dans la base) et ne sont jamais renvoyées par l'API. Les autres objets désignent un secret par son chemin ; la plateforme ne lit la valeur côté serveur que lorsqu'elle en a besoin.
Constructeur SecretsClient
SecretsClient(Transport transport)
Crée le client sur le transport partagé ; EnterpriseAIClient le construit, on y accède par l'accesseur du même nom.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
transport | Transport | oui | Transport partagé par les sous-clients d'un même client. |
SecretsClient.delete
void delete(String path)
Supprimer un secret. Supprime le secret et, avec OpenBao, sa valeur dans le coffre. Exige tenant_admin, security_officer ou developer ; un développeur ne supprime que les secrets qu'il a écrits (403 forbidden). Les objets qui désignent encore ce chemin cessent de fonctionner. Écrit l'événement d'audit secret.delete. Répond 204, 404 not_found, ou 502 secret_backend_error quand le coffre est injoignable.
Route : /v1/secrets/{path} (DELETE).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
path | String | oui | Chemin du secret, barres obliques comprises, par exemple connectors/crm/password. |
Retour : void.
Erreurs levées : les erreurs typées du transport (Erreurs).
SecretsClient.list
Page<JsonNode> list()
Lister les secrets. Liste les métadonnées des secrets du tenant triées par chemin : id, path, backend (openbao ou local), version, created_by, created_at, updated_at. Jamais la valeur. Ouvert à tout membre du tenant. next_cursor vaut toujours null.
Route : /v1/secrets (GET).
Cet élément ne prend aucun paramètre.
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les secrets ».
Erreurs levées : les erreurs typées du transport (Erreurs).
SecretsClient.list
Page<JsonNode> list(Map<String, ?> query)
Lister les secrets. Liste les métadonnées des secrets du tenant triées par chemin : id, path, backend (openbao ou local), version, created_by, created_at, updated_at. Jamais la valeur. Ouvert à tout membre du tenant. next_cursor vaut toujours null.
Route : /v1/secrets (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. |
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les secrets ».
Erreurs levées : les erreurs typées du transport (Erreurs).
SecretsClient.put
JsonNode put(Object body)
Écrire un secret. Crée le secret, ou remplace sa valeur quand le chemin existe (la version augmente de un). Exige tenant_admin, security_officer ou developer ; un développeur ne remplace que les secrets qu'il a écrits (403 forbidden). Un chemin contenant un segment .. répond 400 invalid_request. La réponse (201) donne les métadonnées, jamais la valeur. Écrit l'événement d'audit secret.write. 502 secret_backend_error quand le coffre est injoignable.
Route : /v1/secrets (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Chemin et valeur du secret. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Écrire un secret ».
Erreurs levées : les erreurs typées du transport (Erreurs).
SecretsClient.put
JsonNode put(Object body, RequestOptions options)
Écrire un secret. Crée le secret, ou remplace sa valeur quand le chemin existe (la version augmente de un). Exige tenant_admin, security_officer ou developer ; un développeur ne remplace que les secrets qu'il a écrits (403 forbidden). Un chemin contenant un segment .. répond 400 invalid_request. La réponse (201) donne les métadonnées, jamais la valeur. Écrit l'événement d'audit secret.write. 502 secret_backend_error quand le coffre est injoignable.
Route : /v1/secrets (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Chemin et valeur du secret. | |
options | RequestOptions | oui | Options 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 « Écrire un secret ».
Erreurs levées : les erreurs typées du transport (Erreurs).