Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

Revision 1107025 of FederatedCredential

  • Revision slug: Web/API/FederatedCredential
  • Revision title: FederatedCredential
  • Revision id: 1107025
  • Created:
  • Creator: azoorob3
  • Is current revision? Yes
  • Comment heading capitalization

Revision Content

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

The FederatedCredential interface of the the Credential Management API provides information about credentials from a federated identity provider, which is an entity that a website trusts to correctly authenticate a user, and which provides an API for that purpose. OpenID Connect is an example of such a framework. In supporting browsers an instance of this class may be passed in the credential member of the init object for global {{domxref('fetch')}}.

{{domxref("FederatedCredential.FederatedCredential()")}}
Creates a new FederatedCredential object.

Properties

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

{{domxref("FederatedCredential.provider")}} {{readonlyInline}}
Returns a {{domxref("USVString")}} containing a credential's federated identity provider.

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
{{SpecName('Credential Management')}} {{Spec2('Credential Management')}} Initial definition.

Browser compatibility

{{CompatibilityTable}}
Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support

{{CompatChrome(51.0)}}

{{CompatUnknown}} {{CompatUnknown}} {{CompatUnknown}} {{CompatUnknown}}
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support {{CompatNo}} {{CompatChrome(51.0)}} {{CompatUnknown}} {{CompatUnknown}} {{CompatUnknown}} {{CompatUnknown}} {{CompatUnknown}} {{CompatChrome(51.0)}}

Revision Source

<p>{{SeeCompatTable}}{{APIRef("Credential Management API")}}</p>

<p>The <strong><code>FederatedCredential</code></strong>&nbsp;interface of the the <a href="/en-US/docs/Web/API/Credential_Management_API">Credential Management API</a> provides information about credentials from&nbsp;a federated identity provider, which is an entity that a website trusts to correctly authenticate a user, and which provides an API for that purpose.&nbsp;<a href="https://openid.net/developers/specs/">OpenID Connect</a>&nbsp;is an example of such a framework. In supporting browsers an instance of this class may be passed in the <code>credential</code> member of the <code>init</code> object for global {{domxref('fetch')}}.</p>

<dl>
 <dt>{{domxref("FederatedCredential.FederatedCredential()")}}</dt>
 <dd>Creates a new <code>FederatedCredential</code> object.</dd>
</dl>

<h2 id="Properties">Properties</h2>

<p><em>Inherits properties from its ancestor, {{domxref("Credential")}}.</em></p>

<dl>
 <dt>{{domxref("FederatedCredential.provider")}}&nbsp;{{readonlyInline}}</dt>
 <dd>Returns a {{domxref("USVString")}} containing a credential's federated identity provider.</dd>
</dl>

<h3 id="Event_handlers">Event handlers</h3>

<p>None.</p>

<h2 id="Methods">Methods</h2>

<p>None.</p>

<h2 id="Examples">Examples</h2>

<pre class="brush: js">
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.
});</pre>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('Credential Management')}}</td>
   <td>{{Spec2('Credential Management')}}</td>
   <td>Initial definition.</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_Compatibility">Browser compatibility</h2>

<div>{{CompatibilityTable}}</div>

<div id="compat-desktop">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Chrome</th>
   <th>Firefox (Gecko)</th>
   <th>Internet Explorer</th>
   <th>Opera</th>
   <th>Safari (WebKit)</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>
    <p>{{CompatChrome(51.0)}}</p>
   </td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatUnknown}}</td>
  </tr>
 </tbody>
</table>
</div>

<div id="compat-mobile">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Android</th>
   <th>Android Webview</th>
   <th>Firefox Mobile (Gecko)</th>
   <th>Firefox OS</th>
   <th>IE Mobile</th>
   <th>Opera Mobile</th>
   <th>Safari Mobile</th>
   <th>Chrome for Android</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatChrome(51.0)}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatChrome(51.0)}}</td>
  </tr>
 </tbody>
</table>
</div>
Revert to this revision