workos 5.33.0__py3-none-any.whl → 5.35.0__py3-none-any.whl

workos/__about__.py

@@ -12,7 +12,7 @@ __package_name__ = "workos"
 
 __package_url__ = "https://github.com/workos-inc/workos-python"
 
-__version__ = "5.33.0"
+__version__ = "5.35.0"
 
 __author__ = "WorkOS"
 

workos/_base_client.py

@@ -1,21 +1,21 @@
-from abc import abstractmethod
 import os
+from abc import abstractmethod
 from typing import Optional
-from workos.__about__ import __version__
+
 from workos._client_configuration import ClientConfiguration
-from workos.fga import FGAModule
-from workos.utils._base_http_client import DEFAULT_REQUEST_TIMEOUT
-from workos.utils.http_client import HTTPClient
+from workos.api_keys import ApiKeysModule
 from workos.audit_logs import AuditLogsModule
 from workos.directory_sync import DirectorySyncModule
 from workos.events import EventsModule
+from workos.fga import FGAModule
 from workos.mfa import MFAModule
-from workos.organizations import OrganizationsModule
 from workos.organization_domains import OrganizationDomainsModule
+from workos.organizations import OrganizationsModule
 from workos.passwordless import PasswordlessModule
 from workos.portal import PortalModule
 from workos.sso import SSOModule
 from workos.user_management import UserManagementModule
+from workos.utils._base_http_client import DEFAULT_REQUEST_TIMEOUT
 from workos.webhooks import WebhooksModule
 
 
@@ -65,6 +65,10 @@ class BaseClient(ClientConfiguration):
             else int(os.getenv("WORKOS_REQUEST_TIMEOUT", DEFAULT_REQUEST_TIMEOUT))
         )
 
+    @property
+    @abstractmethod
+    def api_keys(self) -> ApiKeysModule: ...
+
     @property
     @abstractmethod
     def audit_logs(self) -> AuditLogsModule: ...

workos/api_keys.py

@@ -0,0 +1,53 @@
+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_ATTRIBUTE_NAME = "api_key"
+
+
+class ApiKeysModule(Protocol):
+    def validate_api_key(self, *, value: str) -> SyncOrAsync[Optional[ApiKey]]:
+        """Validate an API key.
+
+        Kwargs:
+            value (str): API key value
+
+        Returns:
+            Optional[ApiKey]: Returns ApiKey resource object
+                if supplied value was valid, None if it was not
+        """
+        ...
+
+
+class ApiKeys(ApiKeysModule):
+    _http_client: SyncHTTPClient
+
+    def __init__(self, http_client: SyncHTTPClient):
+        self._http_client = http_client
+
+    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}
+        )
+        if response.get(RESOURCE_OBJECT_ATTRIBUTE_NAME) is None:
+            return None
+        return ApiKey.model_validate(response[RESOURCE_OBJECT_ATTRIBUTE_NAME])
+
+
+class AsyncApiKeys(ApiKeysModule):
+    _http_client: AsyncHTTPClient
+
+    def __init__(self, http_client: AsyncHTTPClient):
+        self._http_client = http_client
+
+    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}
+        )
+        if response.get(RESOURCE_OBJECT_ATTRIBUTE_NAME) is None:
+            return None
+        return ApiKey.model_validate(response[RESOURCE_OBJECT_ATTRIBUTE_NAME])

workos/async_client.py

@@ -1,6 +1,7 @@
 from typing import Optional
 from workos.__about__ import __version__
 from workos._base_client import BaseClient
+from workos.api_keys import AsyncApiKeys
 from workos.audit_logs import AuditLogsModule
 from workos.directory_sync import AsyncDirectorySync
 from workos.events import AsyncEvents
@@ -45,6 +46,12 @@ class AsyncClient(BaseClient):
             timeout=self.request_timeout,
         )
 
+    @property
+    def api_keys(self) -> AsyncApiKeys:
+        if not getattr(self, "_api_keys", None):
+            self._api_keys = AsyncApiKeys(self._http_client)
+        return self._api_keys
+
     @property
     def sso(self) -> AsyncSSO:
         if not getattr(self, "_sso", None):

workos/client.py

@@ -1,6 +1,7 @@
 from typing import Optional
 from workos.__about__ import __version__
 from workos._base_client import BaseClient
+from workos.api_keys import ApiKeys
 from workos.audit_logs import AuditLogs
 from workos.directory_sync import DirectorySync
 from workos.fga import FGA
@@ -45,6 +46,12 @@ class SyncClient(BaseClient):
             timeout=self.request_timeout,
         )
 
+    @property
+    def api_keys(self) -> ApiKeys:
+        if not getattr(self, "_api_keys", None):
+            self._api_keys = ApiKeys(self._http_client)
+        return self._api_keys
+
     @property
     def sso(self) -> SSO:
         if not getattr(self, "_sso", None):

workos/types/api_keys/__init__.py

@@ -0,0 +1 @@
+from .api_keys import ApiKey as ApiKey  # noqa: F401

workos/types/api_keys/api_keys.py

