Docs

Integrations / Devices / SimpleMDM

Get Device Information

Retrieves detailed device information from SimpleMDM including apps and profiles

Retrieves comprehensive device information from SimpleMDM using a device_id, including hardware specs, installed apps, and configuration profiles.

Overview

This tool provides detailed device data including enrollment type (DEP vs user-initiated), app inventory with filtering options, configuration profiles, and extended device specifications. Requires a device_id from the SimpleMDM Find User Device tool.

Setup

Use the same API key setup as SimpleMDM Find User Device:

  1. Navigate to Settings > API in SimpleMDM
  2. Create or use existing API key
  3. In Risotto, select Tools in the sidebar, then select SimpleMDM in the Tool groups list
  4. Find SimpleMDM Get Device Information, click Set up, and enter your key in Api Key
  5. Click Save

Usage

Get basic device information:

"Get SimpleMDM device information for device_id 12345"

Include installed apps:

"Get device info for device 12345 with include_apps=true"

Get managed apps only:

"Get device 12345 apps with app_filter=managed"

Search for specific app:

"Get device 12345 apps, search for Slack"

Include configuration profiles:

"Get device 12345 with include_profiles=true"

Configuration Options

Required:

  • device_id - Device ID from SimpleMDM Find User Device

Optional:

  • include_apps (default: false) - Include installed applications list
  • include_profiles (default: false) - Include configuration profiles
  • app_filter - Filter apps: all, managed, or unmanaged (default: all)
  • search_app - Search for specific app by name (partial match supported)

Response Format

Returns JSON with device information:

{
  "device_id": "12345",
  "device_info": {
    "name": "john-macbook",
    "model_name": "MacBook Pro (14-inch, 2023)",
    "serial_number": "C02XY1ZHJG5H",
    "os_version": "14.2.1",
    "last_seen_at": "2024-01-15T10:30:00Z",
    "status": "enrolled",
    "is_supervised": true,
    "enrollment_type": "device",
    "device_enrollment_type": "dep",
    "battery_level": 85,
    "device_capacity": 500.0,
    "available_device_capacity": 250.0
  },
  "apps": [
    {
      "name": "Slack",
      "identifier": "com.tinyspeck.slackmacgap",
      "version": "4.36.140",
      "bundle_size": 268435456,
      "managed": true
    }
  ],
  "profiles": [
    {
      "name": "Corporate WiFi Profile"
    }
  ]
}

App Filtering

Filter installed apps using app_filter:

  • all - All installed apps (managed and unmanaged)
  • managed - Only apps managed by SimpleMDM
  • unmanaged - Only user-installed apps

Search for specific apps using search_app:

  • Partial name match (case-insensitive)
  • Searches both app name and bundle identifier
  • Example: search_app="slack" finds "Slack" and "Slack Beta"

Enrollment Information

The device_info includes enrollment details:

  • enrollment_type: device (DEP) or user (user-initiated)
  • device_enrollment_type: dep, manual, or other
  • is_supervised: Whether device is supervised
  • enrollment_user_email: Email of user who enrolled (if available)

Troubleshooting

Device not found:

  • Verify device_id is correct
  • Use SimpleMDM Find User Device to get current device_id
  • Check device hasn't been unenrolled

Empty apps list:

  • Device may not have reported inventory yet
  • Use SimpleMDM Refresh Device Inventory to update
  • Wait a few minutes and try again

API key errors:

  • Verify API key has read access to devices
  • Check key hasn't been revoked

Performance Notes

  • App queries are paginated (100 apps per page)
  • Large app lists may take longer to retrieve
  • Use app_filter and search_app to reduce response size
  • Configuration profile queries are separate API calls

Security Notes

  • Requires same API key as Find User Device tool
  • API key needs read access to devices and installed apps
  • App data includes bundle identifiers and versions
  • Consider data sensitivity when logging or displaying app information
  • SimpleMDM Find User Device - Get device_id to use with this tool
  • SimpleMDM Refresh Device Inventory - Update app inventory before querying
  • SimpleMDM Push Assigned Apps - Install apps after checking inventory

Something wrong or missing? Report an issue · View as Markdown