Global Properties

Mandatory properties

The following properties must be defined for each policy.

first_available

The value of this property is an object, containing the minimum required version of the mainstream release of Firefox respectively Firefox ESR.

first_available : { mainstream : '69.0', esr : '68.1' }

Depending of the version of Enterprise Policy Generator, the Enterprise Policy Generator may display a compatibility note.

ui_category

While the order of the policies in the Enterprise Policy Generator is determined by the order of the policies in the policies.js file it's still important to use a correct value for ui_category, otherwise the policy won't appear in the right place or not at all.

ui_category : 'block-access'

Possible values:

value	name in the user interface
block-access	Block Access
disable-features	Disable Features
customization	Customization
network	Network
privacy	Privacy
security	Security
updates-and-data	Updates & Data Collection
others	Other Policies

type

This property is used to determine the type of the policy. Some policies are really simple, others are very complex. The Enterprise Policy Generator needs this property to know how the user interface and the JSON output should be generated.

type : 'boolean'

Possible values:

arraybooleanboolean-inverseenumflat-arraykey-object-listkey-value-pairsobjectpreferencestringurl

Optional properties

additional_note

This property can be used to add additional information to a policy.

additional_note : browser.i18n.getMessage('requirement_windows_or_linux')

deprecation_note

Similar to additional_note this property can be used to add an additional note to a policy. The difference is the different font color of the policy description and the different icon to highlight that the policy is deprecated and should no longer be used.

deprecation_note : browser.i18n.getMessage('policy_description_Extensions_Deprecated')

info_link

This property can be used to add a "more information" link to a policy.

info_link : 'https://developer.mozilla.org/Add-ons/WebExtensions/Match_patterns'