notifyCertificateReceived API
UEM
can use this optional API to notify a PKI connector that a BlackBerry
Dynamics
app has successfully received and imported certificates. A PKI connector can use this information for different purposes, for example, to take action if a certificate is not delivered successfully or to identify old certificates and take action to remove them.The HTTP request line is:
POST customerSpecifiedPrefix/pki?operation=notifyCertificateReceived
UEM
sends the following values:Element |
Type |
Required |
Details |
|---|---|---|---|
user |
String |
Yes |
This is the user’s email address. |
receivedCert |
Base64 |
Yes |
This indicates that the certificate was received successfully. |
otherCerts |
Array of Base64 encoded objects |
No |
This is a list of previously delivered certificates that are also present on the device. |
deviceId |
string |
No |
This is the BlackBerry
Dynamics device ID. |
deviceName |
string |
No |
This is the device name. |
The API call returns the following response values:
Element |
Type |
Required |
Details |
|---|---|---|---|
status |
string |
Yes |
This can be a value of success or failure . |
failureInfo |
string |
No |
A value of retry causes UEM to send the notification again. Any other value, such as badRequest or unknownUser will stop the notification process |
removeCerts |
Array of Base64 encoded objects |
No |
This lists the certificates that UEM will delete from the device. |
Once an HTTP 200 success response is received,
UEM
removes this notification task from the queue. For any other error code, UEM
tries to send the notification again.Sample
Request:
POST /pki?operation=notifyCertificateReceived HTTP/1.0 Host: ra.lifeonthedot.com Content-Type: application/json Content-Length: XYZ { "user": "joe.foo@lifeonthedot.com", "receivedCert": "base64-encode-x509" }
Response:
HTTP/1.0 200 OK Host: ra.lifeonthedot.com Content-Type: application/json Content-Length: XYZ { "status":"success", }