Affichage des détails de clé à l'aide de l'interface utilisateur

Vous pouvez afficher les détails d'une clé spécifique à l'aide de l'interface utilisateur en procédant comme suit:

1. Connectez-vous à l'interface utilisateur.
2. Accédez à Menu > Liste de ressources pour afficher la liste de vos ressources.
3. Dans la liste de ressources IBM Cloud, sélectionnez votre instance Hyper Protect Crypto Services mise à disposition.
4. Sur la page Clés KMS, utilisez la table Clés pour parcourir les clés de votre service.
5. Cliquez sur l'icône Actions pour ouvrir une liste d'options pour une clé spécifique.
6. Dans le menu des options, cliquez sur Afficher les détails de la clé pour afficher les détails de la clé.

Affichage des détails clés avec l'API de service de gestion de clés

Pour afficher des informations détaillées sur une clé racine ou une clé standard spécifique, vous pouvez effectuer un appel GET vers le noeud final suivant :

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID_or_alias>/metadata

1. Extrayez vos données d'authentification afin d'utiliser les clés dans le service.

2. Extrayez l'ID de la clé à examiner.

   La valeur d'ID permet d'accéder à des informations détaillées sur la clé. Vous pouvez trouver l'ID d'une clé dans votre instance de service en extraction d'une liste de vos clés, ou en accédant à l'interface utilisateur.

3. Obtenez les détails relatifs à la clé en exécutant la commande cURL suivante :

   curl -X GET \
     'https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID_or_alias>/metadata' \
     -H 'accept: application/vnd.ibm.kms.key+json' \
     -H 'authorization: Bearer <IAM_token>' \
     -H 'bluemix-instance: <instance_ID>' \
     -H 'x-kms-key-ring: <key_ring_ID>' \
     -H 'correlation-id: <correlation_ID>'
   

   Remplacez les variables de l'exemple de demande conformément au tableau suivant :

   Tableau 1. Décrit les variables requises pour afficher les détails d'une clé à l'aide de l'API

   Variables	Description
   region	Obligatoire. Abréviation de la région, telle que us-south ou eu-de, qui représente la zone géographique dans laquelle réside votre instance Hyper Protect Crypto Services. Pour plus d'informations, voir Noeuds finaux de service régional.
   key_ID_or_alias	Obligatoire. Identificateur ou alias de la clé que vous souhaitez inspecter.
   IAM_token	Obligatoire. Votre jeton d'accès IBM Cloud. Incluez l'ensemble du contenu du jeton IAM, y compris la valeur Bearer, dans la demande cURL. Pour plus d'informations, voir Extraction d'un jeton d'accès.
   instance_ID	Obligatoire. Identificateur unique affecté à votre instance Hyper Protect Crypto Services. Pour plus d'informations, voir Extraction d'un ID d'instance.
   key_ring_ID	Facultatif. Identificateur unique du fichier de clés auquel appartient la clé. S'il n'est pas spécifié, Hyper Protect Crypto Services recherche la clé dans chaque fichier de clés associé à l'instance spécifiée. Par conséquent, il est conseillé de spécifier l'ID du fichier de clés pour une demande plus optimisée. Remarque : les clés créées sans en-tête x-kms-key-ring ont l'ID de fichier de clé "default". Pour plus d'informations, voir Gestion des fichiers de clés.
   correlation_ID	Identificateur unique qui est utilisé pour suivre et corréler des transactions.

   Une réponse GET api/v2/keys/<key_ID_or_alias>/metadata réussie renvoie des détails sur votre clé. L'objet JSON suivant illustre un exemple de valeur renvoyée pour une clé standard :

   {
     "metadata": {
       "collectionType": "application/vnd.ibm.kms.key+json",
       "collectionTotal": 1
     },
     "resources": [
       {
         "type": "application/vnd.ibm.kms.key+json",
         "id": "02fd6835-6001-4482-a892-13bd2085f75d",
         "name": "test-standard-key",
         "state": 1,
         "extractable": true,
         "crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
         "imported": false,
         "creationDate": "2020-03-12T03:50:12Z",
         "createdBy": "...",
         "algorithmType": "AES",
         "algorithmMetadata": {
           "bitLength": "256",
           "mode": "CBC_PAD"
         },
         "algorithmBitSize": 256,
         "algorithmMode": "CBC_PAD",
         "lastUpdateDate": "2020-03-12T03:50:12Z",
         "dualAuthDelete": {
           "enabled": false
         },
         "deleted": false
       }
     ]
   }
   

   Vous devez extraire la valeur payload d'une clé standard ? Pour en savoir plus, voir Extraction d'une clé racine ou d'une clé standard.

   Pour obtenir une description détaillée des paramètres de réponse, voir Gestion des clés Hyper Protect Crypto Services Document de référence de l'API REST.