Go to developer

SDKs / typescript / partner-2fa

enable2FA()

SERVERmethod@keyra/typescript-sdk

Starts enrollment and returns enrollmentUrl. The SDK also exposes qrCode as an alias of enrollmentUrl (URL string, not an image).

Signature

TypeScript
await partner.enable2FA(externalUserId, { returnUrl? })

Type signature

TypeScript
enable2FA(externalUserId: string, opts?: Enable2FAOptions): Promise<EnrollmentSession>

Parameters

ParameterTypeRequiredDescription
externalUserIdstringRequired
optsEnable2FAOptionsOptionalDefault: {}

Returns

Promise<EnrollmentSession>

SDK behavior

  • Maps enrollmentUrl → qrCode for QR rendering helpers.

Underlying API