WebAuthn Types

Type Aliases

AuthenticationOptions

type AuthenticationOptions = object;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:116

Properties

Property	Type	Defined in
challenge	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:119
fetchResponse	Response	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:122
status	"OK"	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:117
timeout	number	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:120
userVerification	UserVerification	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:121
webauthnGeneratedOptionsId	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:118

CredentialPayload

type CredentialPayload = object;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:68

Properties

Property	Type	Defined in
authenticatorAttachment	"platform" | "cross-platform"	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:77
clientExtensionResults	any	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:78
id	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:69
rawId	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:70
response	object	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:71
response.attestationObject	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:73
response.clientDataJSON	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:72
response.transports?	("ble" | "cable" | "hybrid" | "internal" | "nfc" | "smart-card" | "usb")[]	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:74
response.userHandle	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:75
type	"public-key"	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:79

InputType

type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:57

NormalisedInputType

type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:59

Type Declaration

Name	Type	Defined in
override	object	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:60
override.functions()	(originalImplementation, builder) => RecipeInterface	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:61

PostAPIHookContext

type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:43

PreAndPostAPIHookAction

type PreAndPostAPIHookAction = 
  | "REGISTER_OPTIONS"
  | "SIGN_IN_OPTIONS"
  | "SIGN_UP"
  | "SIGN_IN"
  | "EMAIL_EXISTS"
  | "GENERATE_RECOVER_ACCOUNT_TOKEN"
  | "RECOVER_ACCOUNT"
  | "LIST_CREDENTIALS"
  | "REMOVE_CREDENTIAL"
  | "REGISTER_CREDENTIAL";

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:30

PreAPIHookContext

type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:42

RecipeInterface

type RecipeInterface = object;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:125

Properties

