PublicKeyCredential: authenticatorAttachment property
The authenticatorAttachment
read-only property of the PublicKeyCredential
interface is a string that indicates the general category of authenticator used during the associated navigator.credentials.create()
or navigator.credentials.get()
call.
Value
A string, which will be one of the following values:
-
"platform"
-
The authenticator is part of the device WebAuthn is running on (termed a platform authenticator), therefore WebAuthn will communicate with it using a transport available to that platform, such as a platform-specific API. A public key credential bound to a platform authenticator is called a platform credential.
-
"cross-platform"
-
The authenticator is not a part of the device WebAuthn is running on (termed a roaming authenticator as it can roam between different devices), therefore WebAuthn will communicate with it using a cross-platform transport protocol such as Bluetooth or NFC. A public key credential bound to a roaming authenticator is called a roaming credential.
Examples
const options = {
challenge: new Uint8Array(26) ,
rp: {
name: "Example CORP",
id: "login.example.com",
},
user: {
id: new Uint8Array(26) ,
name: "canand@example.com",
displayName: "Carina Anand",
},
pubKeyCredParams: [
{
type: "public-key",
alg: -7,
},
],
};
navigator.credentials
.create({ publicKey: options })
.then((pubKeyCredential) => {
const attachment = pubKeyCredential.authenticatorAttachment;
})
.catch((err) => {
});
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
authenticatorAttachment |
98 |
98 |
No |
No |
84 |
15.5 |
No |
98 |
No |
68 |
15.5 |
18.0 |