PublicKeyCredential: toJSON()-Methode

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Die toJSON()-Methode des PublicKeyCredential-Interfaces gibt eine JSON-Typ-Darstellung eines PublicKeyCredential zurück.

Die Eigenschaften des zurückgegebenen Objekts hängen davon ab, ob die Berechtigung durch navigator.credentials.create() beim Erstellen eines Schlüsselpaares und Registrieren eines Benutzers oder durch navigator.credentials.get() bei der Authentifizierung eines Benutzers erhalten wurde.

Diese Methode wird automatisch aufgerufen, wenn Code einer Web-App JSON.stringify() aufruft, um ein PublicKeyCredential zu serialisieren, damit es beim Registrieren oder Authentifizieren eines Benutzers an den vertrauenden Server gesendet werden kann. Sie ist nicht dazu gedacht, direkt im Code einer Web-App aufgerufen zu werden.

Syntax

js
toJSON()

Parameter

Keine.

Rückgabewert

Eine JSON-Typ-Darstellung eines PublicKeyCredential-Objekts.

Die enthaltenen Eigenschaften hängen davon ab, ob die Berechtigung durch navigator.credentials.create() bei der Registrierung oder durch navigator.credentials.get() beim Authentifizieren eines Benutzers zurückgegeben wurde. Die Werte und Typen der enthaltenen Eigenschaften entsprechen denen von PublicKeyCredential, mit der Ausnahme, dass base64url-codierte Strings anstelle von Puffer-Eigenschaften verwendet werden.

Die Objekt-Eigenschaften sind:

id

Der Wert, der durch PublicKeyCredential.id zurückgegeben wird.

rawId

Eine base64url-codierte Version von PublicKeyCredential.rawId.

authenticatorAttachment Optional

Der Wert, der durch PublicKeyCredential.authenticatorAttachment zurückgegeben wird.

type

Der String "public-key".

clientExtensionResults

Ein Array, das base64url-codierte Versionen der Werte enthält, die durch PublicKeyCredential.getClientExtensionResults() zurückgegeben werden.

response

Das Antwort-Objekt hängt davon ab, ob die Berechtigungen nach einer Registrierung oder einem Authentifizierungsvorgang zurückgegeben werden.

Beispiele

Bei der Registrierung eines neuen Benutzers wird ein vertrauender Server der Web-App Informationen über die erwarteten Berechtigungen bereitstellen. Die Web-App ruft navigator.credentials.create() mit den erhaltenen Informationen (createCredentialOptions unten) auf, was ein Versprechen zurückgibt, das mit der neuen Berechtigung (einem PublicKeyCredential) erfüllt wird.

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

Die Web-App serialisiert dann die zurückgegebene Berechtigung mit JSON.stringify() (was wiederum toJSON() aufruft) und sendet sie zurück an den Server.

js
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
});

Spezifikationen

Specification
Web Authentication: An API for accessing Public Key Credentials - Level 3
# dom-publickeycredential-tojson

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch