Skip to main content

FIDOAuthenticatorSettingsParms

Settings that set the behavior of FIDO authentication.

Properties

NameTypeDescriptionNotes
backupEligibleCheckBooleanA boolean value indicating if synced passkey/FIDO2 tokens should be blocked.[optional]
fidoRelyingPartyAllowlistList<FIDOAllowedRpid>List of allowed relying party IDs for passkey/FIDO2 registration.[optional]
fidoRelyingPartyAllowlistEnabledBooleanA boolean value indicating if passkey/FIDO2 relying party allow list is enabled.[optional]
passkeyAuthenticatorLevelStringThe minimum authentication level required to use FIDO self user actions through the Authentication API.[optional]
registrationAuthenticatorAttachmentRegistrationAuthenticatorAttachmentEnumShould the token be embedded on the device or stored externally?[optional]
registrationRequireResidentKeyRegistrationRequireResidentKeyEnumShould the User ID be stored on the Passkey/FIDO2 token?[optional]
registrationUserVerificationRegistrationUserVerificationEnumShould the token perform user verification?[optional]
timeoutIntegerThe time in seconds that a client will wait for the FIDO token to respond. Value must be between 5 and 300.[optional]
userPresentCheckBooleanA boolean value indicating if user presence is checked by the passkey/FIDO2 token.[optional]

RegistrationAuthenticatorAttachmentEnum

NameValue
EITHER"EITHER"
PLATFORM"PLATFORM"
CROSS_PLATFORM"CROSS_PLATFORM"

RegistrationRequireResidentKeyEnum

NameValue
DISCOURAGED"DISCOURAGED"
PREFERRED"PREFERRED"
REQUIRED"REQUIRED"

RegistrationUserVerificationEnum

NameValue
DISCOURAGED"DISCOURAGED"
PREFERRED"PREFERRED"
REQUIRED"REQUIRED"