FederatedCredential

{{SeeCompatTable}}{{APIRef("Credential Management API")}}{{SecureContext_Header}}

The FederatedCredential interface of the Credential Management API provides information about credentials from a federated identity provider. A federated identity provider is an entity that a website trusts to correctly authenticate a user, and that provides an API for that purpose. OpenID Connect is an example of a federated identity provider framework.

[!NOTE] The Federated Credential Management API (FedCM) provides a more complete solution for handling identity federation in the browser, and uses the {{domxref("IdentityCredential")}} type.

In browsers that support it, an instance of this interface may be passed in the credential member of the init object for global {{domxref("Window/fetch", "fetch()")}}.

{{InheritanceDiagram}}

Constructor

• {{domxref("FederatedCredential.FederatedCredential()","FederatedCredential()")}} {{Experimental_Inline}}
  • : Creates a new FederatedCredential object.

Instance properties

Inherits properties from its ancestor, {{domxref("Credential")}}.

• {{domxref("FederatedCredential.provider")}} {{ReadOnlyInline}} {{Experimental_Inline}}
  • : Returns a string containing a credential's federated identity provider.
• {{domxref("FederatedCredential.protocol")}} {{ReadOnlyInline}} {{Experimental_Inline}}
  • : Returns a string containing a credential's federated identity protocol.

Instance methods

None.

Examples

const cred = new FederatedCredential({
  id,
  name,
  provider: "https://account.google.com",
  iconURL,
});

// Store it
navigator.credentials.store(cred).then(() => {
  // Do something else.
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}