Contents

ParentalControlsContentFilter

The payload that configures the parental control web content filters.

Declaration

object ParentalControlsContentFilter

Properties

NameTypeDescription
allowListEnabledboolean

If true, enables web content filters.

Available: macOS 15.2+

filterAllowList[string]

The array of URLs that defines an allow list. When restrictWeb and useContentFilter are enabled, only URLs in the allow list are available to the user.

Available: macOS 15.2+

filterBlacklist[string]

Use filterDenyList instead.

Deprecated: macOS 15.2+

filterDenyList[string]

The array of URLs that defines a deny list. When restrictWeb and useContentFilter are enabled, no URLs in the deny list are available to the user.

Available: macOS 15.2+

filterWhitelist[string]

Use filterAllowList instead.

Deprecated: macOS 15.2+

restrictWeb Requiredboolean

If true, enables web content filters.

siteAllowList[ParentalControlsContentFilter.SiteAllowListItem]

An array of sites that defines an allow list. If specified, this defines additional allowed sites besides those in the automated allow list and deny list, including disallowed adult sites.

This key is required if allowListEnabled is true.

Available: macOS 15.2+

siteWhitelist[ParentalControlsContentFilter.SiteWhitelistItem]

Use siteAllowList instead.

Deprecated: macOS 15.2+

useContentFilterboolean

If true, filters content automatically.

whitelistEnabledboolean

Use allowListEnabled instead.

Deprecated: macOS 15.2+

Discussion

Specify com.apple.familycontrols.contentfilter as the payload type.

Profile availability

Device channel

macOS

User channel

macOS

Allow manual install

macOS

Requires supervision

N/A

Requires user-approved MDM

N/A

Allowed in user enrollment

N/A

Allow multiple payloads

N/A

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>PayloadContent</key>
    <array>
        <dict>
            <key>filterAllowList</key>
            <array>
                <string>http://www.example.com</string>
            </array>
            <key>filterDenyList</key>
            <array>
                <string>http://www.example2.com</string>
            </array>
            <key>siteAllowList</key>
            <array>
                <dict>
                    <key>address</key>
                    <string>http://www.example3.com</string>
                    <key>bookmarkPath</key>
                    <string>/</string>
                    <key>pageTitle</key>
                    <string>example3</string>
                </dict>
            </array>
            <key>restrictWeb</key>
            <true/>
            <key>useContentFilter</key>
            <true/>
            <key>allowListEnabled</key>
            <true/>
            <key>PayloadIdentifier</key>
            <string>com.example.mycontentfilterpayload</string>
            <key>PayloadType</key>
            <string>com.apple.familycontrols.contentfilter</string>
            <key>PayloadUUID</key>
            <string>342c6863-6e3c-4e00-893e-f76757ae41c7</string>
            <key>PayloadVersion</key>
            <integer>1</integer>
        </dict>
    </array>
    <key>PayloadDisplayName</key>
    <string>Parental Controls Content Filter</string>
    <key>PayloadIdentifier</key>
    <string>com.example.myprofile</string>
    <key>PayloadType</key>
    <string>Configuration</string>
    <key>PayloadUUID</key>
    <string>764e94bc-ab75-456f-ac47-3a1062e70ffb</string>
    <key>PayloadVersion</key>
    <integer>1</integer>
</dict>
</plist>

Topics

Objects

See Also

Parental controls