FederatedCredentialInit

The FederatedCredentialInit dictionary represents the object passed to CredentialsContainer.create() as the value of the federated option: that is, when creating a FederatedCredential object representing a credential associated with a federated identify provider.

Instance properties

iconURL Optional

A string representing the URL of an icon or avatar to be associated with the credential.

id

A string representing a unique ID for the credential.

name Optional

A string representing the credential username.

origin

A string representing the credential's origin. FederatedCredential objects are origin-bound, which means that they will only be usable on the specified origin they were intended to be used on.

protocol Optional

A string representing the protocol of the credentials' federated identity provider (for example, "openidconnect").

provider

A string representing the credentials' federated identity provider (for example "https://www.facebook.com" or "https://accounts.google.com").

Examples

Creating a federated identity credential

const credInit = {
  id: "1234",
  name: "Serpentina",
  origin: "https://example.org",
  protocol: "openidconnect",
  provider: "https://provider.example.org",
};

const makeCredential = document.querySelector("#make-credential");

makeCredential.addEventListener("click", async () => {
  const cred = await navigator.credentials.create({
    federated: credInit,
  });
  console.log(cred.name);
  console.log(cred.provider);
});

Specifications