PublicKeyCredential: toJSON() 方法

语法

toJSON()

参数

无。

返回值

PublicKeyCredential 对象的 JSON 类型表示。

包含的属性取决于凭证是在注册时由 navigator.credentials.create() 返回的，还是在验证用户时由 navigator.credentials.get() 返回的。包含属性的值和类型与 PublicKeyCredential 相同，不同之处在于使用 base64url 编码的字符串来代替 buffer 属性。

对象属性包括：

id

PublicKeyCredential.id 返回的值。

rawId

PublicKeyCredential.rawId 的 base64url 编码版本。

authenticatorAttachment 可选

PublicKeyCredential.authenticatorAttachment 返回的值。

type

字符串 "public-key"。

clientExtensionResults

一个数组，包含 PublicKeyCredential.getClientExtensionResults() 返回的值的 base64url 编码版本。

response

response 属性对象取决于凭证是在注册操作还是认证操作后返回的。

• 在注册新用户时，response 将是 AuthenticatorAttestationResponse 的 JSON 类型表示，其中 buffer 值已被 base64url 编码。

• 在验证用户时，返回的值将是 AuthenticatorAssertionResponse 的 JSON 类型表示版本，其中 buffer 值已被 base64url 编码。

异常

SecurityError DOMException

RP 域无效。

示例

在注册新用户时，信赖方服务器会将有关预期凭证的信息提供给 Web 应用。Web 应用使用收到的信息（如下面的 createCredentialOptions）调用 navigator.credentials.create()，该调用返回一个以新的凭证（一个 PublicKeyCredential）完成的 Promise。

const newCredentialInfo = await navigator.credentials.create({
  createCredentialOptions,
});

然后，Web 应用使用 JSON.stringify()（这反过来会调用 toJSON()）序列化返回的凭证，并将其发布回服务器。

const registration_url = "https://example.com/registration";
const apiRegOptsResp = await fetch(registration_url, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(newCredentialInfo), // Calls newCredentialInfo.toJSON
});

规范

浏览器兼容性

另见

• Web Authentication API
• PublicKeyCredential.parseCreationOptionsFromJSON()
• PublicKeyCredential.parseRequestOptionsFromJSON()