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() des IdentityCredential-Interfaces trennt ein angegebenes föderiertes Anmeldekonto von dem IdP, der zum Abrufen des Anmeldedatensatzes verwendet wurde.

Anschließend erfordert die Nutzung dieses Kontos für eine 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 Kontohinweis angibt, den der IdP verwendet, um das zu trennende Konto zu identifizieren. Der Hinweis kann ein beliebiger String sein, solange der Disconnect-Endpoint das Konto identifizieren kann — zum Beispiel eine E-Mail-Adresse oder Benutzer-ID. Dies muss nicht unbedingt mit der Konto-ID übereinstimmen, die vom kontolisten-Endpoint bereitgestellt wird.
clientId: Ein String, der die Client-ID des RP angibt, wie sie in der providers-Eigenschaft clientId während der Anmeldung angegeben ist.
configURL: Ein String, der die URL der Konfigurationsdatei des IdP angibt, wie sie in der providers-Eigenschaft configURL während der Anmeldung angegeben ist.

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 der disconnect_endpoint fehlt.
Der Ursprung des Dokuments nicht mit der configURL übereinstimmt.

NetworkError DOMException

Wird ausgelöst, wenn:

Der Browser keine Verbindung zum IdP herstellen kann.
Die Anfrage durch eine connect-src Content-Security-Policy untersagt ist.
Ein anderer disconnect()-Aufruf früher gemacht wurde, der noch nicht abgeschlossen ist.
Die FedCM-API global deaktiviert ist.
Die configURL des IdP weder sicher noch potenziell vertrauenswürdig ist.

NotAllowedError DOMException

Wird ausgelöst, wenn das eingebettete <iframe> keine entsprechend gesetzte identity-credentials-get Permissions-Policy hat, um die Verwendung von disconnect() zu ermöglichen oder wenn die FedCM-API global durch eine Richtlinie im Top-Level-Dokument deaktiviert ist.

Beispiele

Grundlegende Nutzung von `disconnect()`

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 enthalten. Siehe Der Disconnect-Endpoint für weitere Details zur zugrunde liegenden HTTP-Kommunikation.

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