Fix: document mdm_enrolled activity limitations for Microsoft enrol…

…lments (#22793)
fleetdm · Oct 10, 2024 · 6224a5f · 6224a5f
1 parent 98dbeb0
commit 6224a5f
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/changes/22532-document-mdm-enrolled-activity-limitations b/changes/22532-document-mdm-enrolled-activity-limitations
@@ -0,0 +1 @@
+* Documented that Microsoft enrollments have less fields filled in the `mdm_enrolled` activity due to how this MDM enrollment flow is implemented.
diff --git a/docs/Contributing/Audit-logs.md b/docs/Contributing/Audit-logs.md
@@ -526,9 +526,9 @@ This activity contains the following fields:
 Generated when a host is enrolled in Fleet's MDM.
 
 This activity contains the following fields:
-- "host_serial": Serial number of the host.
+- "host_serial": Serial number of the host (Apple enrollments only, always empty for Microsoft).
 - "host_display_name": Display name of the host.
-- "installed_from_dep": Whether the host was enrolled via DEP.
+- "installed_from_dep": Whether the host was enrolled via DEP (Apple enrollments only, always false for Microsoft).
 - "mdm_platform": Used to distinguish between Apple and Microsoft enrollments. Can be "apple", "microsoft" or not present. If missing, this value is treated as "apple" for backwards compatibility.
 
 #### Example

diff --git a/server/fleet/activities.go b/server/fleet/activities.go
@@ -758,9 +758,9 @@ func (a ActivityTypeMDMEnrolled) ActivityName() string {
 func (a ActivityTypeMDMEnrolled) Documentation() (activity string, details string, detailsExample string) {
 	return `Generated when a host is enrolled in Fleet's MDM.`,
 		`This activity contains the following fields:
-- "host_serial": Serial number of the host.
+- "host_serial": Serial number of the host (Apple enrollments only, always empty for Microsoft).
 - "host_display_name": Display name of the host.
-- "installed_from_dep": Whether the host was enrolled via DEP.
+- "installed_from_dep": Whether the host was enrolled via DEP (Apple enrollments only, always false for Microsoft).
 - "mdm_platform": Used to distinguish between Apple and Microsoft enrollments. Can be "apple", "microsoft" or not present. If missing, this value is treated as "apple" for backwards compatibility.`, `{
   "host_serial": "C08VQ2AXHT96",
   "host_display_name": "MacBookPro16,1 (C08VQ2AXHT96)",