Payload Variables

There are several payload variables that you can use in any payload in Jamf School to populate settings with attribute values stored in Jamf School.

You can also combine variables with static text. For example:

  • %Username%@domain.com

  • %ProductName% of %FullName%

In addition to combining variables with static text, you can also combine function variables. For example: %FullName,prefix:http://google.com/search?q=,barcode%. This creates a QR code that links to google.com and searches for the user's full name.

The following table describes the payload variables you can use in Jamf School.

Variable

Details

Global Variables

%CompanyId%

The internal ID of your organization

%CompanyNetworkId%

The Network ID of your organization

%CompanyName%

The name of your organization

User Variables (Devices with owners only)

%FullName%

The user’s full name

%FirstName%

The user’s first name

%LastName%

The user’s last name

%Email%

The user’s email address

%ShortName%

The user’s short name

For example: jdoe

%Username%

Alias for %ShortName%

%Password%

The user’s password

Note:

You can only use this variable if the credentials are stored in Jamf School.

%UserId%

The user’s internal ID

%UserGroups%

List of groups the user is a member of

%ManagedAppleId%

The user's Managed Apple ID

%ManagedType%

The type of user

For example: Staff, Student, or Teacher

Note:

You can only use this variable if the user has a Managed Apple ID.

%ManagedGrade%

The grade of the user

For example: K1

Note:

You can only use this variable if the user has a Managed Apple ID.

Service Token Invitation URL

%VPP%

(Profiles only) Link to the URL where the user can accept the service token invite

Note:

You can only use this variable if the user has not associated with a location-based token.

Device Variables

%Name%

The device name

%DeviceGroups%

List of groups the device is a member of

%OSVersion%

The device's OS version

For example: 8.1.3 or 10.9

%udid%

The device's unique identifier

%SerialNumber%

The device’s serial number

%ProductName%

The device’s product name

For example: iPad or MacBook

%WIFIMAC%

The MAC address of the device’s WiFi interface

%AssetTag%

The device’s asset tag

%Notes%

The device’s notes

Functions

%VARIABLE,5%

Lists the first 5 digits of the variable

%VARIABLE,lower%

Lists the variable in lowercase letters

%VARIABLE,upper%

Lists the variable in uppercase letters

%VARIABLE,prefix:%

Adds a prefix to the variable

%VARIABLE,postfix:%

Adds a suffix to the variable

%url,barcode%

(Wallpaper payload only) Adds a QR code with a link to the device in Jamf School

%VARIABLE,barcode%

(Wallpaper payload only) Adds a QR code

Location Variables

%LocationName%

The location's name

%LocationCity%

The location's city

%LocationAddress%

The location's address

%LocationPostalCode%

The location's postal code