Docs4dev
Docs
dom / latest / federatedcredential.html

FederatedCredential

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

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 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 fetch().

Credential FederatedCredential

Constructor

FederatedCredential()

Creates a new FederatedCredential object.

Instance properties

Inherits properties from its ancestor, Credential.

FederatedCredential.provider Read only

Returns a string containing a credential's federated identity provider.

FederatedCredential.protocol Read only

Returns a string containing a credential's federated identity protocol.

Event handlers

None.

Instance methods

None.

Examples

js

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

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

Specifications

Specification
Credential Management Level 1
# federated

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
FederatedCredential 51 79 No No 38 No 51 51 No 41 No 5.0
FederatedCredential 51 79 No No 38 No 51 51 No 41 No 5.0
iconURL 51 79 No No 38 No 51 51 No 41 No 6.0
name 51 79 No No 38 No 51 51 No 41 No 6.0
protocol 51 79 No No 38 No 51 51 No 41 No 5.0
provider 51 79 No No 38 No 51 51 No 41 No 5.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/FederatedCredential