IdentityCredential: isAutoSelected property

Value

A boolean value. true indicates that automatic reauthentication was used; false indicates that it was not.

Examples

Basic federated sign-in and isAutoSelected access

RPs can call navigator.credentials.get() with the identity option to make a request for users to sign in to the RP via an IdP, using identity federation. Auto-reauthentication behavior is controlled by the mediation option in the get() call:

async function signIn() {
  const identityCredential = await navigator.credentials.get({
    identity: {
      providers: [
        {
          configURL: "https://accounts.idp.example/config.json",
          clientId: "********",
        },
      ],
    },
    mediation: "optional", // this is the default
  });

  // isAutoSelected is true if auto-reauthentication occurred.
  const isAutoSelected = identityCredential.isAutoSelected;
}

A successful navigator.credentials.get() call that includes an identity option fulfills with an IdentityCredential instance, which can be used to access the isAutoSelected property: this will equal true if auto-reauthentication occurred.

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