Renew UUID REST Service

Use Renew UUID REST Service to change the value of UUID of a key or certificate present in the IBM® Security Guardium® Key Lifecycle Manager instance.

Note: The import conflict REST services make significant changes to the IBM Security Guardium Key Lifecycle Manager instance that might impact its operation and the communication with the storage device. You must carefully plan and evaluate the changes that are required on both IBM Security Guardium Key Lifecycle Manager and the storage device. The changes must be atomic; that is the changes must be done both on the IBM Security Guardium Key Lifecycle Manager system and the devices. The import conflict resolution REST services handle the changes for IBM Security Guardium Key Lifecycle Manager. For the complete process handling, you must take the guidance of your IBM support representative.

Operation: POST
URL: https://<host>:<port>/SKLM/rest/v1/ckms/conflictResolution/renewUUID

By default, Guardium Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM Security Guardium Key Lifecycle Manager installation, you can modify this default port.

Request

Request Parameters

Parameter	Description
host	Specify the IP address or hostname of the IBM Security Guardium Key Lifecycle Manager server.
port	Specify the port number on which the IBM Security Guardium Key Lifecycle Manager server listens for requests.

Request Headers

Header name	Value
Content-Type	`application/json`
Accept	`application/json`
Authorization	`SKLMAuth userAuthId=<authIdValue>`
Accept-Language	Any valid locale that is supported by IBM Security Guardium Key Lifecycle Manager. For example, `en` or `de`.

Request body

JSON object with the following specification

Property name	Description
type	Specifies the type of object whose UUID is to be renewed. Valid values are `key` and `certificate`.
oldUUID	Specifies the existing UUID value of the object whose UUID is to be renewed.

Response

Response Headers

Header name	Value and description
Status Code	200 OK The request was successful. The response body contains the requested representation. 400 Bad Request The authentication information was not provided in the correct format. 401 Unauthorized The authentication credentials were missing or incorrect. 404 Not Found Error The processing of the request fails. 500 Internal Server Error The processing of the request fails because of an unexpected condition on the server.
Content-Type	`application/json`
Content-Language	Locale for the response message.

Success response body

JSON object with the following specification

JSON property name	Description
code	Returns the value that is specified by the status property.
status	Returns the status to indicate whether the UUID value is changed with an appropriate message.

Error Response Body

JSON object with the following specification.

JSON property name	Description
code	Returns the application error code.
message	Returns a message that describes the error.

Examples

Service request to renew the UUID

POST https://localhost:<port>/SKLM/rest/v1/ckms/conflictResolution/renewUUID
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
{ "type" : "certificate" , "oldUUID" : "CERTIFICATE-74a5aa0-3bb9b042-9c12-4495-8d43-01260a1c845"}

Success response

Status Code : 200 OK
 {"code":"0","status”:”Renew of UUID successfull.”}

Error response

Status Code: 500 Internal Server Error
{"code":"CTGKM2934E","message":"CTGKM2934E Type is not valid”}