导航|地址|刷新
PublicKeyCredential - Web APIs | MDN


Skip to main content

Skip to search



MDN





HTML

HTML: Markup language

HTML reference
Elements

Global attributes

Attributes

See all…
HTML guides
Responsive images

HTML cheatsheet

Date & time formats

See all…
Markup languages
SVG

MathML

XML




CSS

CSS: Styling language

CSS reference
Properties

Selectors

At-rules

Values

See all…
CSS guides
Box model

Animations

Flexbox

Colors

See all…
Layout cookbook
Column layouts

Centering an element

Card component

See all…




JavaScriptJS

JavaScript: Scripting language

JS reference
Standard built-in objects

Expressions & operators

Statements & declarations

Functions

See all…
JS guides
Control flow & error handing

Loops and iteration

Working with objects

Using classes

See all…




Web APIs

Web APIs: Programming interfaces

Web API reference
File system API

Fetch API

Geolocation API

HTML DOM API

Push API

Service worker API

See all…
Web API guides
Using the Web animation API

Using the Fetch API

Working with the History API

Using the Web speech API

Using web workers




All

All web technology

Technologies
Accessibility

HTTP

URI

Web extensions

WebAssembly

WebDriver

See all…
Topics
Media

Performance

Privacy

Security

Progressive web apps




Learn

Learn web development

Frontend developer course
Getting started modules

Core modules

MDN Curriculum

Check out the video course from Scrimba, our partner
Learn HTML
Structuring content with HTML module
Learn CSS
CSS styling basics module

CSS layout module
Learn JavaScript
Dynamic scripting with JavaScript module




Tools

Discover our tools


Playground

HTTP Observatory

Border-image generator

Border-radius generator

Box-shadow generator

Color format converter

Color mixer

Shape generator




About

Get to know MDN better


About MDN

Advertise with us

Community

MDN on GitHub




Blog





Toggle sidebar
Web

Web APIs

PublicKeyCredential

Theme

OS default

Light

Dark



English (US)

Remember language Learn more

Deutsch

English (US)

Français

日本語







PublicKeyCredential

Baseline Widely available *




This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

* Some parts of this feature may have varying levels of support.

Learn more

See full compatibility

?>


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


The PublicKeyCredential interface provides information about a public key / private key pair, which is a credential for logging in to a service using an un-phishable and data-breach resistant asymmetric key pair instead of a password. It inherits from Credential, and is part of the Web Authentication API extension to the Credential Management API.
Credential PublicKeyCredential

Note: This API is restricted to top-level contexts. Use from within an <iframe> element will not have any effect.




In this article

Instance properties

Static methods

Instance methods

Examples

Specifications

Browser compatibility

See also



Instance properties
PublicKeyCredential.authenticatorAttachmentRead only
A string that indicates the mechanism by which the WebAuthn implementation is attached to the authenticator at the time the associated navigator.credentials.create() or navigator.credentials.get() call completes.
PublicKeyCredential.idRead only
Inherited from Credential and overridden to be the base64url encoding of PublicKeyCredential.rawId.
PublicKeyCredential.rawIdRead only
An ArrayBuffer that holds the globally unique identifier for this PublicKeyCredential. This identifier can be used to look up credentials for future calls to navigator.credentials.get().
PublicKeyCredential.responseRead only
An instance of an AuthenticatorResponse object. It is either of type AuthenticatorAttestationResponse if the PublicKeyCredential was the results of a navigator.credentials.create() call, or of type AuthenticatorAssertionResponse if the PublicKeyCredential was the result of a navigator.credentials.get() call.
PublicKeyCredential.typeRead only
Inherited from Credential. Always set to public-key for PublicKeyCredential instances.



