Check-in for Threat Response Matrix update

Mobile Threat Detection vendors use this API to notify their agent in our integrated client to immediately check-in with their management service to receive the latest Threat Response Matrix (TRM). This ensures that their agent is working with the most recent application, network, and device threat information, rather than waiting for the next regularly scheduled check-in event. This API consists of a command and optional payload (URL) that vendors can use to work with GUIDs instead of mdm-identifiers.The API returns the count of devices for which the push notification action successfully initiated. The API silently ignores invalid device identifiers specified in the request.

HTTP Method

POST

Request URI

/msa/v1/cps/device/mtd/notification

Request parameters

Parameter

Description

command 

Required

Parameter Type: Request body

Data Type: String

Possible value: CHECKIN

Command to be forwarded to Mobile Treat Defense vendor.

identifierType

Optional

Parameter Type: Request body

Data Type: Enum

Possible Values: One of :

MDM_IDENTIFIER

GUID

If not specified, the server assumes MDM identifiers.

identifiers 

Required

Parameter Type: Request body

Data Type: String

List of mdm identifiers in this format:

{ "identifiers":["mdm-id-1", "mdm-id-2"] } 

See List of identifiers.

url

Optional

Parameter Type: Request body

Data Type: String

URL to be forwarded to Mobile Treat Defense vendor.

Response fields

Success: HTTP Status 200, and a number result with the count of successfully checked in devices.

See Number result

Example request payload

{
  "command": "CHECKIN",
  "URL": "http://example.com/example",
  "identifiers": [
    "mdm-id-1",
    "mdm-id-2"
  ]
}

Example response

{
    "result": 2
}

In case all the identifiers are invalid, then response code will still be 200, with result as 0.