WEBAUTHN_USER_ENTITY_INFORMATION structure (webauthn.h)

Contains information about the user account for which a credential is being created or used.

Syntax

typedef struct _WEBAUTHN_USER_ENTITY_INFORMATION {
  DWORD  dwVersion;
  DWORD  cbId;
  PBYTE  pbId;
  PCWSTR pwszName;
  PCWSTR pwszIcon;
  PCWSTR pwszDisplayName;
} WEBAUTHN_USER_ENTITY_INFORMATION, *PWEBAUTHN_USER_ENTITY_INFORMATION;

Members

dwVersion

Version of this structure, to allow for modifications in the future. This field is required and should be set to CURRENT_VERSION.

cbId

The size, in bytes, of the user handle pointed to by pbId.

pbId

A pointer to the user handle. This field is required. The Relying Party sets this to a unique, opaque identifier for the user account.

pwszName

Contains a detailed name for this account, such as "john.p.smith@example.com".

pwszIcon

Optional URL that can be used to retrieve an image containing the user's current avatar or a data URI that contains the image data.

pwszDisplayName

Contains the friendly name associated with the user account by the Relying Party, such as "John P. Smith".

Requirements

Requirement	Value
Header	webauthn.h

See also

WEBAUTHN_CREDENTIAL_DETAILS