WEBAUTHN_AUTHENTICATOR_DETAILS structure (webauthn.h)

Contains information about an authenticator available on the system, returned by WebAuthNGetAuthenticatorList.

Syntax

typedef struct _WEBAUTHN_AUTHENTICATOR_DETAILS {
 DWORD dwVersion;
 DWORD cbAuthenticatorId;
 PBYTE pbAuthenticatorId;
 PCWSTR pwszAuthenticatorName;
 DWORD cbAuthenticatorLogo;
 PBYTE pbAuthenticatorLogo;
 BOOL bLocked;
} WEBAUTHN_AUTHENTICATOR_DETAILS, *PWEBAUTHN_AUTHENTICATOR_DETAILS;

Members

dwVersion

Version of this structure, to allow for modifications in the future.

cbAuthenticatorId

The size, in bytes, of the authenticator ID pointed to by pbAuthenticatorId.

pbAuthenticatorId

A pointer to a unique identifier for this authenticator. Pass this value in the cbAuthenticatorId and pbAuthenticatorId fields of WEBAUTHN_AUTHENTICATOR_MAKE_CREDENTIAL_OPTIONS or WEBAUTHN_AUTHENTICATOR_GET_ASSERTION_OPTIONS to target this specific authenticator.

pwszAuthenticatorName

A pointer to a null-terminated string that contains the display name of the authenticator.

cbAuthenticatorLogo

The size, in bytes, of the authenticator logo data pointed to by pbAuthenticatorLogo. The logo is expected to be in SVG format.

pbAuthenticatorLogo

A pointer to the authenticator logo data. The logo is expected to be in SVG format.

bLocked

TRUE if the authenticator is currently locked. When locked, this authenticator's credentials might not be present or updated in the list returned by WebAuthNGetPlatformCredentialList.

Remarks

Use WebAuthNGetAuthenticatorList to obtain an array of these structures. The pbAuthenticatorId value uniquely identifies each authenticator and can be passed to WebAuthNAuthenticatorMakeCredential or WebAuthNAuthenticatorGetAssertion to target a specific authenticator for an operation.

When bLocked is TRUE, the authenticator's credentials may not appear in the list returned by WebAuthNGetPlatformCredentialList until the user unlocks the authenticator.

Requirements

See also

WebAuthNGetAuthenticatorList

WEBAUTHN_AUTHENTICATOR_DETAILS_LIST