Refreshing Details of a Google Cloud Key Version
Use the post /v1/cckm/google/keys/{id}/versions/{versionID}/refresh API to refresh and update the details of a particular version of a Google Cloud key with the given ID. Specify the key ID and the version ID.
Syntax
curl -k '<IP>/api/v1/cckm/google/keys/{id}/versions/{versionID}/refresh' -X POST -H 'Authorization: Bearer AUTHTOKEN' -H 'accept: application/json' --compressed
Here, {id} represents the resource ID of the Google Cloud key and {versionID} represents the resource ID of the key version on the CipherTrust Manager.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/google/keys/ecc73bfb-7605-4263-abb8-84fe431d35fb/versions/e2f79e23-749d-4579-bef1-5777a4651e9e' -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MmFmZDExNy02YzllLTRhNGUtOTAwYS1lYjlhNDNjYWE5ZDIiLCJzdWIiOiJsb2NhbHwzMTI5ODdkMS0wOWNiLTQxZTEtOThmNy1jZjRhNzgwNTZiMTMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNDVmOWE3NWUtMzI1NC00NWJkLWE0NzYtOWU2NWUyNjdmNGVkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjdiYzNkOWM4LWRiYTQtNDVmMy05YWNiLWI3NGM2MzQyYzYyMCIsImlhdCI6MTYxNDc1MTg1MSwiZXhwIjoxNjE0NzUyMTUxfQ.ahdxfM7-WA4u7sotHy6qelc9MkoZytst7oZWsvE7Cr0' -H 'accept: application/json' --compressed
Example Response
{
"id": "e2f79e23-749d-4579-bef1-5777a4651e9e",
"uri": "kylo:kylo:cckm:gcp-key-versions:a88e31c9-101a-42ac-ab1b-8fb58aa5e2ab",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2024-02-02T06:23:42.121236Z",
"updatedAt": "2024-02-02T08:26:49.687385Z",
"deletedAt": null,
"synced_at": "2024-02-02T08:23:49.496516Z",
"rotated_at": "2024-02-02T06:23:42.121236Z",
"parent_key_name": "projects/gemalto-kyloeng/locations/global/keyRings/Piyush/cryptoKeys/symmKey1",
"parent_key_id": "ecc73bfb-7605-4263-abb8-84fe431d35fb",
"key_ring_name": "projects/gemalto-kyloeng/locations/global/keyRings/Piyush",
"version": 3,
"is_primary": true,
"key_material_origin": "cckm",
"deleted": false,
"gone": false,
"local_key_id": "d36e8b041d8b426bb60c348356ed1fc26b4f6cbadf584421962ae3e90f23701e",
"local_key_name": "citrus-ad8c94ae-c2fc-4184-bee0-1d827e76da5f",
"source_key_tier": "local",
"gcp_cloud_resource_name": "projects/gemalto-kyloeng/locations/global/keyRings/Piyush/cryptoKeys/symmKey1/cryptoKeyVersions/3",
"gcp_key_version_params": {
"name": "projects/gemalto-kyloeng/locations/global/keyRings/Piyush/cryptoKeys/symmKey1/cryptoKeyVersions/3",
"state": "ENABLED",
"protectionLevel": "HSM",
"algorithm": "GOOGLE_SYMMETRIC_ENCRYPTION",
"createTime": "2024-02-02T06:23:45.915164Z",
"generateTime": null,
"importJob": "projects/gemalto-kyloeng/locations/global/keyRings/Piyush/importJobs/bc0ba06c-9a37-4b7a-8394-721d8e6432c5",
"importTime": "2024-02-02T06:23:46.123363Z"
}
}
The sample output displays the updated details of a version with the ID e2f79e23-749d-4579-bef1-5777a4651e9e of a Google Cloud key with the ID ecc73bfb-7605-4263-abb8-84fe431d35fb. The details include is version number, name and ID of the parent Google Cloud key, whether the version is primary, origin of key material, version name, state, protection level, and algorithm.
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
