Web/API/PublicKeyCredential/response

Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The response read-only property of the PublicKeyCredential interface is an AuthenticatorResponse object which is sent from the authenticator to the user agent for the creation/fetching of credentials. The information contained in this response will be used by the relying party's server to verify the demand is legitimate.

An AuthenticatorResponse is either:

an AuthenticatorAttestationResponse (when the PublicKeyCredential is created via CredentialsContainer.create())
an AuthenticatorAssertionResponse (when the PublicKeyCredential is obtained via CredentialsContainer.get()).

In order to validate the creation of credentials, a relying party's server needs both:

this response
the extensions of the client (given by PublicKeyCredential.getClientExtensionResults()) to validate the demand.

Note: When validating the fetching of existing credentials, the whole PublicKeyCredential object and the client extensions are necessary for the relying party's server.

Note: This property may only be used in top-level contexts and will not be available in an <iframe> for example.

Syntax

response = publicKeyCredential.response

Value

An AuthenticatorResponse object containing the data a relying party's script will receive and which should be sent to the relying party's server in order to validate the demand for creation or fetching. This object contains data from the client (AuthenticatorResponse/clientDataJSON) and from the authenticator.

Examples

var options = {
  challenge: new Uint8Array(16) /* from the server */,
  rp: {
    name: "Example CORP",
    id  : "login.example.com"
  },
  user: {
    id: new Uint8Array(16) /* from the server */,
    name: "[email protected]",
    displayName: "John Doe"
  },
  pubKeyCredParams: [
    {
      type: "public-key",
      alg: -7
    }
  ]
};

navigator.credentials.create({  publickey: options })
  .then(function (pubKeyCredential) {
    var response = pubKeyCredential.response;
    var clientExtResults = pubKeyCredential.getClientExtensionResults();
    // Send response and client extensions to the server so that it can validate
    // and create credentials
    
}).catch(function (err) {
  // Deal with any error
});

Specifications

Specification	Status	Comment
Web Authentication: An API for accessing Public Key Credentials Level 1The definition of 'response' in that specification.	Recommendation	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`response`	Chrome Full support 67 Full support 67 Full support 65 Notes' Disabled' Notes' Only supports USB U2F tokens. Disabled' From version 65: this feature is behind the `Web Authentication API` preference (needs to be set to `Enabled`). To change preferences in Chrome, visit chrome://flags.	Edge Full support 18	Firefox Full support 60 Notes' Full support 60 Notes' Notes' Only supports USB U2F tokens.	IE No support No	Opera No support No	Safari Full support 13	WebView Android Full support 70	Chrome Android Full support 70	Firefox Android Full support 60 Notes' Full support 60 Notes' Notes' Only supports USB U2F tokens.	Opera Android No support No	Safari iOS Full support 13.3	Samsung Internet Android No support No

Legend

Full support: Full support
No support: No support
See implementation notes.': See implementation notes.
User must explicitly enable this feature.': User must explicitly enable this feature.

PublicKeyCredential.response by Mozilla Contributors is licensed under CC-BY-SA 2.5.