Modifier une clé cryptographique¶
- PATCH /api/keys/(string: key_name)¶
Modifie une clé cryptographique existante avec les informations renseignées en format JSON dans le corps de la requête. Les paramètres omis resteront inchangés.
- En-têtes de requête:
Authorization – Les identifiants de l’utilisateur
- Objet JSON de requête:
name (string) – Le nouveau nom de la clé cryptographique.
type (string) –
Le type de la clé cryptographique. Les valeurs acceptées sont :
AES
pour les clés de (dé)chiffrement AESHMAC
pour les clés de signature HMACPGP-PUBLIC
pour les clés PGP publiquesPGP-PRIVATE
pour les clés PGP privées
key (string) – La représentation textuelle de la clé. Si la clé n’est pas nativement en format textuel, celle-ci doit être convertie en Base64 avant son envoi.
- Status Codes:
201 Created – La clé a été modifiée avec succès
400 Bad Request – Un ou plusieurs des paramètres de la requête sont invalides
401 Unauthorized – Authentification d’utilisateur invalide
404 Not Found – La clé demandée n’existe pas
- En-têtes de réponse:
Location – Le nouveau chemin d’accès à la clé mise à jour
Exemple de requête
PATCH https://my_waarp_gateway.net/api/keys/aes-key HTTP/1.1 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== Content-Type: application/json Content-Length: 107 { "name": "new-aes-key", "type": "AES", "privateKey": "ABCDEFHIJKLabcdefhijkl0123456789" }
Exemple de réponse
HTTP/1.1 201 CREATED Location: https://my_waarp_gateway.net/api/keys/new-aes-key