Pending Machine Device Accept REST Service

Use Pending Machine Device Accept REST Service to accept a pending machine-to-device relationship request. Also, the pending device is added in the IBM® Security Guardium® Key Lifecycle Manager database.

Operation
POST
URL
https://host:port/SKLM/rest/v1/pendingMachineDevices/accept

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.
Request body

JSON object with the following specification:

JSON property name Description
deviceUUID Required. Specify the unique universal identifier for the device. Use the Pending Machine Device List REST Service to locate the pending device UUID.
machineID Required if the value for the machineText property is not specified. Specify the unique ID for the machine. Use the Pending Machine Device List REST Service to locate the pending machine IDs.
machineText Required if the value for the machineID is not specified. Specify the unique, descriptive label for the machine for which you want to accept the connection request.

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 accept operation is successful or not.
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 accept the pending list of machine devices
POST https://localhost:port/SKLM/rest/v1/pendingMachineDevices/accept 
{"machineID": "3131313131313131313131325858" , 
"deviceUUID": "DEVICE-d110f48-4b070cdb-e7d2-4f2c-8644-d6028295f660"}
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Success response
{
    "code": "0",
    "status": "Succeeded"
}
Error response
Status Code : 500 Internal Server Error
Content-Language: en
{
    "code": "CTGKM1100E",
    "message": "CTGKM1100E  Object (machinetype) with identifier MACHINE-d110f48-bd8659ef-3c90-4e74-8c2d-a398e1d1e72d cannot be found."
}