Policy & Configuration

Tools for managing policies, configuration profiles, scripts, and packages in Jamf Pro.

Policy Management

Get Policies

List all policies in Jamf Pro.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": 1,
    "name": "Install Google Chrome",
    "enabled": true,
    "category": "Software Installation",
    "frequency": "Once per computer",
    "scope": {
      "all_computers": false,
      "computer_groups": ["Staff Computers"]
    }
  },
  {
    "id": 2,
    "name": "Security Settings",
    "enabled": true,
    "category": "Security",
    "frequency": "Ongoing",
    "scope": {
      "all_computers": true
    }
  }
]

Usage Examples

Show me all policies in Jamf Pro

List all enabled policies and their categories

Get all policies that apply to all computers

Related Tools

Get Policy Details

Detailed policy configuration

Get Policy Details

Get Computer History

Policy execution logs

Get Computer History

---

Get Policy Details

Get detailed information about a specific policy.

Parameter	Type	Required	Description
policy_id	str	Yes	Policy ID

Example Response

{
  "id": 1,
  "name": "Install Google Chrome",
  "enabled": true,
  "category": {
    "id": 5,
    "name": "Software Installation"
  },
  "frequency": "Once per computer",
  "trigger": "CHECK_IN",
  "scope": {
    "all_computers": false,
    "computer_groups": [{
      "id": 10,
      "name": "Staff Computers"
    }],
    "exclusions": {
      "computers": [],
      "computer_groups": [{
        "id": 15,
        "name": "Lab Computers"
      }]
    }
  },
  "packages": [{
    "id": 25,
    "name": "GoogleChrome-120.0.pkg",
    "action": "Install"
  }],
  "scripts": [{
    "id": 30,
    "name": "Post-Install Configuration",
    "priority": "After"
  }],
  "self_service": {
    "use_for_self_service": true,
    "self_service_display_name": "Google Chrome",
    "install_button_text": "Install",
    "self_service_description": "Install the latest version of Google Chrome"
  }
}

Usage Examples

Get details for policy ID 1

Show me the scope and exclusions for policy 45

What packages and scripts are included in policy ID 100?

Related Tools

Get Policies

List all policies

Get Policies

Get Packages

Package details

Get Packages

---

Configuration Profiles

Get Configuration Profiles

List all macOS configuration profiles.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": 1,
    "name": "Wi-Fi Configuration",
    "description": "Corporate Wi-Fi settings",
    "level": "Computer",
    "distribution_method": "Install Automatically",
    "payloads": ["com.apple.wifi.managed"]
  },
  {
    "id": 2,
    "name": "FileVault Configuration",
    "description": "Enable FileVault encryption",
    "level": "Computer",
    "distribution_method": "Install Automatically",
    "payloads": ["com.apple.MCX.FileVault2"]
  }
]

Usage Examples

List all configuration profiles

Show me all profiles that install automatically

Get all security-related configuration profiles

Related Tools

Get Profile Details

Detailed profile configuration

Get Configuration Profile Details

Get Computer Inventory

Installed profiles on computers

Get Computer Inventory

---

Get Configuration Profile Details

Get detailed information about a specific configuration profile.

Parameter	Type	Required	Description
profile_id	str	Yes	Configuration profile ID

Example Response

{
  "id": 1,
  "name": "Wi-Fi Configuration",
  "description": "Corporate Wi-Fi settings",
  "level": "Computer",
  "uuid": "12345678-1234-1234-1234-123456789012",
  "distribution_method": "Install Automatically",
  "user_removable": false,
  "scope": {
    "all_computers": true,
    "all_jss_users": false,
    "computer_groups": [],
    "exclusions": {
      "computers": [],
      "computer_groups": []
    }
  },
  "payloads": [{
    "payload_type": "com.apple.wifi.managed",
    "payload_identifier": "com.company.wifi",
    "payload_display_name": "Wi-Fi",
    "payload_description": "Configures Wi-Fi settings"
  }]
}

Usage Examples

Get details for configuration profile ID 1

Show me the scope for profile 10

What payloads are included in profile ID 5?

Related Tools

Get Configuration Profiles

List all profiles

Get Configuration Profiles

Get Compliance Status

Profile compliance

Get Compliance Status

---

Scripts

Get Scripts

List all scripts available in Jamf Pro.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": 1,
    "name": "Install Homebrew",
    "category": "Utilities",
    "filename": "install_homebrew.sh",
    "info": "Installs Homebrew package manager",
    "notes": "Run with standard user privileges"
  },
  {
    "id": 2,
    "name": "Enable Firewall",
    "category": "Security",
    "filename": "enable_firewall.sh",
    "info": "Enables macOS firewall",
    "notes": "Requires admin privileges"
  }
]

Usage Examples

List all scripts in Jamf Pro

Show me all security-related scripts

Get all utility scripts available

Related Tools

Get Script Details

Script content and parameters

Get Script Details

Get Policies

Policies using scripts

Get Policies

---

