Web/API/FederatedCredential

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The FederatedCredential interface of the 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.

In browsers that support it, an instance of this interface may be passed in the credential member of the init object for global fetch.

Constructor

FederatedCredential()

Creates a new FederatedCredential object.

Properties

Inherits properties from its ancestor, Credential.

FederatedCredential.provider Read only

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

FederatedCredential.protocol Read only

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

Event handlers

None.

Methods

None.

Examples

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

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

Specifications

Specification	Status	Comment
Credential Management Level 1	Working Draft	Initial definition.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
FederatedCredential Experimental'	Chrome Full support 51	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 38	Safari ?	WebView Android Full support 51	Chrome Android Full support 51	Firefox Android ?	Opera Android Full support 41	Safari iOS ?	Samsung Internet Android Full support 5.0
FederatedCredential() constructor Non-standard'	Chrome Full support 51	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 38	Safari ?	WebView Android Full support 51	Chrome Android Full support 51	Firefox Android ?	Opera Android Full support 41	Safari iOS ?	Samsung Internet Android Full support 5.0
protocol Experimental'	Chrome Full support 51	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 38	Safari ?	WebView Android Full support 51	Chrome Android Full support 51	Firefox Android ?	Opera Android Full support 41	Safari iOS ?	Samsung Internet Android Full support 5.0
provider Experimental'	Chrome Full support 51	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 38	Safari ?	WebView Android Full support 51	Chrome Android Full support 51	Firefox Android ?	Opera Android Full support 41	Safari iOS ?	Samsung Internet Android Full support 5.0

Legend

Full support  

Full support

No support  

No support

Compatibility unknown  

Compatibility unknown

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

Non-standard. Expect poor cross-browser support.'

Non-standard. Expect poor cross-browser support.

FederatedCredential by Mozilla Contributors is licensed under CC-BY-SA 2.5.