supertokens-web-js/recipe/webauthn/types

References documentation for the supertokens-web-js/recipe/webauthn/types package

Type Aliases

AuthenticationOptions

type AuthenticationOptions = object;

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

Properties

Property	Type	Defined in
`challenge`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`fetchResponse`	`Response`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`status`	`"OK"`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`timeout`	`number`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`userVerification`	`UserVerification`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`webauthnGeneratedOptionsId`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts

CredentialPayload

type CredentialPayload = object;

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

Properties

Property	Type	Defined in
`authenticatorAttachment`	`"platform"` \| `"cross-platform"`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`clientExtensionResults`	`any`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`id`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`rawId`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`response`	`object`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`response.attestationObject`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`response.clientDataJSON`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`response.transports?`	(`"ble"` \| `"cable"` \| `"hybrid"` \| `"internal"` \| `"nfc"` \| `"smart-card"` \| `"usb"`)[]	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`response.userHandle`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`type`	`"public-key"`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts

InputType

type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;

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

NormalisedInputType

type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;

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

Type Declaration

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

PostAPIHookContext

type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;

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

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

PreAPIHookContext

type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;

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

RecipeInterface

type RecipeInterface = object;

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

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
`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
`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
`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
`doesBrowserSupportWebAuthn`	(`input`) => `Promise`< \| { `browserSupportsWebauthn`: `boolean`; `platformAuthenticatorIsAvailable`: `boolean`; `status`: `"OK"`; } \| { `error`: `any`; `status`: `"ERROR"`; }>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`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
`getEmailExists`	(`input`) => `Promise`< \| { `exists`: `boolean`; `fetchResponse`: `Response`; `status`: `"OK"`; } \| `GeneralErrorResponse`>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`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
`getSignInOptions`	(`input`) => `Promise`< \| `AuthenticationOptions` \| { `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; } \| `GeneralErrorResponse`>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`listCredentials`	(`input`) => `Promise`< \| { `credentials`: `object`[]; `fetchResponse`: `Response`; `status`: `"OK"`; } \| `GeneralErrorResponse`>	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`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
`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
`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
`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
`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
`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
`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

RegistrationOptions

type RegistrationOptions = object;

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

Properties

Property	Type	Defined in
`attestation`	`"none"` \| `"indirect"` \| `"direct"` \| `"enterprise"`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`authenticatorSelection`	`object`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`authenticatorSelection.requireResidentKey`	`boolean`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`authenticatorSelection.residentKey`	`ResidentKey`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`authenticatorSelection.userVerification`	`UserVerification`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`challenge`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`createdAt`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`excludeCredentials`	`object`[]	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`expiresAt`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`fetchResponse`	`Response`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`pubKeyCredParams`	`object`[]	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`rp`	`object`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`rp.id`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`rp.name`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`status`	`"OK"`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`timeout`	`number`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`user`	`object`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`user.displayName`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`user.id`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`user.name`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts
`webauthnGeneratedOptionsId`	`string`	tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts

ResidentKey

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

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

UserInput

type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;

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

Type Declaration

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

UserVerification

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

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