Security & ComplianceΒΆ

Tools providing security analysis, compliance checking, and vulnerability management capabilities.

Security AnalysisΒΆ

Get CVEsΒΆ

Analyze CVE vulnerabilities affecting a computer using the macadmins SOFA feed.

Parameter

Type

Required

Description

serial

str

Yes

Computer serial number

include_descriptions

bool

No

Include CVE descriptions (default: false)

Example Response
{
  "serial": "ABC123456",
  "os_version": "14.2.0",
  "os_build": "23C64",
  "cve_summary": {
    "total_cves": 15,
    "actively_exploited": 3,
    "days_since_release": 45,
    "patch_available": true,
    "latest_os_version": "14.2.1"
  },
  "affecting_cves": [
    "CVE-2024-12345",
    "CVE-2024-12346",
    "CVE-2024-12347"
  ],
  "exploited_cves": [
    "CVE-2024-12345"
  ],
  "recommendations": [
    "CRITICAL: Update to macOS 14.2.1 immediately",
    "3 actively exploited vulnerabilities affect this system",
    "Security update available since 2024-01-01"
  ]
}

Usage ExamplesΒΆ

Check for CVE vulnerabilities on computer with serial ABC123
Show me all actively exploited CVEs affecting serial XYZ789 with descriptions
Scan computer ABC123 for security vulnerabilities

Get Compliance StatusΒΆ

Check computer compliance with organizational policies.

Parameter

Type

Required

Description

computer_id

str | int

Yes

Computer JSS ID

Example Response
{
  "computer_id": 123,
  "computer_name": "John's MacBook Pro",
  "compliant": false,
  "compliance_score": 75,
  "issues": [
    {
      "type": "policy_failure",
      "severity": "high",
      "policy_id": 45,
      "policy_name": "Security Settings",
      "last_failure": "2024-01-15T08:00:00Z",
      "failure_count": 3
    },
    {
      "type": "profile_missing",
      "severity": "critical",
      "profile_id": 12,
      "profile_name": "FileVault Configuration",
      "required": true
    },
    {
      "type": "outdated_os",
      "severity": "high",
      "current_version": "14.2.0",
      "required_version": "14.2.1",
      "days_outdated": 15
    }
  ],
  "last_check": "2024-01-15T10:00:00Z",
  "next_check": "2024-01-15T22:00:00Z"
}

Usage ExamplesΒΆ

Check compliance status for computer ID 123
Show me compliance issues for computer 456
Get the compliance score and critical issues for computer ID 789

Related ToolsΒΆ

Get Health Scorecard

Overall health including compliance

Get Health Scorecard
Get Policies

View policy configurations

Get Policies

Software RestrictionsΒΆ

Get Restricted SoftwareΒΆ

List all restricted software configurations.

Parameter

Type

Required

Description

No parameters required

Example Response
[
  {
    "id": 1,
    "name": "BitTorrent Clients",
    "process_name": "BitTorrent",
    "match_exact": false,
    "send_notification": true,
    "kill_process": true,
    "delete_executable": false,
    "display_message": "BitTorrent is not allowed on company computers",
    "site": {
      "id": -1,
      "name": "None"
    },
    "scope": {
      "all_computers": true,
      "computer_groups": []
    }
  },
  {
    "id": 2,
    "name": "Limewire",
    "process_name": "Limewire.app",
    "match_exact": true,
    "send_notification": true,
    "kill_process": true,
    "delete_executable": true,
    "display_message": "P2P software is prohibited"
  }
]

Usage ExamplesΒΆ

Show me all restricted software configurations
List software that is blocked on company computers
Get all restricted software rules and their enforcement actions

Related ToolsΒΆ

Get Restricted Software Details

Detailed configuration for specific software

Get Restricted Software Details
Get Policies

Related restriction policies

Get Policies

Get Restricted Software DetailsΒΆ

Get details about a specific restricted software configuration.

Parameter

Type

Required

Description

software_id

str | int

Yes

Restricted software ID

Example Response
{
  "id": 1,
  "name": "BitTorrent Clients",
  "enabled": true,
  "process_name": "BitTorrent",
  "match_exact": false,
  "send_notification": true,
  "kill_process": true,
  "delete_executable": false,
  "display_message": "BitTorrent is not allowed on company computers",
  "site": {
    "id": -1,
    "name": "None"
  },
  "scope": {
    "all_computers": true,
    "computer_groups": [],
    "computers": [],
    "buildings": [],
    "departments": [],
    "exclusions": {
      "computer_groups": [{
        "id": 15,
        "name": "Developer Exceptions"
      }],
      "computers": [],
      "buildings": [],
      "departments": []
    }
  }
}

Usage ExamplesΒΆ

Get details for restricted software ID 1
Show me the scope and exclusions for restricted software 5
Check if BitTorrent restriction applies to all computers

Related ToolsΒΆ

Get Restricted Software

List all restricted software

Get Restricted Software
Get Smart Groups

Groups used in scope/exclusions

Get Smart Groups

License ManagementΒΆ

Get Licensed SoftwareΒΆ

List all licensed software configurations.

