Create Client REST Service
Use the Create Client REST Service to create a client that is registered with Guardium® Key Lifecycle Manager server.
- Operation
POST
- URL
- https://host:port/SKLM/rest/v1/clients
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 |
---|---|
clientName |
Specify the name of the client that you want to create. |
applicationUsage |
Specify the usage type or application for which the client is created. You can specify any of the following values:
|
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
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 client
-
POST https://localhost:port/SKLM/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" }