Delete Client REST Service

Use the Delete Client REST Service to delete a client that is not associated with any cryptographic objects. If the client is associated with cryptographic objects, delete the cryptographic objects, and then delete the client device.

Operation
DELETE
URL
https://host:port/SKLM/rest/v1/clients/{clientName}

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.
Path parameters

JSON object with the following specification:

Property name Description
clientName

Specify the name of the client that you want to delete.

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
messageId Returns the message identifier.
message Returns the message to indicate the operation is successful.
Error response body

JSON object with the following specification.

JSON property name Description
messageId Returns the message identifier.
error Returns a message that describes the error.

Example

Delete a client
DELETE https://localhost:port/SKLM/rest/v1/clients/client_rest1
Success response
-
Incorrect usage example (where the specified client does not exist)
DELETE https://localhost:port/SKLM/rest/v1/clients/client_rest1
Error response
{
    "message": "CTGKM3408E Client with client_rest1 name not found.",
    "messageId": "CTGKM3408E"
}