Merge branch 'main' into feature/dsync-2746-add-email-attribute-to-directoryuser-in-python-sdk

Author: mattgd

.github/workflows/coana-analysis.yml

@@ -2,24 +2,27 @@ name: Coana Vulnerability Analysis
 
 on:
   schedule:
-    # every day at 12 AM
-    - cron: '0 0 * * *'
+    - cron: "0 3 * * *" # every day at 3 AM
   workflow_dispatch:
     inputs:
       tags:
-        description: 'Manually run vulnerability analysis'
+        description: "Manually run vulnerability analysis"
+      # Required by the return-dispatch action
+      distinct_id:
 
 jobs:
   coana-vulnerability-analysis:
     runs-on: ubuntu-latest
-    timeout-minutes: 60
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+
       - name: Run Coana CLI
         id: coana-cli
-        run: |
-          npx @coana-tech/cli run . \
-            --api-key ${{ secrets.COANA_API_KEY }} \
-            --repo-url https://github.com/${{github.repository}}
+        uses: docker://coana/coana:latest
+        with:
+          args: |
+            coana run . \
+              --api-key ${{ secrets.COANA_API_KEY }} \
+              --repo-url https://github.com/${{github.repository}}

.github/workflows/coana-guardrail.yml

@@ -5,24 +5,27 @@ on: pull_request
 jobs:
   guardrail:
     runs-on: ubuntu-latest
-    timeout-minutes: 15
+
     steps:
-      - name: Get changed files
-        id: changed-files
-        uses: tj-actions/changed-files@v44
-        with:
-          separator: ' '
- 
       - name: Checkout the ${{github.base_ref}} branch
         uses: actions/checkout@v4
         with:
           ref: ${{github.base_ref}} # checkout the base branch (usually master/main).
- 
+
+      - name: Fetch the PR branch
+        run: |
+          git fetch ${{ github.event.pull_request.head.repo.clone_url }} ${{ github.head_ref }}:${{ github.head_ref }} --depth=1
+
+      - name: Get list of changed files relative to the main/master branch
+        id: changed-files
+        run: |
+          echo "all_changed_files=$(git diff --name-only ${{ github.base_ref }} ${{ github.head_ref }} | tr '\n' ' ')" >> $GITHUB_OUTPUT
+
       - name: Use Node.js 20.x
         uses: actions/setup-node@v4
         with:
           node-version: 20.x
- 
+
       - name: Run Coana on the ${{github.base_ref}} branch
         run: |
           npx @coana-tech/cli run . \
@@ -31,16 +34,20 @@ jobs:
             -o /tmp/main-branch \
             --changed-files ${{ steps.changed-files.outputs.all_changed_files }} \
             --lightweight-reachability \
- 
-      # Reset file permissions changed by Coana CLI.
+
+      # Reset file permissions.
+      # This is necessary because the Coana CLI may add
+      # new files with root ownership since it's using docker.
+      # These files will not be deleted by the clean step in checkout
+      # if the permissions are not reset.
       - name: Reset file permissions
         run: sudo chown -R $USER:$USER .
- 
+
       - name: Checkout the current branch
         uses: actions/checkout@v4
         with:
           clean: true
- 
+
       - name: Run Coana on the current branch
         run: |
           npx @coana-tech/cli run . \
@@ -49,12 +56,12 @@ jobs:
             -o /tmp/current-branch \
             --changed-files ${{ steps.changed-files.outputs.all_changed_files }} \
             --lightweight-reachability \
- 
+
       - name: Run Report Comparison
         run: |
           npx @coana-tech/cli compare-reports \
             --api-key ${{ secrets.COANA_API_KEY || 'api-key-unavailable' }} \
             /tmp/main-branch/coana-report.json \
             /tmp/current-branch/coana-report.json
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

tests/test_organizations.py

