PublicKeyCredentialCreationOptions.timeout

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

The timeout property, of the PublicKeyCredentialCreationOptions dictionary, represents an hint, given in milliseconds, for the time the script is willing to wait for the completion of the creation operation.

This property is optional and merely is a hint which may be overridden by the browser.

Note: An analogous option exists for the fetching operation (navigators.credentials.get()), see PublicKeyCredentialRequestOptions.timeout.

Syntax

timeout = publicKeyCredentialCreationOptions.timeout

Value

A numerical hint, expressed in milliseconds, giving the time to wait for the creation operation to complete.

Examples

var publicKey = {
  timeout: 6000, // Accepting to wait for a minute before giving up.
  challenge: new Uint8Array(26) /* this actually is given from the server */,
  rp: {
    name: "Example CORP",
    id  : "login.example.com"
  },
  user: {
    id: new Uint8Array(26), /* To be changed for each user */
    name: "jdoe@example.com",
    displayName: "John Doe",
  },
  pubKeyCredParams: [
    {
      type: "public-key",
      alg: -7
    }
  ]
};

navigator.credentials.create({ publicKey })
  .then(function (newCredentialInfo) {
    // send attestation response and client extensions
    // to the server to proceed with the registration
    // 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 'timeout' 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
timeout
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera ? Safari ? WebView Android No support NoChrome Android Full support 67Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?

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

Document Tags and Contributors

Contributors to this page: mdnwebdocs-bot, SphinxKnight
Last updated by: mdnwebdocs-bot,