base python sdk for fga

Author: swaroopAkkineniWorkos

src/workos/fga.py

@@ -1,5 +1,17 @@
+"""
+DEPRECATED: This module is deprecated and will be removed in a future version.
+Please use workos.authorization instead for Fine-Grained Authorization (FGA) functionality.
+
+See authorization.py for the new resource-based FGA APIs:
+- get_resource, create_resource, update_resource, delete_resource, list_resources
+- get_resource_by_external_id, update_resource_by_external_id, delete_resource_by_external_id
+- check, assign_role, remove_role, list_role_assignments, remove_role_assignment
+- list_resources_for_membership, list_memberships_for_resource, list_memberships_for_resource_by_external_id
+"""
+
 import json
 from typing import Any, Mapping, Optional, Protocol, Sequence
+
 from workos.types.fga import (
     CheckOperation,
     CheckResponse,

tests/utils/fixtures/mock_authorization_resource.py

@@ -0,0 +1,54 @@
+"""Mock fixture for AuthorizationResource used in testing new FGA APIs.
+
+This fixture represents the new organization-scoped authorization resource model
+used in the Advanced FGA APIs, distinct from the legacy warrant-based resources.
+"""
+
+from typing import Optional
+
+
+class MockAuthorizationResource:
+    """Mock authorization resource for testing the new FGA resource-based APIs.
+
+    Attributes:
+        id: Internal WorkOS resource ID.
+        external_id: Customer-provided external identifier for the resource.
+        name: Human-readable name for the resource.
+        description: Optional description of the resource.
+        resource_type_slug: The type of resource (e.g., "document", "folder").
+        organization_id: The organization this resource belongs to.
+        parent_resource_id: Optional parent resource ID for hierarchical resources.
+    """
+
+    def __init__(
+        self,
+        id: str = "authz_resource_01HXYZ123ABC456DEF789ABC",
+        external_id: str = "doc-456",
+        name: str = "Q4 Budget Report",
+        description: Optional[str] = "Financial report for Q4 2025",
+        resource_type_slug: str = "document",
+        organization_id: str = "org_01HXYZ123ABC456DEF789ABC",
+        parent_resource_id: Optional[str] = None,
+    ):
+        self.id = id
+        self.external_id = external_id
+        self.name = name
+        self.description = description
+        self.resource_type_slug = resource_type_slug
+        self.organization_id = organization_id
+        self.parent_resource_id = parent_resource_id
+
+    def dict(self) -> dict:
+        """Return the resource as a dictionary matching API response format."""
+        return {
+            "object": "authorization_resource",
+            "id": self.id,
+            "external_id": self.external_id,
+            "name": self.name,
+            "description": self.description,
+            "resource_type_slug": self.resource_type_slug,
+            "organization_id": self.organization_id,
+            "parent_resource_id": self.parent_resource_id,
+            "created_at": "2024-01-15T09:30:00.000Z",
+            "updated_at": "2024-01-15T09:30:00.000Z",
+        }

tests/utils/fixtures/mock_role_assignment.py

@@ -0,0 +1,46 @@
+"""Mock fixture for RoleAssignment used in testing new FGA APIs.
+
+This fixture represents role assignments that grant a role to an organization
+membership on a specific resource.
+"""
+
+
+class MockRoleAssignment:
+    """Mock role assignment for testing the new FGA role assignment APIs.
+
+    Attributes:
+        id: Internal WorkOS role assignment ID.
+        role_slug: The slug of the role being assigned (e.g., "editor", "viewer").
+        resource_id: The internal ID of the resource the role is assigned on.
+        resource_external_id: The external ID of the resource.
+        resource_type_slug: The type of resource (e.g., "document", "folder").
+    """
+
+    def __init__(
+        self,
+        id: str = "role_assignment_01HXYZ123ABC456DEF789ABC",
+        role_slug: str = "editor",
+        resource_id: str = "resource_01HXYZ123ABC456DEF789XYZ",
+        resource_external_id: str = "doc-123",
+        resource_type_slug: str = "document",
+    ):
+        self.id = id
+        self.role_slug = role_slug
+        self.resource_id = resource_id
+        self.resource_external_id = resource_external_id
+        self.resource_type_slug = resource_type_slug
+
+    def dict(self) -> dict:
+        """Return the role assignment as a dictionary matching API response format."""
+        return {
+            "object": "role_assignment",
+            "id": self.id,
+            "role": {"slug": self.role_slug},
+            "resource": {
+                "id": self.resource_id,
+                "external_id": self.resource_external_id,
+                "resource_type_slug": self.resource_type_slug,
+            },
+            "created_at": "2024-01-15T09:30:00.000Z",
+            "updated_at": "2024-01-15T09:30:00.000Z",
+        }