IdentityProvider

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The IdentityProvider interface of the Federated Credential Management (FedCM) API represents an identity provider (IdP) and provides access to related information and functionality.

Static methods

close()

Provides a manual signal to the browser that an IdP sign-in flow is finished. This is needed to, for example, close the IdP sign-in dialog when sign-in is completely finished and the IdP has finished colecting data from the user.

getUserInfo()

Returns information about a previously signed in user on their return to an IdP, which can be used to provide a personalized welcome message and sign-in button.

Examples

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 a personalized sign-in button using the information returned above
}

Specifications

Specification
Federated Credential Management API
# browser-api-identity-provider-interface

Browser compatibility

BCD tables only load in the browser

See also