Authentication Factor

An object representing an Authentication Factor.

Enroll Factor

Enrolls an Authentication Factor to be used as an additional factor of authentication. The returned ID should be used to create an authentication Challenge.

 import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

const factor = await workos.mfa.enrollFactor({
  type: 'totp',
  issuer: 'Foo Corp',
  user: 'alan.turing@example.com',
});

POST

`/auth/factors/enroll`

`Returns`

Get Factor

Gets an Authentication Factor.

 import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

const factor = await workos.mfa.getFactor(
  'auth_factor_01FVYZ5QM8N98T9ME5BCB2BBMJ',
);

GET

`/auth/factors/:id`

`Parameters`

`Returns`

Delete Factor

Permanently deletes an Authentication Factor. It cannot be undone.

Request

 import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

await workos.mfa.deleteFactor('auth_factor_01FVYZ5QM8N98T9ME5BCB2BBMJ');

DELETE

`/auth/factors/:id`

`Parameters`

`Returns`

ChallengeContinue to the next section

Up next

Authentication Factor

Enroll Factor

/auth/factors/enroll

type: "generic_otp" | "sms" | "totp"

phone_number?: string

totp_issuer?: string

totp_user?: string

user_id?: string

Returns

authentication_factor: object

Get Factor

/auth/factors/:id

Parameters

id: string

Returns

authentication_factor: object

Delete Factor

/auth/factors/:id

Parameters

id: string

Returns

empty: empty

`/auth/factors/enroll`

`Returns`

`/auth/factors/:id`

`Parameters`

`Returns`

`/auth/factors/:id`

`Parameters`

`Returns`