Web/API/PublicKeyCredentialCreationOptions/user

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

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. "[email protected]").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: "[email protected]",
    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

Specification	Status	Comment
Web Authentication: An API for accessing Public Key Credentials Level 1The definition of 'user' in that specification.	Recommendation	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`user` Experimental'	Chrome Full support 67	Edge Full support ≤79	Firefox Full support 60	IE No support No	Opera Full support 54	Safari Full support 13	WebView Android No support No	Chrome Android Full support 67	Firefox Android ?	Opera Android Full support 48	Safari iOS Full support 13.3	Samsung Internet Android No support No

Legend

Full support: Full support
No support: No support
Compatibility unknown: Compatibility unknown
Experimental. Expect behavior to change in the future.': Experimental. Expect behavior to change in the future.