io.enterpriseai.resources.ApiKeysClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/ApiKeysClient.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 ApiKeysClient
Identité. Qui appelle l'API et avec quels droits. Ce tag couvre l'identité de l'appelant (whoami), les clés d'API des scripts et des services, les identités de service (charges de travail SPIFFE) qu'un utilisateur peut endosser temporairement, et les correspondances de groupes de l'annuaire qui transforment les groupes Keycloak en appartenances à des projets et en quotas.
Constructeur ApiKeysClient
ApiKeysClient(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. |
ApiKeysClient.create
JsonNode create(Object body)
Créer une clé d'API. Crée une clé d'API pour les scripts et les services. Exige tenant_admin ou developer. La réponse (201) porte le secret complet dans key, montré une seule fois : rangez-le aussitôt dans un magasin de secrets.
Route : /v1/api-keys (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Nom, droits, rattachement et expiration de la nouvelle clé. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Créer une clé d'API ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ApiKeysClient.create
JsonNode create(Object body, RequestOptions options)
Créer une clé d'API. Crée une clé d'API pour les scripts et les services. Exige tenant_admin ou developer. La réponse (201) porte le secret complet dans key, montré une seule fois : rangez-le aussitôt dans un magasin de secrets.
Route : /v1/api-keys (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Nom, droits, rattachement et expiration de la nouvelle clé. | |
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 « Créer une clé d'API ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ApiKeysClient.delete
void delete(String id)
Révoquer une clé d'API. Révoque la clé immédiatement : toute requête ultérieure faite avec elle répond 401 api_key_revoked. Révoquer une clé déjà révoquée réussit sans changement. Autorisé à tenant_admin, security_officer et developer ; un développeur ne révoque que les clés qu'il a créées, toute autre clé répond 404 not_found. Écrit l'événement d'audit api_key.revoke. Répond 204 sans corps.
Route : /v1/api-keys/{key_id} (DELETE).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) de la clé d'API. |
Retour : void.
Erreurs levées : les erreurs typées du transport (Erreurs).
ApiKeysClient.list
Page<JsonNode> list()
Lister les clés d'API. Liste les clés d'API du tenant, paginées par limit et cursor, triées par identifiant. Chaque élément donne le nom, le préfixe public, les rôles, les portées, l'habilitation, le projet, l'environnement, le créateur, l'expiration et l'état de révocation ; jamais le secret ni son empreinte. tenant_admin et security_officer voient toutes les clés, un developer uniquement celles qu'il a créées.
Route : /v1/api-keys (GET).
Cet élément ne prend aucun paramètre.
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les clés d'API ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ApiKeysClient.list
Page<JsonNode> list(Map<String, ?> query)
Lister les clés d'API. Liste les clés d'API du tenant, paginées par limit et cursor, triées par identifiant. Chaque élément donne le nom, le préfixe public, les rôles, les portées, l'habilitation, le projet, l'environnement, le créateur, l'expiration et l'état de révocation ; jamais le secret ni son empreinte. tenant_admin et security_officer voient toutes les clés, un developer uniquement celles qu'il a créées.
Route : /v1/api-keys (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 clés d'API ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ApiKeysClient.rotate
JsonNode rotate(String id)
Faire tourner une clé d'API. Émet une clé de remplacement avec le même nom, les mêmes rôles, portées, habilitation, projet et environnement, et retire l'ancienne. Le nouveau secret figure dans key de la réponse 201, montré une seule fois.
Route : /v1/api-keys/{key_id}/rotate (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) de la clé d'API. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Faire tourner une clé d'API ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ApiKeysClient.rotate
JsonNode rotate(String id, Object body)
Faire tourner une clé d'API. Émet une clé de remplacement avec le même nom, les mêmes rôles, portées, habilitation, projet et environnement, et retire l'ancienne. Le nouveau secret figure dans key de la réponse 201, montré une seule fois.
Route : /v1/api-keys/{key_id}/rotate (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) de la clé d'API. | |
body | Object | oui | Délai de grâce facultatif de l'ancienne clé. Un corps vide révoque l'ancienne clé immédiatement. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Faire tourner une clé d'API ».
Erreurs levées : les erreurs typées du transport (Erreurs).