Static methods
PublicKeyCredential.getClientCapabilities()
Returns a Promise that resolves with an object that can be used to check whether or not particular WebAuthn capabilities and extensions are supported.
PublicKeyCredential.isConditionalMediationAvailable()
Returns a Promise which resolves to true if conditional mediation is available.
PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable()
Returns a Promise which resolves to true if an authenticator bound to the platform is capable of verifying the user.
PublicKeyCredential.parseCreationOptionsFromJSON()
Convenience method for deserializing server-sent credential registration data when registering a user with credentials.
PublicKeyCredential.parseRequestOptionsFromJSON()
Convenience method for deserializing server-sent credential request data when authenticating a (registered) user.
PublicKeyCredential.signalAllAcceptedCredentials()
Signals to the authenticator all of the valid credential IDs that the relying party server still holds for a particular user.
PublicKeyCredential.signalCurrentUserDetails()
Signals to the authenticator that a particular user has updated their user name and/or display name.
PublicKeyCredential.signalUnknownCredential()
Signals to the authenticator that a credential ID was not recognized by the relying party server, for example because it was deleted.



Instance methods
PublicKeyCredential.getClientExtensionResults()
If any extensions were requested, this method will return the results of processing those extensions.
PublicKeyCredential.toJSON()
Convenience method for creating a JSON string representation of a PublicKeyCredential for sending to the server when registering a user with credentials and authenticating a registered user.



Examples
?>


Creating a new instance of PublicKeyCredential

Here, we use navigator.credentials.create() to generate a new credential.


js
const createCredentialOptions = { publicKey: { challenge: new Uint8Array([ 21, 31, 105 /* 29 more random bytes generated by the server */, ]), rp: { name: "Example CORP", id: "login.example.com", }, user: { id: new Uint8Array(16), name: "canand@example.com", displayName: "Carina Anand", }, pubKeyCredParams: [ { type: "public-key", alg: -7, }, ], }, }; navigator.credentials .create(createCredentialOptions) .then((newCredentialInfo) => { const response = newCredentialInfo.response; const clientExtensionsResults = newCredentialInfo.getClientExtensionResults(); }) .catch((err) => { console.error(err); });



Getting an existing instance of PublicKeyCredential

Here, we fetch an existing credential from an authenticator, using navigator.credentials.get().


js
const requestCredentialOptions = { publicKey: { challenge: new Uint8Array([/* bytes sent from the server */]), }, }; navigator.credentials .get(requestCredentialOptions) .then((credentialInfoAssertion) => { // send assertion response back to the server // to proceed with the control of the credential }) .catch((err) => { console.error(err); });



Specifications

Specification

Web Authentication: An API for accessing Public Key Credentials - Level 3?> # iface-pkcredential?>

Browser compatibility





See also

The parent interface Credential






Help improve MDN
Was this page helpful to you?
Yes No
Learn how to contribute
This page was last modified on Jul 3, 2026 by MDN contributors.

View this page on GitHub • Report a problem with this content




Filter sidebar Clear filter input


Web Authentication API

PublicKeyCredential

Instance properties
authenticatorAttachment

id

rawId

response


Static methods
getClientCapabilities()

isConditionalMediationAvailable()

isUserVerifyingPlatformAuthenticatorAvailable()

parseCreationOptionsFromJSON()

parseRequestOptionsFromJSON()

signalAllAcceptedCredentials()

signalCurrentUserDetails()

signalUnknownCredential()


Instance methods
getClientExtensionResults()

toJSON()


Inheritance
Credential


Related pages for Web Authentication API
AuthenticatorAssertionResponse

AuthenticatorAttestationResponse

AuthenticatorResponse

CredentialsContainer.create()

CredentialsContainer.get()

PublicKeyCredentialCreationOptions

PublicKeyCredentialRequestOptions


Guides
Attestation and Assertion

Authenticator data

Web Authentication extensions







MDN
Your blueprint for a better internet.











MDN
About

Blog

Mozilla careers

Advertise with us

MDN Plus

Product help
Contribute
MDN Community

Community resources

Writing guidelines

MDN Discord

MDN on GitHub
Developers
Web technologies

Learn web development

Guides

Tutorials

Glossary

Hacks blog


Mozilla
Website Privacy Notice

Telemetry Settings

Legal

Community Participation Guidelines

Portions of this content are ©1998–2026 by individual mozilla.org contributors. Content available under a Creative Commons license.



------
导航页 打开网址