Recupero dei metadati chiave

È possibile recuperare le caratteristiche generali di una singola chiave di crittografia usando IBM® Key Protect for IBM Cloud®.

Sebbene sia possibile assegnare un accesso a grana fine a una singola chiave, si noti che la chiamata all'API list keys non restituirà le chiavi a cui è stato assegnato un accesso individuale (in altre parole, a cui solo voi potete accedere). La chiamata a questa API restituirà comunque le chiavi nei portachiavi a cui si ha accesso (se si ha accesso a tutte le chiavi di un'istanza, si vedranno tutte le chiavi). Tuttavia, è possibile vedere le chiavi a cui si ha accesso solo seguendo le istruzioni riportate in Concessione dell'accesso alle chiavi per visualizzare la chiave tramite IAM o utilizzando l'API per passare l'ID della chiave specifica.

Il recupero di una chiave richiede un criterio di accesso Writer o Manager, ma potrebbe essere necessario un modo per visualizzare solo i dettagli di una chiave, come la cronologia delle transizioni o la configurazione, senza recuperare la chiave stessa. Se si dispone dei permessi di accesso Reader, si può usare l'API Key Protect Per recuperare solo i metadati di una chiave.

Visualizzazione dei metadati delle chiavi con l'API

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

https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>/metadata

  1. Richiama le tue credenziali di autenticazione per lavorare con le chiavi nel servizio.

  2. Recuperare l'ID della chiave che si desidera ispezionare.

    Il valore ID viene utilizzato per accedere a informazioni dettagliate sulla chiave. È possibile trovare l'ID di una chiave nella propria istanza Key Protect recuperando l'elenco delle chiavi recuperando un elenco di chiavi, oppure accedendo all'istanza Key Protect cruscotto.

  3. Per ottenere dettagli sulla chiave, eseguire il seguente comando curl

    $ curl -X GET \
    "https://<region>.kms.cloud.ibm.com/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>"

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

Descrive le variabili necessarie per visualizzare i dettagli di una chiave con l'API Key Protect API.
Variabile Descrizione
regione Richiesto. L'abbreviazione della regione, come us-south o eu-gb, che rappresenta l'area geografica in cui risiede l'istanza Key Protect. Per ulteriori informazioni, vedere Endpoint del servizio regionale.
keyID_or_alias Richiesto. L'identificatore unico o l'alias della chiave che si vuole ispezionare.
IAM_token Richiesto. Il tuo token di accesso IBM Cloud. Includere l'intero contenuto del token IAM, compreso il valore Bearer, nella richiesta curl. Per ulteriori informazioni, vedere Recupero di un token di accesso.
instance_id Richiesto. L'identificativo univoco che viene assegnato alla tua istanza del servizio Key Protect. Per ulteriori informazioni, vedere Recupero dell'ID di un'istanza.
iD_anello_chiave Facoltativo. L'identificatore univoco del portachiavi di cui fa parte la chiave. L'intestazione è facoltativa, ma se non è specificata, Key Protect cercherà la chiave in ogni portachiavi associato all'istanza specificata. Si consiglia di specificare l'ID del portachiavi per una richiesta più ottimizzata. Nota: L'ID del portachiavi creato senza intestazione x-kms-key-ring è: default. Per ulteriori informazioni, vedere Raggruppamento di chiavi.
iD correlazione Facoltativo: l'identificativo univoco utilizzato per tracciare e correlare le transazioni.

Una risposta GET api/v2/keys/<key_ID_or_alias>/metadata riuscita restituisce dettagli sulla 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:kms: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": "Deprecated",
						"algorithmMetadata": {
								"bitLength": "256",
								"mode": "Deprecated"
						},
						"algorithmBitSize": 256,
						"algorithmMode": "Deprecated",
						"lastUpdateDate": "2020-03-12T03:50:12Z",
						"dualAuthDelete": {
								"enabled": false
						},
						"deleted": false
				}
		]
}

Passi successivi

Avete bisogno di recuperare il valore payload di una chiave standard? Per saperne di più, vedere Recupero di una chiave.

Per una descrizione dettagliata dei parametri di risposta, si veda il file Key Protect Documento di riferimento dell'API REST.