This method first collects all credentials in the
that meet the necessary criteria (defined in the
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
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.
This method is restricted to top-level contexts. Calls to it within an
<iframe> element will resolve without effect.
var promise = CredentialsContainer.get([options])
- options Optional
- An object of type
CredentialRequestOptionsthat 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:
Booleanindicating that returned
Credentialinstances should include user (as opposed to federated) credentials.
FederatedCredentialRequestOptionsobject containing requirements for returned federated credentials. The available options are:
PublicKeyCredentialRequestOptionsobject containing requirements for returned WebAuthn credentials.
Stringindicating whether the user will be required to log on for every visit to the website. Valid values are
Booleanindicating the returned
Credentialinstance should not require user mediation.
signal: An instance of
AbortSignalthat 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 "
|Credential Management Level 1
The definition of 'get()' in that specification.
|Working Draft||Initial definition.|
|Web Authentication: An API for accessing Public Key Credentials Level 1||Recommendation||Initial definition.|
BCD tables only load in the browser