Back to Content

Permissions-Policy: geolocation directive

files/en-us/web/http/reference/headers/permissions-policy/geolocation/index.md

latest2.5 KB
Original Source

{{SeeCompatTable}}

The HTTP {{HTTPHeader("Permissions-Policy")}} header geolocation directive controls whether the current document is allowed to use the {{domxref('Geolocation')}} Interface.

Specifically, where a defined policy blocks use of this feature, calls to {{domxref('Geolocation.getCurrentPosition','getCurrentPosition()')}} and {{domxref('Geolocation.watchPosition','watchPosition()')}} will cause those functions' callbacks to be invoked with a {{domxref('GeolocationPositionError')}} code of PERMISSION_DENIED.

Syntax

http
Permissions-Policy: geolocation=<allowlist>;
  • <allowlist>

Default policy

The default allowlist for geolocation is self. The top-level browsing context and same-origin iframes are allowed access to the geolocation feature by default.

Examples

Basic usage

SecureCorp Inc. wants to disallow geolocation within all cross-origin iframes except those whose origin is https://example.com. It can do so by delivering the following HTTP response header to define a Permissions Policy:

http
Permissions-Policy: geolocation=(self "https://example.com")

SecureCorp Inc. must also include an {{HTMLElement('iframe','allow','#Attributes')}} attribute on each <iframe> element where geolocation is to be allowed:

html
<iframe src="https://example.com/map" allow="geolocation"></iframe>

[!NOTE] Specifying the Permissions-Policy header in this manner disallows geolocation for other origins, even if they are allowed by the <iframe> allow attribute.

Using the default policy

If an allowlist for geolocation is not defined by a Permissions-Policy response header, user agents will apply the default allowlist self. In this mode, geolocation is automatically allowed in the top-level browsing context and same-origin iframes, but not in cross-origin iframes.

To allow geolocation in a cross-origin iframe, include an {{HTMLElement('iframe','allow','#Attributes')}} attribute on the <iframe> element:

html
<iframe src="https://other.com/store-locator" allow="geolocation"></iframe>

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also