Payload Variables for Configuration Profiles

Jamf Pro Documentation 11.16.0

Solution

Application

Content Type

Technical Documentation

Utilities & Services

version

11.16.0

ft:locale

en-US

vrm_version

11.16.0

You can use payload variables to populate configuration profile settings with computer, mobile device, or user attribute values stored in Jamf Pro. This allows you to deploy settings specific to each device or user. For example, you can display the unique serial number on the Lock Screen for an iPad.

To use a payload variable, enter a variable from the list below into any text field when creating a configuration profile in Jamf Pro. When the profile is installed, the $VARIABLE is replaced with the value of the corresponding attribute in Jamf Pro.

Note:

Payload variables are case-sensitive.


Variable	Inventory Information
`$MANAGEMENTID`	Device management ID assigned by Jamf Pro
`$DEVICENAME`	Mobile Device Name
`$ASSET_TAG`	Asset Tag
`$SITENAME`	Site Name
`$SITEID`	Site ID
`$SERIALNUMBER`	Serial Number
`$UDID`	UDID
`$USERNAME`	Username
`$FULLNAME` or `$REALNAME`	Full Name
`$EMAIL`	Email Address
`$PHONE`	Phone Number
`$ROOM`	Room
`$POSITION`	Position
`$DEPARTMENTNAME`	Department Name
`$DEPARTMENTID`	Department ID
`$BUILDINGNAME`	Building Name
`$BUILDINGID`	Building ID
`$MACADDRESS`	MAC Address
`$JSSID`	Jamf Pro ID
`$PROFILEJSSID`	Jamf Pro ID of the Configuration Profile
`$EXTENSIONATTRIBUTE_#`	Extension Attribute ID Number Note: The ID number is found in the extension attribute URL. In the example URL below, "id=2" indicates the extension attribute ID number: `https://JAMF_PRO_URL.jamfcloud.com/mobileDeviceExtensionAttributes.html?id=2&o=r` For more information, see Mobile Device Extension Attributes.