Skip to content
SuperTokens Docs
Esc
↑↓navigate↵open⌘Jpreview
Dashboard
On this page

supertokens-node/recipe/totp/types

References documentation for the supertokens-node/recipe/totp/types package

Type Aliases

APIInterface

type APIInterface = object;

Defined in: recipe/totp/types.ts

Properties

Property Type Defined in
createDevicePOST | undefined | (input) => Promise< | { deviceName: string; qrCodeString: string; secret: string; status: "OK"; } | { status: "DEVICE_ALREADY_EXISTS_ERROR"; } | GeneralErrorResponse> recipe/totp/types.ts
listDevicesGET | undefined | (input) => Promise< | { devices: object[]; status: "OK"; } | GeneralErrorResponse> recipe/totp/types.ts
removeDevicePOST | undefined | (input) => Promise< | { didDeviceExist: boolean; status: "OK"; } | GeneralErrorResponse> recipe/totp/types.ts
verifyDevicePOST | undefined | (input) => Promise< | { status: "OK"; wasAlreadyVerified: boolean; } | { status: "UNKNOWN_DEVICE_ERROR"; } | { currentNumberOfFailedAttempts: number; maxNumberOfFailedAttempts: number; status: "INVALID_TOTP_ERROR"; } | { retryAfterMs: number; status: "LIMIT_REACHED_ERROR"; } | GeneralErrorResponse> recipe/totp/types.ts
verifyTOTPPOST | undefined | (input) => Promise< | { status: "OK" | "UNKNOWN_USER_ID_ERROR"; } | { currentNumberOfFailedAttempts: number; maxNumberOfFailedAttempts: number; status: "INVALID_TOTP_ERROR"; } | { retryAfterMs: number; status: "LIMIT_REACHED_ERROR"; } | GeneralErrorResponse> recipe/totp/types.ts

APIOptions

type APIOptions = object;

Defined in: recipe/totp/types.ts

Properties

Property Type Defined in
config TypeNormalisedInput recipe/totp/types.ts
isInServerlessEnv boolean recipe/totp/types.ts
recipeId string recipe/totp/types.ts
recipeImplementation RecipeInterface recipe/totp/types.ts
req BaseRequest recipe/totp/types.ts
res BaseResponse recipe/totp/types.ts

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/totp/types.ts

Properties

Property Type Defined in
createDevice (input) => Promise< | { deviceName: string; qrCodeString: string; secret: string; status: "OK"; } | { status: "DEVICE_ALREADY_EXISTS_ERROR"; } | { status: "UNKNOWN_USER_ID_ERROR"; }> recipe/totp/types.ts
getUserIdentifierInfoForUserId (input) => Promise< | { info: string; status: "OK"; } | { status: "UNKNOWN_USER_ID_ERROR" | "USER_IDENTIFIER_INFO_DOES_NOT_EXIST_ERROR"; }> recipe/totp/types.ts
listDevices (input) => Promise<{ devices: object[]; status: "OK"; }> recipe/totp/types.ts
removeDevice (input) => Promise<{ didDeviceExist: boolean; status: "OK"; }> recipe/totp/types.ts
updateDevice (input) => Promise<{ status: "OK" | "UNKNOWN_DEVICE_ERROR" | "DEVICE_ALREADY_EXISTS_ERROR"; }> recipe/totp/types.ts
verifyDevice (input) => Promise< | { status: "OK"; wasAlreadyVerified: boolean; } | { status: "UNKNOWN_DEVICE_ERROR"; } | { currentNumberOfFailedAttempts: number; maxNumberOfFailedAttempts: number; status: "INVALID_TOTP_ERROR"; } | { retryAfterMs: number; status: "LIMIT_REACHED_ERROR"; }> recipe/totp/types.ts
verifyTOTP (input) => Promise< | { status: "OK" | "UNKNOWN_USER_ID_ERROR"; } | { currentNumberOfFailedAttempts: number; maxNumberOfFailedAttempts: number; status: "INVALID_TOTP_ERROR"; } | { retryAfterMs: number; status: "LIMIT_REACHED_ERROR"; }> recipe/totp/types.ts

TypeInput

type TypeInput = object;

Defined in: recipe/totp/types.ts

Properties

Property Type Defined in
defaultPeriod? number recipe/totp/types.ts
defaultSkew? number recipe/totp/types.ts
issuer? string recipe/totp/types.ts
override? object recipe/totp/types.ts
override.apis? (originalImplementation, builder) => APIInterface recipe/totp/types.ts
override.functions? (originalImplementation, builder) => RecipeInterface recipe/totp/types.ts

TypeNormalisedInput

type TypeNormalisedInput = object;

Defined in: recipe/totp/types.ts

Properties

Property Type Defined in
defaultPeriod number recipe/totp/types.ts
defaultSkew number recipe/totp/types.ts
issuer string recipe/totp/types.ts
override object recipe/totp/types.ts
override.apis (originalImplementation, builder) => APIInterface recipe/totp/types.ts
override.functions (originalImplementation, builder) => RecipeInterface recipe/totp/types.ts

API reference

API schema and response details