Parameter

Type

Required

Description

No parameters required

Example Response
[
  {
    "id": 1,
    "name": "Adobe Creative Cloud",
    "publisher": "Adobe Inc.",
    "platform": "Mac",
    "bundle_id": "com.adobe.CreativeCloud",
    "total_licenses": 100,
    "used_licenses": 87,
    "available_licenses": 13,
    "license_type": "Per Device"
  },
  {
    "id": 2,
    "name": "Microsoft Office",
    "publisher": "Microsoft",
    "platform": "Mac",
    "bundle_id": "com.microsoft.office",
    "total_licenses": 500,
    "used_licenses": 423,
    "available_licenses": 77,
    "license_type": "Per User"
  }
]

Usage ExamplesΒΆ

Show me all licensed software and their usage
List software licenses with less than 10% availability
Get license counts for all managed software

Related ToolsΒΆ

Get Licensed Software Details

Detailed license information

Get Licensed Software Details
Get Computer Inventory

Check installed software

Get Computer Inventory

Get Licensed Software DetailsΒΆ

Get details about specific licensed software.

Parameter

Type

Required

Description

software_id

str | int

Yes

Licensed software ID

Example Response
{
  "id": 1,
  "name": "Adobe Creative Cloud",
  "publisher": "Adobe Inc.",
  "platform": "Mac",
  "bundle_id": "com.adobe.CreativeCloud",
  "version": "2024",
  "total_licenses": 100,
  "used_licenses": 87,
  "available_licenses": 13,
  "license_type": "Per Device",
  "purchasing_info": {
    "po_number": "PO-2024-001",
    "vendor": "Adobe Direct",
    "purchase_date": "2024-01-01",
    "purchase_price": "$52,000",
    "license_expires": "2025-01-01"
  },
  "scope": {
    "all_computers": false,
    "computer_groups": [{
      "id": 20,
      "name": "Creative Team"
    }]
  },
  "computers": [
    {
      "id": 123,
      "name": "Designer-Mac-01",
      "serial_number": "ABC123"
    }
  ]
}

Usage ExamplesΒΆ

Get details for licensed software ID 1
Show me which computers have Adobe Creative Cloud installed
Check the license expiration date for software ID 5

Related ToolsΒΆ

Get Licensed Software

List all licensed software

Get Licensed Software
Get Users

User assignments for per-user licenses

Get Users

Device SecurityΒΆ

Get Device Lock PINΒΆ

Retrieve the device lock PIN for a lost or stolen computer.

Parameter

Type

Required

Description

computer_id

str

Yes

Computer JSS ID

Example Response
{
  "computer_id": "123",
  "device_lock_pin": "123456",
  "pin_set_date": "2024-01-15T10:00:00Z",
  "pin_expires": "2024-01-22T10:00:00Z",
  "status": "active"
}

Warning

Security Notice: Device lock PINs are sensitive information. Ensure proper authorization before retrieving and handle with appropriate security measures.

Usage ExamplesΒΆ

Get the device lock PIN for computer ID 123
Retrieve the lost device PIN for computer 456
Show me the lock code for stolen computer ID 789

Related ToolsΒΆ

Get Computer Inventory

Device identification details

Get Computer Inventory
Get Computer History

Device management history

Get Computer History

Common Use CasesΒΆ

CVE Vulnerability ScanΒΆ

Scan all computers for actively exploited CVEs and summarize the vulnerable systems
Which computers in our fleet have known security vulnerabilities that are being actively exploited?
Generate a report of all computers affected by CVEs, prioritizing those with active exploits

Compliance AuditΒΆ

Check compliance status for all computers in the Finance department
Find all non-compliant computers and list their critical issues
Generate a compliance report showing computers with scores below 80%

License Usage ReportΒΆ

Show me all software licenses that have less than 10% availability remaining
Generate a license usage report highlighting critical shortages
Which software licenses are expiring in the next 30 days?

Restricted Software MonitoringΒΆ

Show me all restricted software configurations that kill processes and delete executables
Which restricted software rules have the highest impact on users?
List all software restrictions and the computer groups they affect

Security Best PracticesΒΆ

CVE ManagementΒΆ

  1. Regular Scans: Check for CVEs weekly

  2. Prioritize Exploited: Focus on actively exploited CVEs

  3. Rapid Response: Update within 48 hours for critical CVEs

  4. Track Compliance: Monitor update adoption

Compliance MonitoringΒΆ

  1. Automated Checks: Schedule regular compliance scans

  2. Severity Levels: Address critical issues first

  3. Trend Analysis: Track compliance scores over time

  4. Exception Handling: Document approved exceptions

License OptimizationΒΆ

  1. Usage Tracking: Monitor license utilization

  2. Expiration Alerts: Track renewal dates

  3. Reallocation: Reassign unused licenses

  4. Compliance Audit: Ensure proper licensing

Software RestrictionsΒΆ

  1. Clear Policies: Define what’s restricted and why

  2. User Communication: Inform users of restrictions

  3. Exception Process: Have a process for exceptions

  4. Regular Review: Update restricted software list