IdentityCredential: disconnect()-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 federiertes Anmeldekonto von dem IdP, der für die Bereitstellung der Berechtigungsnachweise verwendet wird.

Danach erfordert die Nutzung dieses Kontos für eine federierte Anmeldung, dass der Prozess der federierten Anmeldung erneut gestartet wird.

Syntax

IdentityCredential.disconnect(options)

Parameter

options

Ein Optionsobjekt, das folgende Eigenschaften enthalten kann:

accountHint: Ein Zeichenfolgenhinweis, den der IdP verwendet, um das zu trennende Konto zu identifizieren. Der Hinweis kann eine beliebige Zeichenfolge sein, solange der Disconnect-Endpunkt das Konto identifizieren kann – zum Beispiel eine E-Mail-Adresse oder Benutzer-ID. Dies wird nicht unbedingt mit der Kontonummer übereinstimmen, die vom Kontenlisten-Endpunkt bereitgestellt wird.
clientId: Eine Zeichenfolge, die den Client-Identifikator des RP angibt, wie er im clientId-Attribut der providers IdentityCredentialRequestOptions während der Anmeldung angegeben ist.
configURL: Eine Zeichenfolge, die die Konfigurationsdatei-URL des IdP angibt, wie sie im configURL-Attribut der providers IdentityCredentialRequestOptions 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 von einer connect-src Content-Security-Policy-Richtlinie abgelehnt wird.
Ein weiterer disconnect()-Aufruf zuvor gemacht wurde und noch nicht gelöst 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 einbettende <iframe> keine passende identity-credentials-get Permissions-Policy gesetzt hat, um die Nutzung von disconnect() zu erlauben, oder wenn die FedCM API global durch eine Richtlinie im übergeordneten Dokument deaktiviert ist.

Beispiele

Grundlegende Nutzung von `disconnect()`

Das RP kann ein angegebenes federiertes Anmeldekonto vom zugehörigen IdP trennen, indem es disconnect() aufruft. Diese Funktion kann aus einem übergeordneten RP-Frame 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 seine Konfigurationsdatei aufnehmen. Weitere Details zur zugrunde liegenden HTTP-Kommunikation finden Sie im Abschnitt Der Disconnect-Endpunkt.

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