PayloadKit

Parental Controls: Web Content Filter

com.apple.familycontrols.contentfilter

The payload that configures the parental control web content filters.

macOS
macOS 10.7+combined

Configuration Keys (10)

KeyTypeTitle
restrictWebrequired

If 'true', enables web content filters.

booleanLimit access to websites
whitelistEnabled

Use 'allowListEnabled' instead.

Default: false

booleanEnable site allowlist
siteWhitelist

Use 'siteAllowList' instead.

Depends on: whitelistEnabled ∈ [true]

arraySite Allowlist
useContentFilter

If 'true', filters content automatically.

Default: false

booleanUse built in content filter
filterWhitelist

Use 'filterAllowList' instead.

arrayContent Filter Allowlist
filterBlacklist

Use 'filterDenyList' instead.

arrayContent Filter Backlist
allowListEnabled

If 'true', enables web content filters.

Default: false

boolean
siteAllowList

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'.

array
filterAllowList

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.

array
filterDenyList

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.

array
siteWhitelistItem

A dictionary defining a site for the allow list.

dictSite Allowlist Item
addressrequired

The site prefix, including http(s) scheme.

stringSite address prefix
pageTitle

The site page title.

stringPage Title
filterWhitelistItemrequired

An allowed site.

stringAllowlist URL
filterBlacklistItemrequired

A disallowed site.

stringBlacklist URL
siteAllowListItem

A dictionary defining a site for the allow list.

dict
addressrequired

The site prefix, including the 'http(s)' scheme.

string
pageTitle

The site page title.

string
filterAllowListItemrequired

An allowed site.

string
filterDenyListItemrequired

A disallowed site.

string