Skip to content

feat: FGA_5 list_resources_for_membership, list_memberships_for_resource, list_memberships_for_resource_by_external_id #571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swaroopAkkineniWorkos merged 16 commits into from
Mar 4, 2026
Merged

feat: FGA_5 list_resources_for_membership, list_memberships_for_resource, list_memberships_for_resource_by_external_id #571

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
f3c6575
FGA_5: list_resources_for_membership, list_memberships_for_resource, …
swaroopAkkineniWorkos Feb 20, 2026
43bae56
lol
swaroopAkkineniWorkos Feb 23, 2026
d66d6ec
minor nit
swaroopAkkineniWorkos Feb 23, 2026
9149f71
refactor
swaroopAkkineniWorkos Feb 23, 2026
e9a6975
moar
swaroopAkkineniWorkos Feb 23, 2026
4a949d6
enough
swaroopAkkineniWorkos Mar 2, 2026
700d915
lol
swaroopAkkineniWorkos Mar 2, 2026
3412ff0
Merge branch 'ENT-5224-python-sdk-for-fga-worktree-fuck-around' into …
swaroopAkkineniWorkos Mar 2, 2026
e4c8031
final
swaroopAkkineniWorkos Mar 2, 2026
47e2c77
final
swaroopAkkineniWorkos Mar 2, 2026
7453f18
lol
swaroopAkkineniWorkos Mar 2, 2026
adcafb5
lol
swaroopAkkineniWorkos Mar 2, 2026
a973327
lol
swaroopAkkineniWorkos Mar 2, 2026
c604ff2
feedback
swaroopAkkineniWorkos Mar 4, 2026
b3c924c
merge conflcits
swaroopAkkineniWorkos Mar 4, 2026
30876c9
lint
swaroopAkkineniWorkos Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
355 changes: 354 additions & 1 deletion src/workos/authorization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
from typing import Any, Dict, Optional, Protocol, Sequence
from functools import partial
from typing import Any, Dict, Literal, Optional, Protocol, Sequence

from pydantic import TypeAdapter

from workos.types.authorization.environment_role import (
EnvironmentRole,
EnvironmentRoleList,
)
from workos.types.authorization.organization_membership import (
AuthorizationOrganizationMembership,
)
from workos.types.authorization.organization_role import OrganizationRole
from workos.types.authorization.permission import Permission
from workos.types.authorization.resource import Resource
from workos.types.authorization.role import Role, RoleList
from workos.types.list_resource import (
ListArgs,
Expand Down Expand Up @@ -41,6 +46,30 @@ class PermissionListFilters(ListArgs, total=False):
]


class ResourcesForMembershipListFilters(ListArgs, total=False):
permission_slug: str
parent_resource_id: Optional[str]
parent_resource_type_slug: Optional[str]
parent_resource_external_id: Optional[str]


ResourcesForMembershipListResource = WorkOSListResource[
Resource, ResourcesForMembershipListFilters, ListMetadata
]


class MembershipsForResourceListFilters(ListArgs, total=False):
permission_slug: str
assignment: Optional[Literal["direct", "indirect"]]
Copy link
Copy Markdown
Contributor

@atainter atainter Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth making assignment a type since we'll most likely add it to the list resources for membership endpoint soon.

Copy link
Copy Markdown
Contributor

@atainter atainter Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also referenced a few places so we won't have to redeclare the literals



MembershipsForResourceListResource = WorkOSListResource[
AuthorizationOrganizationMembership,
MembershipsForResourceListFilters,
ListMetadata,
]


class AuthorizationModule(Protocol):
"""Offers methods through the WorkOS Authorization service."""

Expand Down Expand Up @@ -161,6 +190,48 @@ def add_environment_role_permission(
permission_slug: str,
) -> SyncOrAsync[EnvironmentRole]: ...

# Resource-Membership Relationships

def list_resources_for_membership(
self,
organization_membership_id: str,
*,
permission_slug: str,
parent_resource_id: Optional[str] = None,
parent_resource_type_slug: Optional[str] = None,
parent_resource_external_id: Optional[str] = None,
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
before: Optional[str] = None,
after: Optional[str] = None,
order: PaginationOrder = "desc",
) -> SyncOrAsync[ResourcesForMembershipListResource]: ...

