IdentityCredential

Limited availabilitySecure context

The IdentityCredential interface of the Federated Credential Management API (FedCM) represents a user identity credential arising from a successful federated sign-in.

A successful navigator.credentials.get() call that includes an identity option fulfills with an IdentityCredential instance.

Instance properties

Inherits properties from its ancestor, Credential.

• configURL Read only Experimental
  • : A string specifying the config file URL of the IdP used for sign-in.
• isAutoSelected Read only Experimental
  • : A boolean value that indicates whether the federated sign-in was carried out using auto-reauthentication (i.e., without user mediation) or not.
• token Experimental
  • : Returns the token used to validate the associated sign-in.

Static methods

• IdentityCredential.disconnect() Experimental
  • : Disconnects the federated sign-in account used to obtain the credential.

Examples

Basic federated sign-in

Relying parties (RPs) can call navigator.credentials.get() with the identity option to make a request for users to sign in to the RP via an identity provider (IdP), using identity federation. A typical request would look like this:

async function signIn() {
  const identityCredential = await navigator.credentials.get({
    identity: {
      providers: [
        {
          configURL: "https://accounts.idp.example/config.json",
          clientId: "********",
          params: {/* IdP-specific parameters */},
        },
      ],
    },
  });
}

If successful, this call will fulfill with an IdentityCredential instance. From this, you could return the token value, for example:

console.log(identityCredential.token);

Check out Federated Credential Management API (FedCM) for more details on how this works. This call will start off the sign-in flow described in FedCM sign-in flow.

Specifications

Browser compatibility

See also

• Federated Credential Management API