Use Delete Certificate from TrustStore REST Service to delete a
certificate from the IBM® Guardium® Key Lifecycle Manager
truststore.
You cannot delete a certificate that is:
- Associated with a device or a certificate that is marked as either default or partner.
- Scheduled for a future rollover.
- Active
TLSSERVER or IKEV2SERVER certificate.
- Operation
DELETE
- URL
- https://host:port/GKLM/rest/v1/trustStoreCertificates/deleteCertFromTrustStore
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
| Parameter |
Description |
| alias |
Specify the alias of the certificate to be deleted. |
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 the certificate deletion. |
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
- Request to delete a certificate from the truststore
-
DELETE https://localhost:<port>/GKLM/rest/v1/trustStoreCertificates/deleteCertFromTrustStore
{"alias":"servcertificate"}
- Success response
-
{"code":"0","status":"Succeeded"}
- Error response
-
{"code":"CTGKM6002E","message":"CTGKM6002E Bad Request: Invalid user
authentication ID or invalid request format."}