PublicKeyCredentialCreationOptions.authenticatorSelection

Secure context

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

authenticatorSelection, an optional property of the PublicKeyCredentialCreationOptions dictionary, is an object giving criteria to filter out the authenticators to be used for the creation operation.

Syntax

authenticatorSelection = publicKeyCredentialCreationOptions.authenticatorSelection

Value

An object with the following properties:

authenticatorAttachmentOptional
A string which is either "platform" or "cross-platform". The former describes an authenticator which is bound to the client and which is generally not removable. The latter describes a device which may be used across different platform (such as a USB or NFC device).
requireResidentKeyOptional
A boolean which indicated that the credential private key must be stored in the authenticator, the client or in a client device. The default value is false.
userVerificationOptional
A string qualifying how the user verification should be part of the authentication process. The values may be: The default value is "preferred".

The authenticator used for the creation of the public key credential must comply with the requirements.

Note: See PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable() which resolves to true when a user-verifiying platform authenticator is available.

Examples

var publicKey = {
  authenticatorSelection:{
    authenticatorAttachment: "cross-platform",
    requireResidentKey: true,
    userVerification: "required"
  },
  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
Web Authentication: An API for accessing Public Key Credentials - Level 3 (Web Authentication)
# dom-publickeycredentialcreationoptions-authenticatorselection

Browser compatibility

BCD tables only load in the browser

See also