Edit

WEBAUTHN_AUTHENTICATOR_GET_ASSERTION_OPTIONS structure (webauthn.h)

Contains options for the WebAuthNAuthenticatorGetAssertion operation.

Syntax

typedef struct _WEBAUTHN_AUTHENTICATOR_GET_ASSERTION_OPTIONS {
  DWORD                                dwVersion;
  DWORD                                dwTimeoutMilliseconds;
  WEBAUTHN_CREDENTIALS                 CredentialList;
  WEBAUTHN_EXTENSIONS                  Extensions;
  DWORD                                dwAuthenticatorAttachment;
  DWORD                                dwUserVerificationRequirement;
  DWORD                                dwFlags;
  PCWSTR                               pwszU2fAppId;
  BOOL                                 *pbU2fAppId;
  GUID                                 *pCancellationId;
  PWEBAUTHN_CREDENTIAL_LIST            pAllowCredentialList;
  DWORD                                dwCredLargeBlobOperation;
  DWORD                                cbCredLargeBlob;
  PBYTE                                pbCredLargeBlob;
  PWEBAUTHN_HMAC_SECRET_SALT_VALUES    pHmacSecretSaltValues;
  BOOL                                 bBrowserInPrivateMode;
  PCTAPCBOR_HYBRID_STORAGE_LINKED_DATA pLinkedDevice;
  BOOL                                 bAutoFill;
  DWORD                                cbJsonExt;
  PBYTE                                pbJsonExt;
  DWORD                                cCredentialHints;
  LPCWSTR                              *ppwszCredentialHints;
  PCWSTR                               pwszRemoteWebOrigin;
  DWORD                                cbPublicKeyCredentialRequestOptionsJSON;
  PBYTE                                pbPublicKeyCredentialRequestOptionsJSON;
  DWORD                                cbAuthenticatorId;
  PBYTE                                pbAuthenticatorId;
} WEBAUTHN_AUTHENTICATOR_GET_ASSERTION_OPTIONS, *PWEBAUTHN_AUTHENTICATOR_GET_ASSERTION_OPTIONS;

Members

dwVersion

The version of this structure.

dwTimeoutMilliseconds

Time that the operation is expected to complete within. This is used as guidance and can be overridden by the platform.

CredentialList

A WEBAUTHN_CREDENTIALS structure that specifies the list of allowed credentials for the assertion.

Extensions

A WEBAUTHN_EXTENSIONS structure that contains optional extensions to parse when performing the operation.

dwAuthenticatorAttachment

The attachment for the assertion. Optional platform vs cross-platform authenticators.

dwUserVerificationRequirement

The effective user verification requirement.

dwFlags

The flags for the assertion.

pwszU2fAppId

Optional identifier for the U2F AppId. Converted to UTF8 before being hashed. Not lower-cased.

pbU2fAppId

If this is non-NULL, then, set to TRUE if the pwszU2fAppid was used instead of PCWSTR pwszRpId.

pCancellationId

Optional cancellation Id. See WebAuthNGetCancellationId for more information.

pAllowCredentialList

An optional pointer to a WEBAUTHN_CREDENTIAL_LIST that specifies credentials acceptable to the Relying Party. If present, CredentialList is ignored.

dwCredLargeBlobOperation

The large blob operation.

cbCredLargeBlob

Size of pbCredLargeBlob.

pbCredLargeBlob

A pointer to the large credential blob.

pHmacSecretSaltValues

A pointer to a WEBAUTHN_HMAC_SECRET_SALT_VALUES structure that contains PRF values to be converted into HMAC-SECRET values according to the WebAuthn specification.

bBrowserInPrivateMode

Indicates whether the client is using in-private mode in the browser. An optional parameter that defaults to FALSE.

pLinkedDevice

bAutoFill

cbJsonExt

pbJsonExt

cCredentialHints

ppwszCredentialHints

pwszRemoteWebOrigin

cbPublicKeyCredentialRequestOptionsJSON

pbPublicKeyCredentialRequestOptionsJSON

cbAuthenticatorId

The size, in bytes, of the authenticator ID pointed to by pbAuthenticatorId. Set to 0 if not targeting a specific authenticator.

pbAuthenticatorId

An optional pointer to the ID of a specific authenticator to target for this operation. Obtain authenticator IDs by calling WebAuthNGetAuthenticatorList. Set to NULL to use the default authenticator selection behavior.

Requirements

Requirement Value
Header webauthn.h

See also

WebAuthNAuthenticatorGetAssertion

WEBAUTHN_HMAC_SECRET_SALT_VALUES

WebAuthNGetAuthenticatorList