KMIP Secret Data Delete REST Service

Use KMIP Secret Data Delete REST Service to delete a KMIP secret data object. For example, you can delete the secret data that is registered by the client.

Operation: DELETE
URL: https://host:port/SKLM/rest/v1/secretData/{UUID}

By default, Guardium® Key Lifecycle Manager server listens to non-secure port 9080 (HTTP) and secure port 9443 (HTTPS) for communication. During IBM® Security Guardium Key Lifecycle Manager installation, you can modify these default ports.

Note: The non-secure port 9080 is not applicable when IBM Security Guardium Key Lifecycle Manager is deployed in a containerized environment.

Request

Request Parameters

Parameter	Description
host	Specify the IP address or host name 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.
UUID	Required. Specify the unique universal identifier of the secret data object that you want to delete.

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`

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 code that is specified by the status property.
status	Returns the status to indicate whether the delete operation was successful.

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.

Example

Service request to delete a secret data object

DELETE https://localhost:port/SKLM/rest/v1/secretData/K_SEC_DATA-d110f48-626590d9-c597-4ca2-99e9-3e04d519757a
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en

Success response

Status Code : 200 OK
Content-Language: en
{
    "code": "0",
    "status": "Succeeded"
}

Error response

Status Code : 500 Internal server Error
Content-Language: en
{
    "code": "CTGKM3040E",
    "message": "CTGKM3040E  Object with identifier K_SEC_DATA-d110f48-626590d9-c597-4ca2-99e9-3e04d519757a cannot be found."
}