IdentityProvider: getUserInfo() 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 getUserInfo() statische Methode der IdentityProvider-Schnittstelle gibt Informationen über einen Benutzer zurück, der sich angemeldet hat. Diese Informationen können verwendet werden, um eine personalisierte Willkommensnachricht und einen Anmeldebutton bereitzustellen. Diese Methode muss innerhalb eines Ursprungs-<iframe> des Identitätsanbieters (IdP) aufgerufen werden, damit RP-Skripte nicht auf die Daten zugreifen können. Dies muss geschehen, nachdem sich ein Benutzer auf einer relying party (RP)-Seite angemeldet hat.

Dieses Muster ist bereits auf Websites üblich, die Identitätsföderation zur Anmeldung verwenden, aber getUserInfo() bietet eine Möglichkeit, dies zu erreichen, ohne auf Drittanbieter-Cookies angewiesen zu sein.

Nutzungshinweise

Wenn getUserInfo() aufgerufen wird, wird der Browser nur dann eine Anfrage an den IdP- Kontenlisten-Endpunkt für die Benutzerinformationen stellen, wenn beide der folgenden Bedingungen erfüllt sind:

  • Der Benutzer hat sich zuvor mit dem IdP über FedCM in derselben Browserinstanz beim RP angemeldet, und die Daten wurden nicht gelöscht.
  • Der Benutzer ist in derselben Browserinstanz beim IdP angemeldet.

getUserInfo() muss aus einem eingebetteten <iframe> heraus aufgerufen werden, und der Ursprung der eingebetteten Seite muss mit der configURL des IdP übereinstimmen. Zusätzlich muss das einbettende HTML seine Nutzung ausdrücklich über die identity-credentials-get Permissions-Policy erlauben:

html
<iframe
  src="https://idp.example/signin"
  allow="identity-credentials-get"></iframe>

Syntax

js
IdentityProvider.getUserInfo(config)

Parameter

config

Ein Konfigurationsobjekt, das die folgenden Eigenschaften enthalten kann:

configURL

Die URL der Konfigurationsdatei des Identitätsanbieters, von dem Sie Benutzerinformationen abrufen möchten.

clientId

Die clientId des RP, die vom IdP ausgegeben wurde.

Rückgabewert

Ein Promise, das mit einem Array von Objekten erfüllt wird, die jeweils Informationen zu einem separaten Benutzerkonto enthalten. Jedes Objekt enthält die folgenden Eigenschaften:

email

Ein String, der die E-Mail-Adresse des Benutzers darstellt.

name

Ein String, der den vollständigen Namen des Benutzers darstellt.

givenName

Ein String, der den Vor- (Spitz- oder abgekürzten) Namen des Benutzers darstellt.

picture

Ein String, der die URL des Profilbildes des Benutzers darstellt.

Ausnahmen

InvalidStateError DOMException

Wird ausgelöst, wenn die angegebene configURL ungültig ist oder wenn der Ursprung des eingebetteten Dokuments nicht mit der configURL übereinstimmt.

NetworkError DOMException

Wird ausgelöst, wenn der Browser keine Verbindung zum IdP herstellen kann oder wenn getUserInfo() aus dem obersten Dokument aufgerufen wird.

NotAllowedError DOMException

Wird ausgelöst, wenn das einbettende <iframe> keine identity-credentials-get Permissions-Policy gesetzt hat, um die Nutzung von getUserInfo() zu erlauben, oder wenn die FedCM-API global durch eine auf das oberste Dokument gesetzte Richtlinie deaktiviert ist.

Beispiele

js
// Iframe displaying a page from the https://idp.example origin
const user_info = await IdentityProvider.getUserInfo({
  configUrl: "https://idp.example/fedcm.json",
  clientId: "client1234",
});

// IdentityProvider.getUserInfo() returns an array of user information.
if (user_info.length > 0) {
  // Returning accounts should be first, so the first account received
  // is guaranteed to be a returning account
  const name = user_info[0].name;
  const given_name = user_info[0].given_name;
  const display_name = given_name ? given_name : name;
  const picture = user_info[0].picture;
  const email = user_info[0].email;

  // ...

  // Render the personalized sign-in button using the information above
}

Spezifikationen

Specification
Federated Credential Management API
# dom-identityprovider-getuserinfo

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch