Add authenticateWithTotp method (#856)

jonatascastro12 · web-flow · commit 387d60b04530 · 2023-09-05T16:26:17.000-03:00
## Description ## Documentation Does this require changes to the WorkOS Docs? E.g. the [API Reference](https://workos.com/docs/reference) or code snippets need updates. ``` [ ] Yes ``` If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.
diff --git a/src/users/interfaces/authenticate-with-code-options.interface.ts b/src/users/interfaces/authenticate-with-code-options.interface.ts
@@ -1,4 +1,4 @@
-export interface AuthenticateUserWithCodeOptions {
+export interface AuthenticateWithCodeOptions {
   clientId: string;
   code: string;
 }
@@ -7,7 +7,7 @@ export interface AuthenticateUserWithCodeCredentials {
   clientSecret: string | undefined;
 }
 
-export interface SerializedAuthenticateUserWithCodeOptions {
+export interface SerializedAuthenticateWithCodeOptions {
   grant_type: 'authorization_code';
   client_id: string;
   client_secret: string | undefined;
diff --git a/src/users/interfaces/authenticate-with-magic-auth-options.interface.ts b/src/users/interfaces/authenticate-with-magic-auth-options.interface.ts
@@ -1,4 +1,4 @@
-export interface AuthenticateUserWithMagicAuthOptions {
+export interface AuthenticateWithMagicAuthOptions {
   clientId: string;
   code: string;
   userId: string;
@@ -10,7 +10,7 @@ export interface AuthenticateUserWithMagicAuthCredentials {
   clientSecret: string | undefined;
 }
 
-export interface SerializedAuthenticateUserWithMagicAuthOptions {
+export interface SerializedAuthenticateWithMagicAuthOptions {
   grant_type: 'urn:workos:oauth:grant-type:magic-auth:code';
   client_id: string;
   client_secret: string | undefined;
diff --git a/src/users/interfaces/authenticate-with-password-options.interface.ts b/src/users/interfaces/authenticate-with-password-options.interface.ts
@@ -1,4 +1,4 @@
-export interface AuthenticateUserWithPasswordOptions {
+export interface AuthenticateWithPasswordOptions {
   clientId: string;
   email: string;
   password: string;
@@ -10,7 +10,7 @@ export interface AuthenticateUserWithPasswordCredentials {
   clientSecret: string | undefined;
 }
 
-export interface SerializedAuthenticateUserWithPasswordOptions {
+export interface SerializedAuthenticateWithPasswordOptions {
   grant_type: 'password';
   client_id: string;
   client_secret: string | undefined;
diff --git a/src/users/interfaces/authenticate-with-totp-options.interface.ts b/src/users/interfaces/authenticate-with-totp-options.interface.ts
@@ -0,0 +1,19 @@
+export interface AuthenticateWithTotpOptions {
+  clientId: string;
+  code: string;
+  pendingAuthenticationToken: string;
+  authenticationChallengeId: string;
+}
+
+export interface AuthenticateUserWithTotpCredentials {
+  clientSecret: string | undefined;
+}
+
+export interface SerializedAuthenticateWithTotpOptions {
+  grant_type: 'urn:workos:oauth:grant-type:mfa-totp';
+  client_id: string;
+  client_secret: string | undefined;
+  code: string;
+  pending_authentication_token: string;
+  authentication_challenge_id: string;
+}
diff --git a/src/users/interfaces/index.ts b/src/users/interfaces/index.ts
@@ -1,7 +1,7 @@
 export * from './add-user-to-organization-options.interface';
-export * from './authenticate-user-with-magic-auth-options.interface';
-export * from './authenticate-user-with-password-options.interface';
-export * from './authenticate-user-with-token-options.interface';
+export * from './authenticate-with-magic-auth-options.interface';
+export * from './authenticate-with-password-options.interface';
+export * from './authenticate-with-code-options.interface';
 export * from './authentication-response.interface';
 export * from './reset-password-options.interface';
 export * from './send-password-reset-options.interface';
diff --git a/src/users/serializers/authenticate-user-with-code-options.serializer.ts b/src/users/serializers/authenticate-user-with-code-options.serializer.ts
diff --git a/src/users/serializers/authenticate-with-code-options.serializer.ts b/src/users/serializers/authenticate-with-code-options.serializer.ts
@@ -0,0 +1,14 @@
+import {
+  AuthenticateUserWithCodeCredentials,
+  AuthenticateWithCodeOptions,
+  SerializedAuthenticateWithCodeOptions,
+} from '../interfaces';
+
+export const serializeAuthenticateWithCodeOptions = (
+  options: AuthenticateWithCodeOptions & AuthenticateUserWithCodeCredentials,
+): SerializedAuthenticateWithCodeOptions => ({
+  grant_type: 'authorization_code',
+  client_id: options.clientId,
+  client_secret: options.clientSecret,
+  code: options.code,
+});
diff --git a/src/users/serializers/authenticate-with-magic-auth-options.serializer.ts b/src/users/serializers/authenticate-with-magic-auth-options.serializer.ts
@@ -1,13 +1,13 @@
 import {
   AuthenticateUserWithMagicAuthCredentials,
-  AuthenticateUserWithMagicAuthOptions,
-  SerializedAuthenticateUserWithMagicAuthOptions,
+  AuthenticateWithMagicAuthOptions,
+  SerializedAuthenticateWithMagicAuthOptions,
 } from '../interfaces';
 
-export const serializeAuthenticateUserWithMagicAuthOptions = (
-  options: AuthenticateUserWithMagicAuthOptions &
+export const serializeAuthenticateWithMagicAuthOptions = (
+  options: AuthenticateWithMagicAuthOptions &
     AuthenticateUserWithMagicAuthCredentials,
-): SerializedAuthenticateUserWithMagicAuthOptions => ({
+): SerializedAuthenticateWithMagicAuthOptions => ({
   grant_type: 'urn:workos:oauth:grant-type:magic-auth:code',
   client_id: options.clientId,
   client_secret: options.clientSecret,
diff --git a/src/users/serializers/authenticate-with-password-options.serializer.ts b/src/users/serializers/authenticate-with-password-options.serializer.ts
@@ -1,13 +1,13 @@
 import {
   AuthenticateUserWithPasswordCredentials,
-  AuthenticateUserWithPasswordOptions,
-  SerializedAuthenticateUserWithPasswordOptions,
+  AuthenticateWithPasswordOptions,
+  SerializedAuthenticateWithPasswordOptions,
 } from '../interfaces';
 
-export const serializeAuthenticateUserWithPasswordOptions = (
-  options: AuthenticateUserWithPasswordOptions &
+export const serializeAuthenticateWithPasswordOptions = (
+  options: AuthenticateWithPasswordOptions &
     AuthenticateUserWithPasswordCredentials,
-): SerializedAuthenticateUserWithPasswordOptions => ({
+): SerializedAuthenticateWithPasswordOptions => ({
   grant_type: 'password',
   client_id: options.clientId,
   client_secret: options.clientSecret,
diff --git a/src/users/serializers/authenticate-with-totp-options.serializer.ts b/src/users/serializers/authenticate-with-totp-options.serializer.ts
@@ -0,0 +1,17 @@
+import {} from '../interfaces';
+import {
+  AuthenticateUserWithTotpCredentials,
+  AuthenticateWithTotpOptions,
+  SerializedAuthenticateWithTotpOptions,
+} from '../interfaces/authenticate-with-totp-options.interface';
+
+export const serializeAuthenticateWithTotpOptions = (
+  options: AuthenticateWithTotpOptions & AuthenticateUserWithTotpCredentials,
+): SerializedAuthenticateWithTotpOptions => ({
+  grant_type: 'urn:workos:oauth:grant-type:mfa-totp',
+  client_id: options.clientId,
+  client_secret: options.clientSecret,
+  code: options.code,
+  authentication_challenge_id: options.authenticationChallengeId,
+  pending_authentication_token: options.pendingAuthenticationToken,
+});
diff --git a/src/users/serializers/index.ts b/src/users/serializers/index.ts
@@ -1,6 +1,6 @@
-export * from './authenticate-user-with-code-options.serializer';
-export * from './authenticate-user-with-magic-auth-options.serializer';
-export * from './authenticate-user-with-password-options.serializer';
+export * from './authenticate-with-code-options.serializer';
+export * from './authenticate-with-magic-auth-options.serializer';
+export * from './authenticate-with-password-options.serializer';
 export * from './authentication-response.serializer';
 export * from './reset-password-options.serializer';
 export * from './send-password-reset-email.serializer';
diff --git a/src/users/users.spec.ts b/src/users/users.spec.ts
@@ -96,7 +96,7 @@ describe('UserManagement', () => {
         user: userFixture,
       });
 
-      const resp = await workos.users.authenticateUserWithMagicAuth({
+      const resp = await workos.users.authenticateWithMagicAuth({
         clientId: 'proj_whatever',
         code: '123456',
         userId: userFixture.id,
@@ -116,7 +116,7 @@ describe('UserManagement', () => {
       mock.onPost('/users/authenticate').reply(200, {
         user: userFixture,
       });
-      const resp = await workos.users.authenticateUserWithPassword({
+      const resp = await workos.users.authenticateWithPassword({
         clientId: 'proj_whatever',
         email: 'test01@example.com',
         password: 'extra-secure',
@@ -134,7 +134,7 @@ describe('UserManagement', () => {
   describe('authenticateUserWithCode', () => {
     it('sends a token authentication request', async () => {
       mock.onPost('/users/authenticate').reply(200, { user: userFixture });
-      const resp = await workos.users.authenticateUserWithCode({
+      const resp = await workos.users.authenticateWithCode({
         clientId: 'proj_whatever',
         code: 'or this',
       });
@@ -153,6 +153,35 @@ describe('UserManagement', () => {
     });
   });
 
+  describe('authenticateUserWithTotp', () => {
+    it('sends a token authentication request', async () => {
+      mock.onPost('/users/authenticate').reply(200, { user: userFixture });
+      const resp = await workos.users.authenticateWithTotp({
+        clientId: 'proj_whatever',
+        code: 'or this',
+        authenticationChallengeId: 'auth_challenge_01H96FETXGTW1QMBSBT2T36PW0',
+        pendingAuthenticationToken: 'cTDQJTTkTkkVYxQUlKBIxEsFs',
+      });
+
+      expect(mock.history.post[0].url).toEqual('/users/authenticate');
+      expect(JSON.parse(mock.history.post[0].data)).toMatchObject({
+        client_id: 'proj_whatever',
+        code: 'or this',
+        client_secret: 'sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU',
+        grant_type: 'urn:workos:oauth:grant-type:mfa-totp',
+        authentication_challenge_id:
+          'auth_challenge_01H96FETXGTW1QMBSBT2T36PW0',
+        pending_authentication_token: 'cTDQJTTkTkkVYxQUlKBIxEsFs',
+      });
+
+      expect(resp).toMatchObject({
+        user: {
+          email: 'test01@example.com',
+        },
+      });
+    });
+  });
+
   describe('sendVerificationEmail', () => {
     it('sends a Create Email Verification Challenge request', async () => {
       mock
diff --git a/src/users/users.ts b/src/users/users.ts
@@ -2,9 +2,9 @@ import { WorkOS } from '../workos';
 import { AutoPaginatable } from '../common/utils/pagination';
 import {
   AddUserToOrganizationOptions,
-  AuthenticateUserWithCodeOptions,
-  AuthenticateUserWithMagicAuthOptions,
-  AuthenticateUserWithPasswordOptions,
+  AuthenticateWithCodeOptions,
+  AuthenticateWithMagicAuthOptions,
+  AuthenticateWithPasswordOptions,
   AuthenticationResponse,
   AuthenticationResponseResponse,
   ResetPasswordOptions,
@@ -18,9 +18,9 @@ import {
   SendMagicAuthCodeOptions,
   SendVerificationEmailOptions,
   SerializedAddUserToOrganizationOptions,
-  SerializedAuthenticateUserWithCodeOptions,
-  SerializedAuthenticateUserWithMagicAuthOptions,
-  SerializedAuthenticateUserWithPasswordOptions,
+  SerializedAuthenticateWithCodeOptions,
+  SerializedAuthenticateWithMagicAuthOptions,
+  SerializedAuthenticateWithPasswordOptions,
   SerializedResetPasswordOptions,
   SerializedSendPasswordResetEmailOptions,
   SerializedCreateUserOptions,
@@ -33,13 +33,17 @@ import {
   VerifyEmailCodeOptions,
   SendPasswordResetEmailResponseResponse,
 } from './interfaces';
+import {
+  AuthenticateWithTotpOptions,
+  SerializedAuthenticateWithTotpOptions,
+} from './interfaces/authenticate-with-totp-options.interface';
 import {
   deserializeAuthenticationResponse,
   deserializeSendPasswordResetEmailResponse,
   deserializeUser,
-  serializeAuthenticateUserWithMagicAuthOptions,
-  serializeAuthenticateUserWithPasswordOptions,
-  serializeAuthenticateUserWithCodeOptions,
+  serializeAuthenticateWithMagicAuthOptions,
+  serializeAuthenticateWithPasswordOptions,
+  serializeAuthenticateWithCodeOptions,
   serializeResetPasswordOptions,
   serializeSendPasswordResetEmailOptions,
   serializeCreateUserOptions,
@@ -55,6 +59,7 @@ import {
   FactorResponse,
 } from '../mfa/interfaces';
 import { deserializeChallenge, deserializeFactor } from '../mfa/serializers';
+import { serializeAuthenticateWithTotpOptions } from './serializers/authenticate-with-totp-options.serializer';
 import { serializeEnrollUserInMfaFactorOptions } from './serializers/enroll-user-in-mfa-factor-options.serializer';
 
 export class Users {
@@ -95,16 +100,34 @@ export class Users {
     return deserializeUser(data);
   }
 
-  async authenticateUserWithMagicAuth(
-    payload: AuthenticateUserWithMagicAuthOptions,
+  async authenticateWithMagicAuth(
+    payload: AuthenticateWithMagicAuthOptions,
+  ): Promise<AuthenticationResponse> {
+    const { data } = await this.workos.post<
+      AuthenticationResponseResponse,
+      any,
+      SerializedAuthenticateWithMagicAuthOptions
+    >(
+      '/users/authenticate',
+      serializeAuthenticateWithMagicAuthOptions({
+        ...payload,
+        clientSecret: this.workos.key,
+      }),
+    );
+
+    return deserializeAuthenticationResponse(data);
+  }
+
+  async authenticateWithPassword(
+    payload: AuthenticateWithPasswordOptions,
   ): Promise<AuthenticationResponse> {
     const { data } = await this.workos.post<
       AuthenticationResponseResponse,
       any,
-      SerializedAuthenticateUserWithMagicAuthOptions
+      SerializedAuthenticateWithPasswordOptions
     >(
       '/users/authenticate',
-      serializeAuthenticateUserWithMagicAuthOptions({
+      serializeAuthenticateWithPasswordOptions({
         ...payload,
         clientSecret: this.workos.key,
       }),
@@ -113,16 +136,16 @@ export class Users {
     return deserializeAuthenticationResponse(data);
   }
 
-  async authenticateUserWithPassword(
-    payload: AuthenticateUserWithPasswordOptions,
+  async authenticateWithCode(
+    payload: AuthenticateWithCodeOptions,
   ): Promise<AuthenticationResponse> {
     const { data } = await this.workos.post<
       AuthenticationResponseResponse,
       any,
-      SerializedAuthenticateUserWithPasswordOptions
+      SerializedAuthenticateWithCodeOptions
     >(
       '/users/authenticate',
-      serializeAuthenticateUserWithPasswordOptions({
+      serializeAuthenticateWithCodeOptions({
         ...payload,
         clientSecret: this.workos.key,
       }),
@@ -131,16 +154,16 @@ export class Users {
     return deserializeAuthenticationResponse(data);
   }
 
-  async authenticateUserWithCode(
-    payload: AuthenticateUserWithCodeOptions,
+  async authenticateWithTotp(
+    payload: AuthenticateWithTotpOptions,
   ): Promise<AuthenticationResponse> {
     const { data } = await this.workos.post<
       AuthenticationResponseResponse,
       any,
-      SerializedAuthenticateUserWithCodeOptions
+      SerializedAuthenticateWithTotpOptions
     >(
       '/users/authenticate',
-      serializeAuthenticateUserWithCodeOptions({
+      serializeAuthenticateWithTotpOptions({
         ...payload,
         clientSecret: this.workos.key,
       }),

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-export interface AuthenticateUserWithCodeOptions {`
	`1`	`+export interface AuthenticateWithCodeOptions {`
`2`	`2`	`clientId: string;`
`3`	`3`	`code: string;`
`4`	`4`	`}`
`@@ -7,7 +7,7 @@ export interface AuthenticateUserWithCodeCredentials {`
`7`	`7`	`clientSecret: string \| undefined;`
`8`	`8`	`}`
`9`	`9`
`10`		`-export interface SerializedAuthenticateUserWithCodeOptions {`
	`10`	`+export interface SerializedAuthenticateWithCodeOptions {`
`11`	`11`	`grant_type: 'authorization_code';`
`12`	`12`	`client_id: string;`
`13`	`13`	`client_secret: string \| undefined;`