Use the List Client Group Export Files REST Service to list the client
group exported files in the specified directory.
- Operation
GET
- URL
- https://host:port/SKLM/rest/v1/clientExport/listClientGroupExportFiles
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. |
Query parameters
JSON property name |
Description |
exportDirectory |
Specify the location of the client group exported files.
|
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 array that contains JSON objects with the following specification:
JSON property name |
Description |
export_id |
Returns the identifier of the exported file. |
exported_file |
Returns the name of the exported file. |
client_group |
Returns the name of the exported client group. |
export_created |
Returns the name of the user who created the client group. |
description |
Returns the description of the client group. |
Error response body
JSON object with the following specification.
JSON property name |
Description |
messageId |
Returns the message identifier. |
error |
Returns a message that describes the error. |
Example
- Listing client group exported file
-
GET https://localhost:port/SKLM/rest/v1/clientExport/listClientGroupExportFiles
- Success response
-
[
{
"export_id": "EXPORT_ID",
"exported_file": "sklm_v4.2.1.1_xxxxxxxxxxxxxx+xxxx_export.exp",
"client_group": "Exported_GroupName",
"export_created": "sklmadmin",
"description": "description for client Group"
}
]