Recuperación de metadatos de clave

Puede recuperar las características generales de una clave de cifrado utilizando IBM® Key Protect for IBM Cloud®.

Aunque puede asignar acceso preciso a una sola clave, tenga en cuenta que al llamar a la API listar claves no se devolverán las claves a las que haya asignado acceso individual (en otras palabras, a las que sólo pueda acceder usted). Sin embargo, al llamar a esta API se devolverán las claves que estén en los anillos de claves a los que tenga acceso (si tiene acceso a todas las claves de una instancia, verá todas las claves). Sin embargo, puede ver las claves a las que sólo usted tiene acceso siguiendo las instrucciones de Cómo otorgar acceso a las claves para ver la clave a través de IAM o utilizando la API para pasar el ID de clave específico.

Para recuperar una clave se requiere una política de acceso de Escritor o Gestor, pero quizás necesite una forma de ver únicamente los detalles de una clave, como por ejemplo su historial de transición o configuración, sin recuperar la clave propiamente dicha. Si dispone de permisos de acceso de Lector, puede utilizar la API Key Protect Para recuperar sólo los metadatos sobre una clave.

Visualización de metadatos de clave con la API

Para ver información detallada sobre una clave específica, puede realizar una llamada GET al siguiente punto final.

https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>/metadata

  1. Recupere sus credenciales de autenticación para trabajar con claves en el servicio.

  2. 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 la instancia de Key Protect recuperando una lista de sus claves o accediendo al panel de control de Key Protect salpicadero.

  3. Obtenga detalles sobre la clave ejecutando el siguiente mandato curl.

    $ curl -X GET \
    "https://<region>.kms.cloud.ibm.com/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.

Describe las variables necesarias para ver los detalles de una clave con la Key Protect API.
Variable Descripción
región Obligatorio. La abreviatura de región, como us-south o eu-gb, que representa el área geográfica donde reside su instancia de Key Protect. Para obtener más información, consulte Puntos finales de servicio regional.
keyID_or_alias Obligatorio. El identificador exclusivo o el 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 Bearer, en la solicitud curl. Para obtener más información, consulte Recuperación de una señal de acceso.
instance_ID Obligatorio. El único identificador que está asignado a su instancia de servicio de Key Protect. Para obtener más información, consulte Recuperación de un ID de instancia.
ID_conjunto_claves Opcional. El identificador exclusivo del conjunto de claves del que forma parte la clave. La cabecera en sí es opcional, pero si no se especifica, Key Protect buscará la clave en cada anillo de claves asociado a la instancia especificada. Se recomienda especificar el ID de conjunto de claves para optimizar la solicitud. 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 Agrupación de claves.
correlation_ID Opcional. El identificador exclusivo que se utiliza para realizar un seguimiento 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",
						"aliases": [
								"alias-1",
								"alias-2"
						],
						"state": 1,
						"expirationDate": "2020-03-15T03:50:12Z",
						"extractable": true,
						"crn": "crn:v1:bluemix:public:kms: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": "Deprecated",
						"algorithmMetadata": {
								"bitLength": "256",
								"mode": "Deprecated"
						},
						"algorithmBitSize": 256,
						"algorithmMode": "Deprecated",
						"lastUpdateDate": "2020-03-12T03:50:12Z",
						"dualAuthDelete": {
								"enabled": false
						},
						"deleted": false
				}
		]
}

Próximos pasos

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

Para obtener una descripción detallada de los parámetros de respuesta, consulte el Key Protect Documento de referencia de la API REST.