CredentialsContainer.get()

This article needs a technical review. How you can help.

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The get() method of the CredentialsContainer interface returns a Promise to a Credential instance that matches the provided parameters.

This method is restricted to top-level contexts. Calls to it within an <iframe> element will resolve without effect.

Syntax

CredentialsContainer.get([options]).then(function(Credential) { ... })

Parameters

options Optional
An object that sets options to look for among the credentials in the CredentialsContainer. The available options are:
  • password: a Boolean indicating that returned Credential instances should include user (as opposed to federated) credentials. 
  • federated: An object containing requirements for returned federated credentials. The available options are:
    • providers: An array of DOMString instances of identity providers to search for.
    • protocols n array of DOMString instances of federation protocols to search for.
  • unmediated: a Boolean indicating a returned Credential instances should not require user mediation.

Returns

Promise to a Credential instance that matches the provided parameters.

Example

// TBD

Specifications

Specification Status Comment
Credential Management Level 1 Editor's Draft Initial definition.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 51.0        
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support 51.0           51.0

Document Tags and Contributors

 Contributors to this page: rolfedh, jpmedley
 Last updated by: rolfedh,