PublicKeyCredential.response
Secure context: This 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 thePublicKeyCredential
is created viaCredentialsContainer.create()
) - an
AuthenticatorAssertionResponse
(when thePublicKeyCredential
is obtained viaCredentialsContainer.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
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
response |
67 |
18 |
60
Only supports USB U2F tokens.
|
No |
No |
13 |
No |
70 |
60
Only supports USB U2F tokens.
|
No |
13 |
No |
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredential/response