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 statische Methode disconnect() der Schnittstelle IdentityCredential trennt ein angegebenes föderiertes Anmeldekonto vom IdP, das verwendet wurde, um die Berechtigung zu erhalten.

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

Syntax

IdentityCredential.disconnect(options)

Parameter

options

Ein Optionsobjekt, das die folgenden Eigenschaften enthalten kann:

accountHint: Ein String, der einen Hinweis auf das Konto angibt, den der IdP verwendet, um das zu trennende Konto zu identifizieren. Der Hinweis kann ein beliebiger String sein, solange der Trennendpunkt das Konto identifizieren kann — beispielsweise eine E-Mail-Adresse oder Benutzer-ID. Dies muss nicht unbedingt mit der vom Kontenlistenendpunkt bereitgestellten Konto-ID übereinstimmen.
clientId: Ein String, der den Mandanten-Identifikator (Client ID) des RP angibt, wie im providers clientId-Eigentum während der Anmeldung angegeben.
configURL: Ein String, der die URL der Konfigurationsdatei des IdP angibt, wie im providers configURL-Eigentum während der Anmeldung angegeben.

Rückgabewert

Ein Promise, das mit undefined erfüllt wird.

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, sich mit dem IdP zu verbinden.
Die Anfrage von einem connect-src Content-Security-Policy nicht erlaubt wird.
Ein anderes disconnect() zuvor aufgerufen wurde, das noch nicht abgeschlossen ist.
Die FedCM API global deaktiviert wurde.
Die configURL des IdP weder sicher noch potenziell vertrauenswürdig ist.

NotAllowedError DOMException

Wird ausgelöst, wenn das eingebettete <iframe> nicht über eine identity-credentials-get Permissions-Policy verfügt, um die Nutzung von disconnect() zu erlauben, oder wenn die FedCM API global durch eine auf dem Top-Level-Dokument gesetzte Richtlinie deaktiviert ist.

Beispiele

Grundlegende Nutzung von `disconnect()`

Das RP kann ein angegebenes föderiertes Anmeldekonto vom zugehörigen IdP trennen, indem es 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 enthalten. Weitere Details zur zugrunde liegenden HTTP-Kommunikation finden Sie unter Der Trennendpunkt.

Spezifikationen

Specification
Federated Credential Management API # dom-identitycredential-disconnect

Browser-Kompatibilität

Siehe auch

Federated Credential Management API auf developer.chrome.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