Authentication Challenge

An object representing a Challenge of an Authentication Factor.

Example Authentication Challenge

 const challenge = {
  object: 'authentication_challenge',
  id: 'auth_challenge_01FVYZWQTZQ5VB6BC5MPG2EYC5',
  createdAt: '2022-02-15T15:26:53.274Z',
  updatedAt: '2022-02-15T15:26:53.274Z',
  expiresAt: '2022-02-15T15:36:53.279Z',
  authenticationFactorId: 'auth_factor_01FVYZ5QM8N98T9ME5BCB2BBMJ',
};

`interface Challenge`

Challenge Factor

Creates a Challenge for an Authentication Factor.

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

const workos = new WorkOS('sk_example_123456789');

const challenge = await workos.mfa.challengeFactor({
  authenticationFactorId: 'auth_factor_01FZ4TS14D1PHFNZ9GF6YD8M1F',
  smsTemplate: 'Your code is {{code}}',
});

`mfa.challengeFactor()`

`Parameters` `object`

`Returns`

Challenge

Verify Challenge

Verify Authentication Challenge.

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

const workos = new WorkOS('sk_example_123456789');

const { challenge, valid } = await workos.mfa.verifyChallenge({
  authenticationChallengeId: 'auth_challenge_01FVYZWQTZQ5VB6BC5MPG2EYC5',
  code: '123456',
});

`mfa.verifyChallenge()`

`Parameters` `object`

`Returns` `object`

OrganizationContinue to the next section

Up next

Authentication Challenge

interface Challenge

object: "authentication_challenge"

id: string

createdAt: string

updatedAt: string

expiresAt: string

authenticationFactorId: string

Challenge Factor

mfa.challengeFactor()

Parameters object

authenticationFactorId: string

smsTemplate?: string

Returns

Verify Challenge

mfa.verifyChallenge()

Parameters object

authenticationChallengeId: string

code: string

Returns object

challenge: Challenge

valid: boolean

`interface Challenge`

`mfa.challengeFactor()`

`Parameters` `object`

`Returns`

`mfa.verifyChallenge()`

`Parameters` `object`

`Returns` `object`