Utility ToolsΒΆ
Additional utility and management tools for JCDS files, webhooks, LDAP integration, and system utilities.
File ManagementΒΆ
Get JCDS FilesΒΆ
List all files stored in Jamf Cloud Distribution Service (JCDS).
Parameter |
Type |
Required |
Description |
|---|---|---|---|
No parameters required |
Example Response
[
{
"id": "abc123def456",
"name": "Company_Logo.png",
"size": 45678,
"md5": "d41d8cd98f00b204e9800998ecf8427e",
"sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
"region": "us-east-1",
"created": "2024-01-10T10:00:00Z",
"modified": "2024-01-10T10:00:00Z"
},
{
"id": "xyz789ghi012",
"name": "Self_Service_Banner.jpg",
"size": 123456,
"md5": "5d41402abc4b2a76b9719d911017c592",
"region": "us-east-1",
"created": "2024-01-05T14:30:00Z"
}
]
Usage ExamplesΒΆ
Webhook ManagementΒΆ
Get WebhooksΒΆ
List all configured webhooks.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
No parameters required |
Example Response
[
{
"id": 1,
"name": "Slack Notifications",
"enabled": true,
"url": "https://hooks.slack.com/services/...",
"content_type": "application/json",
"event": "ComputerAdded",
"connection_timeout": 5000,
"read_timeout": 5000
},
{
"id": 2,
"name": "ServiceNow Integration",
"enabled": true,
"url": "https://instance.service-now.com/api/...",
"event": "ComputerCheckIn",
"authentication_type": "Basic",
"username": "jamf_integration"
}
]
Usage ExamplesΒΆ
Related ToolsΒΆ
Detailed webhook configuration
Webhook triggers from policies
Get Webhook DetailsΒΆ
Get detailed information about a specific webhook.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
str | int |
Yes |
Webhook ID |
Example Response
{
"id": 1,
"name": "Slack Notifications",
"enabled": true,
"url": "https://hooks.slack.com/services/...",
"content_type": "application/json",
"event": "ComputerAdded",
"connection_timeout": 5000,
"read_timeout": 5000,
"authentication_type": "None",
"username": "",
"enable_display_fields_for_group_object": false,
"smart_group": {
"id": -1,
"name": "None"
},
"display_fields": [
{
"name": "general",
"inventory_display": {
"id": "general"
}
},
{
"name": "hardware",
"inventory_display": {
"id": "hardware"
}
}
]
}
Usage ExamplesΒΆ
Related ToolsΒΆ
List all webhooks
Groups used in webhooks
Directory ServicesΒΆ
Get LDAP ServersΒΆ
List all configured LDAP servers.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
No parameters required |
Example Response
[
{
"id": 1,
"name": "Corporate Active Directory",
"hostname": "ldap.company.com",
"port": 389,
"use_ssl": true,
"authentication_type": "Simple",
"account": "CN=JamfLDAP,OU=ServiceAccounts,DC=company,DC=com",
"use_wildcards": true,
"connection_timeout": 15,
"search_timeout": 60,
"referral_response": "Follow"
},
{
"id": 2,
"name": "Azure AD",
"hostname": "ldaps.company.com",
"port": 636,
"use_ssl": true
}
]
Usage ExamplesΒΆ
Related ToolsΒΆ
Detailed LDAP configuration
LDAP-synced users
Get LDAP Server DetailsΒΆ
Get detailed information about a specific LDAP server.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
str | int |
Yes |
LDAP server ID |
Example Response
{
"id": 1,
"name": "Corporate Active Directory",
"hostname": "ldap.company.com",
"port": 389,
"use_ssl": true,
"authentication_type": "Simple",
"account": "CN=JamfLDAP,OU=ServiceAccounts,DC=company,DC=com",
"use_wildcards": true,
"connection_timeout": 15,
"search_timeout": 60,
"referral_response": "Follow",
"mappings": {
"user_mappings": {
"user_id": "sAMAccountName",
"username": "sAMAccountName",
"real_name": "displayName",
"email_address": "mail",
"department": "department",
"building": "physicalDeliveryOfficeName",
"room": "roomNumber",
"telephone": "telephoneNumber",
"position": "title"
},
"user_group_mappings": {
"object_classes": "group",
"search_base": "DC=company,DC=com",
"search_scope": "All Subtrees",
"group_id": "cn",
"group_name": "cn"
}
},
"connection": {
"open_close_timeout": 15,
"search_timeout": 60,
"use_referrals": true,
"test_successful": true,
"test_date": "2024-01-15T10:00:00Z"
}
}
Usage ExamplesΒΆ
Related ToolsΒΆ
List all LDAP servers
Directory binding configurations
Get Directory BindingsΒΆ
List all directory binding configurations.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
No parameters required |
Example Response
[
{
"id": 1,
"name": "Active Directory Binding",
"priority": 1,
"domain": "COMPANY.COM",
"username": "jamfbind",
"computer_ou": "CN=Computers,DC=company,DC=com",
"type": "Active Directory"
},
{
"id": 2,
"name": "OpenDirectory Binding",
"priority": 2,
"server": "od.company.com",
"type": "Open Directory"
}
]
Usage ExamplesΒΆ
Related ToolsΒΆ
Detailed binding configuration
LDAP server configurations
Get Directory Binding DetailsΒΆ
Get detailed information about a specific directory binding.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
str | int |
Yes |
Directory binding ID |
Example Response
{
"id": 1,
"name": "Active Directory Binding",
"priority": 1,
"domain": "COMPANY.COM",
"username": "jamfbind",
"computer_ou": "CN=Computers,DC=company,DC=com",
"type": "Active Directory",
"open_close_timeout": 15,
"mapping": {
"uid": "sAMAccountName",
"user_gid": "primaryGroupID",
"gid": "primaryGroupID",
"preferred_domain_controller": "",
"preferred_domain_controller_port": 389
},
"cache": {
"cache_last_user": true,
"require_confirmation": false,
"local_home": false,
"use_unc_path": true,
"mount_style": "SMB",
"default_shell": "/bin/bash"
},
"administrative": {
"preferred_domain_controller": "",
"allowed_groups": "Domain Admins,Enterprise Admins",
"authentication_from_any_domain": true,
"packet_signing": "Allow",
"packet_encryption": "Allow",
"password_interval": 14,
"restrict_ddns": false,
"namespace": "Domain"
}
}
Usage ExamplesΒΆ
Related ToolsΒΆ
List all bindings
LDAP server details
Advanced SearchΒΆ
Get Advanced Computer SearchesΒΆ
List all advanced computer searches.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
No parameters required |
Example Response
[
{
"id": 1,
"name": "Computers with Low Disk Space",
"criteria": [
{
"name": "Available MB",
"priority": 0,
"and_or": "and",
"search_type": "less than",
"value": "10240"
}
],
"display_fields": ["Computer Name", "Available MB", "Last Check-in"],
"site": {
"id": -1,
"name": "None"
}
},
{
"id": 2,
"name": "Non-Compliant Computers",
"criteria": [
{
"name": "FileVault 2 Status",
"priority": 0,
"and_or": "and",
"search_type": "is not",
"value": "Enabled"
}
]
}
]
Usage ExamplesΒΆ
Related ToolsΒΆ
Search results and details
Direct computer search
Get Advanced Computer Search DetailsΒΆ
Get details about a specific advanced computer search.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
str | int |
Yes |
Advanced search ID |
Example Response
{
"id": 1,
"name": "Computers with Low Disk Space",
"view_as": "Standard Web Page",
"sort_1": "Available MB",
"sort_2": "",
"sort_3": "",
"criteria": [
{
"name": "Available MB",
"priority": 0,
"and_or": "and",
"search_type": "less than",
"value": "10240",
"opening_paren": false,
"closing_paren": false
}
],
"display_fields": [
"Computer Name",
"Available MB",
"Last Check-in",
"Username",
"Operating System"
],
"computers": [
{
"id": 123,
"name": "John-MacBook-Pro",
"udid": "12345678-1234-1234-1234-123456789012",
"Computer_Name": "John-MacBook-Pro",
"Available_MB": "5234",
"Last_Check_in": "2024-01-15 10:30:00",
"Username": "john.doe",
"Operating_System": "14.2.1"
}
],
"site": {
"id": -1,
"name": "None"
}
}
Usage ExamplesΒΆ
Related ToolsΒΆ
List all searches
Smart computer groups
Computer GroupsΒΆ
Get Smart GroupsΒΆ
List all smart computer groups.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
No parameters required |
Example Response
[
{
"id": 1,
"name": "All Managed Computers",
"is_smart": true,
"criteria": [
{
"name": "Managed",
"priority": 0,
"and_or": "and",
"search_type": "is",
"value": "Managed"
}
],
"site": {
"id": -1,
"name": "None"
}
},
{
"id": 2,
"name": "macOS 14 Computers",
"is_smart": true,
"criteria": [
{
"name": "Operating System Version",
"priority": 0,
"and_or": "and",
"search_type": "like",
"value": "14."
}
]
}
]
Usage ExamplesΒΆ
Related ToolsΒΆ
Group members and details
Policies scoped to groups
Get Smart Group DetailsΒΆ
Get detailed information about a computer group.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
str |
Yes |
Computer group ID |
Example Response
{
"id": 1,
"name": "All Managed Computers",
"is_smart": true,
"criteria": [
{
"name": "Managed",
"priority": 0,
"and_or": "and",
"search_type": "is",
"value": "Managed",
"opening_paren": false,
"closing_paren": false
}
],
"site": {
"id": -1,
"name": "None"
},
"computers": [
{
"id": 123,
"name": "John-MacBook-Pro",
"serial_number": "ABC123456",
"mac_address": "00:11:22:33:44:55"
}
],
"computer_count": 245
}
Usage ExamplesΒΆ
Related ToolsΒΆ
List all smart groups
Computer group memberships
Get Extension AttributesΒΆ
List all computer extension attributes.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
No parameters required |
Example Response
[
{
"id": 1,
"name": "Battery Cycle Count",
"enabled": true,
"description": "Returns the battery cycle count",
"data_type": "Integer",
"input_type": "Script",
"inventory_display": "Hardware"
},
{
"id": 2,
"name": "Time Machine Status",
"enabled": true,
"description": "Checks if Time Machine is configured",
"data_type": "String",
"input_type": "Script",
"inventory_display": "Operating System"
}
]
Usage ExamplesΒΆ
Related ToolsΒΆ
Extension attribute values
Scripts used in attributes
System UtilitiesΒΆ
PingΒΆ
Simple ping test to verify MCP server connectivity.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
No parameters required |
Example Response
{
"message": "pong",
"status": "ok"
}
Usage ExamplesΒΆ
Related ToolsΒΆ
Full system health check
Verify data retrieval
Best PracticesΒΆ
Webhook SecurityΒΆ
Use HTTPS: Always use HTTPS endpoints
Authentication: Configure authentication
Timeout Settings: Set appropriate timeouts
Error Handling: Monitor webhook failures
Payload Size: Be aware of size limits
LDAP ConfigurationΒΆ
Use SSL/TLS: Always encrypt LDAP traffic
Service Accounts: Use dedicated accounts
Search Optimization: Configure search bases
Connection Testing: Regularly test connections
Timeout Values: Set reasonable timeouts
Advanced SearchesΒΆ
Performance: Avoid overly complex criteria
Naming Convention: Use descriptive names
Regular Review: Audit saved searches
Display Fields: Only include needed fields
Site Scoping: Use sites to limit scope
Extension AttributesΒΆ
Script Efficiency: Optimize script performance
Error Handling: Handle script failures gracefully
Data Types: Use appropriate data types
Documentation: Document attribute purpose
Regular Audits: Review for unused attributes