IdentityCredentialRequestOptions

Instanzeigenschaften

context Optional

Ein String, der den Kontext angibt, in dem sich der Nutzer mit FedCM authentifiziert. Der Browser verwendet diesen Wert, um den Text in seiner FedCM-Benutzeroberfläche besser an den Kontext anzupassen. Mögliche Werte sind:

"continue"

Geeignet für Situationen, in denen der Nutzer eine Identität auswählt, um zum nächsten Schritt im Ablauf fortzufahren, der eine Anmeldung erfordert. Browser werden eine Textzeile ähnlich der folgenden bereitstellen:

Continue to <page-origin> with <IdP>

"signin"

Geeignet für allgemeine Situationen, in denen der Nutzer sich mit einem IdP-Konto anmeldet, das er bereits auf diesem Ursprung verwendet hat. Browser werden eine Textzeile ähnlich der folgenden bereitstellen:

Sign in to <page-origin> with <IdP>

"signup"

Eine Option für Situationen, in denen der Nutzer sich mit einem neuen IdP-Konto am Ursprung anmeldet, das er hier zuvor nicht verwendet hat. Browser werden eine Textzeile ähnlich der folgenden bereitstellen:

Sign up to <page-origin> with <IdP>

"use"

Geeignet für Situationen, in denen eine andere Aktion, wie zum Beispiel die Validierung einer Zahlung, durchgeführt wird. Browser werden eine Textzeile ähnlich der folgenden bereitstellen:

Use <page-origin> with <IdP>

Der Standardwert ist "signin".

mode Optional

Ein String, der den UI-Modus für den Anmeldevorgang festlegt. Mögliche Werte sind:

active

Der Anmeldevorgang muss durch eine Nutzeraktion wie das Klicken auf eine Schaltfläche gestartet werden. Wenn mode auf active gesetzt ist, kann providers nur eine Länge von 1 haben, andernfalls wird das get()-Promise abgelehnt.

passive

Der Anmeldevorgang kann ohne direkte Nutzerinteraktion gestartet werden. Dies ist der Standardwert.

Siehe Aktiver versus passiver Modus für weitere Details zu den Unterschieden zwischen den beiden Modi.

providers

Ein Array von Objekten, das Details zu den IdPs spezifiziert, die dem Nutzer als Anmeldeoptionen präsentiert werden sollen. Diese Objekte können die folgenden Eigenschaften enthalten:

configURL

Ein String, der die URL der Konfigurationsdatei des IdP angibt. Weitere Informationen finden Sie unter Bereitstellung einer Konfigurationsdatei.

clientId

Ein String, der den RP-Client-Identifier angibt. Diese Information wird vom IdP in einem separaten, spezifischen Prozess an den RP ausgegeben.

domainHint Optional

Ein String, der auf die Domäne der Konten hinweist, an denen der RP interessiert ist. Wenn angegeben, zeigt der Benutzeragent nur Konten an, die den in dem domain_hints-Array angegebenen Domänenhinweiswerten entsprechen. Wenn "any" angegeben ist, wird der RP jedes Konto anzeigen, das mit mindestens einem Domänenhinweis verknüpft ist.

fields Optional

Ein Array von Strings, das die Benutzerinformationen spezifiziert, die der RP vom IdP im Anmeldeprozess erhalten möchte. Die genauen Strings variieren je nach IdP, tendieren jedoch ähnlich zu "name", "email" oder "profile-picture-url" zu sein.

loginHint Optional

Ein String, der einen Hinweis auf die Kontooption(en) gibt, die der Browser als Anmeldemöglichkeit für den Nutzer bereitstellen soll. Dies ist nützlich in Fällen, in denen der Nutzer bereits angemeldet ist und die Seite von ihm verlangt, sich erneut zu authentifizieren. Andernfalls kann der Reauthentifizierungsprozess verwirrend sein, wenn ein Nutzer mehrere Konten hat und sich nicht daran erinnert, welches er zuvor zur Anmeldung verwendet hat. Der Wert für die loginHint-Eigenschaft kann aus der vorherigen Anmeldung des Nutzers entnommen werden und wird mit den login_hints-Werten abgeglichen, die der IdP im zurückgegebene Array von Benutzerinformationen aus dem Konto-Listen-Endpunkt bereitstellt.

nonce Optional

Ein zufälliger String, der eingeschlossen werden kann, um sicherzustellen, dass die Antwort speziell für diese Anfrage ausgestellt wird, um Replay-Angriffe zu verhindern.

Hinweis: Diese Eigenschaft wurde aus der Spezifikation entfernt, da nicht alle Protokolle, die die FedCM API verwenden, einen nonce benötigen. Wenn der RP einen nonce einfügen muss, sollte dieser in der params-Eigenschaft bereitgestellt werden.

params Optional

Alle zusätzlichen Parameter, die der RP an den IdP übermitteln muss.

Spezifikationen

Browser-Kompatibilität