IdentityCredentialRequestOptions

Instanz-Eigenschaften

context Optional

Ein String, der den Kontext angibt, in dem sich der Benutzer 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 Benutzer eine Identität auswählt, um zur nächsten Seite im Ablauf zu gelangen, die eine Anmeldung erfordert. Browser bieten eine ähnliche Textzeile an:

Continue to <page-origin> with <IdP>

"signin"

Geeignet für allgemeine Situationen, in denen sich der Benutzer mit einem IdP-Konto anmeldet, das er auf dieser Herkunft bereits genutzt hat. Browser bieten eine ähnliche Textzeile an:

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

"signup"

Eine Option für Situationen, in denen sich der Benutzer mit einem neuen IdP-Konto anmeldet, das er hier bisher nicht verwendet hat. Browser bieten eine ähnliche Textzeile an:

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

"use"

Geeignet für Situationen, in denen eine andere Aktion, wie die Validierung einer Zahlung, durchgeführt wird. Browser bieten eine ähnliche Textzeile an:

Use <page-origin> with <IdP>

Der Standardwert ist "signin".

mode Optional

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

active

Der Anmeldeablauf muss über eine Benutzeraktion, wie das Klicken eines Buttons, eingeleitet werden. Wenn mode auf active gesetzt ist, kann providers nur eine Länge von 1 haben, andernfalls wird das get()-Versprechen abgelehnt.

passive

Der Anmeldeablauf kann ohne direkte Benutzerinteraktion eingeleitet werden. Dies ist der Standardwert.

Siehe Aktiver versus passiver Modus für mehr Details über den Unterschied zwischen den beiden Modi.

providers

Ein Array von Objekten, das Details der IdPs angibt, die dem Benutzer als Optionen für die Anmeldung angezeigt werden sollen. Diese Objekte können die folgenden Eigenschaften enthalten:

configURL

Ein String, der die URL der Konfigurationsdatei des IdP angibt. Siehe Bereitstellen einer Konfigurationsdatei für weitere Informationen.

clientId

Ein String, der den RP-Client-Identifikator angibt. Diese Information wird vom IdP an den RP in einem separaten, IdP-spezifischen Verfahren ausgestellt.

domainHint Optional

Ein String, der auf die Domain der Konten hinweist, an denen der RP interessiert ist. Wenn bereitgestellt, zeigt der Benutzeragent nur Konten an, die den Domain-Hinweiswert in ihrem domain_hints-Array enthalten. Wenn "any" angegeben ist, zeigt der RP jedes Konto an, das mit mindestens einem Domain-Hinweis verknüpft ist.

fields Optional

Ein Array von Strings, die Benutzerinformationen angeben, die der RP vom IdP für den Anmeldeprozess erhalten möchte. Die genauen Strings variieren je nach IdP, sind jedoch ähnlich zu "name", "email" oder "profile-picture-url".

loginHint Optional

Ein String, der einen Hinweis auf die Kontooptionen gibt, die der Browser dem Benutzer zur Anmeldung vorschlagen soll. Dies ist nützlich in Fällen, in denen sich der Benutzer bereits angemeldet hat und die Website verlangt, dass er sich erneut authentifiziert. Andernfalls kann der erneute Authentifizierungsprozess verwirrend sein, wenn ein Benutzer mehrere Konten hat und sich nicht erinnern kann, welches er zuvor verwendet hat. Der Wert für die loginHint-Eigenschaft kann von der vorherigen Anmeldung des Benutzers übernommen werden und wird mit den login_hints-Werten abgeglichen, die vom IdP im Array der vom IdP zurückgegebenen Benutzerinformationen bereitgestellt werden Konto-Liste-Endpunkt.

nonce Optional

Ein zufälliger String, der eingefügt werden kann, um sicherzustellen, dass die Antwort speziell für diese Anfrage ausgestellt wird und 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 einschließen muss, sollte er in der params-Eigenschaft bereitgestellt werden.

params Optional

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

Spezifikationen

Browser-Kompatibilität