Use the Change Opaque Object Name REST Service to change the name of
an opaque object that exists in the IBM® Guardium® Key Lifecycle Manager
server.
- Operation
POST- URL
- https://host:port/GKLM/rest/v1/ckms/conflictResolution/changeOpaqueObjectName
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 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 |
| oldName |
Specifies the existing value of the opaque object that is present in the
IBM Guardium Key Lifecycle Manager system. |
| newName |
Specifies the new value to be set for the opaque object. This value must be
unique in the IBM Guardium Key Lifecycle Manager system. |
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 opaque name 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 opaque object name
-
POST https://localhost:port/GKLM/rest/v1/ckms/conflictResolution/changeOpaqueObjectName
{ "oldName": "OMOS-M-1-10",
"newName": "NewName"}'
-
- Success response
-
Status Code : 200 OK
{"code": 0,
"status": "The name is changed successfully."}
- Error response
-
Status Code: 500 Internal Server Error
{{
"code": "CTGKM7102E",
"message": "CTGKM7102E Opaque object with name OMOS does not exist."
}}