Configuration des appels d'API Unified Key Orchestrator-Plan Unified Key Orchestrator

Vous pouvez utiliser l'APIUnified Key Orchestrator pour créer, extraire et détruire des modèles de clé, des clés et des magasins de clés dans IBM Cloud® Hyper Protect Crypto Services pour Unified Key Orchestrator.

La configuration des appels d'API Unified Key Orchestrator s'applique uniquement au plan Unified Key Orchestrator.

Lorsque vous utilisez l'API Unified Key Orchestrator pour créer des clés KMS IBM Cloud installées dans des magasins de clés KMS internes, ces clés sont des clés racine et peuvent être utilisées pour le chiffrement d'enveloppe. Vous pouvez également utiliser l'API de service de gestion des clés pour créer des clés KMS IBM Cloud internes et effectuer des actions sur les clés.

Extraction de vos données d'identification IBM Cloud

Pour utiliser l'API, vous devez générer vos données d'authentification et d'identification de service. Pour collecter vos données d'identification, procédez comme suit :

Générez un jeton d'accès IBM Cloud IAM.
Extrayez l'ID d'instance qui identifie de manière unique votre instance Hyper Protect Crypto Services.

Formation de votre demande d'interface de programmationUnified Key Orchestrator

Lorsque vous soumettez un appel d'API au service, structurez votre demande d'API en fonction de la manière dont votre instance Hyper Protect Crypto Services a été initialement mise à disposition.

Pour générer une demande, associez un noeud final de service régional aux données d'authentification appropriées. Par exemple, si vous avez créé une instance de service pour la région us-south, utilisez le noeud final et les en-têtes API ci-dessous pour parcourir les clés du service :

Si vous créez vos instances après le 12 avril 2024 dans certaines régions, vous devrez peut-être utiliser les nouveaux noeuds finaux d'API avec le nouveau format <instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud. La date de disponibilité varie selon la région. Pour plus d'informations sur les régions prises en charge, les dates de disponibilité et les nouvelles URL de noeud final, voir Nouveaux noeuds finaux.

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

Remplacez <region> et <instance_ID> par la région et le numéro de port de votre nœud final d'interface de programmation. Vous pouvez obtenir <region> et <instance_ID> dans le tableau de bord de l'interface utilisateur de votre instance de service mise à disposition via Overview > URL de noeud finalUnified Key Orchestrator. Vous pouvez également extraire l'URL de noeud final d'APIde manière dynamique.

Notez que la plage de ports d'une instance Hyper Protect Crypto Services est comprise entre 8000 et 19999.
Remplacez <access_token> par le service extrait et les données d'authentification.
Remplacez <vault_id> par l'ID du coffre auquel vos clés sont affectées.

Vous souhaitez effectuer le suivi de vos demandes d'API en cas de problème ? Lorsque vous incluez le drapeau -v dans le cadre d'une demande cURL, vous obtenez une valeur correlation-id dans les en-têtes de réponse. Vous pouvez utiliser cette valeur pour établir une corrélation et suivre la demande à des fins de débogage.

Etapes suivantes

Vous êtes maintenant prêt à commencer à gérer vos clés de chiffrement et vos données. Pour en savoir plus sur la gestion de vos clés à l'aide d'un programme, consultez la documentation de référence de l'API Unified Key Orchestrator.