@@ -109,20 +109,20 @@ def test_get_organization(
         assert request_kwargs["method"] == "get"
         assert request_kwargs["url"].endswith("/organizations/organization_id")
 
-    def test_get_organization_by_lookup_key(
+    def test_get_organization_by_external_id(
         self, mock_organization, capture_and_mock_http_client_request
     ):
         request_kwargs = capture_and_mock_http_client_request(
             self.http_client, mock_organization, 200
         )
 
         organization = syncify(
-            self.organizations.get_organization_by_lookup_key(lookup_key="test")
+            self.organizations.get_organization_by_external_id(external_id="test")
         )
 
         assert organization.dict() == mock_organization
         assert request_kwargs["method"] == "get"
-        assert request_kwargs["url"].endswith("/organizations/by_lookup_key/test")
+        assert request_kwargs["url"].endswith("/organizations/external_id/test")
 
     def test_create_organization_with_domain_data(
         self, mock_organization, capture_and_mock_http_client_request

tests/test_user_management.py

@@ -392,6 +392,27 @@ def test_get_user(self, mock_user, capture_and_mock_http_client_request):
         assert user.profile_picture_url == "https://example.com/profile-picture.jpg"
         assert user.last_sign_in_at == "2021-06-25T19:07:33.155Z"
 
+    def test_get_user_by_external_id(
+        self, mock_user, capture_and_mock_http_client_request
+    ):
+        request_kwargs = capture_and_mock_http_client_request(
+            self.http_client, mock_user, 200
+        )
+
+        external_id = "external-id"
+        user = syncify(
+            self.user_management.get_user_by_external_id(external_id=external_id)
+        )
+
+        assert request_kwargs["url"].endswith(
+            f"user_management/users/external_id/{external_id}"
+        )
+        assert request_kwargs["method"] == "get"
+        assert user.id == "user_01H7ZGXFP5C6BBQY6Z7277ZCT0"
+        assert user.profile_picture_url == "https://example.com/profile-picture.jpg"
+        assert user.last_sign_in_at == "2021-06-25T19:07:33.155Z"
+        assert user.metadata == mock_user["metadata"]
+
     def test_list_users_auto_pagination(
         self,
         mock_users_multiple_pages,

tests/utils/fixtures/mock_organization.py

@@ -22,4 +22,5 @@ def __init__(self, id):
                     domain="example.io",
                 )
             ],
+            metadata={"key": "value"},
         )

tests/utils/fixtures/mock_user.py

@@ -17,4 +17,5 @@ def __init__(self, id):
             last_sign_in_at="2021-06-25T19:07:33.155Z",
             created_at=now,
             updated_at=now,
+            metadata={"key": "value"},
         )

workos/__about__.py

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

workos/__init__.py

@@ -1,2 +1,4 @@
 from workos.client import SyncClient as WorkOSClient
 from workos.async_client import AsyncClient as AsyncWorkOSClient
+
+__all__ = ["WorkOSClient", "AsyncWorkOSClient"]

workos/organizations.py

@@ -1,5 +1,6 @@
 from typing import Optional, Protocol, Sequence
 
+from workos.types.metadata import Metadata
 from workos.types.organizations.domain_data_input import DomainDataInput
 from workos.types.organizations.list_filters import OrganizationListFilters
 from workos.types.roles.role import RoleList
@@ -60,13 +61,13 @@ def get_organization(self, organization_id: str) -> SyncOrAsync[Organization]:
         """
         ...
 
-    def get_organization_by_lookup_key(
-        self, lookup_key: str
+    def get_organization_by_external_id(
+        self, external_id: str
     ) -> SyncOrAsync[Organization]:
-        """Gets details for a single Organization by lookup key
+        """Gets details for a single Organization by external id
 
         Args:
-            lookup_key (str): Organization's lookup key
+            external_id (str): Organization's external id
 
         Returns:
             Organization: Organization response from WorkOS
@@ -79,6 +80,8 @@ def create_organization(
         name: str,
         domain_data: Optional[Sequence[DomainDataInput]] = None,
         idempotency_key: Optional[str] = None,
+        external_id: Optional[str] = None,
+        metadata: Optional[Metadata] = None,
     ) -> SyncOrAsync[Organization]:
         """Create an organization
 
