Web Authentication API
The isConditionalMediationAvailable() static method of the PublicKeyCredential interface returns a Promise which resolves to true if the device supports conditional get.
This method is equivalent to the object returned by PublicKeyCredential.getClientCapabilities() containing a true value for its conditionalGet property, and developers are encouraged to prefer this API.
[!NOTE] This method does not indicate whether conditional create is supported. For this, check the value of
conditionalCreatein the object returned by PublicKeyCredential.getClientCapabilities().
Syntax
PublicKeyCredential.isConditionalMediationAvailable()
Parameters
None.
Return value
A Promise which resolves to a boolean value indicating whether or not conditional get is available.
Exceptions
The returned Promise may be rejected with the following values:
SecurityErrorDOMException- : The RP domain is not valid.
Examples
Before invoking a conditional WebAuthn API call, check if:
- The browser supports the Web Authentication API.
- The browser supports conditional get.
// Availability of `window.PublicKeyCredential` means WebAuthn is usable.
if (
window.PublicKeyCredential &&
PublicKeyCredential.isConditionalMediationAvailable
) {
// Check if conditional get is available.
const isCMA = await PublicKeyCredential.isConditionalMediationAvailable();
if (isCMA) {
// Call WebAuthn authentication
const publicKeyCredentialRequestOptions = {
// Server generated challenge
challenge: challengeFromServer,
// The same RP ID as used during registration
rpId: "example.com",
};
const credential = await navigator.credentials.get({
publicKey: publicKeyCredentialRequestOptions,
signal: abortController.signal,
// Specify 'conditional' to activate conditional UI
mediation: "conditional",
});
}
}
Specifications
Browser compatibility
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
