Schlüsselmetadaten werden abgerufen

Sie können die allgemeinen Merkmale eines einzelnen Verschlüsselungsschlüssels abrufen mithilfe von IBM® Key Protect for IBM Cloud®.

Sie können zwar differenzierten Zugriff auf einen einzelnen Schlüssel zuweisen, beachten Sie jedoch, dass durch das Aufrufen der API zum Auflisten von Schlüsseln keine Schlüssel zurückgegeben werden, denen Sie einen individuellen Zugriff zugewiesen haben (auf die also nur Sie zugreifen können). Wenn Sie diese API aufrufen, werden jedoch die Schlüssel in den Schlüsselringen zurückgegeben, auf die Sie Zugriff haben (wenn Sie Zugriff auf alle Schlüssel in einer Instanz haben, werden alle Schlüssel angezeigt). Sie können jedoch die Schlüssel anzeigen, auf die nur Sie Zugriff haben, indem Sie die Anweisungen in Zugriff auf Schlüssel erteilen befolgen, um den Schlüssel über IAM anzuzeigen, oder indem Sie die API verwenden, um die spezifische Schlüssel-ID zu übergeben.

Das Abrufen eines Schlüssels erfordert eine Writer- oder Manager-Zugriffsrichtlinie, aber Sie benötigen möglicherweise eine Möglichkeit, nur die Details zu einem Schlüssel anzuzeigen, wie z. B. das Übertragungsprotokoll oder die Konfiguration, ohne den Schlüssel selbst abzurufen. Wenn Sie über Lesezugriffsrechte verfügen, können Sie die Key Protect API verwenden, um nur Metadaten über einen Schlüssel abzurufen.

Schlüsselmetadaten mit der API anzeigen

Zum Anzeigen detaillierter Informationen zu einem bestimmten Schlüssel können Sie einen GET-Aufruf an den folgenden Endpunkt absetzen.

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

  1. Rufen Sie Ihre Authentifizierungsnachweise ab, um mit den Schlüsseln im Service zu arbeiten.

  2. Rufen Sie die ID des Schlüssels ab, den Sie untersuchen wollen.

    Der ID-Wert wird für den Zugriff auf detaillierte Informationen zu dem Schlüssel verwendet. Sie können die ID für einen Schlüssel in Ihrer Key Protect-Instanz finden, indem Sie eine Liste Ihrer Schlüssel abrufen oder auf das Key Protect- armaturenbrett.

  3. Details zu dem Schlüssel erhalten Sie, indem Sie den folgenden Befehl curl ausführen.

    $ 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>"

    Ersetzen Sie die Variablen in der Beispielanforderung entsprechend der folgenden Tabelle.

Beschreibt die Variablen, die benötigt werden, um Details zu einem Schlüssel mit der Key Protect API.
Variabel Beschreibung
Bereich Erforderlich. Die Regionsabkürzung (z. B. us-south oder eu-gb) für den geografischen Bereich, in dem sich Ihre Key Protect-Instanz befindet. Weitere Informationen finden Sie unter Regionale Serviceendpunkte.
keyID_or_alias Erforderlich. Die eindeutige ID oder der Aliasname für den Schlüssel, den Sie untersuchen möchten.
IAM_token Erforderlich. Ihr IBM Cloud-Zugriffstoken. Fügen Sie den vollständigen Inhalt des IAM-Tokens, einschließlich des Träger-Wertes, in die Curl-Anforderung ein. Weitere Informationen finden Sie unter Zugriffstoken abrufen.
instance_id Erforderlich. Die eindeutige ID, die Ihrer Key Protect-Serviceinstanz zugewiesen ist. Weitere Informationen finden Sie unter Instanz-ID abrufen.
key_ring_ID Optional. Die eindeutige Kennung des Schlüsselrings, zu dem der Schlüssel gehört. Der Header selbst ist optional, aber wenn nicht angegeben, sucht Key Protect in jedem Schlüsselring, der der angegebenen Instanz zugeordnet ist, nach dem Schlüssel. Es wird empfohlen, die Schlüsselring-ID für eine optimiertere Anforderung anzugeben. Hinweis: Die Schlüsselring-ID der Schlüssel, die ohne den Header x-kms-key-ring erstellt werden, lautet wie folgt: default. Weitere Informationen finden Sie unter Gruppierungsschlüssel.
correlation_ID OptionalDie eindeutige Kennung, mit der Transaktionen überwacht und korreliert werden.

Eine erfolgreiche GET api/v2/keys/<key_ID_or_alias>/metadata-Antwort gibt Details zu Ihrem Schlüssel zurück. Das folgende JSON-Objekt zeigt ein Beispiel für einen zurückgegebenen Wert für einen Standardschlüssel.

{
		"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
				}
		]
}

Nächste Schritte

Sie müssen den Wert von payload für einen Standardwert abrufen? Weitere Informationen dazu finden Sie unter Schlüssel abrufen.

Eine ausführliche Beschreibung der Antwortparameter finden Sie im Key Protect REST-API-Referenzdokument.