大网数据广告活动
Web 标准与前端开发

PublicKeyCredential: toJSON() method

· 52CE 我爱测

The **`toJSON()`** method of the PublicKeyCredential interface returns a JSON-serializable plain object representing the `PublicKeyCredential` object.

Web Authentication API

The toJSON() method of the PublicKeyCredential interface returns a JSON-serializable plain object representing the PublicKeyCredential object.

The method is automatically called by JSON.stringify() when a PublicKeyCredential object is encountered during JSON serialization.

Syntax

toJSON()

Parameters

None.

Return value

A JSON-serializable plain object containing the following properties:

  • PublicKeyCredential/authenticatorAttachment : not present if its value is null
  • clientExtensionResults: a JSON-serializable object representing the values returned by PublicKeyCredential/getClientExtensionResults, with buffer values encoded as base64url strings
  • PublicKeyCredential/id
  • PublicKeyCredential/rawId: encoded as a base64url string
  • PublicKeyCredential/response: a JSON-serializable object representing the AuthenticatorResponse value, with buffer values encoded as base64url strings. Namely:
    • When it's an AuthenticatorAssertionResponse, contains the following properties:
      • AuthenticatorAssertionResponse/authenticatorData
      • AuthenticatorResponse/clientDataJSON
      • AuthenticatorAssertionResponse/signature
      • AuthenticatorAssertionResponse/userHandle : not present if its value is null
    • When it's an AuthenticatorAttestationResponse, contains the following properties:
      • AuthenticatorAttestationResponse/attestationObject
      • authenticatorData: the value returned by AuthenticatorAttestationResponse.getAuthenticatorData()
      • AuthenticatorResponse/clientDataJSON
      • publicKey : the value returned by AuthenticatorAttestationResponse.getPublicKey(), omitted if it is null
      • publicKeyAlgorithm: the value returned by AuthenticatorAttestationResponse.getPublicKeyAlgorithm()
      • transports: the value returned by AuthenticatorAttestationResponse.getTransports()
  • Credential/type

Unless stated otherwise, each property's value is copied as-is.

Exceptions

  • SecurityError DOMException
    • : The RP domain is not valid.

Examples

Calling toJSON() directly

When registering a new user, a relying party server will supply information about the expected credentials to the web app. The web app calls navigator.credentials.create() with the received information (createCredentialOptions below), which returns a promise that fulfills with the new credential (a PublicKeyCredential).

Calling toJSON() directly returns a plain object. Its properties have the same values as the corresponding properties of the original object.

const credential = await navigator.credentials.create({
  publicKey: createCredentialOptions,
});

const json = credential.toJSON();
console.log(json); // A plain object
console.log(typeof json); // "object"
console.log(json.id); // Same value as credential.id

Serializing to a JSON string

The returned credential is serialized using JSON.stringify(), which calls the toJSON() method automatically. The web app posts the serialized credential back to the server.

const jsonString = JSON.stringify(credential);
console.log(jsonString);

const registrationURL = "https://example.com/registration";
const apiRegOptsResp = await fetch(registrationURL, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: jsonString,
});

This would log a JSON string like so (formatted for readability):

{
  "authenticatorAttachment": "platform",
  "clientExtensionResults": {},
  "id": "...",
  "rawId": "...",
  "response": {
    "attestationObject": "...",
    "authenticatorData": "...",
    "clientDataJSON": "...",
    "publicKey": "...",
    "publicKeyAlgorithm": -7,
    "transports": ["internal"]
  },
  "type": "public-key"
}

The base64url-encoded values are abbreviated as "..." for readability.

Specifications

Browser compatibility

See also

  • Web Authentication API
  • PublicKeyCredential.parseCreationOptionsFromJSON_static
  • PublicKeyCredential.parseRequestOptionsFromJSON_static

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。