CredentialsContainer.get

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

Syntax

var promise = CredentialsContainer.get([options])

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 An array of DOMString instances of federation protocols to search for.
• mediation: A String indicating whether the user will be required to log on for every visit to the website. Valid values are "silent", "optional", or "required".
• unmediated: A Boolean indicating the returned Credential instance should not require user mediation.

Returns

A Promise that resolves with a Credential instance that matches the provided parameters.

Specifications

Browser compatibility