--- title: Permissions API slug: Web/API/Permissions_API tags: - API - Introduction - NeedsTranslation - Overview - Permissions - Permissions API - TopicStub - Web - access translation_of: Web/API/Permissions_API ---
{{DefaultAPISidebar("Permissions API")}}
The Permissions API provides a consistent programmatic way to query the status of API permissions attributed to the current context. For example, the Permissions API can be used to determine if permission to access a particular API has been granted or denied.
Historically different APIs handle their own permissions inconsistently — for example the Notifications API allows for explicit checking of permission status and requesting permission, whereas the Geolocation API doesn't (which causes problems if the user denied the initial permission request). The Permissions API provides the tools to allow developers to implement a better user experience as far as permissions are concerned.
The permissions
property has been made available on the {{domxref("Navigator")}} object, both in the standard browsing context and the worker context ({{domxref("WorkerNavigator")}} — so permission checks are available inside workers), and returns a {{domxref("Permissions")}} object that provides access to the Permissions API functionality.
Once you have this object you can then perform permission-related tasks, for example querying a permission using the {{domxref("Permissions.query()")}} method to return a promise that resolves with the {{domxref("PermissionStatus")}} for a specific API.
Not all APIs' permission statuses can be queried using the Permissions API. Notable APIs that are Permissions-aware include:
More APIs will gain Permissions API support over time.
We have made a simple example available called Location Finder. You can run the example live, or view the source code on Github.
Read more about how it works in our article Using the Permissions API.
Specification | Status | Comment |
---|---|---|
{{SpecName('Permissions API')}} | {{Spec2('Permissions API')}} | Initial definition. |
{{Compat("api.Permissions")}}