@@ -98,6 +101,8 @@ def update_organization(
         organization_id: str,
         name: Optional[str] = None,
         domain_data: Optional[Sequence[DomainDataInput]] = None,
+        external_id: Optional[str] = None,
+        metadata: Optional[Metadata] = None,
     ) -> SyncOrAsync[Organization]:
         """Update an organization
 
@@ -125,7 +130,6 @@ def delete_organization(self, organization_id: str) -> SyncOrAsync[None]:
 
 
 class Organizations(OrganizationsModule):
-
     _http_client: SyncHTTPClient
 
     def __init__(self, http_client: SyncHTTPClient):
@@ -167,9 +171,9 @@ def get_organization(self, organization_id: str) -> Organization:
 
         return Organization.model_validate(response)
 
-    def get_organization_by_lookup_key(self, lookup_key: str) -> Organization:
+    def get_organization_by_external_id(self, external_id: str) -> Organization:
         response = self._http_client.request(
-            "organizations/by_lookup_key/{lookup_key}".format(lookup_key=lookup_key),
+            "organizations/external_id/{external_id}".format(external_id=external_id),
             method=REQUEST_METHOD_GET,
         )
 
@@ -181,6 +185,8 @@ def create_organization(
         name: str,
         domain_data: Optional[Sequence[DomainDataInput]] = None,
         idempotency_key: Optional[str] = None,
+        external_id: Optional[str] = None,
+        metadata: Optional[Metadata] = None,
     ) -> Organization:
         headers = {}
         if idempotency_key:
@@ -190,6 +196,8 @@ def create_organization(
             "name": name,
             "domain_data": domain_data,
             "idempotency_key": idempotency_key,
+            "external_id": external_id,
+            "metadata": metadata,
         }
 
         response = self._http_client.request(
@@ -208,11 +216,15 @@ def update_organization(
         name: Optional[str] = None,
         domain_data: Optional[Sequence[DomainDataInput]] = None,
         stripe_customer_id: Optional[str] = None,
+        external_id: Optional[str] = None,
+        metadata: Optional[Metadata] = None,
     ) -> Organization:
         json = {
             "name": name,
             "domain_data": domain_data,
             "stripe_customer_id": stripe_customer_id,
+            "external_id": external_id,
+            "metadata": metadata,
         }
 
         response = self._http_client.request(
@@ -237,7 +249,6 @@ def list_organization_roles(self, organization_id: str) -> RoleList:
 
 
 class AsyncOrganizations(OrganizationsModule):
-
     _http_client: AsyncHTTPClient
 
     def __init__(self, http_client: AsyncHTTPClient):
@@ -279,9 +290,9 @@ async def get_organization(self, organization_id: str) -> Organization:
 
         return Organization.model_validate(response)
 
-    async def get_organization_by_lookup_key(self, lookup_key: str) -> Organization:
+    async def get_organization_by_external_id(self, external_id: str) -> Organization:
         response = await self._http_client.request(
-            "organizations/by_lookup_key/{lookup_key}".format(lookup_key=lookup_key),
+            "organizations/external_id/{external_id}".format(external_id=external_id),
             method=REQUEST_METHOD_GET,
         )
 
@@ -293,6 +304,8 @@ async def create_organization(
         name: str,
         domain_data: Optional[Sequence[DomainDataInput]] = None,
         idempotency_key: Optional[str] = None,
+        external_id: Optional[str] = None,
+        metadata: Optional[Metadata] = None,
     ) -> Organization:
         headers = {}
         if idempotency_key:
@@ -302,6 +315,8 @@ async def create_organization(
             "name": name,
             "domain_data": domain_data,
             "idempotency_key": idempotency_key,
+            "external_id": external_id,
+            "metadata": metadata,
         }
 
         response = await self._http_client.request(
@@ -320,11 +335,15 @@ async def update_organization(
         name: Optional[str] = None,
         domain_data: Optional[Sequence[DomainDataInput]] = None,
         stripe_customer_id: Optional[str] = None,
+        external_id: Optional[str] = None,
+        metadata: Optional[Metadata] = None,
     ) -> Organization:
         json = {
             "name": name,
             "domain_data": domain_data,
             "stripe_customer_id": stripe_customer_id,
+            "external_id": external_id,
+            "metadata": metadata,
         }
 
         response = await self._http_client.request(

workos/types/metadata.py

@@ -0,0 +1,4 @@
+from typing import Dict
+
+
+Metadata = Dict[str, str]