> [!NOTE] > **Important:** This API works **only on ChromeOS**.

## Description The `chrome.networking.onc` API is used for configuring network connections (Cellular, Ethernet, VPN or WiFi). This API is available in auto-launched Chrome OS kiosk sessions. Network connection configurations are specified following [Open Network Configuration (ONC)](https://chromium.googlesource.com/chromium/src/+/main/components/onc/docs/onc_spec.md) specification. **NOTE**: Most dictionary properties and enum values use UpperCamelCase to match the ONC specification instead of the JavaScript lowerCamelCase convention.

## Permissions `networking.onc`

## Availability Chrome 59+ ChromeOS only


## Types ### ActivationStateType #### Enum "Activated" "Activating" "NotActivated" "PartiallyActivated"
### CaptivePortalStatus #### Enum "Unknown" "Offline" "Online" "Portal" "ProxyAuthRequired"
### CellularProperties #### Properties - ActivationState [ActivationStateType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ActivationStateType) optional Carrier account activation state. - ActivationType string optional The cellular network activation type. - AllowRoaming boolean optional Whether roaming is allowed for the network. - AutoConnect boolean optional Whether the cellular network should be connected automatically (when in range). - Family string optional Cellular device technology family - `CDMA` or `GSM`. - FirmwareRevision string optional The firmware revision loaded in the cellular modem. - FoundNetworks [FoundNetworkProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-FoundNetworkProperties)\[\] optional The list of networks found during the most recent network scan. - HardwareRevision string optional The cellular modem hardware revision. - HomeProvider [CellularProviderProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-CellularProviderProperties) optional Information about the operator that issued the SIM card currently installed in the modem. - Manufacturer string optional The cellular modem manufacturer. - ModelID string optional The cellular modem model ID. - NetworkTechnology string optional If the modem is registered on a network, the network technology currently in use. - PaymentPortal [PaymentPortal](https://developer.chrome.com/docs/apps/reference/networking/onc#type-PaymentPortal) optional Online payment portal a user can use to sign-up for or modify a mobile data plan. - RoamingState string optional The roaming state of the cellular modem on the current network. - SIMLockStatus [SIMLockStatus](https://developer.chrome.com/docs/apps/reference/networking/onc#type-SIMLockStatus) optional The state of SIM lock for GSM family networks. - SIMPresent boolean optional Whether a SIM card is present. - Scanning boolean optional Chrome 63+ True when a cellular network scan is in progress. - ServingOperator [CellularProviderProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-CellularProviderProperties) optional Information about the operator on whose network the modem is currently registered. - SignalStrength number optional The current network signal strength. - SupportNetworkScan boolean optional Whether the cellular network supports scanning. ### CellularProviderProperties #### Properties - Code string Cellular network ID as a simple concatenation of the network's MCC (Mobile Country Code) and MNC (Mobile Network Code). - Country string optional The two-letter country code. - Name string The operator name. ### CellularStateProperties #### Properties - ActivationState [ActivationStateType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ActivationStateType) optional See [`CellularProperties.ActivationState`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-ActivationState). - NetworkTechnology string optional See [`CellularProperties.NetworkTechnology`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-NetworkTechnology). - RoamingState string optional See [`CellularProperties.RoamingState`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-RoamingState). - SIMPresent boolean optional See [`CellularProperties.SIMPresent`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-SIMPresent). - SignalStrength number optional See [`CellularProperties.SignalStrength`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-SignalStrength). ### CertificatePattern #### Properties - EnrollmentURI string\[\] optional List of URIs to which the user can be directed in case no certificates that match this pattern are found. - Issuer [IssuerSubjectPattern](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IssuerSubjectPattern) optional If set, pattern against which X.509 issuer settings should be matched. - IssuerCARef string\[\] optional List of certificate issuer CA certificates. A certificate must be signed by one of them in order to match this pattern. - Subject [IssuerSubjectPattern](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IssuerSubjectPattern) optional If set, pattern against which X.509 subject settings should be matched. ### ClientCertificateType #### Enum "Ref" "Pattern"
### ConnectionStateType #### Enum "Connected" "Connecting" "NotConnected"
### DeviceStateProperties #### Properties - SIMLockStatus [SIMLockStatus](https://developer.chrome.com/docs/apps/reference/networking/onc#type-SIMLockStatus) optional Chrome 62+ The SIM lock status if Type = Cellular and SIMPresent = True. - SIMPresent boolean optional Chrome 62+ Set to the SIM present state if the device type is Cellular. - Scanning boolean optional Set if the device is enabled. True if the device is currently scanning. - State [DeviceStateType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-DeviceStateType) The current state of the device. - Type [NetworkType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkType) The network type associated with the device (Cellular, Ethernet or WiFi). ### DeviceStateType #### Enum "Uninitialized" Device is available but not initialized. "Disabled" Device is initialized but not enabled. "Enabling" Enabled state has been requested but has not completed. "Enabled" Device is enabled. "Prohibited" Device is prohibited.
### EAPProperties #### Properties - AnonymousIdentity string optional - ClientCertPKCS11Id string optional Chrome 60+ - ClientCertPattern [CertificatePattern](https://developer.chrome.com/docs/apps/reference/networking/onc#type-CertificatePattern) optional - ClientCertProvisioningProfileId string optional Chrome 93+ - ClientCertRef string optional - ClientCertType [ClientCertificateType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ClientCertificateType) - Identity string optional - Inner string optional - Outer string optional The outer EAP type. Required by ONC, but may not be provided when translating from Shill. - Password string optional - SaveCredentials boolean optional - ServerCAPEMs string\[\] optional - ServerCARefs string\[\] optional - SubjectMatch [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional Chrome 60+ - UseProactiveKeyCaching boolean optional - UseSystemCAs boolean optional ### EthernetProperties #### Properties - Authentication string optional The authentication used by the Ethernet network. Possible values are `None` and `8021X`. - AutoConnect boolean optional Whether the Ethernet network should be connected automatically. - EAP [EAPProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-EAPProperties) optional Network's EAP settings. Required for 8021X authentication. ### EthernetStateProperties #### Properties - Authentication string See [`EthernetProperties.Authentication`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-EthernetProperties-Authentication). ### FoundNetworkProperties #### Properties - LongName string optional The network operator's long-format name. - NetworkId string Network ID. - ShortName string optional The network operator's short-format name. - Status string Network availability. - Technology string Access technology used by the network. ### GlobalPolicy #### Properties - AllowOnlyPolicyNetworksToAutoconnect boolean optional If true, only policy networks may auto connect. Defaults to false. - AllowOnlyPolicyNetworksToConnect boolean optional If true, only policy networks may be connected to and no new networks may be added or configured. Defaults to false. - AllowOnlyPolicyNetworksToConnectIfAvailable boolean optional Chrome 70+ If true and a managed network is available in the visible network list, only policy networks may be connected to and no new networks may be added or configured. Defaults to false. - BlockedHexSSIDs string\[\] optional Chrome 86+ List of blocked networks. Connections to blocked networks are prohibited. Networks can be unblocked again by specifying an explicit network configuration. Defaults to an empty list. ### IPConfigProperties #### Properties - ExcludedRoutes string\[\] optional Chrome 76+ Array of IP blocks in CIDR notation, see onc_spec.md for details. - Gateway string optional Gateway address used for the IP configuration. - IPAddress string optional The IP address for a connection. Can be IPv4 or IPv6 address, depending on value of `Type`. - IncludedRoutes string\[\] optional Chrome 76+ Array of IP blocks in CIDR notation, see onc_spec.md for details. - NameServers string\[\] optional Array of addresses used for name servers. - RoutingPrefix number optional The routing prefix. - SearchDomains string\[\] optional Chrome 76+ Array of strings for name resolution, see onc_spec.md for details. - Type string optional The IP configuration type. Can be `IPv4` or `IPv6`. - WebProxyAutoDiscoveryUrl string optional The URL for WEb Proxy Auto-Discovery, as reported over DHCP. ### IPConfigType #### Enum "DHCP" "Static"
### IssuerSubjectPattern #### Properties - CommonName string optional If set, the value against which to match the certificate subject's common name. - Locality string optional If set, the value against which to match the certificate subject's common location. - Organization string optional If set, the value against which to match the certificate subject's organizations. At least one organization should match the value. - OrganizationalUnit string optional If set, the value against which to match the certificate subject's organizational units. At least one organizational unit should match the value. ### ManagedBoolean #### Properties - Active boolean optional The active value currently used by the network configuration manager (e.g. Shill). - DeviceEditable boolean optional Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - DevicePolicy boolean optional The property value provided by the device policy. - Effective string optional The source from which the effective property value was determined. - SharedSetting boolean optional The value set for all users of the device. Only provided if `DeviceEditiable` is `true`. - UserEditable boolean optional Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - UserPolicy boolean optional The property value provided by the user policy. - UserSetting boolean optional The property value set by the logged in user. Only provided if `UserEditable` is `true`. ### ManagedCellularProperties #### Properties - ActivationState [ActivationStateType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ActivationStateType) optional See [`CellularProperties.ActivationState`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-ActivationState). - ActivationType string optional See [`CellularProperties.ActivationType`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-ActivationType). - AllowRoaming boolean optional See [`CellularProperties.AllowRoaming`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-AllowRoaming). - AutoConnect [ManagedBoolean](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedBoolean) optional See [`CellularProperties.AutoConnect`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-AutoConnect). - Family string optional See [`CellularProperties.Family`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-Family). - FirmwareRevision string optional See [`CellularProperties.FirmwareRevision`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-FirmwareRevision). - FoundNetworks [FoundNetworkProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-FoundNetworkProperties)\[\] optional See [`CellularProperties.FoundNetworks`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-FoundNetworks). - HardwareRevision string optional See [`CellularProperties.HardwareRevision`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-HardwareRevision). - HomeProvider [CellularProviderProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-CellularProviderProperties)\[\] optional See [`CellularProperties.HomeProvider`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-HomeProvider). - Manufacturer string optional See [`CellularProperties.Manufacturer`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-Manufacturer). - ModelID string optional See [`CellularProperties.ModelID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-ModelID). - NetworkTechnology string optional See [`CellularProperties.NetworkTechnology`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-NetworkTechnology). - PaymentPortal [PaymentPortal](https://developer.chrome.com/docs/apps/reference/networking/onc#type-PaymentPortal) optional See [`CellularProperties.PaymentPortal`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-PaymentPortal). - RoamingState string optional See [`CellularProperties.RoamingState`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-RoamingState). - SIMLockStatus [SIMLockStatus](https://developer.chrome.com/docs/apps/reference/networking/onc#type-SIMLockStatus) optional See [`CellularProperties.SIMLockStatus`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-SIMLockStatus). - SIMPresent boolean optional See [`CellularProperties.SIMPresent`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-SIMPresent). - Scanning boolean optional Chrome 63+ See [`CellularProperties.Scanning`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-Scanning). - ServingOperator [CellularProviderProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-CellularProviderProperties) optional See [`CellularProperties.ServingOperator`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-ServingOperator). - SignalStrength number optional See [`CellularProperties.SignalStrength`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-SignalStrength). - SupportNetworkScan boolean optional See [`CellularProperties.SupportNetworkScan`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-CellularProperties-SupportNetworkScan). ### ManagedDOMString #### Properties - Active string optional The active value currently used by the network configuration manager (e.g. Shill). - DeviceEditable boolean optional Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - DevicePolicy string optional The property value provided by the device policy. - Effective string optional The source from which the effective property value was determined. - SharedSetting string optional The value set for all users of the device. Only provided if `DeviceEditiable` is `true`. - UserEditable boolean optional Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - UserPolicy string optional The property value provided by the user policy. - UserSetting string optional The property value set by the logged in user. Only provided if `UserEditable` is `true`. ### ManagedDOMStringList #### Properties - Active string\[\] optional The active value currently used by the network configuration manager (e.g. Shill). - DeviceEditable boolean optional Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - DevicePolicy string\[\] optional The property value provided by the device policy. - Effective string optional The source from which the effective property value was determined. - SharedSetting string\[\] optional The value set for all users of the device. Only provided if `DeviceEditiable` is `true`. - UserEditable boolean optional Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - UserPolicy string\[\] optional The property value provided by the user policy. - UserSetting string\[\] optional The property value set by the logged in user. Only provided if `UserEditable` is `true`. ### ManagedEthernetProperties #### Properties - Authentication [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional See [`EthernetProperties.Authentication`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-EthernetProperties-Authentication). - AutoConnect [ManagedBoolean](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedBoolean) optional See [`EthernetProperties.AutoConnect`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-EthernetProperties-AutoConnect). ### ManagedIPConfigProperties #### Properties - Gateway [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional See [`IPConfigProperties.Gateway`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-IPConfigProperties-Gateway). - IPAddress [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional See [`IPConfigProperties.IPAddress`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-IPConfigProperties-IPAddress). - NameServers [ManagedDOMStringList](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMStringList) optional See [`IPConfigProperties.NameServers`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-IPConfigProperties-NameServers). - RoutingPrefix [ManagedLong](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedLong) optional See [`IPConfigProperties.RoutingPrefix`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-IPConfigProperties-RoutingPrefix). - Type [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional See [`IPConfigProperties.Type`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-IPConfigProperties-Type). - WebProxyAutoDiscoveryUrl [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional See [`IPConfigProperties.WebProxyAutoDiscoveryUrl`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-IPConfigProperties-WebProxyAutoDiscoveryUrl). ### ManagedIPConfigType #### Properties - Active [IPConfigType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigType) optional The active value currently used by the network configuration manager (e.g. Shill). - DeviceEditable boolean optional Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - DevicePolicy [IPConfigType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigType) optional The property value provided by the device policy. - Effective string optional The source from which the effective property value was determined. - SharedSetting [IPConfigType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigType) optional The value set for all users of the device. Only provided if `DeviceEditiable` is `true`. - UserEditable boolean optional Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - UserPolicy [IPConfigType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigType) optional The property value provided by the user policy. - UserSetting [IPConfigType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigType) optional The property value set by the logged in user. Only provided if `UserEditable` is `true`. ### ManagedLong #### Properties - Active number optional The active value currently used by the network configuration manager (e.g. Shill). - DeviceEditable boolean optional Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - DevicePolicy number optional The property value provided by the device policy. - Effective string optional The source from which the effective property value was determined. - SharedSetting number optional The value set for all users of the device. Only provided if `DeviceEditiable` is `true`. - UserEditable boolean optional Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - UserPolicy number optional The property value provided by the user policy. - UserSetting number optional The property value set by the logged in user. Only provided if `UserEditable` is `true`. ### ManagedManualProxySettings #### Properties - FTPProxy [ManagedProxyLocation](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedProxyLocation) optional See [`ManualProxySettings.FTPProxy`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ManualProxySettings-FTPProxy). - HTTPProxy [ManagedProxyLocation](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedProxyLocation) optional See [`ManualProxySettings.HTTPProxy`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ManualProxySettings-HTTPProxy). - SOCKS [ManagedProxyLocation](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedProxyLocation) optional See [`ManualProxySettings.SOCKS`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ManualProxySettings-SOCKS). - SecureHTTPProxy [ManagedProxyLocation](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedProxyLocation) optional See [`ManualProxySettings.SecureHTTPProxy`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ManualProxySettings-SecureHTTPProxy). ### ManagedProperties #### Properties - Cellular [ManagedCellularProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedCellularProperties) optional See [`NetworkProperties.Cellular`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Cellular). - Connectable boolean optional See [`NetworkProperties.Connectable`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Connectable). - ConnectionState [ConnectionStateType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ConnectionStateType) optional See [`NetworkProperties.ConnectionState`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-ConnectionState). - ErrorState string optional See [`NetworkProperties.ErrorState`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-ErrorState). - Ethernet [ManagedEthernetProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedEthernetProperties) optional See [`NetworkProperties.Ethernet`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Ethernet). - GUID string See [`NetworkProperties.GUID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-GUID). - IPAddressConfigType [ManagedIPConfigType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedIPConfigType) optional See [`NetworkProperties.IPAddressConfigType`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-IPAddressConfigType). - IPConfigs [IPConfigProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigProperties)\[\] optional See [`NetworkProperties.IPConfigs`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-IPConfigs). - MacAddress string optional See [`NetworkProperties.MacAddress`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-MacAddress). - Metered [ManagedBoolean](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedBoolean) optional Chrome 85+ See [`NetworkProperties.Metered`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Metered). - Name [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional See [`NetworkProperties.Name`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Name). - NameServersConfigType [ManagedIPConfigType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedIPConfigType) optional See [`NetworkProperties.NameServersConfigType`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-NameServersConfigType). - Priority [ManagedLong](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedLong) optional See [`NetworkProperties.Priority`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Priority). - ProxySettings [ManagedProxySettings](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedProxySettings) optional See [`NetworkProperties.ProxySettings`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-ProxySettings). - RestrictedConnectivity boolean optional See [`NetworkProperties.RestrictedConnectivity`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-RestrictedConnectivity). - SavedIPConfig [IPConfigProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigProperties) optional See [`NetworkProperties.SavedIPConfig`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-SavedIPConfig). - Source string optional See [`NetworkProperties.Source`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Source). - StaticIPConfig [ManagedIPConfigProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedIPConfigProperties) optional See [`NetworkProperties.StaticIPConfig`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-StaticIPConfig). - TrafficCounterResetTime number optional Chrome 125+ See [`NetworkProperties.TrafficCounterResetTime`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-TrafficCounterResetTime). - Type [NetworkType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkType) See [`NetworkProperties.Type`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Type). - VPN [ManagedVPNProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedVPNProperties) optional See [`NetworkProperties.VPN`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-VPN). - WiFi [ManagedWiFiProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedWiFiProperties) optional See [`NetworkProperties.WiFi`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-WiFi). ### ManagedProxyLocation #### Properties - Host [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) See [`ProxyLocation.Host`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ProxyLocation-Host). - Port [ManagedLong](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedLong) See [`ProxyLocation.Port`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ProxyLocation-Port). ### ManagedProxySettings #### Properties - ExcludeDomains [ManagedDOMStringList](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMStringList) optional See [`ProxySettings.ExcludeDomains`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ProxySettings-ExcludeDomains). - Manual [ManagedManualProxySettings](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedManualProxySettings) optional See [`ProxySettings.Manual`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ProxySettings-Manual). - PAC [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional See [`ProxySettings.PAC`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ProxySettings-PAC). - Type [ManagedProxySettingsType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedProxySettingsType) See [`ProxySettings.Type`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ProxySettings-Type). ### ManagedProxySettingsType #### Properties - Active [ProxySettingsType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ProxySettingsType) optional The active value currently used by the network configuration manager (e.g. Shill). - DeviceEditable boolean optional Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - DevicePolicy [ProxySettingsType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ProxySettingsType) optional The property value provided by the device policy. - Effective string optional The source from which the effective property value was determined. - SharedSetting [ProxySettingsType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ProxySettingsType) optional The value set for all users of the device. Only provided if `DeviceEditiable` is `true`. - UserEditable boolean optional Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to `false`. - UserPolicy [ProxySettingsType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ProxySettingsType) optional The property value provided by the user policy. - UserSetting [ProxySettingsType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ProxySettingsType) optional The property value set by the logged in user. Only provided if `UserEditable` is `true`. ### ManagedThirdPartyVPNProperties #### Properties - ExtensionID [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) See [`ThirdPartyVPNProperties.ExtensionID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ThirdPartyVPNProperties-ExtensionID). - ProviderName string optional See [`ThirdPartyVPNProperties.ProviderName`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-ThirdPartyVPNProperties-ProviderName). ### ManagedVPNProperties #### Properties - AutoConnect [ManagedBoolean](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedBoolean) optional See [`VPNProperties.AutoConnect`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-VPNProperties-AutoConnect). - Host [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional See [`VPNProperties.Host`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-VPNProperties-Host). - Type [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional See [`VPNProperties.Type`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-VPNProperties-Type). ### ManagedWiFiProperties #### Properties - AllowGatewayARPPolling [ManagedBoolean](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedBoolean) optional See [`WiFiProperties.AllowGatewayARPPolling`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-AllowGatewayARPPolling). - AutoConnect [ManagedBoolean](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedBoolean) optional See [`WiFiProperties.AutoConnect`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-AutoConnect). - BSSID string optional See [`WiFiProperties.BSSID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-BSSID). - Frequency number optional See [`WiFiProperties.Frequency`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-Frequency). - FrequencyList number\[\] optional See [`WiFiProperties.FrequencyList`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-FrequencyList). - HexSSID [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional See [`WiFiProperties.HexSSID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-HexSSID). - HiddenSSID [ManagedBoolean](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedBoolean) optional See [`WiFiProperties.HiddenSSID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-HiddenSSID). - RoamThreshold [ManagedLong](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedLong) optional Deprecated, ignored. See [`WiFiProperties.RoamThreshold`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-RoamThreshold). - SSID [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) optional See [`WiFiProperties.SSID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-SSID). - Security [ManagedDOMString](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedDOMString) See [`WiFiProperties.Security`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-Security). - SignalStrength number optional See [`WiFiProperties.SignalStrength`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-SignalStrength). ### ManualProxySettings #### Properties - FTPProxy [ProxyLocation](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ProxyLocation) optional Settings for FTP proxy. - HTTPProxy [ProxyLocation](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ProxyLocation) optional Settings for HTTP proxy. - SOCKS [ProxyLocation](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ProxyLocation) optional Settings for SOCKS proxy. - SecureHTTPProxy [ProxyLocation](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ProxyLocation) optional Settings for secure HTTP proxy. ### NetworkConfigProperties #### Properties - Cellular [CellularProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-CellularProperties) optional See [`NetworkProperties.Cellular`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Cellular). - Ethernet [EthernetProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-EthernetProperties) optional See [`NetworkProperties.Ethernet`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Ethernet). - GUID string optional See [`NetworkProperties.GUID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-GUID). - IPAddressConfigType [IPConfigType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigType) optional See [`NetworkProperties.IPAddressConfigType`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-IPAddressConfigType). - Name string optional See [`NetworkProperties.Name`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Name). - NameServersConfigType [IPConfigType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigType) optional See [`NetworkProperties.NameServersConfigType`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-NameServersConfigType). - Priority number optional See [`NetworkProperties.Priority`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Priority). - Type [NetworkType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkType) optional See [`NetworkProperties.Type`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Type). - VPN [VPNProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-VPNProperties) optional See [`NetworkProperties.VPN`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-VPN). - WiFi [WiFiProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-WiFiProperties) optional See [`NetworkProperties.WiFi`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-WiFi). - WiMAX [WiMAXProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-WiMAXProperties) optional Deprecated. ### NetworkFilter #### Properties - configured boolean optional If true, only include configured (saved) networks. Defaults to 'false'. - limit number optional Maximum number of networks to return. Defaults to 1000 if unspecified. Use 0 for no limit. - networkType [NetworkType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkType) The type of networks to return. - visible boolean optional If true, only include visible (physically connected or in-range) networks. Defaults to 'false'. ### NetworkProperties #### Properties - Cellular [CellularProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-CellularProperties) optional For cellular networks, cellular network properties. - Connectable boolean optional Whether the network is connectable. - ConnectionState [ConnectionStateType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ConnectionStateType) optional The network's current connection state. - ErrorState string optional The last recorded network error state. - Ethernet [EthernetProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-EthernetProperties) optional For Ethernet networks, the Ethernet network properties. - GUID string The network GUID. - IPAddressConfigType [IPConfigType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigType) optional The network's IP address configuration type. - IPConfigs [IPConfigProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigProperties)\[\] optional The network's IP configuration. - MacAddress string optional The network's MAC address. - Metered boolean optional Chrome 85+ Whether the network is metered. - Name string optional A user friendly network name. - NameServersConfigType [IPConfigType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigType) optional The IP configuration type for the name servers used by the network. - Priority number optional The network priority. - ProxySettings [ProxySettings](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ProxySettings) optional The network's proxy settings. - RestrictedConnectivity boolean optional For a connected network, whether the network connectivity to the Internet is limited, e.g. if the network is behind a portal, or a cellular network is not activated. - SavedIPConfig [IPConfigProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigProperties) optional IP configuration that was received from the DHCP server before applying static IP configuration. - Source string optional Indicates whether and how the network is configured. Possible values are: - `Device` - `DevicePolicy` - `User` - `UserPolicy` - `None` 'None' conflicts with extension code generation so we must use a string for 'Source' instead of a SourceType enum. - StaticIPConfig [IPConfigProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-IPConfigProperties) optional The network's static IP configuration. - TrafficCounterResetTime number optional Chrome 125+ When traffic counters were last reset. - Type [NetworkType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkType) The network type. - VPN [VPNProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-VPNProperties) optional For VPN networks, the network VPN properties. - WiFi [WiFiProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-WiFiProperties) optional For WiFi networks, the network WiFi properties. ### NetworkStateProperties #### Properties - Cellular [CellularStateProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-CellularStateProperties) optional See [`NetworkProperties.Cellular`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Cellular). - Connectable boolean optional See [`NetworkProperties.Connectable`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Connectable). - ConnectionState [ConnectionStateType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ConnectionStateType) optional See [`NetworkProperties.ConnectionState`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-ConnectionState). - ErrorState string optional See [`NetworkProperties.ErrorState`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-ErrorState). - Ethernet [EthernetStateProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-EthernetStateProperties) optional See [`NetworkProperties.Ethernet`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Ethernet). - GUID string See [`NetworkProperties.GUID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-GUID). - Name string optional See [`NetworkProperties.Name`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Name). - Priority number optional See [`NetworkProperties.Priority`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Priority). - Source string optional See [`NetworkProperties.Source`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Source). - Type [NetworkType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkType) See [`NetworkProperties.Type`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-Type). - VPN [VPNStateProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-VPNStateProperties) optional See [`NetworkProperties.VPN`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-VPN). - WiFi [WiFiStateProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-WiFiStateProperties) optional See [`NetworkProperties.WiFi`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-NetworkProperties-WiFi). ### NetworkType #### Enum "All" "Cellular" "Ethernet" "Tether" "VPN" "Wireless" "WiFi"
### PaymentPortal #### Properties - Method string The HTTP method to use for the payment portal. - PostData string optional The post data to send to the payment portal. Ignored unless `Method` is `POST`. - Url string optional The payment portal URL. ### ProxyLocation #### Properties - Host string The proxy IP address host. - Port number The port to use for the proxy. ### ProxySettings #### Properties - ExcludeDomains string\[\] optional Domains and hosts for which manual proxy settings are excluded. - Manual [ManualProxySettings](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManualProxySettings) optional Manual proxy settings - used only for `Manual` proxy settings. - PAC string optional URL for proxy auto-configuration file. - Type [ProxySettingsType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ProxySettingsType) The type of proxy settings. ### ProxySettingsType #### Enum "Direct" "Manual" "PAC" "WPAD"
### SIMLockStatus #### Properties - LockEnabled boolean Whether SIM lock is enabled. - LockType string The status of SIM lock - possible values are `'sim-pin'`, `'sim-puk'` and `''`. - RetriesLeft number optional Number of PIN lock tries allowed before PUK is required to unlock the SIM. ### ThirdPartyVPNProperties #### Properties - ExtensionID string ID of the third-party VPN provider extension. - ProviderName string optional The VPN provider name. ### VPNProperties #### Properties - AutoConnect boolean optional Whether the VPN network should be connected automatically. - Host string optional The VPN host. - Type string optional The VPN type. This cannot be an enum because of 'L2TP-IPSec'. This is optional for NetworkConfigProperties which is passed to setProperties which may be used to set only specific properties. ### VPNStateProperties #### Properties - Type string See [`VPNProperties.Type`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-VPNProperties-Type). ### WiFiProperties #### Properties - AllowGatewayARPPolling boolean optional Deprecated since Chrome 131 Removed in M131. There is no active ARP polling now.
- AutoConnect boolean optional Whether the WiFi network should be connected automatically when in range. - BSSID string optional The BSSID of the associated access point.. - EAP [EAPProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-EAPProperties) optional The network EAP properties. Required for `WEP-8021X` and `WPA-EAP` networks. - Frequency number optional The WiFi service operating frequency in MHz. For connected networks, the current frequency on which the network is connected. Otherwise, the frequency of the best available BSS. - FrequencyList number\[\] optional Contains all operating frequency recently seen for the WiFi network. - HexSSID string optional HEX-encoded copy of the network SSID. - HiddenSSID boolean optional Whether the network SSID will be broadcast. - Passphrase string optional Chrome 66+ The passphrase for WEP/WPA/WPA2 connections. This property can only be set - properties returned by [`getProperties`](https://developer.chrome.com/docs/apps/reference/networking/onc#method-getProperties) will not contain this value. - RoamThreshold number optional Deprecated, ignored. - SSID string optional The network SSID. - Security string optional The network security type. - SignalStrength number optional The network signal strength. ### WiFiStateProperties #### Properties - BSSID string optional See [`WiFiProperties.BSSID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-BSSID). - Frequency number optional See [`WiFiProperties.Frequency`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-Frequency). - HexSSID string optional Chrome 62+ See [`WiFiProperties.HexSSID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-HexSSID). - SSID string optional Chrome 62+ See [`WiFiProperties.SSID`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-SSID). - Security string See [`WiFiProperties.Security`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-Security). - SignalStrength number optional See [`WiFiProperties.SignalStrength`](https://developer.chrome.com/docs/apps/reference/networking/onc#property-WiFiProperties-SignalStrength). ### WiMAXProperties #### Properties - AutoConnect boolean optional Whether the network should be connected automatically. - EAP [EAPProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-EAPProperties) optional The network EAP properties. ## Methods ### createNetwork() Promise ```typescript chrome.networking.onc.createNetwork(   shared: boolean,   properties: NetworkConfigProperties,   callback?: function, ): Promise ``` Creates a new network configuration from properties. If a matching configured network already exists, this will fail. Otherwise returns the GUID of the new network. #### Parameters - shared boolean If `true`, share this network configuration with other users. *This option is exposed only to Chrome's Web UI.* \* When called by apps, `false` is the only allowed value. - properties [NetworkConfigProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkConfigProperties) The properties to configure the new network with. - callback function optional The `callback` parameter looks like: ```typescript (result: string) => void ```
- result string #### Returns - Promise\ Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ### disableNetworkType() ```typescript chrome.networking.onc.disableNetworkType(   networkType: NetworkType, ): void ``` Disables any devices matching the specified network type. See note for [`enableNetworkType`](https://developer.chrome.com/docs/apps/reference/networking/onc#method-enableNetworkType). #### Parameters - networkType [NetworkType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkType) The type of network to disable. ### enableNetworkType() ```typescript chrome.networking.onc.enableNetworkType(   networkType: NetworkType, ): void ``` Enables any devices matching the specified network type. Note, the type might represent multiple network types (e.g. 'Wireless'). #### Parameters - networkType [NetworkType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkType) The type of network to enable. ### forgetNetwork() Promise ```typescript chrome.networking.onc.forgetNetwork(   networkGuid: string,   callback?: function, ): Promise ``` Forgets a network configuration by clearing any configured properties for the network with GUID `networkGuid`. This may also include any other networks with matching identifiers (e.g. WiFi SSID and Security). If no such configuration exists, an error will be set and the operation will fail. **In kiosk sessions, this method will not be able to forget shared network configurations.** #### Parameters - networkGuid string The GUID of the network to forget. - callback function optional The `callback` parameter looks like: ```typescript () => void ```
#### Returns - Promise\ Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ### getCaptivePortalStatus() Promise ```typescript chrome.networking.onc.getCaptivePortalStatus(   networkGuid: string,   callback?: function, ): Promise ``` Returns captive portal status for the network matching 'networkGuid'. #### Parameters - networkGuid string The GUID of the network to get captive portal status for. - callback function optional The `callback` parameter looks like: ```typescript (result: CaptivePortalStatus) => void ```
- result [CaptivePortalStatus](https://developer.chrome.com/docs/apps/reference/networking/onc#type-CaptivePortalStatus) #### Returns - Promise\<[CaptivePortalStatus](https://developer.chrome.com/docs/apps/reference/networking/onc#type-CaptivePortalStatus)\> Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ### getDeviceStates() Promise ```typescript chrome.networking.onc.getDeviceStates(   callback?: function, ): Promise ``` Returns states of available networking devices. #### Parameters - callback function optional The `callback` parameter looks like: ```typescript (result: DeviceStateProperties[]) => void ```
- result [DeviceStateProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-DeviceStateProperties)\[\] #### Returns - Promise\<[DeviceStateProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-DeviceStateProperties)\[\]\> Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ### getGlobalPolicy() Promise ```typescript chrome.networking.onc.getGlobalPolicy(   callback?: function, ): Promise ``` Gets the global policy properties. These properties are not expected to change during a session. #### Parameters - callback function optional The `callback` parameter looks like: ```typescript (result: GlobalPolicy) => void ```
- result [GlobalPolicy](https://developer.chrome.com/docs/apps/reference/networking/onc#type-GlobalPolicy) #### Returns - Promise\<[GlobalPolicy](https://developer.chrome.com/docs/apps/reference/networking/onc#type-GlobalPolicy)\> Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ### getManagedProperties() Promise ```typescript chrome.networking.onc.getManagedProperties(   networkGuid: string,   callback?: function, ): Promise ``` Gets the merged properties of the network with id networkGuid from the sources: User settings, shared settings, user policy, device policy and the currently active settings. #### Parameters - networkGuid string The GUID of the network to get properties for. - callback function optional The `callback` parameter looks like: ```typescript (result: ManagedProperties) => void ```
- result [ManagedProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedProperties) #### Returns - Promise\<[ManagedProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-ManagedProperties)\> Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ### getNetworks() Promise ```typescript chrome.networking.onc.getNetworks(   filter: NetworkFilter,   callback?: function, ): Promise ``` Returns a list of network objects with the same properties provided by [`getState`](https://developer.chrome.com/docs/apps/reference/networking/onc#method-getState). A filter is provided to specify the type of networks returned and to limit the number of networks. Networks are ordered by the system based on their priority, with connected or connecting networks listed first. #### Parameters - filter [NetworkFilter](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkFilter) Describes which networks to return. - callback function optional The `callback` parameter looks like: ```typescript (result: NetworkStateProperties[]) => void ```
- result [NetworkStateProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkStateProperties)\[\] #### Returns - Promise\<[NetworkStateProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkStateProperties)\[\]\> Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ### getProperties() Promise ```typescript chrome.networking.onc.getProperties(   networkGuid: string,   callback?: function, ): Promise ``` Gets all the properties of the network with id networkGuid. Includes all properties of the network (read-only and read/write values). #### Parameters - networkGuid string The GUID of the network to get properties for. - callback function optional The `callback` parameter looks like: ```typescript (result: NetworkProperties) => void ```
- result [NetworkProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkProperties) #### Returns - Promise\<[NetworkProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkProperties)\> Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ### getState() Promise ```typescript chrome.networking.onc.getState(   networkGuid: string,   callback?: function, ): Promise ``` Gets the cached read-only properties of the network with id networkGuid. This is meant to be a higher performance function than [`getProperties`](https://developer.chrome.com/docs/apps/reference/networking/onc#method-getProperties), which requires a round trip to query the networking subsystem. The following properties are returned for all networks: GUID, Type, Name, WiFi.Security. Additional properties are provided for visible networks: ConnectionState, ErrorState, WiFi.SignalStrength, Cellular.NetworkTechnology, Cellular.ActivationState, Cellular.RoamingState. #### Parameters - networkGuid string The GUID of the network to get properties for. - callback function optional The `callback` parameter looks like: ```typescript (result: NetworkStateProperties) => void ```
- result [NetworkStateProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkStateProperties) #### Returns - Promise\<[NetworkStateProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkStateProperties)\> Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ### requestNetworkScan() ```typescript chrome.networking.onc.requestNetworkScan(   networkType?: NetworkType, ): void ``` Requests that the networking subsystem scan for new networks and update the list returned by `getVisibleNetworks`. This is only a request: the network subsystem can choose to ignore it. If the list is updated, then the [`onNetworkListChanged`](https://developer.chrome.com/docs/apps/reference/networking/onc#event-onNetworkListChanged) event will be fired. #### Parameters - networkType [NetworkType](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkType) optional Chrome 63+ If provided, requests a scan specific to the type. For Cellular a mobile network scan will be requested if supported. ### setProperties() Promise ```typescript chrome.networking.onc.setProperties(   networkGuid: string,   properties: NetworkConfigProperties,   callback?: function, ): Promise ``` Sets the properties of the network with id `networkGuid`. This is only valid for configured networks (Source != None). Unconfigured visible networks should use [`createNetwork`](https://developer.chrome.com/docs/apps/reference/networking/onc#method-createNetwork) instead. **In kiosk sessions, calling this method on a shared network will fail.** #### Parameters - networkGuid string The GUID of the network to set properties for. - properties [NetworkConfigProperties](https://developer.chrome.com/docs/apps/reference/networking/onc#type-NetworkConfigProperties) The properties to set. - callback function optional The `callback` parameter looks like: ```typescript () => void ```
#### Returns - Promise\ Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ### startConnect() Promise ```typescript chrome.networking.onc.startConnect(   networkGuid: string,   callback?: function, ): Promise ``` Starts a connection to the network with networkGuid. #### Parameters - networkGuid string The GUID of the network to connect to. - callback function optional The `callback` parameter looks like: ```typescript () => void ```
#### Returns - Promise\ Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ### startDisconnect() Promise ```typescript chrome.networking.onc.startDisconnect(   networkGuid: string,   callback?: function, ): Promise ``` Starts a disconnect from the network with networkGuid. #### Parameters - networkGuid string The GUID of the network to disconnect from. - callback function optional The `callback` parameter looks like: ```typescript () => void ```
#### Returns - Promise\ Chrome 125+ Promises are only supported for Manifest V3 and later, other platforms need to use callbacks. ## Events ### onDeviceStateListChanged ```typescript chrome.networking.onc.onDeviceStateListChanged.addListener(   callback: function, ) ``` Fired when the list of devices has changed or any device state properties have changed. #### Parameters - callback function The `callback` parameter looks like: ```typescript () => void ```
### onNetworkListChanged ```typescript chrome.networking.onc.onNetworkListChanged.addListener(   callback: function, ) ``` Fired when the list of networks has changed. Sends a complete list of GUIDs for all the current networks. #### Parameters - callback function The `callback` parameter looks like: ```typescript (changes: string[]) => void ```
- changes string\[\] ### onNetworksChanged ```typescript chrome.networking.onc.onNetworksChanged.addListener(   callback: function, ) ``` Fired when the properties change on any of the networks. Sends a list of GUIDs for networks whose properties have changed. #### Parameters - callback function The `callback` parameter looks like: ```typescript (changes: string[]) => void ```
- changes string\[\] ### onPortalDetectionCompleted ```typescript chrome.networking.onc.onPortalDetectionCompleted.addListener(   callback: function, ) ``` Fired when a portal detection for a network completes. Sends the GUID of the network and the corresponding captive portal status. #### Parameters - callback function The `callback` parameter looks like: ```typescript (networkGuid: string, status: CaptivePortalStatus) => void ```
- networkGuid string - status [CaptivePortalStatus](https://developer.chrome.com/docs/apps/reference/networking/onc#type-CaptivePortalStatus)