permissions

Extensions need permissions to access more powerful WebExtension APIs. They can ask for permissions at install time, by including the permissions they need in the permissions manifest.json key. The main advantages of asking for permissions at install time are:

• The user is only asked once, so it's less disruptive for them, and a simpler decision.
• The extension can rely on the access to the APIs it needs, because if already running, the permissions have been granted.

In most major browsers, users can see if their installed extensions request advanced permissions through the browser's extensions manager.

With the permissions API, an extension can ask for additional permissions at runtime. These permissions need to be listed in the optional_permissions manifest.json key. Note that some permissions are not allowed in optional_permissions. The main advantages of this are:

• The extension can run with a smaller set of permissions, except when it actually needs them.
• The extension can handle permission denial in a graceful manner, instead of presenting the user with a global "all or nothing" choice at install time. You can still get a lot out of that map extension, without giving it access to your location, for example.

• The extension may need host permissions, but not know at install time which host permissions it needs. For example, the list of hosts may be a user setting. In this scenario, asking for a more specific range of hosts at runtime, can be an alternative to asking for "<all_urls>" at install time.

To use the permissions API, decide which permissions your extension can request at runtime, and list them in optional_permissions. After this, you can request any permissions that were included in optional_permissions. Requests may only be made in the handler for a user action (for example, a click handler).

Starting with Firefox 84, users will be able to manage optional permissions of installed extensions from the Add-ons Manager. Extensions that use optional permissions should listen for browser.permissions.onAdded and browser.permissions.onRemoved API events to know when a user grants or revokes these permissions.

For advice on designing your request for runtime permissions, to maximize the likelihood that users grant them, see Request permissions at runtime.

Types

permissions.Permissions

Represents a set of permissions.

Methods

permissions.contains()

Discover an extension's given set of permissions.

permissions.getAll()

Get all the permissions this extension currently has.

permissions.remove()

Give up a set of permissions.

permissions.request()

Ask for a set of permissions.

Event handlers

permissions.onAdded

Fired when a new permission is granted.

permissions.onRemoved

Fired when a permission is removed.

Browser compatibility

See also

• manifest.json permissions property
• manifest.json optional_permissions property

Example extensions

• permissions