Client Group Import Conflicts REST Service

Use the Client Group Import Conflicts REST Service to list data conflicts, if any, when the client group data is imported from an export file into an IBM Security Guardium Key Lifecycle Manager instance. The conflicts must be resolved before the data is imported. You can view the list of conflicts to analyze and resolve the problems.

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

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 group 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 group data into the 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 group 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 list import conflicts during client group data import
POST https://localhost:<port>/SKLM/rest/v1/clientImport/importConflictsOfClientGroup
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=ebd8e605-0fcb-4de7-b53e-919f652a5af6
{"importFilePath": ""${SKLM_DATA}\\sklm_v4.2.1.0_20230810025919-0700_export.exp", 
"password": "SKLM@admin123"}
Success response
Status Code : 200 OK
{"code": 1"}
Error response
Status Code : 400 Bad Request
{"code": "CTGKM2915E",
  "message": "CTGKM2915E Specified export file does not exist: 
C:\\Program Files\\IBM\\WebSphere\\Liberty\\products\\sklm\\data\\sklm_v4.2.1.0_20230860025919-0700_export.exp ."}