Skip to main content

FIDORegisterChallenge

A FIDORegisterChallenge defines the information returned when a user starts to register a FIDO token.

Properties

NameTypeDescriptionNotes
challengeStringThe registration challenge generated by Identity as a Service. This is a base-64 encoded value.[optional]
registeredCredentialsList<String>The IDs of FIDO tokens already registered to this user. These values are base-64 encoded.[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]
rpNameStringThe name of this relying party. This is the name of the Identity as a Service account.[optional]
timeoutIntegerThe time in seconds that the client will wait for the FIDO token to respond.[optional]
userDisplayNameStringThe display name of this user. It will be 'firstname lastname' of the user[optional]
userIdStringThe id of this user. It will be UUID of the user base-64 encoded.[optional]
userNameStringThe name of this user. It will be the userId of the user.[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"