notifyCertificateRemoved API

Sample

UEM can use this optional API to notify the PKI connector that a certificate is no longer in use and can be revoked.

The HTTP request line is:

POST customerSpecifiedPrefix/pki?operation=notifyCertificateRemoved

UEM sends the following values:

Element

Type

Required

Details

user

String

Yes

This is the user’s email address.

removedCerts

Array of Base64 encoded objects

Yes

This is a list of the certificates that are no longer in use.

reason

String

No
This element indicates why the certificate is no longer in use with one of the following values:
  • userRemoved
  • certRemoved
  • appRemoved
  • duplicate

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.

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.

Request:

POST /pki?operation=notifyCertificateRemoved HTTP/1.0
Host: ra.lifeonthedot.com
Content-Type: application/json
Content-Length: XYZ
{
"user": "joe.foo@lifeonthedot.com",
"removedCerts": ["base64-encode-x509"],
"reason": "certRemoved"
}

Response:

HTTP/1.0 200 OK
Host: ra.lifeonthedot.com
Content-Type: application/json
Content-Length: XYZ
{
"status":"success",
}