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.
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
: aBoolean
indicating that returnedCredential
instances should include user (as opposed to federated) credentials.federated
: AFederatedCredentialRequestOptions
object containing requirements for returned federated credentials. The available options are:publicKey
: AnPublicKeyCredentialRequestOptions
object containing requirements for returned WebAuthn credentials.mediation
: AString
indicating whether the user will be required to log on for every visit to the website. Valid values are"silent"
,"optional"
, or"required"
.unmediated
: ABoolean
indicating the returnedCredential
instance should not require user mediation.signal
: An instance ofAbortSignal
that can indicate that an ongoingget()
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 unambigiously obtained, the Promise will resolve to null.
Specifications
Specification | Status | Comment |
---|---|---|
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. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
get | Chrome Full support 51 | Edge Full support 18 | Firefox Full support Yes | IE ? | Opera No support No | Safari Full support 13 | WebView Android Full support 51 | Chrome Android Full support 51 | Firefox Android Full support Yes | Opera Android No support No | Safari iOS Full support 13.3 | Samsung Internet Android Full support 5.0 |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
See also
Feature-Policy
directivepublickey-credentials-get