Renew Key Alias REST Service

Edit online

Use the Renew Key Alias REST Service to change the alias of a key present in the IBM® Guardium® Key Lifecycle Manager instance.

Note: The Conflict resolution REST services make significant changes to the IBM Guardium Key Lifecycle Manager server that might impact its operation and the communication with the storage device. Consider the following points before you run any of these REST services:
  • Plan and evaluate the changes that are required on both IBM Guardium Key Lifecycle Manager and the storage device.
  • Ensure that the changes are atomic, that is, the changes are done on both the IBM Guardium Key Lifecycle Manager system and the devices for key serving to continue.
  • The REST services handle the changes only for IBM Guardium Key Lifecycle Manager.
  • After changing the alias of a server certificate, you must restart the IBM Guardium Key Lifecycle Manager server.

    If this certificate is marked In Use, then you must first mark the certificate as In Use again, and then restart the server.

For the complete process handling, take the guidance of your IBM support representative.
Operation
POST
URL
https://host:port/GKLM/rest/v1/ckms/conflictResolution/renewKeyAlias

By default, IBM Guardium Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM 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 Guardium Key Lifecycle Manager server.
port Specify the port number on which the IBM 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 Guardium Key Lifecycle Manager. For example, en or de.
Request body

JSON object with the following specification
Property name Description
oldAlias Specifies the existing value of the alias for the key that is present in the IBM Guardium Key Lifecycle Manager system.
newAliasPrefix Specifies the value to be set for the alias of the key.

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 key alias 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 key alias
POST https://localhost:port/GKLM/rest/v1/ckms/conflictResolution/renewKeyAlias
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
{"oldAlias" : "fri004a19372000000000" ,"newAliasPrefix" : "fri"}
Success response
Status Code : 200 OK
 {"code":"0","status”:”Renew of Key alias successfull.”}
Error response
Status Code: 500 Internal Server Error
{"code":"CTGKM2918E","message":"CTGKM2918E Key with Alias name fri004a19372000000000 doesn't exists."}