PayloadKit

General

Configuration

Use this section to define general settings

iOSmacOStvOS
macOS 10.7+iOS 4.0+exclusive

Configuration Keys (6)

KeyTypeDescriptionDefaultRange

Removal Date

dateThe date when the system automatically removes the profile.Default: —Range: —

Duration Until Removal

realThe number of seconds until the profile is automatically removed. If the 'RemovalDate' key is present, the system uses whichever field yields the earliest date.Default: —Range: —

Consent Text

dictA 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.Default: —Range: —
{{key}}string

Language ID

stringThe IETF BCP 47 identifier for that language (for example, en or jp).Default: —Range: —
{{value}}string

Localized License Agreement

stringThe agreement localized to that language.Default: —Range: —
defaultstring

Default License Agreement

stringThe 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.Default: —Range: —

Has removal passcode

booleanSet to 'true' if there's a removal passcode.Default: falseRange: —

Expiration Date

dateThe date when a profile is no longer valid and the system presents an update button to the user.Default: —Range: —

Target Device Type

integerThe 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 ProDefault: 0Range: Any or Unspecified (0), iPhone/iPad/iPod Touch (1), Apple Watch (2), HomePod (3), Apple TV (4), Mac (5), Vision Pro (6)