IdentityCredential: disconnect() statische Methode

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

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

Die disconnect() statische Methode der IdentityCredential Schnittstelle trennt ein angegebenes föderiertes Anmeldekonto von dem verwendeten IdP, um den Berechtigungsnachweis zu erhalten.

Danach erfordert die Verwendung dieses Kontos für eine föderierte Anmeldung, dass der Anmeldeprozess erneut gestartet wird.

Syntax

IdentityCredential.disconnect(options)

Parameter

options

Ein Optionsobjekt, das die folgenden Eigenschaften enthalten kann:

accountHint: Ein String, der einen Kontohinweis angibt, den der IdP nutzt, um das zu trennende Konto zu identifizieren. Der Hinweis kann ein beliebiger String sein, solange der Trennungsendpunkt das Konto identifizieren kann — z.B. eine E-Mail-Adresse oder Benutzer-ID. Dies muss nicht unbedingt mit der Konto-ID übereinstimmen, die vom Kontenlisten-Endpunkt angegeben wurde.
clientId: Ein String, der die Client-ID des RP angibt, wie im providers clientId Eigenschaft während der Anmeldung spezifiziert.
configURL: Ein String, der die Konfigurationsdatei-URL des IdP angibt, wie im providers configURL Eigenschaft während der Anmeldung spezifiziert.

Rückgabewert

Ein Promise, das sich mit undefined erfüllt.

Ausnahmen

InvalidStateError DOMException

Wird ausgelöst, wenn:

Die configURL des IdP ungültig ist oder den disconnect_endpoint fehlt.
Der Ursprung des Dokuments nicht mit der configURL übereinstimmt.

NetworkError DOMException

Wird ausgelöst, wenn:

Der Browser nicht in der Lage ist, eine Verbindung zum IdP herzustellen.
Die Anfrage durch eine connect-src Content-Security-Policy untersagt wird.
Ein anderer disconnect() Aufruf vorher gemacht wurde, der noch nicht aufgelöst ist.
Die FedCM API wurde global deaktiviert.
Die configURL des IdP weder sicher noch potenziell vertrauenswürdig ist.

NotAllowedError DOMException

Wird ausgelöst, wenn das eingebettete <iframe> keine identity-credentials-get Permissions-Policy gesetzt hat, um die Verwendung von disconnect() zu erlauben oder wenn die FedCM API global durch eine auf das oberste Dokument gesetzte Richtlinie deaktiviert wurde.

Beispiele

Grundlegende `disconnect()` Nutzung

Der RP kann ein angegebenes föderiertes Anmeldekonto vom zugehörigen IdP trennen, indem er disconnect() aufruft. Diese Funktion kann von einem Top-Level RP-Frame aus aufgerufen werden.

IdentityCredential.disconnect({
  configURL: "https://idp.example.com/config.json",
  clientId: "rp123",
  accountHint: "account456",
});

Damit ein disconnect() Aufruf funktioniert, muss der IdP einen disconnect_endpoint in seiner Konfigurationsdatei einfügen. Siehe Der Trennungsendpunkt für weitere Details zur zugrundeliegenden HTTP-Kommunikation.

Spezifikationen

Specification
Federated Credential Management API # dom-identitycredential-disconnect

Browser-Kompatibilität

Siehe auch

Federated Credential Management API auf privacysandbox.google.com (2023)

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.

Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden