PublicKeyCredentialCreationOptions.user

The user property of the PublicKeyCredentialCreationOptions dictionary is an object describing the user account for which the credentials are generated (via navigator.credentials.create()).

Syntax

userAccount = publicKeyCredentialCreationOptions.user

Properties

displayName

A DOMString which is human readable and intended for display. It may be the full name of the user (e.g. "John Doe"). This is not intended to store the login of the user (see name below).

icon Optional

An URL as a USVString value which points to an image resource which can be the avatar image for the user.

id

A BufferSource uniquely identifying a given user. This an opaque identifier which can be used by the authenticator to link the user account with its corresponding credentials. This value will later be used when fetching the credentials in AuthenticatorAssertionResponse.userHandle.

name

A DOMString giving a human-readable name for the user's identifier (e.g. "jdoe@example.com").This property is intended for display and may be use to distinguish different account with the same displayName.

Examples

var publicKey = {
  challenge: new Uint8Array(26) /* this actually is given from the server */,
  rp: {
    name: "Example CORP",
    id  : "login.example.com"
  },
  user: {
    // To be changed for each user
    id: new Uint8Array.from(window.atob("LAEGMLKJNRLKGNAMLAFALFKA="), c=>c.charCodeAt(0));

    name: "jdoe@example.com",
    displayName: "John Doe",
    icon: "https://gravatar.com/avatar/jdoe.png"
  },
  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

Browser compatibility

See also

• AuthenticatorAssertionResponse.userHandle which should match the id property of user for the same user/credential.