The payload that configures the parental control web content filters.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
restrictWeb restrictWeb If `true`, enables web content filters. | boolean | required | — | ✓Yes | macOS (10.7+) |
useContentFilter useContentFilter If `true`, filters content automatically. | boolean | optional | false | ✓Yes | macOS (10.7+) |
allowlistEnabled allowlistEnabled If `true`, enables web content filters. | boolean | optional | false | ✓Yes | macOS (15.2+) |
whitelistEnabled whitelistEnabled Deprecated (macOS 15.2) Use `allowlistEnabled` instead. | boolean | optional | false | ✓Yes | macOS (legacy - 15.2) |
siteAllowlist 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`. 1 subkey | array | optional | — | ✓Yes | macOS (15.2+) |
└─ siteAllowlistItem siteAllowlistItem A dictionary defining a site for the allow list. 2 subkeys | dictionary | — | ✓Yes | macOS (10.7+) | |
└─ └─ address address The site prefix, including the `http(s)` scheme. | string | required | — | ✓Yes | macOS (10.7+) |
└─ └─ pageTitle pageTitle The site page title. | string | optional | — | ✓Yes | macOS (10.7+) |
siteWhitelist siteWhitelist Deprecated (macOS 15.2) Use `siteAllowlist` instead. 1 subkey | array | optional | — | ✓Yes | macOS (legacy - 15.2) |
└─ siteWhitelistItem siteWhitelistItem A dictionary defining a site for the allow list. 2 subkeys | dictionary | — | ✓Yes | macOS (10.7+) | |
└─ └─ address address The site prefix, including http(s) scheme. | string | required | — | ✓Yes | macOS (10.7+) |
└─ └─ pageTitle pageTitle The site page title. | string | optional | — | ✓Yes | macOS (10.7+) |
filterAllowlist 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. 1 subkey | array | optional | — | ✓Yes | macOS (15.2+) |
└─ filterAllowlistItem filterAllowlistItem An allowed site. | string | required | — | ✓Yes | macOS (10.7+) |
filterWhitelist filterWhitelist Deprecated (macOS 15.2) Use `filterAllowlist` instead. 1 subkey | array | optional | — | ✓Yes | macOS (legacy - 15.2) |
└─ filterWhitelistItem filterWhitelistItem An allowed site. | string | required | — | ✓Yes | macOS (10.7+) |
filterDenylist 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. 1 subkey | array | optional | — | ✓Yes | macOS (15.2+) |
└─ filterDenylistItem filterDenylistItem A disallowed site. | string | required | — | ✓Yes | macOS (10.7+) |
filterBlacklist filterBlacklist Deprecated (macOS 15.2) Use `filterDenylist` instead. 1 subkey | array | optional | — | ✓Yes | macOS (legacy - 15.2) |
└─ filterBlacklistItem filterBlacklistItem A disallowed site. | string | required | — | ✓Yes | macOS (10.7+) |
