CredentialsContainer.get()

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

The get() method of the CredentialsContainer interface returns a Promise to a single Credential instance that matches the provided parameters. If no match is found the Promise will resolve to null.

This method first collects all credentials in the CredentialsContainer that meet the necessary criteria (defined in the options argument). From the resulting set of credentials, it then selects the best one. Depending on the options, it may display a dialog to the user and ask the user to make the selection.

This method collects credentials by calling the "CollectFromCredentialStore" method for each credential type allowed by the options argument. For example: if options.password exists, then the PasswordCredential.[[CollectFromCredentialStore]] is called.

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

Syntax

var promise = CredentialsContainer.get([options])

Parameters

options Optional

An object of type CredentialRequestOptions that contains options for the request. The options include criteria that the credentials are required or allowed to have, and options for interacting with the user. It can contain the following properties:

  • password: a boolean value 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.
  • publicKey: An object containing requirements for returned WebAuthn credentials. The available options are:
    • challenge: A BufferSource, emitted by the relying party's server and used as a cryptographic challenge. This value will be signed by the authenticator and the signature will be sent back as part of AuthenticatorAssertionResponse.signature.
    • timeout Optional: A numerical hint, in milliseconds, which indicates the time the caller is willing to wait for the retrieval operation to complete. This hint may be overridden by the browser.
    • rpId Optional: A USVString which indicates the relying party's identifier (ex. "login.example.org"). If this option is not provided, the client will use the current origin's domain.
    • allowCredentials Optional: An Array of credentials descriptor which restricts the acceptable existing credentials for retrieval.
    • userVerification Optional: A string qualifying how the user verification should be part of the authentication process.
    • extensions Optional: An object with several client extensions' inputs. Those extensions are used to request additional processing (e.g. dealing with legacy FIDO APIs credentials, prompting a specific text on the authenticator, etc.).
  • 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 value indicating the returned Credential instance should not require user mediation.
  • signal: An instance of AbortSignal that can indicate that an ongoing get() operation should be halted. An aborted operation may complete normally (generally if the abort was received after the operation finished) or reject with an "AbortError" DOMException.

Returns

A Promise that resolves with a Credential instance that matches the provided parameters. If a single Credential cannot be unambiguously obtained, the Promise will resolve to null.

Specifications

Specification
Credential Management Level 1 (Credential Management 1)
# dom-credentialscontainer-get

Browser compatibility

BCD tables only load in the browser

See also