Configuración de llamadas de API de Unified Key Orchestrator-Plan de Unified Key Orchestrator

Puede utilizar la API deUnified Key Orchestrator para crear, recuperar y destruir plantillas de clave, claves y almacenes de claves en IBM Cloud® Hyper Protect Crypto Services para Unified Key Orchestrator.

La configuración de las llamadas de API de Unified Key Orchestrator sólo se aplica al plan Unified Key Orchestrator.

Cuando utiliza la API Unified Key Orchestrator para crear claves KMS de IBM Cloud instaladas en almacenes de claves KMS internos, estas claves son claves raíz y se pueden utilizar para el cifrado de sobre. También puede utilizar la API de servicio de gestión de claves para crear claves internas de IBM Cloud KMS y realizar acciones hacia las claves.

Recuperación de sus credenciales de IBM Cloud

Para trabajar con la API, debe generar credenciales de servicio y autenticación. Complete los pasos siguientes para recopilar sus credenciales:

  1. Genere una señal de acceso de IBM Cloud IAM.

  2. Recupere el ID de instancia que identifica de forma exclusiva la instancia de Hyper Protect Crypto Services.

Formación de la solicitud de API de Unified Key Orchestrator

Cuando se realiza una llamada de API al servicio, la solicitud de API se estructura de acuerdo a cómo se suministró su instancia de Hyper Protect Crypto Services.

Para crear su solicitud, hay que emparejar un punto final de servicio regional con las credenciales de autenticación adecuadas. Por ejemplo, si ha creado una instancia de servicio para la región us-south, utilice el siguiente punto final y las cabeceras de API para examinar claves en el servicio:

Si crea las instancias después del 12 de abril de 2024 en determinadas regiones, es posible que tenga que utilizar los nuevos puntos finales de API con el nuevo formato como <instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud. La fecha de disponibilidad varía según la región. Para obtener más información sobre las regiones soportadas, las fechas de disponibilidad y los nuevos URL de punto final, consulte Nuevos puntos finales.

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

  • Sustituya <region> y <instance_ID> por la región y el número de puerto del punto final de la API. Puede obtener <region> y <instance_ID> en el panel de control de la interfaz de usuario de la instancia de servicio suministrada a través de Visión general > Unified Key Orchestrator URL de punto final. O bien, puede recuperar dinámicamente el URL de punto final de API.

    Tenga en cuenta que el rango de puertos de una instancia de Hyper Protect Crypto Services está entre 8000- 19999.

  • Sustituya <access_token> por las credenciales de autenticación y servicio recuperadas.

  • Sustituya <vault_id> por el ID de la caja fuerte a la que están asignadas las claves.

¿Desea realizar un seguimiento de las solicitudes de API por si algo va mal? Cuando se incluye el distintivo -v como parte de la solicitud cURL, se obtiene un valor de correlation-id en las cabeceras de respuesta. Puede utilizar este valor para correlacionar y realizar un seguimiento de la solicitud con fines de depuración.

Qué hacer a continuación

Ya está todo listo para empezar a gestionar datos y claves de cifrado. Para obtener más información sobre la gestión mediante programación de las claves, consulte la documentación de referencia de la API de Unified Key Orchestrator.