JavaScript Object Notation (JSON) Pointer defines a syntax for identifying a specific value within a JSON payload. Using the sample payload and JSON Pointer examples below, identify the attributes that you want to use to populate your attribute contract.
For a complete technical description of JSON Pointer syntax, see JavaScript Object Notation (JSON) Pointer on ietf.org.
Example Jamf Pro JSON payload for computers
Portions of the following payload have been removed for brevity. For a complete example, see Find computers by ID in the Jamf Pro API documentation.
{
"computer": {
"general": {
"id": 1,
"name": "Admins iMac",
"ip_address": "10.1.1.1",
"last_reported_ip": "192.0.0.1",
"udid": "55900BDC-347C-58B1-D249-F32244B11D30",
"jamf_version": "9.99.0-t1494340586",
"platform": "Mac",
"remote_management": {
"managed": true,
"management_username": "casperadmin"
},
"mdm_capable": true,
"mdm_capable_users": {
"mdm_capable_user": "string"
},
"management_status": {
"enrolled_via_dep": true,
"user_approved_enrollment": true,
"user_approved_mdm": true
},
"site": {
"id": 0,
"name": "None"
}
},
"location": {
"username": "JBetty",
"realname": "Betty Jackson",
"real_name": "Betty Jackson",
"email_address": "jbetty@company.com",
"position": "Systems Engineer",
"phone": "123-555-6789",
"phone_number": "123-555-6789",
"department": "Sales Staff",
"building": "New York Office",
"room": 1159
},
"groups_accounts": {
"computer_group_memberships": [
{
"group": "All Managed Clients"
}
],
"local_accounts": [
{
"user": {
"name": "_amavisd",
"realname": "AMaViS Daemon",
"uid": 83,
"home": "/var/virusmails",
"home_size": "-1MB",
"home_size_mb": -1,
"administrator": false,
"filevault_enabled": false
}
}
]
},
"configuration_profiles": [
{
"size": 1,
"configuration_profile": {
"id": 1,
"name": "string",
"uuid": "string",
"is_removable": false
}
}
]
}
}| Description | JSON Pointer | Example value |
|---|---|---|
| Device IP address | /computer/general/ip_address | 10.1.1.1 |
| User's name | /computer/location/realname | Betty Jackson |
| User's location | /computer/location/building | New York Office |
| User's administrator status | /computer/groups_accounts/local_accounts/0/user/administrator | false |
To populate an attribute with the entire JSON response, leave the attribute mapping field blank.
Example Jamf Pro JSON payload for mobile devices
Portions of the following payload have been removed for brevity. For a complete example, see Find mobile devices by ID in the Jamf Pro API documentation.
{
"mobile_device": {
"general": {
"id": 1,
"display_name": "Tinas iPad",
"device_name": "Tinas iPad",
"name": "Tinas iPad",
"os_type": "iOS",
"udid": "270aae10800b6e61a2ee2bbc285eb967050b5984",
"phone_number": "123-555-6789",
"ip_address": "192.0.0.1",
"managed": true,
"supervised": true
},
"location": {
"username": "JBetty",
"realname": "Betty Jackson",
"real_name": "Betty Jackson",
"email_address": "jbetty@company.com",
"position": "Systems Engineer",
"phone": "123-555-6789",
"phone_number": "123-555-6789",
"department": "Sales Staff",
"building": "New York Office",
"room": 1159
},
"security": {
"data_protection": true,
"block_level_encryption_capable": true,
"file_level_encryption_capable": true,
"passcode_present": true,
"passcode_compliant": true,
"passcode_compliant_with_profile": true,
"passcode_lock_grace_period_enforced": "Not Available",
"hardware_encryption": "string",
"activation_lock_enabled": true,
"jailbreak_detected": "Normal"
},
"network": {
"home_carrier_network": "Verizon",
"phone_number": 5555555555
},
"mobile_device_groups": [
{
"size": 1,
"mobile_device_group": {
"id": 1,
"name": "string"
}
}
]
}
}| Description | JSON Pointer | Example value |
|---|---|---|
| Device IP address | /mobile_device/general/ip_address | 192.0.0.1 |
| User's name | /mobile_device/location/realname | Betty Jackson |
| User's location | /mobile_device/location/building | New York Office |
| Device jailbreak status | /mobile_device/security/jailbreak_detected | Normal |