Add list auth factors method

Author: blairworkos

tests/test_user_management.py

@@ -2,6 +2,7 @@
 
 from tests.utils.fixtures.mock_session import MockSession
 from tests.utils.fixtures.mock_user import MockUser
+from tests.utils.fixtures.mock_auth_factor_totp import MockAuthFactorTotp
 from workos.user_management import UserManagement
 
 
@@ -126,7 +127,6 @@ def mock_magic_auth_challenge_response(self):
 
     @pytest.fixture
     def mock_enroll_auth_factor_response(self):
-
         return {
             "authentication_challenge": {
                 "object": "authentication_challenge",
@@ -150,6 +150,22 @@ def mock_enroll_auth_factor_response(self):
             }
         }
 
+    @pytest.fixture
+    def mock_auth_factors(self):
+        auth_factors_list = [MockAuthFactorTotp(id=str(i)).to_dict() for i in range(2)]
+
+        dict_response = {
+            "data": auth_factors_list,
+            "list_metadata": {"before": None, "after": None},
+            "metadata": {
+                "params": {
+                    "user_id": 'user_12345',
+                },
+                "method": UserManagement.list_auth_factors,
+            },
+        }
+        return dict_response
+
     def test_create_user(self, mock_user, mock_request_method):
         mock_request_method("post", mock_user, 201)
 
@@ -430,3 +446,17 @@ def test_enroll_auth_factor(self, mock_enroll_auth_factor_response, mock_request
         )
 
         assert enroll_auth_factor == mock_enroll_auth_factor_response
+
+    def test_auth_factors_returns_metadata(
+        self,
+        mock_auth_factors,
+        mock_request_method,
+    ):
+        mock_request_method("get", mock_auth_factors, 200)
+
+        auth_factors = self.user_management.list_auth_factors(
+            user="user_12345",
+        )
+
+        dict_auth_factors = auth_factors.to_dict()
+        assert dict_auth_factors["metadata"]["params"]["user_id"] == "user_12345"

tests/utils/fixtures/mock_auth_factor_totp.py

@@ -0,0 +1,25 @@
+import datetime
+from workos.resources.base import WorkOSBaseResource
+
+
+class MockAuthFactorTotp(WorkOSBaseResource):
+    def __init__(self, id):
+        self.object = "authentication_factor"
+        self.id = id
+        self.created_at = datetime.datetime.now()
+        self.updated_at = datetime.datetime.now()
+        self.type = "totp"
+        self.totp = {
+            "qr_code": "data:image/png;base64,{base64EncodedPng}",
+            "secret": "NAGCCFS3EYRB422HNAKAKY3XDUORMSRF",
+            "uri": "otpauth://totp/FooCorp:[email protected]?secret=NAGCCFS3EYRB422HNAKAKY3XDUORMSRF&issuer=FooCorp",
+            }
+
+    OBJECT_FIELDS = [
+        "object",
+        "id",
+        "created_at",
+        "updated_at",
+        "type",
+        "totp",
+    ]

workos/user_management.py

@@ -3,6 +3,7 @@
 from workos.resources.password_challenge_response import WorkOSPasswordChallengeResponse
 from workos.resources.list import WorkOSListResource
 from workos.resources.mfa import WorkOSAuthenticationChallengeAndFactor
+from workos.resources.mfa import WorkOSAuthenticationFactorTotp
 from workos.resources.users import WorkOSUser
 from workos.utils.pagination_order import Order
 from workos.utils.request import (
@@ -566,18 +567,44 @@ def enroll_auth_factor(
         headers = {}
 
         payload = {
-            "user_id": user,
             "type": type,
             "totp_issuer": totp_issuer,
             "totp_user": totp_user,
         }
 
         response = self.request_helper.request(
-            USER_AUTH_FACTORS_PATH,
+            USER_AUTH_FACTORS_PATH.format(user),
             method=REQUEST_METHOD_POST,
             headers=headers,
             params=payload,
             token=workos.api_key,
         )
 
         return WorkOSAuthenticationChallengeAndFactor.construct_from_response(response).to_dict()
+    
+    def list_auth_factors(
+        self,
+        user,
+    ):
+        """Lists the Auth Factors for a user.
+
+        Kwargs:
+            user (str): The unique ID of the User to list the auth factors for.
+
+        Returns:
+            dict: List of Authentication Factors for a User from WorkOS.
+        """
+        response = self.request_helper.request(
+            USER_AUTH_FACTORS_PATH.format(user),
+            method=REQUEST_METHOD_GET,
+            token=workos.api_key,
+        )
+
+        response["metadata"] = {
+            "params": {
+                "user_id": user,
+            },
+            "method": UserManagement.list_auth_factors,
+        }
+
+        return self.construct_from_response(response)