WiFi
The payload that configures Wi-Fi settings.
Declaration
object WiFiProperties
| Name | Type | Description |
|---|---|---|
AllowJoinBeforeFirstUnlock | boolean | If There are several restrictions on the use of this flag:
The device fails to install the profile payload if any of these conditions are not met. Available in visionOS 26 and later. |
AutoJoin | boolean | If If Available in iOS 5 and later, macOS 10.7 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
CaptiveBypass | boolean | If Available in iOS 10 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
DisableAssociationMACRandomization | boolean | If If This value is only locked when MDM installs the profile. If the profile is manually installed, the system sets the value but the user can change it. Available in iOS 14 and later, macOS 15 and later, visionOS 1 and later, and watchOS 7 and later. |
DisplayedOperatorName | string | The operator name to display when connected to this network. Used only with Wi-Fi Hotspot 2.0 access points. Available in iOS 7 and later, macOS 10.9 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
DomainName | string | The primary domain of the tunnel. Available in iOS 7 and later, macOS 10.9 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
EAPClientConfiguration | WiFi.EAPClientConfiguration | The enterprise network configuration. |
EnableIPv6 | boolean | If |
EncryptionType | string | The encryption type for the network. If set to anything except As of iOS 16, tvOS 16, watchOS 9, and macOS 13:
Prior to iOS 16, tvOS 16, and watchOS 9, specifying Prior to macOS 13, the encryption type, if specified explicitly, needed to match the encryption type of the network exactly. |
HESSID | string | The HESSID used for Wi-Fi Hotspot 2.0 negotiation. Available in iOS 7 and later, macOS 10.7 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
HIDDEN_NETWORK | boolean | If |
IsHotspot | boolean | If Available in iOS 7 and later, macOS 10.9 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
MCCAndMNCs | [string] | An array of Mobile Country Code/Mobile Network Code (MCC/MNC) pairs used for Wi-Fi Hotspot 2.0 negotiation. Each string must contain exactly six digits. Available in iOS 7 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
NAIRealmNames | [string] | An array of Network Access Identifier Realm names used for Wi-Fi Hotspot 2.0 negotiation. Available in iOS 7 and later, macOS 10.9 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
Password | string | The password for the access point. |
PayloadCertificateUUID | string | The UUID of the certificate payload within the same profile to use for the client credential. |
ProxyPACFallbackAllowed | boolean | If |
ProxyPACURL | string | The URL of the PAC file that defines the proxy configuration. |
ProxyPassword | string | The password used to authenticate to the proxy server. |
ProxyServer | string | The proxy server’s network address. |
ProxyServerPort | integer | The proxy server’s port number. |
ProxyType | string | The proxy type, if any, to use. If you choose the manual proxy type, you need the proxy server address, including its port and optionally a user name and password into the proxy server. If you choose the auto proxy type, you can enter a proxy autoconfiguration (PAC) URL. |
ProxyUsername | string | The user name used to authenticate to the proxy server. |
QoSMarkingPolicy | WiFi.QoSMarkingPolicy | A dictionary that contains the list of apps that the system allows to benefit from L2 and L3 marking. When this dictionary isn’t present, the system allows all apps to use L2 and L3 marking when the Wi-Fi network supports Cisco QoS fast lane. Available in iOS 10 and later, macOS 10.13 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
RoamingConsortiumOIs | [string] | An array of Roaming Consortium Organization Identifiers used for Wi-Fi Hotspot 2.0 negotiation. Available in iOS 7 and later, macOS 10.9 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
ServiceProviderRoamingEnabled | boolean | If Available in iOS 7 and later, macOS 10.9 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
SetupModes | [string] | An array of strings that contain the type of connection mode to attach. Available in macOS 10.7 and later. |
SSID_STR | string | The SSID of the Wi-Fi network to use. In iOS 7.0 and later, the SSID is optional if a value exists for Available in iOS 7 and later, macOS 10.7 and later, tvOS 9 and later, visionOS 1 and later, and watchOS 3.2 and later. |
TLSCertificateRequired | boolean | If |
Mentioned in
Discussion
Specify com.apple.wifi.managed as the payload type.
Profile availability
Device channel | iOS, macOS, Shared iPad, tvOS, visionOS, watchOS |
User channel | macOS |
Allow manual install | iOS, macOS, tvOS, visionOS, watchOS |
Requires supervision | NA |
Requires user-approved MDM | NA |
Allowed in user enrollment | iOS, macOS, visionOS |
Allow multiple payloads | iOS, macOS, Shared iPad, tvOS, visionOS, watchOS |
Profile example
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>New item</key>
<dict>
<key>PayloadContent</key>
<array>
<dict>
<key>AutoJoin</key>
<true/>
<key>CaptiveBypass</key>
<false/>
<key>DisableAssociationMACRandomization</key>
<false/>
<key>EncryptionType</key>
<string>WPA</string>
<key>HIDDEN_NETWORK</key>
<true/>
<key>IsHotspot</key>
<false/>
<key>Password</key>
<string>Password123</string>
<key>PayloadDisplayName</key>
<string>Wi-Fi</string>
<key>ProxyType</key>
<string>None</string>
<key>SSID_STR</key>
<string>Example</string>
<key>PayloadIdentifier</key>
<string>com.example.mywifipayload</string>
<key>PayloadType</key>
<string>com.apple.wifi.managed</string>
<key>PayloadUUID</key>
<string>94c487e0-d6f8-41e3-b66d-a89994e6919b</string>
<key>PayloadVersion</key>
<integer>1</integer>
</dict>
</array>
<key>PayloadDisplayName</key>
<string>Wi-Fi</string>
<key>PayloadIdentifier</key>
<string>com.example.myprofile</string>
<key>PayloadType</key>
<string>Configuration</string>
<key>PayloadUUID</key>
<string>71e9b0f7-02f8-4aea-b365-b381d872909a</string>
<key>PayloadVersion</key>
<integer>1</integer>
</dict>
</dict>
</plist>