Update Owner REST Service

Use the Update Owner REST Service to update the owner of the KMIP objects to use the new client certificate.

Operation: PUT
URL: https://host:port/SKLM/rest/v1/certificates/client

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.

Before you begin

Authenticate to the IBM Security Guardium Key Lifecycle Manager by using your username and password. For more information, see Authentication process for REST services.

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 property name	Description
oldAlias	Specify the alias of the old client certificate.
newAlias	Specify the alias of the new client certificate.

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
status	Returns the status to indicate whether the objects were updated to use the new client certificate.

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 update the owner of a KMIP object

PUT https://localhost:port/SKLM/rest/v1/certificates/client
Content-Type: application/json 
Accept : application/json 
Authorization: SKLMAuth userAuthId=139aeh34567m 
Accept-Language : en 
{ "oldAlias" : "client_cert", "newAlias":"newClient_cert"}

Success response

Status Code : 200 OK 
	Content-Language: en 

	{"code":"0","status":"CTGKM0606I Update successful, change will take effect immediately"}

Incorrect usage example (the alias of the new certificate is incorrect)

PUT https://localhost:port/SKLM/rest/v1/certificates/client
Content-Type: application/json 
Accept : application/json 
Authorization: SKLMAuth userAuthId=139aeh34567m 
Accept-Language : en 
{ "oldAlias" : "abc", "newAlias":"xyz"}

Error response

{
  "code": "CTGKM2918E",
  "message": "CTGKM2918E Certificate with Alias name xyz doesn't exists."
}