Publish Notification REST Service

Use the Publish Notification REST Service to publish an event and notify the user of the event.

Operation: POST
URL: https://host:port/GKLM/rest/v1/ckms/notification

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.

JSON property name	Description
severity	Specify the severity of the event. Possible values are: 1 High 2 Medium 3 Low
source	Specify the hostname of the system on which the event occurred.
eventType	Specify the type of the event. Possible value is `CERTIFICATE_EXPIRY_IN_30DAYS`.
properties	Specify the custom properties that are required to construct the event message. Custom properties must be in JSON format. For example, `"0"=<aliasName>, "1"=<subjectName>`.

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 code that is specified by the status property.
status	Returns a message that indicates the status of the operation.

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

POST https://localhost:port/GKLM/rest/v1/ckms/notification
{
  "severity": "1",
  "source": "hostname",
  "eventType": "CERTIFICATE_EXPIRY_IN_30DAYS"
}

Success response

{
  "code": "0",
  "status": "Succeeded"
}

Incorrect service request

POST https://localhost:port/GKLM/rest/v1/ckms/notification
{
  "severity": "1"
}

Error response

{
  "code": "CTGKM0631E",
  "message": "CTGKM0631E Missing required parameter \"  source  \" ."
}