Feature-Policy: publickey-credentials

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The HTTP Feature-Policy header publickey-credentials directive controls whether the current document is allowed to access Web Authentcation API, i.e, via navigator.credentials.create({publicKey: ...,...}) and navigator.credentials.get({publicKey: ...,...}).

When this policy is enabled, any attempt to create or query public key credentials will result in an error.

Syntax

Feature-Policy: publickey-credentials <allowlist>;
<allowlist>

An allowlist is a list of origins that takes one or more of the following values, separated by spaces:

  • *: The feature will be allowed in this document, and all nested browsing contexts (iframes) regardless of their origin.
  • 'self': The feature will be allowed in this document, and in all nested browsing contexts (iframes) in the same origin.
  • 'src': (In an iframe allow attribute only) The feature will be allowed in this iframe, as long as the document loaded into it comes from the same origin as the URL in the iframe's src attribute.
  • 'none': The feature is disabled in top-level and nested browsing contexts.
  • <origin(s)>: The feature is allowed for specific origins (for example, https://example.com). Origins should be separated by a space.

The values * (enable for all origins) or 'none' (disable for all origins) may only be used alone, while 'self' and 'src' may be used with one or more origins.

Features are each defined to have a default allowlist, which is one of:

  • *: The feature is allowed by default in top-level browsing contexts and all nested browsing contexts (iframes).
  • 'self': The feature is allowed by default in top-level browsing contexts and in nested browsing contexts (iframes) in the same origin. The feature is not allowed in cross-origin documents in nested browsing contexts.
  • 'none': The feature is disabled in top-level and nested browsing contexts.

Default policy

The default allowlist is 'self'.

Specifications

Specification Status Comment
Feature Policy Editor's Draft Initial definition.
Web Authentication Level 2 Editor's draft. Definition of publickey-credentials directive, default allowlist.

Browser compatibility

No compatibility data found. Please contribute data for "http.headers.Feature-Policy.publickey-credentials" (depth: 1) to the MDN compatibility data repository.

See also