Change Name REST Service
Use the Change Name REST Service to change the serial number of a storage device.
Note: The Conflict resolution REST services make significant changes to the IBM Security 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 Security Guardium Key Lifecycle Manager and the storage device.
- Ensure that the changes are atomic, that is, the changes are done on both the IBM Security Guardium Key Lifecycle Manager system and the devices for key serving to continue.
- The REST services handle the changes only for IBM Security Guardium Key Lifecycle Manager.
- After changing the alias of a server certificate, you must restart the IBM Security 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.
- Operation
POST
- URL
- https://host:port/SKLM/rest/v1/ckms/conflictResolution/changeName
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 that the user can change the name of a device serial number. You can provide the value Device, Client, or LTOKeyGroup. |
oldName | Specifies the existing value of the storage device serial number. |
newName | Specifies the new value to be set for the storage device serial number. |
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
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 serial number of the storage device 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 change the serial number of a storage device
POST https://localhost:port/SKLM/rest/v1/ckms/conflictResolution/changeName Content-Type: application/json Accept: application/json Authorization: SKLMAuth userAuthId=139aeh34567m {"type" : "Device" , "oldName" : "device1", "newName" : "newdevice1"}