PayloadKit

Network Usage Rules

com.apple.networkusagerules

The payload that configures network-usage rules.

iOS 9.0+
Apple schemaexclusive

Not available with User Enrollment · Only one instance per profile

Configuration Keys (2)

KeyTypeDescriptionDefaultRange

Application Network Usage Rules

arrayAn array of application rules, that apply to only managed apps.Default: —Range: —

Network Usage Rules

dictThe application rules dictionary.Default: —Range: —

Bundle Identifier Matches

arrayA list of managed app identifiers, as strings, that must follow the associated rules. If this key is missing, the rules apply to all managed apps on the device. Each string in the 'AppIdentifierMatches' array may either be an exact app identifier match (for example, 'com.mycompany.myapp') or it may specify a prefix match for the bundle ID by using the * wildcard character. If used, this character must appear after a period (.) and may only appear once, at the end of the string; for example, 'com.mycompany.\*'.Default: —Range: —

Bundle Identifier

required
stringA managed app identifier.Default: —Range: —

Allow Cellular Data

booleanIf 'false', disables cellular data for all matching managed apps.Default: trueRange: —

Allow Data Roaming

booleanIf 'false', disables cellular data while roaming for all matching managed apps.Default: trueRange: —

Wi-Fi Assist Policy Rules

iOS 13.0+

arrayAn array of SIM rules, that apply to all apps.Default: —Range: —
dictThe policy for individual SIM cards.Default: —Range: —
ICCIDsarray

SIM ICCIDs

required
arrayOne or more ICCIDs of SIM cards for which the 'WiFiAssistPolicy' applies. All ICCIDs in all installed Network Usage Rules payloads must be unique. An example ICCID is '89310410106543789301'.Default: —Range: —
ICCIDstring
required
stringAn ICCID.Default: —Range: —

Policy

required
integerThe Wi-Fi Assist policy to apply to the SIM cards specified in the ICCIDs. Allowed values: '2': Use the default system policy for the specified SIM card(s). '3': Make Wi-Fi Assist switch more aggressively from a poor Wi-Fi connection to cellular data for the specified SIM card(s). This setting may increase cellular data use and may impact battery life. For more information, see About Wi-Fi Assist (https://support.apple.com/en-us/HT205296).Default: —Range: Default (2), Allow frequent switching to cellular data (3)