Client Import REST Service

Use the Client Import REST Service to import client data into IBM Security Guardium Key Lifecycle Manager server from the export file. The export file is an encrypted archive that contains client data from a different instance of IBM Security Guardium Key Lifecycle Manager.

Operation
POST
URL
https://host:port/SKLM/rest/v1/clientImport

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:

Property name Description
importFilePath Specifies the location of the export file that contains client data for importing into the current instance of IBM Security Guardium Key Lifecycle Manager.
password Specifies the password that was used to encrypt the export file for importing and decrypting client data into current instance of IBM Security Guardium Key Lifecycle Manager.

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 value that is specified by the status property.
status Returns the status to indicate whether the client data is imported into IBM Security Guardium Key Lifecycle Manager from the export file with an appropriate message.
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 import client data
POST https://localhost:<port>/SKLM/rest/v1/clientImport
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=a7e57bca-5591-468c-ad58-039bc6dc9670
{"importFilePath": "${SKLM_DATA}\\sklm_v4.2.1.0_20230810093243+0530_export.exp", 
"password": "my@Password123"}
Success response
Status Code : 200 OK
{ "code": 0,
  "status": "CTGKM2908I Import operation succeeded. Please restart the server for changes to come into effect.",
  "messageId": "CTGKM2908I"}
Error response
Status Code : 400 Bad Request
{"code":"CTGKM2915E","status":"CTGKM2915E Specified export file does not exist: 
/opt/IBM/WebSphere/Liberty/products/sklm/data/sklm_v4.2.1.0_20230810003243+0530_export.exp ."}