Get Script Details

Get detailed information about a specific script.

Parameter	Type	Required	Description
script_id	str	Yes	Script ID

Example Response

{
  "id": 1,
  "name": "Install Homebrew",
  "category": {
    "id": 5,
    "name": "Utilities"
  },
  "filename": "install_homebrew.sh",
  "info": "Installs Homebrew package manager",
  "notes": "Run with standard user privileges",
  "priority": "Before",
  "parameters": {
    "parameter4": "User to install for",
    "parameter5": "Install location",
    "parameter6": "",
    "parameter7": "",
    "parameter8": "",
    "parameter9": "",
    "parameter10": "",
    "parameter11": ""
  },
  "os_requirements": "10.15",
  "script_contents": "#!/bin/bash\n# Install Homebrew\n..."
}

Usage Examples

Get details for script ID 1

Show me the contents of script 10

What parameters does script ID 5 accept?

Related Tools

Get Scripts

List all scripts

Get Scripts

Get Policy Details

Policies using this script

Get Policy Details

---

Packages

Get Packages

List all packages available in Jamf Pro.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": 1,
    "name": "Google Chrome",
    "filename": "GoogleChrome-120.0.pkg",
    "category": "Web Browsers",
    "info": "Google Chrome web browser",
    "size": "215 MB"
  },
  {
    "id": 2,
    "name": "Microsoft Office",
    "filename": "Office365-16.80.pkg",
    "category": "Productivity",
    "info": "Microsoft Office suite",
    "size": "2.1 GB"
  }
]

Usage Examples

List all packages in Jamf Pro

Show me all web browser packages

Get all productivity software packages

Related Tools

Get Package Details

Package configuration details

Get Package Details

Get Policies

Policies deploying packages

Get Policies

---

Get Package Details

Get detailed information about a specific package.

Parameter	Type	Required	Description
package_id	str	Yes	Package ID

Example Response

{
  "id": 1,
  "name": "Google Chrome",
  "filename": "GoogleChrome-120.0.pkg",
  "category": {
    "id": 10,
    "name": "Web Browsers"
  },
  "info": "Google Chrome web browser",
  "notes": "Latest stable version",
  "size": "215 MB",
  "priority": 10,
  "os_requirements": "10.15",
  "fill_user_template": false,
  "indexed": true,
  "fill_existing_user_template": false,
  "boot_volume_required": true,
  "allow_uninstalled": true,
  "os_install": false,
  "serial_number": "",
  "suppress_updates": false,
  "ignore_conflicts": false,
  "suppress_from_dock": false,
  "suppress_eula": false,
  "suppress_registration": false
}

Usage Examples

Get details for package ID 1

Show me the requirements for package 10

What is the size and OS requirement for package ID 5?

Related Tools

Get Packages

List all packages

Get Packages

Get Policy Details

Policies using this package

Get Policy Details

---

Patch Management

Get Patch Software Titles

List all patch management software titles.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": 1,
    "name": "Google Chrome",
    "publisher": "Google",
    "app_name": "Google Chrome.app",
    "bundle_id": "com.google.Chrome",
    "current_version": "120.0.6099.129",
    "last_update": "2024-01-10T00:00:00Z",
    "installed_count": 450
  }
]

Usage Examples

List all patch management software titles

Show me software titles with available patches

Get all patch titles and their current versions

Related Tools

Get Patch Policies

Patch deployment policies

Get Patch Policies

Get Computer Inventory

Installed software versions

Get Computer Inventory

---

Get Patch Policies

List all patch policies.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": 1,
    "name": "Chrome Auto-Update",
    "enabled": true,
    "target_version": "120.0.6099.129",
    "release_date": "2024-01-10T00:00:00Z",
    "incremental_updates": true,
    "reboot_required": false
  }
]

Usage Examples

List all patch policies

Show me enabled patch policies

Get all patch policies that don't require a reboot

Related Tools

Get Patch Software Titles

Available patch titles

Get Patch Software Titles

Get Policies

Related deployment policies

Get Policies

---

Best Practices

Policy Analysis

1. Check Scope: Review which computers policies target

2. Verify Enabled: Ensure critical policies are enabled

3. Review Frequency: Check if frequency matches intent

4. Audit Exclusions: Verify exclusions are intentional

Profile Management

1. Payload Review: Understand what each profile configures

2. User Removable: Check if users can remove critical profiles

3. Distribution Method: Ensure automatic where needed

4. Scope Verification: Confirm proper targeting

Script Security

1. Review Contents: Audit script code for security

2. Parameter Usage: Check for hardcoded sensitive data

3. Privilege Level: Verify appropriate execution context

4. OS Requirements: Ensure compatibility

Package Deployment

1. Size Awareness: Consider bandwidth for large packages

2. Priority Order: Check installation sequence

3. Requirements: Verify OS compatibility

4. Update Strategy: Plan for version management

See also

• Jamf Pro Policies API

• Configuration Profiles API

• Scripts API

• Packages API