PublicKeyCredentialRequestOptions.userVerification

Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

userVerification is an optional property of the PublicKeyCredentialRequestOptions. This is a string which indicates how the user verification should be part of the authentication process.

Note: An analogous option exists for the creation operation (navigators.credentials.create()), see the userVerification property of PublicKeyCredentialCreationOptions.authenticatorSelection.

Syntax

userVerification = publicKeyCredentialRequestOptions.userVerification

Value

A string qualifying how the user verification should be part of the authentication process. The values may be:

The default value is "preferred".

Examples

var options = {
  userVerification: "preferred",
  challenge: new Uint8Array([/* bytes sent from the server */]),
};

navigator.credentials.get({ "publicKey": options })
    .then(function (credentialInfoAssertion) {
    // send assertion response back to the server
    // to proceed with the control of the credential
}).catch(function (err) {
     console.error(err);
});

Specifications

Specification Status Comment
Web Authentication: An API for accessing Public Key Credentials Level 1
The definition of 'userVerification' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
userVerification
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera Full support YesSafari ? WebView Android Full support 67Chrome Android Full support 67Firefox Android ? Opera Android Full support YesSafari iOS ? Samsung Internet Android Full support 9.0

Legend

Full support  
Full support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.

See also