WEBAUTHN_AUTHENTICATOR_MAKE_CREDENTIAL_OPTIONS structure (webauthn.h)

The options for the WebAuthNAuthenticatorMakeCredential operation.

Syntax

typedef struct _WEBAUTHN_AUTHENTICATOR_MAKE_CREDENTIAL_OPTIONS {
  DWORD                                dwVersion;
  DWORD                                dwTimeoutMilliseconds;
  WEBAUTHN_CREDENTIALS                 CredentialList;
  WEBAUTHN_EXTENSIONS                  Extensions;
  DWORD                                dwAuthenticatorAttachment;
  BOOL                                 bRequireResidentKey;
  DWORD                                dwUserVerificationRequirement;
  DWORD                                dwAttestationConveyancePreference;
  DWORD                                dwFlags;
  GUID                                 *pCancellationId;
  PWEBAUTHN_CREDENTIAL_LIST            pExcludeCredentialList;
  DWORD                                dwEnterpriseAttestation;
  DWORD                                dwLargeBlobSupport;
  BOOL                                 bPreferResidentKey;
  BOOL                                 bBrowserInPrivateMode;
  BOOL                                 bEnablePrf;
  PCTAPCBOR_HYBRID_STORAGE_LINKED_DATA pLinkedDevice;
  DWORD                                cbJsonExt;
  PBYTE                                pbJsonExt;
} WEBAUTHN_AUTHENTICATOR_MAKE_CREDENTIAL_OPTIONS, *PWEBAUTHN_AUTHENTICATOR_MAKE_CREDENTIAL_OPTIONS;

Members

dwVersion

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

Credentials used for exclusion.

Extensions

Optional extensions to parse when performing the operation.

dwAuthenticatorAttachment

Optional platform vs cross-platform authenticators.

bRequireResidentKey

Require key to be resident or not. This is optional and defaults to FALSE.

dwUserVerificationRequirement

The user verification requirement.

dwAttestationConveyancePreference

The attestation conveyance preference.

dwFlags

The flags (reserved for future use).

pCancellationId

The optional cancellation Id. See WebAuthNGetCancellationId for more information.

pExcludeCredentialList

The exclude credential list. If present, CredentialList will be ignored.

dwEnterpriseAttestation

The enterprise attestation.

dwLargeBlobSupport

The requested large blob support: none, required or preferred. User will receive NTE_INVALID_PARAMETER when large blob is set to required or preferred and bRequireResidentKey isn't set to TRUE.

bPreferResidentKey

Prefer key to be resident. Optional parameter, defaulting to FALSE. When TRUE, overrides bRequireResidentKey.

bBrowserInPrivateMode

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

bEnablePrf

pLinkedDevice

cbJsonExt

pbJsonExt

Requirements

Requirement	Value
Header	webauthn.h

See also

WebAuthNAuthenticatorMakeCredential

WebAuthNGetCancellationId