Class default

constructor

• new default(): default

  Returns default

Staticinit

StaticcreateDevice

• createDevice(
      userId: string,
      userIdentifierInfo?: string,
      deviceName?: string,
      skew?: number,
      period?: number,
      userContext?: Record<string, any>,
  ): Promise<
      | {
          deviceName: string;
          qrCodeString: string;
          secret: string;
          status: "OK";
      }
      | { status: "DEVICE_ALREADY_EXISTS_ERROR" }
      | { status: "UNKNOWN_USER_ID_ERROR" },
  >

  Parameters

  • userId: string
  • OptionaluserIdentifierInfo: string
  • OptionaldeviceName: string
  • Optionalskew: number
  • Optionalperiod: number
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | {
          deviceName: string;
          qrCodeString: string;
          secret: string;
          status: "OK";
      }
      | { status: "DEVICE_ALREADY_EXISTS_ERROR" }
      | { status: "UNKNOWN_USER_ID_ERROR" },
  >

StaticlistDevices

• listDevices(
      userId: string,
      userContext?: Record<string, any>,
  ): Promise<
      {
          devices: {
              name: string;
              period: number;
              skew: number;
              verified: boolean;
          }[];
          status: "OK";
      },
  >

  Parameters

  • userId: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      {
          devices: {
              name: string;
              period: number;
              skew: number;
              verified: boolean;
          }[];
          status: "OK";
      },
  >

StaticremoveDevice

• removeDevice(
      userId: string,
      deviceName: string,
      userContext?: Record<string, any>,
  ): Promise<{ didDeviceExist: boolean; status: "OK" }>

  Parameters

  • userId: string
  • deviceName: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ didDeviceExist: boolean; status: "OK" }>

StaticupdateDevice

• updateDevice(
      userId: string,
      existingDeviceName: string,
      newDeviceName: string,
      userContext?: Record<string, any>,
  ): Promise<
      {
          status: "OK"
          | "DEVICE_ALREADY_EXISTS_ERROR"
          | "UNKNOWN_DEVICE_ERROR";
      },
  >

  Parameters

  • userId: string
  • existingDeviceName: string
  • newDeviceName: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      {
          status: "OK"
          | "DEVICE_ALREADY_EXISTS_ERROR"
          | "UNKNOWN_DEVICE_ERROR";
      },
  >

StaticverifyDevice

• verifyDevice(
      tenantId: string,
      userId: string,
      deviceName: string,
      totp: string,
      userContext?: Record<string, any>,
  ): Promise<
      | { status: "OK"; wasAlreadyVerified: boolean }
      | { status: "UNKNOWN_DEVICE_ERROR" }
      | {
          currentNumberOfFailedAttempts: number;
          maxNumberOfFailedAttempts: number;
          status: "INVALID_TOTP_ERROR";
      }
      | { retryAfterMs: number; status: "LIMIT_REACHED_ERROR" },
  >

  Parameters

  • tenantId: string
  • userId: string
  • deviceName: string
  • totp: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | { status: "OK"; wasAlreadyVerified: boolean }
      | { status: "UNKNOWN_DEVICE_ERROR" }
      | {
          currentNumberOfFailedAttempts: number;
          maxNumberOfFailedAttempts: number;
          status: "INVALID_TOTP_ERROR";
      }
      | { retryAfterMs: number; status: "LIMIT_REACHED_ERROR" },
  >

StaticverifyTOTP

• verifyTOTP(
      tenantId: string,
      userId: string,
      totp: string,
      userContext?: Record<string, any>,
  ): Promise<
      | { status: "OK"
      | "UNKNOWN_USER_ID_ERROR" }
      | {
          currentNumberOfFailedAttempts: number;
          maxNumberOfFailedAttempts: number;
          status: "INVALID_TOTP_ERROR";
      }
      | { retryAfterMs: number; status: "LIMIT_REACHED_ERROR" },
  >

  Parameters

  • tenantId: string
  • userId: string
  • totp: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | { status: "OK"
      | "UNKNOWN_USER_ID_ERROR" }
      | {
          currentNumberOfFailedAttempts: number;
          maxNumberOfFailedAttempts: number;
          status: "INVALID_TOTP_ERROR";
      }
      | { retryAfterMs: number; status: "LIMIT_REACHED_ERROR" },
  >