@@ -0,0 +1,20 @@
+from typing import Literal, Optional, Sequence
+
+from workos.types.workos_model import WorkOSModel
+
+
+class ApiKeyOwner(WorkOSModel):
+    type: str
+    id: str
+
+
+class ApiKey(WorkOSModel):
+    object: Literal["api_key"]
+    id: str
+    owner: ApiKeyOwner
+    name: str
+    obfuscated_value: str
+    last_used_at: Optional[str] = None
+    permissions: Sequence[str]
+    created_at: str
+    updated_at: str

workos/types/directory_sync/directory_user.py

@@ -38,6 +38,7 @@ class DirectoryUser(WorkOSModel):
     created_at: str
     updated_at: str
     role: Optional[InlineRole] = None
+    roles: Optional[Sequence[InlineRole]] = None
 
     def primary_email(self) -> Union[DirectoryUserEmail, None]:
         return next((email for email in self.emails if email.primary), None)

workos/types/sso/profile.py

@@ -22,6 +22,7 @@ class Profile(WorkOSModel):
     last_name: Optional[str] = None
     idp_id: str
     role: Optional[ProfileRole] = None
+    roles: Optional[Sequence[ProfileRole]] = None
     groups: Optional[Sequence[str]] = None
     custom_attributes: Optional[Mapping[str, Any]] = None
     raw_attributes: Optional[Mapping[str, Any]] = None

