Configurazione delle chiamate API Unified Key Orchestrator- Piano Unified Key Orchestrator

Puoi utilizzare l'API Unified Key Orchestrator API per creare, richiamare e eliminare i template di chiavi, le chiavi e gli archivi chiavi in IBM Cloud® Hyper Protect Crypto Services per Unified Key Orchestrator.

La configurazione delle chiamate API Unified Key Orchestrator si applica solo al piano Unified Key Orchestrator.

Quando utilizzi l'API Unified Key Orchestrator per creare le chiavi KMS IBM Cloud installate nei keystore KMS interni, queste chiavi sono chiavi root e possono essere utilizzate per la crittografia envelope. Puoi anche utilizzare l'API del servizio di gestione delle chiavi per creare chiavi KMS IBM Cloud interne ed eseguire azioni nei confronti delle chiavi.

Richiamo delle tue credenziali IBM Cloud

Per utilizzare l'API, devi generare le tue credenziali del servizio e di autenticazione. Completa la seguente procedura per raccogliere le tue credenziali:

Genera un token di accesso IBM Cloud IAM.
Richiama l'ID istanza che identifica in modo univoco la tua istanza di Hyper Protect Crypto Services.

Formazione della richiesta API Unified Key Orchestrator

Quando effettui una chiamata API al servizio, struttura la tua richiesta API in base a come hai inizialmente eseguito il provisioning della tua istanza di Hyper Protect Crypto Services.

Per creare la tua richiesta, accoppia un endpoint del servizio regionale con le credenziali di autenticazione appropriate. Ad esempio, se hai creato un'istanza del servizio per la regione us-south, utilizza il seguente endpoint e le intestazioni API per sfogliare le chiavi nel tuo servizio:

Se crei le tue istanze dopo il 12 aprile 2024 in alcune regioni, potresti dover utilizzare i nuovi endpoint API con il nuovo formato come <instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud. La data di disponibilità varia in base alla regione. Per ulteriori informazioni sulle regioni supportate, le date di disponibilità e i nuovi URL di endpoint, vedi Nuovi endpoint.

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>'

Sostituisci <region> e <instance_ID> con la regione e il numero di porta del tuo endpoint API. Puoi ottenere <region> e <instance_ID> nel tuo dashboard dell'IU della tua istanza del servizio con provisioning tramite Panoramica > Unified Key Orchestrator URL dell'endpoint. In alternativa, puoi richiamare in modo dinamico l'URL dell'endpoint API.

Nota che l'intervallo di porte di una istanza Hyper Protect Crypto Services è compreso tra 8000- 19999.
Sostituisci <access_token> con il tuo servizio richiamato e le credenziali di autenticazione.
Sostituisci <vault_id> con l'ID del vault a cui sono assegnate le chiavi.

Vuoi tenere traccia delle tue richieste API nel caso che qualcosa non funzioni? Quando includi l'indicatore -v come parte della richiesta cURL, ottieni un valore correlation-id nelle intestazioni della risposta. Puoi utilizzare questo valore per correlare e tracciare la richiesta per scopi di debug.

Operazioni successive

È tutto pronto per iniziare a gestire le tue chiavi e i tuoi dati di crittografia. Per ulteriori informazioni sulla gestione programmatica delle tue chiavi, consulta la documentazione di riferimento dell'API Unified Key Orchestrator.