Use Machine
Device Delete REST Service to
remove the association of a device to an existing machine identifier
in the IBM® Security Guardium® Key Lifecycle Manager database.
- Operation
DELETE- URL
- https://<host>:<port>/SKLM/rest/v1/machines/device
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. |
Request body
JSON
object with the following
specification:
| Property name |
Description |
| deviceUUID |
Required. Specify a value for a unique universal
identifier for the device, such as DEVICE-7d588437-e725-48bf-a836-00a47df64e78.
Use Device List REST Service to locate the device
uuid. |
| machineID |
Required parameter if you do not specify the
value of machineText. Specify a unique ID in
a range 1 - 48 characters. For example: 3042383030303437000000000000.
Use Machine Identity List REST Service to locate
machine identities. |
| machineText |
Required parameter if you do not specify the
value of machineID or deviceUUID.
Specify a unique, user-supplied descriptive label greater than zero
bytes and not more than 96 bytes for a machine, such as myEncryptedDS5000. |
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 removal
of a machine device association 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 remove a machine device association when device
and machine exist
DELETE https://localhost:<port>/SKLM/rest/v1/machines/device
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
{"deviceUUID”:”DEVICE-7d588437-e725-48bf-a836-00a47df64e78","machineID":
"3042383030303437000000000000”}
- Success response
Status Code : 200 OK
{"code":"0","status":"Succeeded"}
- Error response when there is no device association
DELETE https://localhost:<port>/SKLM/rest/v1/machines/device
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
{"deviceUUID”:”DEVICE-7d588437-e725-48bf-a836-00a47df64e78","machineID":
"3042383030303437000000000000”}
- Error response
Status Code : 500 Internal Server Error
{"code":"CTGKM1436E","message":"CTGKM1436E No machine affinity
between device DEVICE-7d588437-e725-48bf-a836-00a47df64e78 and
machine 3042383030303437000000000000."}