Contents

WebContentFilterPlugin

The declaration to configure a WebContent Filter that uses a plugin.

Declaration

object WebContentFilterPlugin

Properties

NameTypeDescription
AuthenticationWebContentFilterPluginAuthenticationObject

Settings that control authentication.

ContentFilterUUIDstring

A globally unique identifier for this content filter configuration. The content filter processes network traffic for managed apps with the same ContentFilterUUID in their app attributes. This key must be present for unsupervised devices and user enrollment.

Available: iOS 27+ | iPadOS 27+ | visionOS 27+

FilterWebContentFilterPluginFilterObject

Settings that control authentication.

Organizationstring

The organization string to pass to the third-party plug-in.

PluginBundleID Requiredstring

The bundle ID of the plug-in that provides filtering service. Consult your filtering solution vendor to determine what to specify for this value.

ServerAddressstring

The server address, which may be the IP address, hostname, or URL.

VendorConfigWebContentFilterPluginVendorConfigObject

The custom dictionary that the filtering service plug-in needs.

VisibleName Requiredstring

The name of the web content filter that the system displays on the device.

Discussion

Specify com.apple.configuration.webcontent-filter.plugin as the declaration type.

Configuration availability

Allowed in supervised enrollment

iOS, macOS, Shared iPad, visionOS

Allowed in device enrollment

iOS, Shared iPad, visionOS

Allowed in user enrollment

iOS, Shared iPad, visionOS

Allowed in local enrollment

iOS, macOS, Shared iPad, visionOS

Allowed in system scope

iOS, macOS, Shared iPad, visionOS

Allowed in user scope

N/A

Apply

Multiple configurations are applied separately

Configuration example

This configuration sets up a web content filter using a Network Extension plugin bundle.

{
    "Type": "com.apple.configuration.webcontent-filter.plugin",
    "Identifier": "EB13EE2B-5D63-4EBA-810F-5B81D07F5017",
    "ServerToken": "E180CA9A-F089-4FA3-BBDF-94CC159C4AE8",
    "Payload": {
        "VisibleName": "Content Filter",
        "PluginBundleID": "com.example.contentfilter",
        "ServerAddress": "filter.example.com",
        "ContentFilterUUID": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890"
    }
}

Topics

Objects

See Also

Configurations