Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
WebAuthNGetAuthenticatorList function (webauthn.h)
Retrieves a list of authenticators available on the system, including plugin authenticators.
Syntax
HRESULT WebAuthNGetAuthenticatorList(
PCWEBAUTHN_AUTHENTICATOR_DETAILS_OPTIONS pWebAuthNGetAuthenticatorListOptions,
PWEBAUTHN_AUTHENTICATOR_DETAILS_LIST *ppAuthenticatorDetailsList
);
Parameters
pWebAuthNGetAuthenticatorListOptions
An optional pointer to a WEBAUTHN_AUTHENTICATOR_DETAILS_OPTIONS structure that specifies options for the query. May be NULL.
ppAuthenticatorDetailsList
When this function returns successfully, contains a pointer to a WEBAUTHN_AUTHENTICATOR_DETAILS_LIST structure. Free this with WebAuthNFreeAuthenticatorList.
Return value
If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. Call WebAuthNGetErrorName to get a human-readable error string.
Remarks
Use this function to enumerate authenticators on the system. Each authenticator is described by a WEBAUTHN_AUTHENTICATOR_DETAILS structure that includes its identifier, display name, logo, and lock state.
The authenticator ID returned in each entry can be passed to WebAuthNAuthenticatorMakeCredential or WebAuthNAuthenticatorGetAssertion via the cbAuthenticatorId and pbAuthenticatorId fields in the options structure to target a specific authenticator.
This function requires WebAuthn API version 9 or later. Call WebAuthNGetApiVersionNumber to verify support.
Requirements
| Requirement | Value |
|---|---|
| Header | webauthn.h |
| Library | OneCoreUAP.Lib |
See also
Feedback
Was this page helpful?