PublicKeyCredential: toJSON() メソッド

構文

toJSON()

引数

なし。

返値

PublicKeyCredential オブジェクトの JSON 形式の表現です。

含まれるプロパティは、その資格情報が登録時に navigator.credentials.create() によって返されたものか、ユーザーの認証時に navigator.credentials.get() によって取得されたものかによって異なります。 含まれるプロパティの値と型は、PublicKeyCredential と同じですが、バッファープロパティの代わりに base64url でエンコードされた文字列が使用される点が異なります。

オブジェクトのプロパティは以下の通りです。

id

PublicKeyCredential.id で返される値です。

rawId

PublicKeyCredential.rawId を base64url で符号化したもの。

authenticatorAttachment 省略可

PublicKeyCredential.authenticatorAttachment から返される値。

type

文字列 "public-key"。

clientExtensionResults

PublicKeyCredential.getClientExtensionResults() から返される値を base64url で符号化したものの配列。

response

response プロパティのオブジェクトは、登録操作または認証操作の後に資格情報が返されるかどうかによって異なります。

• 新しいユーザーを登録する際、response は AuthenticatorAttestationResponse の JSON 形式の表現となり、バッファーの値は base64url で符号化されています。

• ユーザーを認証する際、返される値は AuthenticatorAssertionResponse の JSON 形式の表現となり、バッファーの値は base64url で符号化されています。

例外

SecurityError DOMException

RP のドメインが有効ではありません。

例

新しいユーザーを登録する際、認証依頼者のサーバーは、期待される資格情報に関する情報をウェブアプリに提供します。 ウェブアプリは、受け取った情報（下記の createCredentialOptions）を引数としてnavigator.credentials.create()を呼び出し、新しい資格情報（PublicKeyCredential）を返すプロミスを取得します。

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

その後、ウェブアプリは JSON.stringify() （これは toJSON() を呼び出します）を使用して、返された資格情報をシリアライズし、それをサーバーに POST で送信します。

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

仕様書

ブラウザーの互換性

関連情報

• ウェブ認証 API
• PublicKeyCredential.parseCreationOptionsFromJSON()
• PublicKeyCredential.parseRequestOptionsFromJSON()