Machine Identity Add REST Service
Use Machine Identity Add REST Service to create a machine identity in the IBM® Security Guardium® Key Lifecycle Manager database.
- Operation
POST
- URL
- https://<host>:<port>/SKLM/rest/v1/machines
By default, Guardium Key Lifecycle Manager server
listens to non-secure port 9080 (HTTP) and secure port 9443
(HTTPS) for communication. During IBM Security Guardium Key Lifecycle Manager
installation, you can modify these default ports.
Note: The non-secure port 9080 is not applicable
when IBM Security Guardium Key Lifecycle Manager is deployed in a containerized
environment.
Request
Request Parameters
Parameter | Description |
---|---|
host | Specify the IP address or host name 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 |
---|---|
machineID | Required. Specify a unique ID in a range 1 - 48 characters. For example: 3042383030303437000000000000. Use Machine Identity List REST Service to locate machine identities. |
machineText | Optional. Specify a unique, user-supplied descriptive label greater than zero bytes and not more than 96 bytes for a machine, such as myEncryptedDS5000. |
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
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 addition of a machine identity to the database 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 add a machine identity
POST https://localhost:<port>/SKLM/rest/v1/machines Content-Type: application/json Accept: application/json Authorization: SKLMAuth userAuthId=139aeh34567m {"machineID":"3042383030303437000000000000”}
- Error response when a machine identity exists
POST https://localhost:<port>/SKLM/rest/v1/machines Content-Type: application/json Accept: application/json Authorization: SKLMAuth userAuthId=139aeh34567m {"machineID":"3042383030303437000000000000”}