Client Group Export REST Service
Use the Client Group Export REST to create an encrypted archive that contains client group data for exporting to another instance of IBM Security Guardium Key Lifecycle Manager.
- Operation
POST
- URL
- https://host:port/SKLM/rest/v1/clientExport/clientGroupExport
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
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. |
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. |
JSON object with the following specification:
Property name | Description |
---|---|
name | Specifies the name of the client group that you want to export. |
exportDirectory | Specifies the location to store the archive file that contains the client
group data for exporting. If you do not specify a directory, the export archive file is stored in the SKLM_DATA directory by default. If you specify a value, the directory is created under SKLM_DATA and the archive file is stored in it. For example, if you specify the value as export1, then the archive file is stored in the following path:
|
password | Specifies the password that you need to decrypt and import client group data. |
description | Specifies the additional information that indicates purpose of the client group export file. |
Response
Header name | Value and description |
---|---|
Status Code |
|
Content-Type | application/json |
Content-Language | Locale for the response message. |
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 exported to an archive in the specified directory with an appropriate message. |
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 export client group data
-
POST https://localhost:port/SKLM/rest/v1/clientGroupsExport Content-Type: application/json Accept: application/json Authorization: SKLMAuth userAuthId=a7e57bca-5591-468c-ad58-039bc6dc9670 {"name": "TestGrp", "exportDirectory": "/root/", "password": "myPassword@123", "description": "Export of client group"}