def list_memberships_for_resource(
self,
resource_id: str,
*,
permission_slug: str,
assignment: Optional[Literal["direct", "indirect"]] = None,
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
before: Optional[str] = None,
after: Optional[str] = None,
order: PaginationOrder = "desc",
) -> SyncOrAsync[MembershipsForResourceListResource]: ...

def list_memberships_for_resource_by_external_id(
self,
organization_id: str,
resource_type_slug: str,
external_id: str,
*,
permission_slug: str,
assignment: Optional[Literal["direct", "indirect"]] = None,
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
before: Optional[str] = None,
after: Optional[str] = None,
order: PaginationOrder = "desc",
) -> SyncOrAsync[MembershipsForResourceListResource]: ...


class Authorization(AuthorizationModule):
_http_client: SyncHTTPClient
Expand Down Expand Up @@ -437,6 +508,147 @@ def add_environment_role_permission(

return EnvironmentRole.model_validate(response)

# Resource-Membership Relationships

def list_resources_for_membership(
self,
organization_membership_id: str,
*,
permission_slug: str,
parent_resource_id: Optional[str] = None,
parent_resource_type_slug: Optional[str] = None,
parent_resource_external_id: Optional[str] = None,
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
before: Optional[str] = None,
after: Optional[str] = None,
order: PaginationOrder = "desc",
) -> ResourcesForMembershipListResource:
if parent_resource_id is not None and (
parent_resource_type_slug is not None
or parent_resource_external_id is not None
):
raise ValueError(
"Cannot specify both parent_resource_id and "
"parent_resource_type_slug/parent_resource_external_id. "
"Use one identification method."
)
if (parent_resource_type_slug is None) != (parent_resource_external_id is None):
raise ValueError(
"parent_resource_type_slug and parent_resource_external_id "
"must be provided together."
)

list_params: ResourcesForMembershipListFilters = {
"limit": limit,
"before": before,
"after": after,
"order": order,
"permission_slug": permission_slug,
}
if parent_resource_id is not None:
list_params["parent_resource_id"] = parent_resource_id
if parent_resource_type_slug is not None:
list_params["parent_resource_type_slug"] = parent_resource_type_slug
if parent_resource_external_id is not None:
list_params["parent_resource_external_id"] = parent_resource_external_id

response = self._http_client.request(
f"authorization/organization_memberships/{organization_membership_id}/resources",
method=REQUEST_METHOD_GET,
params=list_params,
)

return WorkOSListResource[
Resource, ResourcesForMembershipListFilters, ListMetadata
](
list_method=partial(
self.list_resources_for_membership, organization_membership_id
),
list_args=list_params,
**ListPage[Resource](**response).model_dump(),
)

def list_memberships_for_resource(
self,
resource_id: str,
*,
permission_slug: str,
assignment: Optional[Literal["direct", "indirect"]] = None,
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
before: Optional[str] = None,
after: Optional[str] = None,
order: PaginationOrder = "desc",
) -> MembershipsForResourceListResource:
list_params: MembershipsForResourceListFilters = {
"limit": limit,
"before": before,
"after": after,
"order": order,
"permission_slug": permission_slug,
}
if assignment is not None:
list_params["assignment"] = assignment

response = self._http_client.request(
f"authorization/resources/{resource_id}/organization_memberships",
method=REQUEST_METHOD_GET,
params=list_params,
)

return WorkOSListResource[
AuthorizationOrganizationMembership,
MembershipsForResourceListFilters,
ListMetadata,
](
list_method=partial(self.list_memberships_for_resource, resource_id),
list_args=list_params,
**ListPage[AuthorizationOrganizationMembership](**response).model_dump(),
)

def list_memberships_for_resource_by_external_id(
self,
organization_id: str,
resource_type_slug: str,
external_id: str,
*,
permission_slug: str,
assignment: Optional[Literal["direct", "indirect"]] = None,
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
before: Optional[str] = None,
after: Optional[str] = None,
order: PaginationOrder = "desc",
) -> MembershipsForResourceListResource:
list_params: MembershipsForResourceListFilters = {
"limit": limit,
"before": before,
"after": after,
"order": order,
"permission_slug": permission_slug,
}
if assignment is not None:
list_params["assignment"] = assignment

response = self._http_client.request(
f"authorization/organizations/{organization_id}/resources/{resource_type_slug}/{external_id}/organization_memberships",
method=REQUEST_METHOD_GET,
params=list_params,
)

return WorkOSListResource[
AuthorizationOrganizationMembership,
MembershipsForResourceListFilters,
ListMetadata,
](
list_method=partial(
self.list_memberships_for_resource_by_external_id,
organization_id,
resource_type_slug,
external_id,
),
list_args=list_params,
**ListPage[AuthorizationOrganizationMembership](**response).model_dump(),
)


class AsyncAuthorization(AuthorizationModule):
_http_client: AsyncHTTPClient
Expand Down Expand Up @@ -712,3 +924,144 @@ async def add_environment_role_permission(
)

return EnvironmentRole.model_validate(response)

# Resource-Membership Relationships

async def list_resources_for_membership(
self,
organization_membership_id: str,
*,
permission_slug: str,
parent_resource_id: Optional[str] = None,
parent_resource_type_slug: Optional[str] = None,
parent_resource_external_id: Optional[str] = None,
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
before: Optional[str] = None,
after: Optional[str] = None,
order: PaginationOrder = "desc",
) -> ResourcesForMembershipListResource:
if parent_resource_id is not None and (
parent_resource_type_slug is not None
or parent_resource_external_id is not None
):
raise ValueError(
"Cannot specify both parent_resource_id and "
"parent_resource_type_slug/parent_resource_external_id. "
"Use one identification method."
)
if (parent_resource_type_slug is None) != (parent_resource_external_id is None):
raise ValueError(
"parent_resource_type_slug and parent_resource_external_id "
"must be provided together."
)

list_params: ResourcesForMembershipListFilters = {
"limit": limit,
"before": before,
"after": after,
"order": order,
"permission_slug": permission_slug,
}
if parent_resource_id is not None:
list_params["parent_resource_id"] = parent_resource_id
if parent_resource_type_slug is not None:
list_params["parent_resource_type_slug"] = parent_resource_type_slug
if parent_resource_external_id is not None:
list_params["parent_resource_external_id"] = parent_resource_external_id

response = await self._http_client.request(
f"authorization/organization_memberships/{organization_membership_id}/resources",
method=REQUEST_METHOD_GET,
params=list_params,
)

return WorkOSListResource[
Resource, ResourcesForMembershipListFilters, ListMetadata
](
list_method=partial(
self.list_resources_for_membership, organization_membership_id
),
list_args=list_params,
**ListPage[Resource](**response).model_dump(),
)

async def list_memberships_for_resource(
self,
resource_id: str,
*,
permission_slug: str,
assignment: Optional[Literal["direct", "indirect"]] = None,
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
before: Optional[str] = None,
after: Optional[str] = None,
order: PaginationOrder = "desc",
) -> MembershipsForResourceListResource:
list_params: MembershipsForResourceListFilters = {
"limit": limit,
"before": before,
"after": after,
"order": order,
"permission_slug": permission_slug,
}
if assignment is not None:
list_params["assignment"] = assignment

response = await self._http_client.request(
f"authorization/resources/{resource_id}/organization_memberships",
method=REQUEST_METHOD_GET,
params=list_params,
)

return WorkOSListResource[
AuthorizationOrganizationMembership,
MembershipsForResourceListFilters,
ListMetadata,
](
list_method=partial(self.list_memberships_for_resource, resource_id),
list_args=list_params,
**ListPage[AuthorizationOrganizationMembership](**response).model_dump(),
)

async def list_memberships_for_resource_by_external_id(
self,
organization_id: str,
resource_type_slug: str,
external_id: str,
*,
permission_slug: str,
assignment: Optional[Literal["direct", "indirect"]] = None,
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
before: Optional[str] = None,
after: Optional[str] = None,
order: PaginationOrder = "desc",
) -> MembershipsForResourceListResource:
list_params: MembershipsForResourceListFilters = {
"limit": limit,
"before": before,
"after": after,
"order": order,
"permission_slug": permission_slug,
}
if assignment is not None:
list_params["assignment"] = assignment

response = await self._http_client.request(
f"authorization/organizations/{organization_id}/resources/{resource_type_slug}/{external_id}/organization_memberships",
method=REQUEST_METHOD_GET,
params=list_params,
)

return WorkOSListResource[
AuthorizationOrganizationMembership,
MembershipsForResourceListFilters,
ListMetadata,
](
list_method=partial(
self.list_memberships_for_resource_by_external_id,
organization_id,
resource_type_slug,
external_id,
),
list_args=list_params,
**ListPage[AuthorizationOrganizationMembership](**response).model_dump(),
)
Loading