References
TOTP Types
Type Aliases
APIInterface
type APIInterface = object;
Defined in: recipe/totp/types.ts:149
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:150 |
| listDevicesGET | | undefined | (input) => Promise< | { devices: object[]; status: "OK"; } | GeneralErrorResponse> | recipe/totp/types.ts:170 |
| removeDevicePOST | | undefined | (input) => Promise< | { didDeviceExist: boolean; status: "OK"; } | GeneralErrorResponse> | recipe/totp/types.ts:185 |
| 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:200 |
| 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:228 |
APIOptions
type APIOptions = object;
Defined in: recipe/totp/types.ts:140
Properties
| Property | Type | Defined in |
|---|---|---|
| config | TypeNormalisedInput | recipe/totp/types.ts:142 |
| isInServerlessEnv | boolean | recipe/totp/types.ts:144 |
| recipeId | string | recipe/totp/types.ts:143 |
| recipeImplementation | RecipeInterface | recipe/totp/types.ts:141 |
| req | BaseRequest | recipe/totp/types.ts:145 |
| res | BaseResponse | recipe/totp/types.ts:146 |
RecipeInterface
type RecipeInterface = object;
Defined in: recipe/totp/types.ts:49
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:58 |
| getUserIdentifierInfoForUserId | (input) => Promise< | { info: string; status: "OK"; } | { status: "UNKNOWN_USER_ID_ERROR" | "USER_IDENTIFIER_INFO_DOES_NOT_EXIST_ERROR"; }> | recipe/totp/types.ts:50 |
| listDevices | (input) => Promise<{ devices: object[]; status: "OK"; }> | recipe/totp/types.ts:87 |
| removeDevice | (input) => Promise<{ didDeviceExist: boolean; status: "OK"; }> | recipe/totp/types.ts:96 |
| updateDevice | (input) => Promise<{ status: "OK" | "UNKNOWN_DEVICE_ERROR" | "DEVICE_ALREADY_EXISTS_ERROR"; }> | recipe/totp/types.ts:79 |
| 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:100 |
| 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:124 |
TypeInput
type TypeInput = object;
Defined in: recipe/totp/types.ts:21
Properties
| Property | Type | Defined in |
|---|---|---|
| defaultPeriod? | number | recipe/totp/types.ts:24 |
| defaultSkew? | number | recipe/totp/types.ts:23 |
| issuer? | string | recipe/totp/types.ts:22 |
| override? | object | recipe/totp/types.ts:26 |
| override.apis? | (originalImplementation, builder) => APIInterface | recipe/totp/types.ts:31 |
| override.functions? | (originalImplementation, builder) => RecipeInterface | recipe/totp/types.ts:27 |
TypeNormalisedInput
type TypeNormalisedInput = object;
Defined in: recipe/totp/types.ts:35
Properties
| Property | Type | Defined in |
|---|---|---|
| defaultPeriod | number | recipe/totp/types.ts:38 |
| defaultSkew | number | recipe/totp/types.ts:37 |
| issuer | string | recipe/totp/types.ts:36 |
| override | object | recipe/totp/types.ts:40 |
| override.apis | (originalImplementation, builder) => APIInterface | recipe/totp/types.ts:45 |
| override.functions | (originalImplementation, builder) => RecipeInterface | recipe/totp/types.ts:41 |