您正位於 MDN Web Docs 的可編輯版本

以 MDN Web Docs 使用者身分檢視: https://developer.mozilla.org/zh-TW/docs/Web/API/PublicKeyCredentialRequestOptions

PublicKeyCredentialRequestOptions

我們的志工尚未將本文翻譯為 正體中文 (繁體) 版本。加入我們,幫忙翻譯!
您也可以閱讀本文的 English (US) 版本。

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

The PublicKeyCredentialRequestOptions dictionary of the Web Authentication API holds the options passed to navigator.credentials.get() in order to fetch a given PublicKeyCredential.

Properties

PublicKeyCredentialRequestOptions.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.
PublicKeyCredentialRequestOptions.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.
PublicKeyCredentialRequestOptions.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.
PublicKeyCredentialRequestOptions.allowCredentials Optional
An Array of credentials descriptor which restricts the acceptable existing credentials for retrieval.
PublicKeyCredentialRequestOptions.userVerification Optional
A string qualifying how the user verification should be part of the authentication process.
PublicKeyCredentialRequestOptions.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.).

Methods

None.

Examples

var options = {
  challenge: new Uint8Array([/* bytes sent from the server */]),
  rpId: "example.com", /* will only work if the current domain
                         is something like foo.example.com */
  userVerification: "preferred",
  timeout: 60000,     // Wait for a minute
  allowCredentials: [
    {
      transports: "usb",
      type: "public-key",
      id: new Uint8Array(26) // actually provided by the server
    },
    {
      transports: "internal",
      type: "public-key",
      id: new Uint8Array(26) // actually provided by the server
    }
  ],
  extensions: {
    uvm: true,  // RP wants to know how the user was verified
    loc: false,
    txAuthSimple: "Could you please verify yourself?"
  }
};

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 'PublicKeyCredentialRequestOptions dictionary' in that specification.
Recommendation Initial definition.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
PublicKeyCredentialRequestOptions
Experimental
Chrome Full support 67Edge Full support ≤79Firefox Full support 60IE No support NoOpera Full support 54Safari Full support 13WebView Android Full support 67Chrome Android Full support 67Firefox Android ? Opera Android Full support 48Safari iOS Full support 13.3Samsung Internet Android No support No
allowCredentials
Experimental
Chrome Full support 67Edge Full support ≤79Firefox Full support 60IE No support NoOpera Full support 54Safari Full support 13WebView Android Full support 67Chrome Android Full support 67Firefox Android ? Opera Android Full support 48Safari iOS Full support 13.3Samsung Internet Android No support No
challenge
Experimental
Chrome Full support 67Edge Full support ≤79Firefox Full support 60IE No support NoOpera Full support 54Safari Full support 13WebView Android Full support 67Chrome Android Full support 67Firefox Android ? Opera Android Full support 48Safari iOS Full support 13.3Samsung Internet Android No support No
extensions
Experimental
Chrome Full support 67Edge Full support ≤79Firefox Full support 60IE No support NoOpera Full support 54Safari Full support 13WebView Android Full support 67Chrome Android Full support 67Firefox Android ? Opera Android Full support 48Safari iOS Full support 13.3Samsung Internet Android No support No
rpId
Experimental
Chrome Full support 67Edge Full support ≤79Firefox Full support 60IE No support NoOpera Full support 54Safari Full support 13WebView Android Full support 67Chrome Android Full support 67Firefox Android ? Opera Android Full support 48Safari iOS Full support 13.3Samsung Internet Android No support No
timeout
Experimental
Chrome Full support 67Edge Full support ≤79Firefox Full support 60IE No support NoOpera Full support 54Safari Full support 13WebView Android Full support 67Chrome Android Full support 67Firefox Android ? Opera Android Full support 48Safari iOS Full support 13.3Samsung Internet Android No support No
userVerification
Experimental
Chrome Full support 67Edge Full support ≤79Firefox Full support 60IE No support NoOpera Full support 54Safari Full support 13WebView Android Full support 67Chrome Android Full support 67Firefox Android ? Opera Android Full support 48Safari iOS Full support 13.3Samsung Internet Android No support No

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