Configuring an email notification channel by using the REST interface
You can configure an email notification channel by using the REST interface.
Procedure
- Open the Swagger UI. For more information, see Using Swagger UI.
- Authenticate and authorize to access the IBM Security Guardium Key Lifecycle Manager REST services. For more information, see Authentication process for REST services.
- Run the Add Email Server REST Service to configure
an email notification channel.
POST https://localhost:port/SKLM/rest/v1/ckms/notification/channel/email { "toEmailAddress": "user01@james.local", "password": "1234", "fromEmailAddress": "user02@james.local", "smtpHost": "host1", "smtpPort": "465" }
- To configure additional properties of the email server, run the Add Additional Email Server Properties REST Service.
PUT https://localhost:port/SKLM/rest/v1/ckms/notification/channel/email/additonalProperties [ {"name":"mail.smtp.socketFactory.class","value":"javax.net.ssl.SSLSocketFactory"}, {"name":"mail.smtp.socketFactory.port","value":"465"}, {"name":"mail.smtp.auth","value":"true"} ]
- Run the Test Connection to Email Server REST Service
to test whether the email notification channel is configured.
POST https://localhost:port/SKLM/rest/v1/ckms/notification/channel/email/testConnection
- Run the Update Config Property REST Service to set
the following properties:
GET https://localhost:port/SKLM/rest/v1/configProperties { "certNotifyExpiryServiceFrequencyInHours" : "24", "notification.enable" : "true", "notification.interval" : "60" }
- Run the List Notification Channel REST Service to
view the details of the configured notification channel.
GET https://localhost:port/SKLM/rest/v1/ckms/notification/channel
- To update any of the configuration properties, use the Update Email Server REST Service.
PUT https://localhost:port/SKLM/rest/v1/ckms/notification/channel/email { "toEmailAddress": "user01@james.local", "password": "1234", "fromEmailAddress": "user02@james.local", "smtpHost": "email_server", "smtpPort": "465" }