在此页

• 特性
• 方法
• 范例
• 规范
• 浏览器兼容性
• 另请参阅
• 相关话题

安全上下文
此特征只可用于 安全上下文 (HTTPS)，在某些或所有 支持浏览器 .

PublicKeyCredentialRequestOptions dictionary of the Web 身份验证 API holds the options passed to navigator.credentials.get() in order to fetch a given PublicKeyCredential .

特性

PublicKeyCredentialRequestOptions.challenge

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 可选

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 可选

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 可选

数组 of credentials descriptor which restricts the acceptable existing credentials for retrieval.

PublicKeyCredentialRequestOptions.userVerification 可选

A string qualifying how the user verification should be part of the authentication process.

PublicKeyCredentialRequestOptions.extensions 可选

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.).

方法

None.

范例

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);
});
					

规范

规范	状态	注释
Web Authentication: An API for accessing Public Key Credentials Level 1 The definition of 'PublicKeyCredentialRequestOptions dictionary' in that specification.	推荐	初始定义。

浏览器兼容性

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request. 更新 GitHub 上的兼容性数据

	桌面						移动
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
PublicKeyCredentialRequestOptions	Chrome 67	Edge ≤79	Firefox 60	IE ?	Opera Yes	Safari 13	WebView Android 67	Chrome Android 67	Firefox Android ?	Opera Android Yes	Safari iOS 13.3	Samsung Internet Android No
allowCredentials	Chrome 67	Edge ≤79	Firefox 60	IE ?	Opera Yes	Safari 13	WebView Android 67	Chrome Android 67	Firefox Android ?	Opera Android Yes	Safari iOS 13.3	Samsung Internet Android No
challenge	Chrome 67	Edge ≤79	Firefox 60	IE ?	Opera Yes	Safari 13	WebView Android 67	Chrome Android 67	Firefox Android ?	Opera Android Yes	Safari iOS 13.3	Samsung Internet Android No
extensions	Chrome 67	Edge ≤79	Firefox 60	IE ?	Opera Yes	Safari 13	WebView Android 67	Chrome Android 67	Firefox Android ?	Opera Android Yes	Safari iOS 13.3	Samsung Internet Android No
rpId	Chrome 67	Edge ≤79	Firefox 60	IE ?	Opera Yes	Safari 13	WebView Android 67	Chrome Android 67	Firefox Android ?	Opera Android Yes	Safari iOS 13.3	Samsung Internet Android No
timeout	Chrome 67	Edge ≤79	Firefox 60	IE ?	Opera Yes	Safari 13	WebView Android 67	Chrome Android 67	Firefox Android ?	Opera Android Yes	Safari iOS 13.3	Samsung Internet Android No
userVerification	Chrome 67	Edge ≤79	Firefox 60	IE ?	Opera Yes	Safari 13	WebView Android 67	Chrome Android 67	Firefox Android ?	Opera Android Yes	Safari iOS 13.3	Samsung Internet Android No

图例

完整支持

完整支持

不支持

不支持

兼容性未知 ?

兼容性未知

实验。期望将来行为有所改变。

实验。期望将来行为有所改变。

另请参阅

• PublicKeyCredentialCreationOptions : the dictionary which provides option for the public key credential creation

元数据

• 最后修改： Aug 7, 2020

相关话题

1. Web 身份验证 API
2. PublicKeyCredentialRequestOptions
3. 特性

   1. allowCredentials
   2. challenge
   3. extensions
   4. rpId
   5. timeout
   6. userVerification
4. Related pages for Web Authentication API

   1. AuthenticatorAssertionResponse
   2. AuthenticatorAttestationResponse
   3. AuthenticatorResponse
   4. CredentialsContainer
   5. PublicKeyCredential