Richiamo di una chiave con l'API del servizio di gestione chiavi

Per visualizzare informazioni dettagliate su una chiave specifica, puoi effettuare una chiamata GET al seguente endpoint.

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

1. Richiama le tue credenziali del servizio e di autenticazione per utilizzare le chiavi nel servizio.

2. Richiama l'ID della chiave standard che desideri accedere o gestire.

   Il valore ID viene utilizzato per accedere alle informazioni dettagliate sulla chiave standard, come il materiale della chiave stesso. Puoi richiamare l'ID per una chiave specificata effettuando una richiesta GET /v2/keys o accedendo all'IU.

3. Esegui il seguente comando cURL per ottenere i dettagli sulla tua chiave e il materiale relativo.

   curl -X GET \
     "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID_or_alias>" \
     -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>'
   

   Sostituisci le variabili nella richiesta di esempio in base alla seguente tabella.

   Tabella 4. Descrive le variabili necessarie per visualizzare una chiave specificata con l'API

   Variabile	Descrizione
   region	Obbligatorio. L'abbreviazione della regione, come us-south o eu-de, che rappresenta l'area geografica in cui risiede la tua istanza Hyper Protect Crypto Services. Per ulteriori informazioni, vedi Endpoint del servizio regionali.
   key_ID_or_alias	Obbligatorio. L'identificativo o l'alias per la chiave che si desidera richiamare.
   IAM_token	Obbligatorio. Il tuo token di accesso IBM Cloud. Includi il contenuto completo del token IAM, incluso il valore Bearer, nella richiesta cURL. Per ulteriori informazioni, vedi Richiamo di un token di accesso.
   instance_ID	Obbligatorio. L'identificativo univoco assegnato alla tua istanza Hyper Protect Crypto Services. Per ulteriori informazioni, vedi Richiamo di un ID istanza.
   key_ring_ID	Facoltativo. L'identificatore univoco dell'anello chiave a cui appartiene la chiave. Se non specificato, Hyper Protect Crypto Services ricercherà la chiave in ogni anello chiave associato all'istanza specificata. Pertanto, si consiglia di specificare l'ID key ring per una richiesta più ottimizzata. Nota: l'ID key ring dei tasti creati senza intestazione x-kms-key-ring è: default. Per ulteriori informazioni, consultare Gestione degli anelli chiave.
   correlation_ID	L'identificativo univoco utilizzato per tracciare e correlare le transazioni.

   Una risposta GET api/v2/keys/<key_ID_or_alias> di successo restituisce i dettagli sulla tua chiave e il materiale della chiave. Il seguente oggetto JSON mostra un valore restituito di esempio per una chiave 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",
               "aliases": [
                   "alias-1",
                   "alias-2"
                 ],
               "state": 1,
               "expirationDate": "2020-03-15T03:50:12Z",
               "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,
               "payload": "Rm91ciBzY29yZSBhbmQgc2V2ZW4geWVhcnMgYWdv..."
           }
       ]
   }
   

   Il seguente oggetto JSON mostra un esempio di valore restituito per una chiave root.

   {
       "metadata": {
           "collectionType": "application/vnd.ibm.kms.key+json",
           "collectionTotal": 1
       },
       "resources": [
           {
               "type": "application/vnd.ibm.kms.key+json",
               "id": "2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
               "aliases": [
                   "alias-1",
                   "alias-2"
               ],
               "name": "test-root-key",
               "state": 1,
               "extractable": false,
               "crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:30372f20-d9f1-40b3-b486-a709e1932c9c:key:2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
               "imported": false,
               "creationDate": "2020-03-05T16:28:38Z",
               "createdBy": "...",
               "algorithmType": "AES",
               "algorithmMetadata": {
                   "bitLength": "256",
                   "mode": "CBC_PAD"
               },
               "algorithmBitSize": 256,
               "algorithmMode": "CBC_PAD",
               "lastUpdateDate": "2020-03-05T16:39:25Z",
               "keyVersion": {
                   "id": "436901cb-f4e4-45f4-bd65-91a7f6d13461",
                   "creationDate": "2020-03-05T16:39:25Z"
               },
               "dualAuthDelete": {
                   "enabled": false
               },
               "deleted": false
           }
       ]
   }
   

   Il materiale payload o chiave per un tasto root rimane entro i limiti di un modulo di sicurezza hardware e non può essere richiamato.

   Per una descrizione dettagliata dei parametri di risposta, consultare la Hyper Protect Crypto Services gestione chiavi REST API reference doc.