IdentityCredential: isAutoSelected-Eigenschaft

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

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

Die schreibgeschützte isAutoSelected-Eigenschaft der IdentityCredential-Schnittstelle zeigt an, ob der föderierte Anmeldefluss mithilfe von automatischer Neuauthentifizierung (d.h. ohne Benutzermediation) durchgeführt wurde oder nicht.

Eine automatische Neuauthentifizierung kann erfolgen, wenn ein Aufruf von navigator.credentials.get() mit einem mediation Optionswert von "optional" oder "silent" ausgeführt wird. Es ist für eine relying party (RP) hilfreich zu wissen, ob eine automatische Neuauthentifizierung erfolgt ist, um Analysen/Leistungsbewertungen durchzuführen und für UX-Zwecke — eine automatische Anmeldung kann einen anderen UI-Fluss erfordern als eine nicht-automatische Anmeldung.

Wert

Ein boolescher Wert. true zeigt an, dass die automatische Neuauthentifizierung verwendet wurde; false zeigt an, dass sie nicht verwendet wurde.

Beispiele

Grundlegende föderierte Anmeldung und Zugriff auf `isAutoSelected`

RPs können navigator.credentials.get() mit der Option identity aufrufen, um eine Anfrage zu stellen, damit Benutzer sich über einen IdP beim RP anmelden, wobei die Identitätsföderation verwendet wird. Das Verhalten der automatischen Neuauthentifizierung wird durch die mediation-Option im get()-Aufruf gesteuert:

async function signIn() {
  const identityCredential = await navigator.credentials.get({
    identity: {
      providers: [
        {
          configURL: "https://accounts.idp.example/config.json",
          clientId: "********",
        },
      ],
    },
    mediation: "optional", // this is the default
  });

  // isAutoSelected is true if auto-reauthentication occurred.
  const isAutoSelected = identityCredential.isAutoSelected;
}

Ein erfolgreicher Aufruf von navigator.credentials.get(), der eine identity Option umfasst, wird mit einer IdentityCredential-Instanz erfüllt, die verwendet werden kann, um auf die isAutoSelected-Eigenschaft zuzugreifen: Diese wird true entsprechen, wenn eine automatische Neuauthentifizierung stattgefunden hat.

Weitere Informationen über die Funktionsweise finden Sie in Federated Credential Management API (FedCM). Dieser Aufruf startet den Anmeldefluss, der im FedCM Anmeldefluss beschrieben wird.