return None on invalid API key

Author: denizs

tests/test_api_keys.py

@@ -4,7 +4,6 @@
 from tests.utils.fixtures.mock_api_key import MockApiKey
 from tests.utils.syncify import syncify
 from workos.api_keys import API_KEY_VALIDATION_PATH, ApiKeys, AsyncApiKeys
-from workos.exceptions import AuthenticationException
 
 
 @pytest.mark.sync_and_async(ApiKeys, AsyncApiKeys)
@@ -44,9 +43,8 @@ def test_validate_api_key_with_invalid_key(
     ):
         mock_http_client_with_response(
             module_instance._http_client,
-            {"message": "Invalid API key", "error": "invalid_api_key"},
-            401,
+            {"api_key": None},
+            200,
         )
 
-        with pytest.raises(AuthenticationException):
-            syncify(module_instance.validate_api_key(value="invalid-key"))
+        assert syncify(module_instance.validate_api_key(value="invalid-key")) is None

workos/api_keys.py

@@ -1,27 +1,24 @@
-from typing import Protocol
+from typing import Optional, Protocol
 
 from workos.types.api_keys import ApiKey
 from workos.typing.sync_or_async import SyncOrAsync
 from workos.utils.http_client import AsyncHTTPClient, SyncHTTPClient
 from workos.utils.request_helper import REQUEST_METHOD_POST
 
 API_KEY_VALIDATION_PATH = "api_keys/validations"
+RESOURCE_OBJECT_PATH = "api_key"
 
 
 class ApiKeysModule(Protocol):
-    def validate_api_key(self, *, value: str) -> SyncOrAsync[ApiKey]:
-        """Validates the configured API key.
+    def validate_api_key(self, *, value: str) -> SyncOrAsync[Optional[ApiKey]]:
+        """Validate an API key.
+
+        Kwargs:
+            value (str): API key value
 
         Returns:
-            ApiKey: The validated API key details containing
-                information about the key's name and usage
-
-        Raises:
-            AuthenticationException: If the API key is invalid or
-                unauthorized (401)
-            NotFoundException: If the API key is not found (404)
-            ServerException: If the API server encounters an error
-                (5xx)
+            Optional[ApiKey]: Returns ApiKey resource object
+                if supplied value was valid, None if it was not
         """
         ...
 
@@ -32,12 +29,13 @@ class ApiKeys(ApiKeysModule):
     def __init__(self, http_client: SyncHTTPClient):
         self._http_client = http_client
 
-    def validate_api_key(self, *, value: str) -> ApiKey:
+    def validate_api_key(self, *, value: str) -> Optional[ApiKey]:
         response = self._http_client.request(
-            API_KEY_VALIDATION_PATH, method=REQUEST_METHOD_POST, json={
-                "value": value}
+            API_KEY_VALIDATION_PATH, method=REQUEST_METHOD_POST, json={"value": value}
         )
-        return ApiKey.model_validate(response["api_key"])
+        if response.get(RESOURCE_OBJECT_PATH) is None:
+            return None
+        return ApiKey.model_validate(response[RESOURCE_OBJECT_PATH])
 
 
 class AsyncApiKeys(ApiKeysModule):
@@ -46,9 +44,10 @@ class AsyncApiKeys(ApiKeysModule):
     def __init__(self, http_client: AsyncHTTPClient):
         self._http_client = http_client
 
-    async def validate_api_key(self, *, value: str) -> ApiKey:
+    async def validate_api_key(self, *, value: str) -> Optional[ApiKey]:
         response = await self._http_client.request(
-            API_KEY_VALIDATION_PATH, method=REQUEST_METHOD_POST, json={
-                "value": value}
+            API_KEY_VALIDATION_PATH, method=REQUEST_METHOD_POST, json={"value": value}
         )
-        return ApiKey.model_validate(response["api_key"])
+        if response.get(RESOURCE_OBJECT_PATH) is None:
+            return None
+        return ApiKey.model_validate(response[RESOURCE_OBJECT_PATH])