PublicKeyCredential: метод toJSON()

Метод toJSON() интерфейса PublicKeyCredential возвращает представление типа JSON объекта PublicKeyCredential.

Свойства возвращаемого объекта зависят от того, возвращается ли учётная запись методом navigator.credentials.create() при создании пары ключей и регистрации пользователя, или методом navigator.credentials.get() при аутентификации пользователя.

Этот метод вызывается автоматически, когда веб-приложение использует JSON.stringify() для сериализации PublicKeyCredential для отправки на сервер доверенной стороны при регистрации или аутентификации пользователя. Он не предназначен для прямого вызова кодом веб-приложения.

Нет.

Представление типа JSON объекта PublicKeyCredential.

Включаемые свойства зависят от того, возвращена ли учётная запись методом navigator.credentials.create() при регистрации или методом navigator.credentials.get() при аутентификации пользователя. Значения и типы включаемых свойств такие же, как и для PublicKeyCredential, за исключением того, что используются строки, закодированные в base64url, вместо свойств типа buffer.

Свойства объекта:

id

Значение, возвращаемое методом PublicKeyCredential.id.

rawId

Base64url-кодированное значение PublicKeyCredential.rawId.

authenticatorAttachment Необязательно

Значение, возвращаемое методом PublicKeyCredential.authenticatorAttachment.

type

Строка "public-key".

clientExtensionResults

Массив, содержащий base64url-кодированные версии значений, возвращённых методом PublicKeyCredential.getClientExtensionResults().

response

Объект свойства response зависит от того, возвращены ли учётные данные после операции регистрации или аутентификации.

• При регистрации нового пользователя response будет представлять собой представление типа JSON объекта AuthenticatorAttestationResponse, где значения типа buffer закодированы в base64url.

• При аутентификации пользователя возвращаемое значение будет представлять собой представление типа JSON объекта AuthenticatorAssertionResponse, где значения типа buffer закодированы в base64url.

При регистрации нового пользователя сервер доверенной стороны предоставляет веб-приложению информацию об ожидаемых учётных данных. Веб-приложение вызывает navigator.credentials.create() с полученной информацией (createCredentialOptions ниже), которая возвращает промис, выполняющийся с новой учётной записью (объект PublicKeyCredential).

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

Затем веб-приложение сериализует возвращённую учётную запись с помощью 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
});

• API аутентификации веб-сайта
• PublicKeyCredential.parseCreationOptionsFromJSON()
• PublicKeyCredential.parseRequestOptionsFromJSON()