AuthenticatorAttestationResponse
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The AuthenticatorAttestationResponse
interface of the Web Authentication API is the result of a WebAuthn credential registration. It contains information about the credential that the server needs to perform WebAuthn assertions, such as its credential ID and public key.
An AuthenticatorAttestationResponse
object instance is available in the response
property of a PublicKeyCredential
object returned by a successful CredentialsContainer.create()
call.
This interface inherits from AuthenticatorResponse
.
Note: This interface is restricted to top-level contexts. Use of its features from within an <iframe>
element will not have any effect.
Instance properties
Also inherits properties from its parent, AuthenticatorResponse
.
AuthenticatorAttestationResponse.attestationObject
Secure context Read only-
An
ArrayBuffer
containing authenticator data and an attestation statement for a new key pair generated by the authenticator. AuthenticatorResponse.clientDataJSON
Secure context Read only-
Inherited from
AuthenticatorResponse
, this property contains the JSON-compatible serialization of the data passed from the browser to the authenticator in order to generate this credential — i.e., whenCredentialsContainer.create()
is called with apublicKey
option. This data contains some information from the options passed into thecreate()
call, and some information controlled by the browser.
Instance methods
AuthenticatorAttestationResponse.getAuthenticatorData()
Secure context-
Returns an
ArrayBuffer
containing the authenticator data contained within theAuthenticatorAttestationResponse.attestationObject
property. AuthenticatorAttestationResponse.getPublicKey()
Secure context-
Returns an
ArrayBuffer
containing the DERSubjectPublicKeyInfo
of the new credential (see Subject Public Key Info), ornull
if this is not available. AuthenticatorAttestationResponse.getPublicKeyAlgorithm()
Secure context-
Returns a number that is equal to a COSE Algorithm Identifier, representing the cryptographic algorithm used for the new credential.
AuthenticatorAttestationResponse.getTransports()
Secure context-
Returns an array of strings describing which transport methods (e.g.,
usb
,nfc
) are believed to be supported with the authenticator. The array may be empty if the information is not available.
Examples
See Creating a public key credential using the WebAuthn API for a detailed example.
Specifications
Specification |
---|
Web Authentication: An API for accessing Public Key Credentials - Level 3 # authenticatorattestationresponse |
Browser compatibility
BCD tables only load in the browser
See also
AuthenticatorAssertionResponse
: the interface for the type of response given when retrieving an existing credentialAuthenticatorResponse
: the parent interface