Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Contains 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;
PWEBAUTHN_HMAC_SECRET_SALT pPRFGlobalEval;
DWORD cCredentialHints;
LPCWSTR *ppwszCredentialHints;
BOOL bThirdPartyPayment;
PCWSTR pwszRemoteWebOrigin;
DWORD cbPublicKeyCredentialCreationOptionsJSON;
PBYTE pbPublicKeyCredentialCreationOptionsJSON;
DWORD cbAuthenticatorId;
PBYTE pbAuthenticatorId;
} 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
A WEBAUTHN_CREDENTIALS structure that specifies credentials to exclude. If a matching credential already exists on the authenticator, the operation fails.
Extensions
A WEBAUTHN_EXTENSIONS structure that contains 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
An optional pointer to a WEBAUTHN_CREDENTIAL_LIST that specifies credentials to exclude. If present, CredentialList is 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
pPRFGlobalEval
cCredentialHints
ppwszCredentialHints
bThirdPartyPayment
pwszRemoteWebOrigin
cbPublicKeyCredentialCreationOptionsJSON
pbPublicKeyCredentialCreationOptionsJSON
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 |