Create Generic KMIP Client REST Service

Use the Create Generic KMIP Client REST Service to create a generic KMIP client that is registered with IBM® Guardium Key Lifecycle Manager server.

Operation
POST
URL
https://host:port/GKLM/rest/v1/clients

By default, IBM Guardium Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM 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 Guardium Key Lifecycle Manager server.
port Specify the port number on which the IBM 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 Guardium Key Lifecycle Manager. For example, en or de.
Request body

JSON object with the following specification:

Property name Description
clientName

Specify the name of the generic KMIP client that you want to create.
applicationUsage

Specify the usage type or application for which the generic KMIP client is created.

You can specify any of the following values:
Oracle
Specifies that this generic KMIP client is used for configuring Oracle TDE.
MongoDB
Specifies that this generic KMIP client is used for configuring MongoDB.
VMware
Specifies that this generic KMIP client is used for configuring VMware.
Ceph
Specifies that this generic KMIP client is used for configuring Ceph.
FileNet
Specifies that this generic KMIP client is used for configuring FileNet.
NetApp
Specifies that this generic KMIP client is used for configuring NetApp.
Db2
Specifies that this generic KMIP client is used for configuring Db2.
Generic
Specifies a generic KMIP client that uses the Key Management Interoperability Protocol to interact with IBM Guardium Key Lifecycle Manager.

Response

Response Headers
Header name Value and description
Status Code
201 Created
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
messageId Returns the message identifier.
message Returns the message to indicate the operation is successful.
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

Create a generic KMIP client
POST https://localhost:port/GKLM/rest/v1/clients
{
	"clientName":"client_rest1",
	"clientType":"REST"	
}
Success response

  {
    "message": "CTGKM3411I Successfully created client CLIENT_REST1 .",
    "messageId": "CTGKM3411I"
}
Error response
{
    "error": "CTGKM3430E Failed to create client. Client with name CLIENT_REST1 already exists.",
    "messageId": "CTGKM3430E"
}