Change Secret Data Alias REST Service

Use the Change Secret Data Alias REST Service to change secret data alias that is present in the IBM Security Guardium Key Lifecycle Manager server.

Operation
POST
URL
https://host:port/SKLM/rest/v1/ckms/conflictResolution/changeSecretDataAlias

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
oldAlias Specifies the existing value of the alias for the secret data present in IBM Security Guardium Key Lifecycle Manager system.
newAlias Specifies the new value to be set for the alias of the secret data. This value must be unique in the IBM Security Guardium Key Lifecycle Manager system.

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 secret data 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 change secret data alias
POST https://localhost:portSKLM/rest/v1/ckms/conflictResolution/changeSecretDataAlias
{
  "oldAlias": "64bdbc41ce7f4196a3e1a3c583811f0d",
  "newAlias": "64bdbc41ce7f4196a3e1a3c583811f0dasd"
}
Success response
Status Code : 200 OK
 {
  "code": 0,
  "status": "Secret data alias successfully changed."
}
Error response
Status Code: 500 Internal Server Error
{
  "code": "CTGKM7100E",
  "message": "CTGKM7100E Secret data with alias name 64bdbc41ce7f4196a3e1a3c583811f0d does not exist."
}