Enroll an MFA factor

POST/auth/factors

Enrolls a TOTP, phone, or WebAuthn factor for the current user.

Parameters

MFAEnrollParams

factorType'totp' | 'phone' | 'webauthn': The factor type to enroll.
friendlyName?string: A user-facing name for the factor.
issuer?string: Issuer used for a TOTP factor.
phone?string: Required by the phone-factor overload.

Returns

idstring
type"totp" | "phone" | "webauthn"
friendly_name?string
totp?TotpObject
phone?string

1import { Jupiter } from '@jupiter-cloud/sdk'2 3const client = new Jupiter(4  'https://api.jupitercloud.co',5  'project-id'6)7 8const result = await client.auth.mfa.enroll({9  factorType: 'totp',10  friendlyName: 'Authenticator app'11})12 13if (result.error) {14  throw result.error15}16 17console.log(result)

Response

200

1{2  "data": {3    "id": "00000000-0000-4000-8000-000000000002",4    "type": "totp",5    "friendly_name": "Authenticator app",6    "totp": {7      "qr_code": "<svg>...</svg>",8      "secret": "JBSWY3DPEHPK3PXP",9      "uri": "otpauth://totp/Jupiter:user@example.com"10    }11  },12  "error": null13}