Refreshing an OCI Key
Use the post /v1/cckm/oci/keys/{id}/refresh API to refresh an OCI key and its versions on the CipherTrust Manager.
Syntax
curl -k '<IP>/api/v1/cckm/oci/keys/{id}/refresh' -X POST -H 'Authorization: Bearer AUTHTOKEN' -H 'accept: application/json' --compressed
Here, {id} is the resource ID of the OCI key on the CipherTrust Manager. Note that the resource id is different from key_id on OCI. Run the get /v1/cckm/oci/keys API to view the resource ID (id) of the OCI key on the CipherTrust Manager.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authentication token. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/oci/keys/90671f17-28ff-4f93-86dc-ff08983469e7/enable' -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3ZjRlNmJkNi0wMzgzLTQ4MGMtYWZmZS0wYTQxNDgzZmVlNmUiLCJzdWIiOiJsb2NhbHxlNjM3NTVjOS01YzRhLTQ0NzUtOWI0Zi0wN2JjNzQxYjQ1MGEiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODJlZTQ2MzAtNjQwMi00MTQ3LTliNDYtNWE5YzU1OGVjZWU4Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImI4MThiN2MzLTk5NzItNDU0YS1iMjI0LWQ2NGQwOWVlOGRmNSIsImlhdCI6MTYzNDU0MzE0OSwiZXhwIjoxNjM0NTQzNDQ5fQ.KEXK5uaMecdIQT8QWsIqVn6szCz5VBPetDh8i2ePiLU' -H 'accept: application/json' --compressed
Example Response
{
"application/json": {
"id": "1b350f57-aa02-40d1-9d7c-e1e747f2d7f5",
"uri": "kylo:kylo:cckm:oci-key:testocikey-1b350f57-aa02-40d1-9d7c-e1e747f2d7f5",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2022-01-27T12:53:54.857776Z",
"updatedAt": "2022-01-27T12:53:54.854851Z",
"cloud_name": "oci",
"vault_id": "c100fd48-5083-4f67-9afa-49ee128ddd77",
"tenancy": "gemaltoproductdev",
"region": "us-ashburn-1",
"key_material_origin": "native",
"oci_params": {
"compartment_id": "ocid1.tenancy.oc1..aaaaaabadixbhkjhk52q2mvlsn634ql4c5aaal6hb2vg7audpd4d4mcf5zluymff6sq",
"current_key_version": "ocid1.keyversion.oc1.iad.bzq26sungjyhkaaeuk.aueimhzjlyqaa.abuwcljrdr2i4ld72pkcopnyes34u5ypffduargf67wir5dptn2yjt4jwwga",
"display_name": "TestOciKey",
"key_id": "ocid1.key.oc1.iad.bzq26sungjyhkaaeuk.abuwcljrdr2i4ld72pkcopnyes34u5ypffduargf67wir5dptn2yjt4jwwga",
"algorithm": "AES",
"length": 32,
"lifecycle_state": "ENABLED",
"time_created": "2022-01-27T12:53:54.76Z",
"vault_name": "CCKM-Testing",
"defined_tags": {},
"freeform_tags": {},
"protection_mode": "SOFTWARE",
"is_primary": true
}
}
}
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
