Lister les clés cryptographiques¶
- GET /api/keys¶
Renvoie une liste des clés cryptographiques remplissant les critères donnés en paramètres de requête.
- En-têtes de requête:
Authorization – Les identifiants de l’utilisateur
- Paramètres:
limit (int) – Le nombre maximum de résultats souhaités (défaut: 20)
offset (int) – Le numéro du premier résultat souhaité (défaut: 0)
sort ([name+|name-|type+|type-]) – Le paramètre selon lequel les clés seront triées (défaut: name+)
- Status Codes:
200 OK – La liste a été renvoyée avec succès
400 Bad Request – Un ou plusieurs des paramètres de requêtes sont invalides
401 Unauthorized – Authentification d’utilisateur invalide
- Objet JSON de réponse:
cryptoKeys (array) – La liste des clés demandés
- Tableau d’objets JSON de réponse:
name (string) – Le nom de la clé cryptographique.
type (string) –
Le type de la clé cryptographique. Les valeurs possibles 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 sera convertie en Base64.
Exemple de requête
GET https://my_waarp_gateway.net/api/keys?limit=10&sort=name- HTTP/1.1 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Exemple de réponse
HTTP/1.1 200 OK Content-Type: application/json Content-Length: 76 { "cryptoKeys": [{ "name": "aes-key", "type": "AES", "privateKey": "0123456789abcdefhijklABCDEFHIJKL" },{ "name": "hmac-key", "type": "HMAC", "privateKey": "ABCDEFHIJKLabcdefhijkl0123456789" } }] }