Property	Type	Defined in
authenticateCredential	(input) => Promise< | { authenticationResponse: AuthenticationResponseJSON; status: "OK"; } | { error: any; status: "FAILED_TO_AUTHENTICATE_USER"; } | { error: any; status: "WEBAUTHN_NOT_SUPPORTED"; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:251
authenticateCredentialWithSignIn	(input) => Promise< | { fetchResponse: Response; status: "OK"; user: User; } | { fetchResponse: Response; status: "INVALID_OPTIONS_ERROR"; } | { fetchResponse: Response; status: "INVALID_CREDENTIALS_ERROR"; } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED"; } | { error: any; status: "FAILED_TO_AUTHENTICATE_USER"; } | { error: any; status: "WEBAUTHN_NOT_SUPPORTED"; } | GeneralErrorResponse>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:293
createAndRegisterCredentialForSessionUser	(input) => Promise< | { fetchResponse: Response; status: "OK"; } | GeneralErrorResponse | { reason?: string; status: "REGISTER_CREDENTIAL_NOT_ALLOWED"; } | { err: string; status: "INVALID_EMAIL_ERROR"; } | { status: "INVALID_CREDENTIALS_ERROR"; } | { status: "OPTIONS_NOT_FOUND_ERROR"; } | { status: "INVALID_OPTIONS_ERROR"; } | { reason?: string; status: "INVALID_AUTHENTICATOR_ERROR"; } | { status: "AUTHENTICATOR_ALREADY_REGISTERED"; } | { error: any; status: "FAILED_TO_REGISTER_USER"; } | { error: any; status: "WEBAUTHN_NOT_SUPPORTED"; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:338
createCredential	(input) => Promise< | { registrationResponse: RegistrationResponseJSON; status: "OK"; } | { status: "AUTHENTICATOR_ALREADY_REGISTERED"; } | { error: any; status: "FAILED_TO_REGISTER_USER"; } | { error: any; status: "WEBAUTHN_NOT_SUPPORTED"; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:239
doesBrowserSupportWebAuthn	(input) => Promise< | { browserSupportsWebauthn: boolean; platformAuthenticatorIsAvailable: boolean; status: "OK"; } | { error: any; status: "ERROR"; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:406
generateRecoverAccountToken	(input) => Promise< | { fetchResponse: Response; status: "OK"; } | { fetchResponse: Response; reason: string; status: "RECOVER_ACCOUNT_NOT_ALLOWED"; } | GeneralErrorResponse>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:207
getEmailExists	(input) => Promise< | { exists: boolean; fetchResponse: Response; status: "OK"; } | GeneralErrorResponse>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:199
getRegisterOptions	(input) => Promise< | RegistrationOptions | { fetchResponse: Response; status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"; } | { err: string; fetchResponse: Response; status: "INVALID_EMAIL_ERROR"; } | { fetchResponse: Response; status: "INVALID_OPTIONS_ERROR"; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:126
getSignInOptions	(input) => Promise< | AuthenticationOptions | { fetchResponse: Response; status: "INVALID_OPTIONS_ERROR"; } | GeneralErrorResponse>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:147
listCredentials	(input) => Promise< | { credentials: object[]; fetchResponse: Response; status: "OK"; } | GeneralErrorResponse>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:359
recoverAccount	(input) => Promise< | { email: string; fetchResponse: Response; status: "OK"; user: User; } | GeneralErrorResponse | { fetchResponse: Response; status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"; } | { fetchResponse: Response; status: "INVALID_CREDENTIALS_ERROR"; } | { fetchResponse: Response; status: "OPTIONS_NOT_FOUND_ERROR"; } | { fetchResponse: Response; status: "INVALID_OPTIONS_ERROR"; } | { fetchResponse: Response; reason: string; status: "INVALID_AUTHENTICATOR_ERROR"; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:219
registerCredential	(input) => Promise< | { fetchResponse: Response; status: "OK"; } | GeneralErrorResponse | { fetchResponse: Response; reason?: string; status: "REGISTER_CREDENTIAL_NOT_ALLOWED"; } | { fetchResponse: Response; status: "INVALID_CREDENTIALS_ERROR"; } | { fetchResponse: Response; status: "OPTIONS_NOT_FOUND_ERROR"; } | { fetchResponse: Response; status: "INVALID_OPTIONS_ERROR"; } | { fetchResponse: Response; reason?: string; status: "INVALID_AUTHENTICATOR_ERROR"; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:384
registerCredentialWithRecoverAccount	(input) => Promise< | { email: string; fetchResponse: Response; status: "OK"; user: User; } | { fetchResponse: Response; status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"; } | { fetchResponse: Response; status: "INVALID_OPTIONS_ERROR"; } | GeneralErrorResponse | { fetchResponse: Response; status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"; } | { fetchResponse: Response; status: "INVALID_CREDENTIALS_ERROR"; } | { fetchResponse: Response; status: "OPTIONS_NOT_FOUND_ERROR"; } | { fetchResponse: Response; reason: string; status: "INVALID_AUTHENTICATOR_ERROR"; } | { status: "AUTHENTICATOR_ALREADY_REGISTERED"; } | { error: any; status: "FAILED_TO_REGISTER_USER"; } | { error: any; status: "WEBAUTHN_NOT_SUPPORTED"; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:310
registerCredentialWithSignUp	(input) => Promise< | { fetchResponse: Response; status: "OK"; user: User; } | { err: string; fetchResponse: Response; status: "INVALID_EMAIL_ERROR"; } | GeneralErrorResponse | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED"; } | { fetchResponse: Response; status: "INVALID_CREDENTIALS_ERROR"; } | { fetchResponse: Response; status: "OPTIONS_NOT_FOUND_ERROR"; } | { fetchResponse: Response; status: "INVALID_OPTIONS_ERROR"; } | { fetchResponse: Response; reason: string; status: "INVALID_AUTHENTICATOR_ERROR"; } | { fetchResponse: Response; status: "EMAIL_ALREADY_EXISTS_ERROR"; } | { status: "AUTHENTICATOR_ALREADY_REGISTERED"; } | { error: any; status: "FAILED_TO_REGISTER_USER"; } | { error: any; status: "WEBAUTHN_NOT_SUPPORTED"; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:262
removeCredential	(input) => Promise< | { fetchResponse: Response; status: "OK"; } | GeneralErrorResponse | { fetchResponse: Response; status: "CREDENTIAL_NOT_FOUND_ERROR"; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:372
signIn	(input) => Promise< | { fetchResponse: Response; status: "OK"; user: User; } | { fetchResponse: Response; status: "INVALID_CREDENTIALS_ERROR"; } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED"; } | GeneralErrorResponse>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:179
signUp	(input) => Promise< | { fetchResponse: Response; status: "OK"; user: User; } | GeneralErrorResponse | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED"; } | { fetchResponse: Response; status: "INVALID_CREDENTIALS_ERROR"; } | { fetchResponse: Response; status: "OPTIONS_NOT_FOUND_ERROR"; } | { fetchResponse: Response; status: "INVALID_OPTIONS_ERROR"; } | { fetchResponse: Response; reason: string; status: "INVALID_AUTHENTICATOR_ERROR"; } | { fetchResponse: Response; status: "EMAIL_ALREADY_EXISTS_ERROR"; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:155

RegistrationOptions

type RegistrationOptions = object;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:82

Properties

Property	Type	Defined in
attestation	"none" | "indirect" | "direct" | "enterprise"	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:103
authenticatorSelection	object	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:108
authenticatorSelection.requireResidentKey	boolean	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:109
authenticatorSelection.residentKey	ResidentKey	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:110
authenticatorSelection.userVerification	UserVerification	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:111
challenge	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:96
createdAt	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:85
excludeCredentials	object[]	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:98
expiresAt	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:86
fetchResponse	Response	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:113
pubKeyCredParams	object[]	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:104
rp	object	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:87
rp.id	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:88
rp.name	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:89
status	"OK"	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:83
timeout	number	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:97
user	object	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:91
user.displayName	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:94
user.id	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:92
user.name	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:93
webauthnGeneratedOptionsId	string	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:84

ResidentKey

type ResidentKey = "required" | "preferred" | "discouraged";

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:45

UserInput

type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:48

Type Declaration

Name	Type	Defined in
override?	object	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:49
override.functions()?	(originalImplementation, builder) => RecipeInterface	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:50

UserVerification

type UserVerification = "required" | "preferred" | "discouraged";

Defined in: tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:46