Fetching the Metadata of a Version of External Keys
Use the get /v1/cckm/oci/ekm/v1/vaults/{vaultId}/keys/{keyId}/keyVersions/{keyVersionId}/metadata API to fetch the metadata associated with a version of an external key.
To fetch the metadata associated with a specific version of the external key, specify the version ID of the key as an input parameter.
The API returns the key version specification (algorithm and size), status (ACTIVE or BLOCKED), and the supported cryptographic operations (encrypt, decrypt, sign, verify, wrap, and unwrap).
This release supports the encrypt and decrypt operations.
The supported scope value is oci_hyok_getKeyMetadata.
When running the API,
{vaultId}is the resource ID of the external vault on the CipherTrust Manager.{keyId}is the resource ID of the external key on the CipherTrust Manager.{keyVersionId}is the resource ID of the version of the external key on the CipherTrust Manager. This is the key version for which the metadata is to be fetched.
Header
| Parameter | Type | Description |
|---|---|---|
| opc-request-id | String | Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. |
Example Request
get https://<Host IP Address>/api/v1/cckm/oci/ekm/v1/vaults/{vaultId}/keys/{keyId}/keyVersions/{keyVersionId}/metadata
<authorization token and other headers>
Example Response
{
"keyId": "650e330b-47b1-4d9f-ab72-866b4e10df39",
"keyVersionId": "1272f6a0-9377-4e9a-9158-460860716eaf",
"state": "ACTIVE",
"keyVersionOps": [
"ENCRYPT",
"DECRYPT"
]
}
Response Codes
| Response Code | Description |
|---|---|
| 200 | Ok |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Not found |
| 403 | Forbidden |
| 500 | Internal server error |
Refer to HTTP status codes for details.
