Pending Machine Device Reject REST Service

Use Pending Machine Device Reject REST Service to reject a machine-to-device relationship request. The rejection also deletes the relationship of the device with the machine identifier in the IBM Guardium Key Lifecycle Manager database.

Operation: POST
URL: https://host:port/GKLM/rest/v1/pendingMachineDevices/reject

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

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

JSON object with the following specification:

JSON property name	Description
deviceUUID	Required. Specify the unique universal identifier for the pending device. Use the Machine Device List REST Service to locate the UUID.
machineUUID	Required. Specify the unique universal identifier for the machine. Use the Machine Identity List REST Service to locate the UUID.

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 reject 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 reject a machine-to-device relationship request

POST https://localhost:port/GKLM/rest/v1/pendingMachineDevices/reject 
{"machineUUID": "MACHINE-d110f48-405a544d-411a-4324-9c89-aa05b3cfd7a4" , "deviceUUID": "DEVICE-d110f48-aae391b5-f944-4473-ab1c-bcd6d27399fd"}
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."
}