{workos-5.33.0.dist-info → workos-5.35.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: workos
-Version: 5.33.0
+Version: 5.35.0
 Summary: WorkOS Python Client
 Home-page: https://github.com/workos-inc/workos-python
 Author: WorkOS

{workos-5.33.0.dist-info → workos-5.35.0.dist-info}/RECORD

@@ -1,10 +1,11 @@
-workos/__about__.py,sha256=-nB8UrwKFTtayBxBV9wbxK-eZX381M0MPI4jlQUT290,406
+workos/__about__.py,sha256=FY3Dake_y_fTMLwYhgwGt3TE9MkKL521aj0eNeXv5WE,406
 workos/__init__.py,sha256=hOdbO_MJCvpLx8EbRjQg-fvFAB-glJmrmxUZK8kWG0k,167
-workos/_base_client.py,sha256=YWLXBpd0YeID3WKYZkKa4l9ZuB9e6HgdLmPKZIzXsME,3599
+workos/_base_client.py,sha256=CIfAk6Bdj1hpOy3TcfIGXy8X4Efa7wi7cKracjkcTHk,3633
 workos/_client_configuration.py,sha256=g3eXhtrEMN6CW0hZ5uHb2PmLurXjyBkWZeQYMPeJD6s,222
-workos/async_client.py,sha256=c_lP7y49k3FEx0S6We8PrEw3PhTkD0VHyHJaKgc51HU,4358
+workos/api_keys.py,sha256=3AljcqAO1uJYP315AZymX184eJ9X_gH7xa_rKU6rMjw,1817
+workos/async_client.py,sha256=OYwH4BMEQQSaQoKPgAxGs24TQQcaQQndoivCte-Y1FI,4594
 workos/audit_logs.py,sha256=bYoAoNO4FRSaT34UxiVkgTXCVH8givcS2YGhH_9O3NA,3983
-workos/client.py,sha256=hIm87iNtKfwQ93H5aRXnhTqUJIOzUEG1GX0jdLBLAYc,4345
+workos/client.py,sha256=18fDBbsUnHnJj3WqxEmX72oWxgfJvCWIH1CFb_gsjkU,4566
 workos/directory_sync.py,sha256=6Z1gHz1LWNy56EtkXwNm6jhRRcvsJ7ASeDLy_Q1oKM0,14601
 workos/events.py,sha256=b4JIzMbd5LlVtpOMKVojC70RCHAgmLN3nJ62_2U0GwI,3892
 workos/exceptions.py,sha256=wYDlbMLVxrKQTF0M6ExFlxS5YEkvNZ4BeWLryRxcAFs,2335
@@ -25,6 +26,8 @@ workos/types/__init__.py,sha256=aYScTXq5jOyp0AYvdWffaj5-zdDuNtCCJtbzt5GM19k,267
 workos/types/list_resource.py,sha256=VcJaz8qE91y9t-PRI0mTjzPdtyoU8EGAo6-TJGjbqzg,6747
 workos/types/metadata.py,sha256=uUqDkGJGyFY3H4JZObSiCfn4jKBue5CBhOqv79TI1n0,52
 workos/types/workos_model.py,sha256=bV_p3baadcUJOU_7f6ysZ6KXhpt3E_93spuZnfJs9vc,735
+workos/types/api_keys/__init__.py,sha256=CMjEAI6EAO2En9UUwvEQW6EAVuV6l5wWPvmuKH8oKhs,53
+workos/types/api_keys/api_keys.py,sha256=eVpXS6hhLCFhIqJ_oQNIbwjL9u0blVykjpQxZEEKDS8,403
 workos/types/audit_logs/__init__.py,sha256=daPn8wAVEnlM1fCpOsy3dVZV_0YEp8bA1T_nhk5-pU8,211
 workos/types/audit_logs/audit_log_event.py,sha256=GVvbu3JJpXW-N16zdWi-0c3W9z_t3JB7Y6-Rc463upw,672
 workos/types/audit_logs/audit_log_event_actor.py,sha256=vYojEwq4EPwAO01p_9FmVuKg6Cr7lycrWkldB_W26GA,320
@@ -37,7 +40,7 @@ workos/types/directory_sync/directory.py,sha256=M7IvlTeKrLj-BpGeX-nafBM6BWUnHb3-
 workos/types/directory_sync/directory_group.py,sha256=4bRB3inN72GfsJEA17OpMEI-_6hhdXFVGpTL0PWaXL0,439
 workos/types/directory_sync/directory_state.py,sha256=4qaD1Snonde1oVj1tDUITzXh0imPUKkacQnb2TcuAIY,607
 workos/types/directory_sync/directory_type.py,sha256=NuHJzxI80WjxKiCSwMj1dfMpfB4o5JHErfLWfxCnKRs,443
-workos/types/directory_sync/directory_user.py,sha256=MqojNO_Wy4Fwv-xXp_dPhZm7rE1OQwtszzrY3uWE10Q,2086
+workos/types/directory_sync/directory_user.py,sha256=ZIlhkR2afO5cvWxEXAWsYjOy_sBC9_GBFaa5B3ZYyBo,2135
 workos/types/directory_sync/list_filters.py,sha256=Q4jlocRp4DguCm5e4Oo7udK7IfKmm3N1Rojtg4Eu96w,449
 workos/types/events/__init__.py,sha256=t_Pt--jhehN-qFACREbSsZbUFQjQDe12xU-dQAjZfoI,548
 workos/types/events/authentication_payload.py,sha256=-4DhxWNxyd0Q01w2R4RyoQAwxNrRKMYJAdcRJUrzjEk,1779
@@ -89,7 +92,7 @@ workos/types/roles/role.py,sha256=GhY6tCFIW33Z-SCbP---Esyoz_ePFvoamxIqyWvCNJ4,54
 workos/types/sso/__init__.py,sha256=feBeNqummbAvLaiAn9mTmW5O8axKHUWxh6IkQceKeAc,115
 workos/types/sso/connection.py,sha256=GTpaS02EMv2cJAkt20tSxldVCcKQlpl37vQSIAIHSdM,1679
 workos/types/sso/connection_domain.py,sha256=kMa9GatwUl6YilMU9iiyUKXFfEUKWYub7PyjjYmqhLc,185
-workos/types/sso/profile.py,sha256=IWHpg2GdIvE7eAGi1RJheAqp9AozsKuGfiFc9_IteHI,1075
+workos/types/sso/profile.py,sha256=htysPjNhago855TXVfDe685hQKEnc60u6AO0CHWs1T4,1125
 workos/types/sso/sso_provider_type.py,sha256=JfO-Ta1wJP7jhtbnWKcS9tElMK_7P6AM10nY-7mM4XE,159
 workos/types/user_management/__init__.py,sha256=paHEZ8-QWPjX6PftupYRRVqfy6tVNevfl2kAD3ZgEZw,384
 workos/types/user_management/authenticate_with_common.py,sha256=2mGRfIgoeX5Ee7c_rxQm6rb6PHyaIBHbGFQsWAhGhY8,2101
@@ -128,8 +131,8 @@ workos/utils/crypto_provider.py,sha256=QeQSR4t9xLlb90kEfl8onVUsf1yCkYq0EjFTxK0mU
 workos/utils/http_client.py,sha256=TM5yMFFExmAE8D2Z43-5O301tRbnylLG0aXO0isGorE,6197
 workos/utils/pagination_order.py,sha256=_-et1DDJLG0czarTU7op4W6RA0V1f85GNsUgtyRU55Q,70
 workos/utils/request_helper.py,sha256=NaO16qPPbSNnCeE0fiNKYb8gM-dK_okYVJbLGrEGXz8,793
-workos-5.33.0.dist-info/LICENSE,sha256=mU--WL1JzelH2tXpKVoOlpud4cpqKSRTtdArCvYZmb4,1063
-workos-5.33.0.dist-info/METADATA,sha256=yqlekSvf2kMaq1cjaweH1L7mN2mo7lZnJ9XYhiRxz2U,4187
-workos-5.33.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-workos-5.33.0.dist-info/top_level.txt,sha256=ZFskIfue1Tw-JwjyIXRvdsAl9i0DX9VbqmgICXV84Sk,7
-workos-5.33.0.dist-info/RECORD,,
+workos-5.35.0.dist-info/LICENSE,sha256=mU--WL1JzelH2tXpKVoOlpud4cpqKSRTtdArCvYZmb4,1063
+workos-5.35.0.dist-info/METADATA,sha256=UPSLxCbIUU7Zd5g2lgIxhpxdVxwtL58i_jO09rMDyRs,4187
+workos-5.35.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+workos-5.35.0.dist-info/top_level.txt,sha256=ZFskIfue1Tw-JwjyIXRvdsAl9i0DX9VbqmgICXV84Sk,7
+workos-5.35.0.dist-info/RECORD,,