Use Get Pending Client Certificate Count REST Service to get the count
of pending client certificates that need to be accepted for secure communication between the client
device and IBM Security Guardium Key Lifecycle Manager.
- Operation
GET
- URL
- https://host:port/SKLM/rest/v1/pendingClientCertificates/pendingClientCertCount
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 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. |
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 |
Pending Date |
Returns the date from when the devices are pending. |
Machine UUID |
Returns the unique universal identifier of the machine. |
Machine ID |
Returns the unique machine ID, which is a concatenation of the Worldwide name
and the volume serial number. The value has a minimum length of 1 and a maximum length of 48
characters. For example, 3042383030303437000000000000. |
Machine Text |
Returns the unique, user-supplied descriptive label of the machine. |
Device UUID |
Returns the unique universal identifier of the device. |
Serial Number |
Returns the serial number of the device. |
Device Text |
Returns the text of the device. |
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 obtain the list of pending devices
-
GET https://localhost:port/SKLM/rest/v1/pendingMachineDevices
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
-
- Success response
-
Status Code : 200 OK
Content-Language: en
[
{
"Pending Date": "6/25/18, 10:55:58 AM Pacific Daylight Time",
"Machine UUID": "MACHINE-d110f48-405a544d-411a-4324-9c89-aa05b3cfd7a4",
"Machine ID": "3131313131313131313131325858",
"Machine Text": null,
"Device uuid": "DEVICE-d110f48-aae391b5-f944-4473-ab1c-bcd6d27399fd",
"Serial Number": "ds5k00000002",
"Device Text": ""
}
]
- Error response
-
Status Code : 400 Bad Request
Content-Language: en
{"code":"CTGKM6002E","message":"CTGKM6002E Bad Request: Invalid user
authentication ID or invalid request format."}