Unified Key Orchestrator-API-Aufrufe einrichten- Unified Key Orchestrator Plan

Sie können die API Unified Key Orchestrator verwenden, um Schlüsselvorlagen, Schlüssel und Keystores in IBM Cloud® Hyper Protect Crypto Services für Unified Key Orchestratorzu erstellen, abzurufen und zu löschen.

Die Einrichtung von Unified Key Orchestrator-API-Aufrufen gilt nur für den Plan Unified Key Orchestrator.

Wenn Sie dieUnified Key Orchestrator API zum ErstellenIBM Cloud KMS-Schlüssel, die in internen KMS-Schlüsselspeichern installiert sind. Diese Schlüssel sind Stammschlüssel und können verwendet werden für Umschlagverschlüsselung. Sie können auch die API des Schlüsselverwaltungsdienstes zur Schaffung von internenIBM Cloud KMS-Schlüssel und Ausführen von Aktionen für Schlüssel.

IBM Cloud-Berechtigungsnachweise abrufen

Zur Arbeit mit der API müssen Sie eigene Service- und Authentifizierungsnachweise generieren. Führen Sie die folgenden Schritte aus, um Ihre Berechtigungsnachweise zusammenzustellen:

  1. Generieren Sie ein IBM Cloud-IAM-Zugriffstoken.

  2. Rufen Sie die Instanz-ID ab, die Ihre Hyper Protect Crypto Services-Instanz eindeutig identifiziert.

Unified Key Orchestrator-API-Anforderung erstellen

Wenn Sie einen API-Aufruf für den Service absetzen, strukturieren Sie Ihre API-Anforderung auf dieselbe Weise, wie Sie Ihre ursprüngliche Instanz von Hyper Protect Crypto Services bereitgestellt haben.

Um Ihre Anforderung zu erstellen, kombinieren Sie einen regionalen Serviceendpunkt mit dem entsprechenden Authentifizierungsnachweis. Beispiel: Wenn Sie eine Serviceinstanz für die Region us-south erstellen, verwenden Sie den folgenden Endpunkt und die folgenden API-Header, um die Schlüssel in Ihrem Service zu durchsuchen:

Wenn Sie Ihre Instanzen nach dem 12. April 2024 in bestimmten Regionen erstellen, müssen Sie möglicherweise die neuen API-Endpunkte mit dem neuen Format verwenden als <instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud. Das Verfügbarkeitsdatum variiert je nach Region. Weitere Informationen zu den unterstützten Regionen, den Verfügbarkeitsdaten und den neuen Endpunkt-URLs finden Sie unter Neue Endpunkte.

curl --location --request GET 'https://<instance_ID>.uko.<region>.hs-crypto.appdomain.cloud/api/v4/managed_keys' \
    --header 'Authorization: Bearer <access_token>' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'UKO-Vault: <vault_id>'

  • Ersetzen Sie <region> und <instance_ID> durch die Region und Portnummer Ihres API-Endpunkts. Sie erhalten die <region> Und <instance_ID> in Ihrem bereitgestellten Service-Instanz-UI-Dashboard überÜberblick >Unified Key Orchestrator Endpunkt-URL. Oder Sie können dynamisch Rufen Sie die URL des API-Endpunkts ab.

    Beachten Sie, dass der Portbereich einer Hyper Protect Crypto Services-Instanz zwischen 8000- 19999 liegt.

  • Ersetzen Sie <access_token> durch Ihre abgerufenen Service-und Authentifizierungsnachweise.

  • Ersetzen Sie <vault_id> durch die ID des Vaults, dem Ihre Schlüssel zugewiesen sind.

Möchten Sie Ihre API-Anfragen verfolgen können, wenn etwas schiefgeht? Wenn Sie in Ihrer cURL-Anforderung das Flag -v angeben, erhalten Sie in den Antwortheadern den Wert correlation-id. Sie können diesen Wert verwenden, um die Anforderung zu Debugzwecken zu korrelieren und zu verfolgen.

Nächste Schritte

Nun sind Sie bereit, mit der Verwaltung Ihrer Verschlüsselungsschlüssel und -daten zu beginnen. Weitere Informationen zur programmgesteuerten Verwaltung Ihrer Schlüssel finden Sie im Referenzdokument zur Unified Key Orchestrator-API.