Use Pending
Client Certificate Reject REST Service to
reject the certificate that is pushed to the server from a client
device. This service also discards the certificate data from the IBM Guardium Key Lifecycle Manager database.
You cannot use this certificate for secure communication.
- Operation
DELETE
- URL
- https://<host>:<port>/GKLM/rest/v1/pendingClientCertificates/{uuid}
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. |
Path parameter
JSON
object with
the following specification:
Property name |
Description |
uuid |
Specify the universal unique identifier of the
certificate in the IBM Guardium Key Lifecycle Manager database,
such as CERTIFICATE-a3862239-a367-41ff-97a1-0ca72cfa08e8 . |
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 rejection
of pending client certificate 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. |
Examples
- Service request to reject a pending client certificate
DELETE https://localhost:<port>/GKLM/rest/v1/pendingClientCertificates/
CERTIFICATE-4e064e39-5c15-4e29-83ab-ebd4d275e148
Content-Type: application/json
Accept : application/json
Authorization : SKLMAuth userAuthId=37ea1939-1374-4db7-84cd-14e399be2d20
Accept-Language : en
- Success
response
Status Code: 200 OK
{"code": "0","status": "Succeeded"}
- Error response when there is no pending client certificate
Status Code : 500 Internal Server Error
{"code":"CTGKM2307E","message":"CTGKM2307E Client certificate UUID
not found in the database: CERTIFICATE-4e064e39-5c15-4e29-83ab-
ebd4d275e148 "}