WebAuthNAuthenticatorGetAssertion function (webauthn.h)

Produces an assertion signature representing an assertion by the authenticator that the user has consented to a specific transaction, such as logging in or completing a purchase.

Syntax

HRESULT WebAuthNAuthenticatorGetAssertion(
 HWND hWnd,
 LPCWSTR pwszRpId,
 PCWEBAUTHN_CLIENT_DATA pWebAuthNClientData,
 PCWEBAUTHN_AUTHENTICATOR_GET_ASSERTION_OPTIONS pWebAuthNGetAssertionOptions,
 PWEBAUTHN_ASSERTION *ppWebAuthNAssertion
);

Parameters

hWnd

The handle for the window that will be used to display the UI.

pwszRpId

The ID of the Relying Party.

pWebAuthNClientData

The client data to be sent to the authenticator for the Relying Party.

pWebAuthNGetAssertionOptions

The options for the WebAuthNAuthenticatorGetAssertion operation.

ppWebAuthNAssertion

A pointer to a WEBAUTHN_ASSERTION that receives the assertion.

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. Call WebAuthNGetW3CExceptionDOMError to map the result to a W3C DOM exception code.

Remarks

Note: Before performing this operation, all other operations in progress in the authenticator session MUST be aborted by running the WebAuthNCancelCurrentOperation operation.

If the authenticator cannot find any credential corresponding to the specified Relying Party that matches the specified criteria, it terminates the operation and returns an error.

Requirements

See also

WebAuthNCancelCurrentOperation

WEBAUTHN_ASSERTION