Use Machine Identity Update REST Service to update the machine text of
a machine in the IBM® Security Guardium® Key Lifecycle Manager database.
- Operation
PUT- URL
- https://host:port/SKLM/rest/v1/machines
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 |
| machineUUID |
Required. Specify the unique universal identifier of the machine identity that
you want to update. Use Machine Identity List REST Service to locate the machine
UUIDs. |
| machineText |
Required. Specify a unique, user-supplied descriptive label greater than zero
bytes and not more than 96 bytes for the 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 description of the machine identity
was updated 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. |
Examples
- Service request to update the description of a machine identity
PUT https://localhost:port/SKLM/rest/v1/machines
{"machineUUID":"MACHINE-d4ef1a8-6a49c57b-82b7-479a-9e94-08e1c07e3db2","machineText":"Test Text"}
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
- Success response
Status Code : 200 OK
{"code":"0","status":"Succeeded"}
- Error response when a machine identity exists
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."
}