PayloadKit

General

Configuration

Use this section to define general settings

iOSmacOStvOS
macOS 10.7+iOS 4.0+exclusive

Configuration Keys (6)

KeyTypeTitle
RemovalDate

The date when the system automatically removes the profile.

dateRemoval Date
DurationUntilRemoval

The number of seconds until the profile is automatically removed. If the 'RemovalDate' key is present, the system uses whichever field yields the earliest date.

realDuration Until Removal
ConsentText

A dictionary that includes: - A key that contains the IETF BCP 47 identifier for a language, such as en or jp - A value that contains the agreement localized to language specified by the key The dictionary can also contain an optional key, 'default', with its value consisting of the unlocalized (usually in en) agreement. The system always displays the agreement in a dialog, and the user needs to agree before the system can install the profile. The system chooses a localized version in the order of preference that the user specifies in macOS, or based on the user's current language setting in iOS. If there's no exact match, the system uses the default localization. If there's no default localization, the system uses the en localization. If there's no en localization, the system uses the first available localization. Tip: Provide a default value, if possible. The system won't display a warning if the user's locale doesn't match any localization in the 'ConsentText' dictionary.

dictConsent Text
HasRemovalPasscode

Set to 'true' if there's a removal passcode.

Default: false

booleanHas removal passcode
PayloadExpirationDate

The date when a profile is no longer valid and the system presents an update button to the user.

dateExpiration Date
TargetDeviceType

The type of platform of the target device. Specifying the platform type helps prevent unintended installations. For interactive installations on iOS devices, specifying a target platform avoids interstitial alerts that prompt the user to choose a profile target when multiple targets are eligible. Allowed values: - '0': Any/unspecified - '1': iPhone/iPad/iPod Touch - '2': Apple Watch - '3': HomePod - '4': Apple TV - '5': Mac - '6': Vision Pro

Default: 0

Range: Any or Unspecified (0), iPhone/iPad/iPod Touch (1), Apple Watch (2), HomePod (3), Apple TV (4), Mac (5), Vision Pro (6)

integerTarget Device Type
{{key}}

The IETF BCP 47 identifier for that language (for example, en or jp).

stringLanguage ID
{{value}}

The agreement localized to that language.

stringLocalized License Agreement
default

The system chooses a localized version in the order of preference specified by the user (macOS) or based on the user's current language setting (iOS). If no exact match is found, the default localization is used. If there is no default localization, the en localization is used. If there is no en localization, then the first available localization is used.

stringDefault License Agreement