Visualización de detalles sobre una clave raíz o una clave estándar

Puede recuperar las características generales de una clave de cifrado utilizando IBM Cloud® Hyper Protect Crypto Services.

La recuperación de una clave raíz o de una clave estándar requiere una política de acceso Escritor o Gestor, pero es posible que necesite una forma de ver sólo los detalles sobre una clave raíz o una clave estándar, como el historial de transición o la configuración, sin recuperar la clave en sí. Si tiene permisos de acceso de Lector, puede utilizar la API de gestión de claves de Hyper Protect Crypto Services para recuperar sólo metadatos sobre una clave raíz o una clave estándar.

Ver detalles clave con la interfaz de usuario

Puede ver detalles sobre una clave específica con la interfaz de usuario completando los siguientes pasos:

Inicie sesión en la interfaz de usuario.
Vaya a Menú > Lista de recursos para ver una lista de sus recursos.
Desde la lista de recursos de IBM Cloud seleccione su instancia suministrada de Hyper Protect Crypto Services.
En la página Claves KMS, utilice la tabla Claves para explorar las claves de su servicio.
Pulse el icono Acciones para abrir una lista de opciones para una clave específica.
En el menú de opciones, pulse Ver detalles de clave para ver los detalles de la clave.

Visualización de detalles de clave con la API de servicio de gestión de claves

Para ver información detallada sobre una clave raíz o una clave estándar específica, puede realizar una llamada GET al siguiente punto final.

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID_or_alias>/metadata

Recupere sus credenciales de autenticación para trabajar con claves en el servicio.
Recupere el ID de la clave que desea inspeccionar.

El valor de la ID se utiliza para acceder a la información detallada acerca de la clave. Puede encontrar el ID de una clave en su instancia de servicio haciendo clic en recuperando una lista de sus claves, o accediendo a la interfaz de usuario.

Obtenga los detalles sobre la clave con el siguiente mandato cURL.

curl -X GET \
  'https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/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>'

Sustituya las variables de la solicitud de ejemplo de acuerdo con la siguiente tabla.

Tabla 1. Describe las variables necesarias para ver detalles sobre una clave con la API
Variable	Descripción
`region`	Obligatorio. La abreviatura de la región, como `us-south` o `eu-de`, que representa el área geográfica donde suHyper Protect Crypto Services reside la instancia. Para obtener más información, consulte Puntos finales de servicio regional.
`key_ID_or_alias`	Obligatorio. El identificador o alias de la clave que desea inspeccionar.
`IAM_token`	Obligatorio. Su señal de acceso de IBM Cloud. Incluya el contenido completo de la señal `IAM`, incluido el valor de Bearer, en la solicitud cURL. Para obtener más información, consulte Recuperación de una señal de acceso.
`instance_ID`	Obligatorio. El identificador exclusivo que está asignado a su instancia de Hyper Protect Crypto Services. Para obtener más información, consulte Recuperación de un ID de instancia.
`key_ring_ID`	Opcional. El identificador exclusivo del conjunto de claves al que pertenece la clave. Si no se especifica, Hyper Protect Crypto Services buscará la clave en cada conjunto de claves asociado a la instancia especificada. Por lo tanto, se recomienda especificar el ID del conjunto de claves para una solicitud más optimizada. Nota: El ID del conjunto de claves que se ha creado sin una cabecera `x-kms-key-ring` es: default. Para obtener más información, consulte Gestionar conjuntos de claves.
`correlation_ID`	El identificador exclusivo que se ha utilizado para rastrear y correlacionar transacciones.

Una respuesta GET api/v2/keys/<key_ID_or_alias>/metadata satisfactoria devuelve los detalles de la clave. El siguiente objeto JSON muestra un valor devuelto de ejemplo para una clave estándar.

{
  "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",
      "state": 1,
      "extractable": true,
      "crn": "crn:v1:bluemix:public:hs-crypto: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": "AES",
      "algorithmMetadata": {
        "bitLength": "256",
        "mode": "CBC_PAD"
      },
      "algorithmBitSize": 256,
      "algorithmMode": "CBC_PAD",
      "lastUpdateDate": "2020-03-12T03:50:12Z",
      "dualAuthDelete": {
        "enabled": false
      },
      "deleted": false
    }
  ]
}

¿Necesita recuperar el valor de payload para una clave estándar? Para obtener más información, consulte Recuperación de una clave raíz o una clave estándar.

Para obtener una descripción detallada de los parámetros de respuesta, consulte el Gestión de claves de Hyper Protect Crypto Services Documento de referencia de API REST.