nanomdm/service/webhook/event.json at main · Pro-Creation-Curacao/nanomdm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Event",
  "description": "MicroMDM webhook event",
  "type": "object",
  "required": [ "topic", "created_at" ],
  "properties": {
    "acknowledge_event": {
      "description": "If present, the MDM \"command and report results\" (a.k.a. \"Acknowledge\" or \"Connect\") event. The topic name will be `mdm.Connect`.",
      "$ref": "#/$defs/AcknowledgeEvent"
    },
    "checkin_event": {
      "description": "If present, the MDM check-in event.",
      "$ref": "#/$defs/CheckinEvent"
    },
    "created_at": {
      "description": "The date and time the event was created at.",
      "type": "string",
      "format": "date-time"
    },
    "event_id": {
      "description": "The unique identifier of the event.",
      "type": "string"
    },
    "topic": {
      "description": "The topic name of the event.",
      "enum": [
        "mdm.Authenticate",
        "mdm.TokenUpdate",
        "mdm.CheckOut",
        "mdm.UserAuthenticate",
        "mdm.SetBootstrapToken",
        "mdm.GetBootstrapToken",
        "mdm.Connect",
        "mdm.DeclarativeManagement",
        "mdm.GetToken"
      ]
    }
  },
  "$defs": {
    "AcknowledgeEvent": {
      "title": "MDM Acknowledge Event",
      "description": "The \"command and report results\" (a.k.a. \"Acknowledge\" or \"Connect\") event. Represents the MDM command report from MDM enrollments.",
      "type": "object",
      "required": [ "status", "raw_payload" ],
      "properties": {
        "command_uuid": {
          "description": "The command UUID parsed from the command report, if available.",
          "type": "string"
        },
        "enrollment_id": {
          "description": "The `EnrollmentID` of the MDM enrollment.",
          "$ref": "#/$defs/EnrollmentID"
        },
        "ids": {
          "description": "NanoMDM enrollment IDs.",
          "$ref": "#/$defs/IDs"
        },
        "raw_payload": {
          "description": "The raw HTTP body of the MDM command report.",
          "$ref": "#/$defs/RawPayload"
        },
        "status": {
          "description": "The MDM status of the device. Can indicate command report status.",
          "type": "string"
        },
        "udid": {
          "description": "The `UDID` of the MDM device.",
          "$ref": "#/$defs/UDID"
        },
        "url_params": {
          "description": "Query paramters of the command report MDM HTTP request.",
          "$ref": "#/$defs/URLParams"
        }
      }
    },
    "CheckinEvent": {
      "title": "MDM Check-in Event",
      "description": "The MDM check-in event. The specific check-in type will be indicated in the event topic name as well as the `MessageType` key in the raw payload.",
      "type": "object",
      "required": [ "raw_payload" ],
      "properties": {
        "enrollment_id": {
          "description": "The `EnrollmentID` of the MDM enrollment.",
          "$ref": "#/$defs/EnrollmentID"
        },
        "ids": {
          "description": "NanoMDM enrollment IDs.",
          "$ref": "#/$defs/IDs"
        },
        "raw_payload": {
          "description": "The raw HTTP body of the MDM command report.",
          "$ref": "#/$defs/RawPayload"
        },
        "token_update_tally": {
          "description": "Count of how many `TokenUpdate` check-in messages have occured since device enrollment. Primarily to differentiate an enrollment `TokenUpdate` vs. a follow-up. Will only be present for a topic name of `mdm.TokenUpdate`.",
          "type": "integer"
        },
        "udid": {
          "description": "The `UDID` of the MDM device.",
          "$ref": "#/$defs/UDID"
        },
        "url_params": {
          "description": "Query paramters of the command report MDM HTTP request.",
          "$ref": "#/$defs/URLParams"
        }
      }
    },
    "EnrollmentID": {
      "description": "An `EnrollmentID` of the MDM enrollment.",
      "type": "string"
    },
    "IDs": {
      "description": "NanoMDM enrollment IDs.",
      "type": "object",
      "required": [ "id", "type" ],
      "properties": {
        "id": {
          "description": "NanoMDM enrollment ID. See https://github.com/micromdm/nanomdm/blob/main/docs/operations-guide.md#enrollment-ids for details.",
          "type": "string"
        },
        "type": {
          "description": "Type of enrollment.",
          "enum": [
            "Device",
            "User",
            "User Enrollment (Device)",
            "User Enrollment",
            "Shared iPad"
          ]
        },
        "parent_id": {
          "description": "Parent Enrollment ID. In the case of a user channel enrollment the Parent ID will be the device channel enrollment ID for the user user.",
          "type": "string"
        }
      }
    },
    "RawPayload": {
      "description": "A raw HTTP body of an MDM request.",
      "type": "string",
      "contentEncoding": "base64",
      "contentMediaType": "application/x-plist"
    },
    "UDID": {
      "description": "A `UDID` identifier of the MDM enrollment.",
      "type": "string"
    },
    "URLParams": {
      "description": "Query paramters of an MDM HTTP request.",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  }
}