Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions src/workos/authorization.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ def create_permission(
slug: str,
name: str,
description: Optional[str] = None,
resource_type_slug: Optional[str] = None,
) -> SyncOrAsync[Permission]: ...

def list_permissions(
Expand Down Expand Up @@ -133,6 +134,7 @@ def create_environment_role(
slug: str,
name: str,
description: Optional[str] = None,
resource_type_slug: Optional[str] = None,
) -> SyncOrAsync[EnvironmentRole]: ...

def list_environment_roles(self) -> SyncOrAsync[EnvironmentRoleList]: ...
Expand Down Expand Up @@ -174,10 +176,13 @@ def create_permission(
slug: str,
name: str,
description: Optional[str] = None,
resource_type_slug: Optional[str] = None,
) -> Permission:
json: Dict[str, Any] = {"slug": slug, "name": name}
if description is not None:
json["description"] = description
if resource_type_slug is not None:
json["resource_type_slug"] = resource_type_slug

response = self._http_client.request(
AUTHORIZATION_PERMISSIONS_PATH,
Expand Down Expand Up @@ -359,10 +364,13 @@ def create_environment_role(
slug: str,
name: str,
description: Optional[str] = None,
resource_type_slug: Optional[str] = None,
) -> EnvironmentRole:
json: Dict[str, Any] = {"slug": slug, "name": name}
if description is not None:
json["description"] = description
if resource_type_slug is not None:
json["resource_type_slug"] = resource_type_slug

response = self._http_client.request(
"authorization/roles",
Expand Down Expand Up @@ -450,10 +458,13 @@ async def create_permission(
slug: str,
name: str,
description: Optional[str] = None,
resource_type_slug: Optional[str] = None,
) -> Permission:
json: Dict[str, Any] = {"slug": slug, "name": name}
if description is not None:
json["description"] = description
if resource_type_slug is not None:
json["resource_type_slug"] = resource_type_slug

response = await self._http_client.request(
AUTHORIZATION_PERMISSIONS_PATH,
Expand Down Expand Up @@ -635,10 +646,13 @@ async def create_environment_role(
slug: str,
name: str,
description: Optional[str] = None,
resource_type_slug: Optional[str] = None,
) -> EnvironmentRole:
json: Dict[str, Any] = {"slug": slug, "name": name}
if description is not None:
json["description"] = description
if resource_type_slug is not None:
json["resource_type_slug"] = resource_type_slug

response = await self._http_client.request(
"authorization/roles",
Expand Down
1 change: 1 addition & 0 deletions src/workos/types/authorization/environment_role.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ class EnvironmentRole(WorkOSModel):
name: str
slug: str
description: Optional[str] = None
resource_type_slug: str
Copy link
Contributor

Choose a reason for hiding this comment

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

Verify API always returns this field - without Optional or default, Pydantic fails if missing.

permissions: Sequence[str]
type: Literal["EnvironmentRole"]
created_at: str
Expand Down
1 change: 1 addition & 0 deletions src/workos/types/authorization/organization_role.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ class OrganizationRole(WorkOSModel):
name: str
slug: str
description: Optional[str] = None
resource_type_slug: str
Copy link
Contributor

Choose a reason for hiding this comment

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

Verify API always returns this field - without Optional or default, Pydantic fails if missing.

permissions: Sequence[str]
type: Literal["OrganizationRole"]
created_at: str
Expand Down
1 change: 1 addition & 0 deletions src/workos/types/authorization/permission.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ class Permission(WorkOSModel):
slug: str
name: str
description: Optional[str] = None
resource_type_slug: str
Copy link
Contributor

Choose a reason for hiding this comment

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

Verify API always returns this field - without Optional or default, Pydantic fails if missing.

system: bool
created_at: str
updated_at: str
45 changes: 45 additions & 0 deletions tests/test_authorization.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,35 @@ def test_create_permission(

assert permission.id == "perm_01ABC"
assert permission.slug == "documents:read"
assert permission.resource_type_slug == "organization"
assert request_kwargs["method"] == "post"
assert request_kwargs["url"].endswith("/authorization/permissions")
assert request_kwargs["json"] == {
"slug": "documents:read",
"name": "Read Documents",
}

def test_create_permission_with_resource_type_slug(
self, mock_permission, capture_and_mock_http_client_request
):
request_kwargs = capture_and_mock_http_client_request(
self.http_client, mock_permission, 201
)

syncify(
self.authorization.create_permission(
slug="documents:read",
name="Read Documents",
resource_type_slug="project",
)
)

assert request_kwargs["json"] == {
"slug": "documents:read",
"name": "Read Documents",
"resource_type_slug": "project",
}

def test_create_permission_with_description(
self, mock_permission, capture_and_mock_http_client_request
):
Expand Down Expand Up @@ -205,6 +227,7 @@ def test_create_organization_role(

assert role.id == "role_01ABC"
assert role.type == "OrganizationRole"
assert role.resource_type_slug == "organization"
assert request_kwargs["method"] == "post"
assert request_kwargs["url"].endswith(
"/authorization/organizations/org_01EHT88Z8J8795GZNQ4ZP1J81T/roles"
Expand Down Expand Up @@ -366,10 +389,32 @@ def test_create_environment_role(

assert role.id == "role_01DEF"
assert role.type == "EnvironmentRole"
assert role.resource_type_slug == "organization"
assert request_kwargs["method"] == "post"
assert request_kwargs["url"].endswith("/authorization/roles")
assert request_kwargs["json"] == {"slug": "member", "name": "Member"}

def test_create_environment_role_with_resource_type_slug(
self, mock_environment_role, capture_and_mock_http_client_request
):
request_kwargs = capture_and_mock_http_client_request(
self.http_client, mock_environment_role, 201
)

syncify(
self.authorization.create_environment_role(
slug="member",
name="Member",
resource_type_slug="project",
)
)

assert request_kwargs["json"] == {
"slug": "member",
"name": "Member",
"resource_type_slug": "project",
}

def test_list_environment_roles(
self, mock_environment_roles, capture_and_mock_http_client_request
):
Expand Down
1 change: 1 addition & 0 deletions tests/utils/fixtures/mock_environment_role.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ def __init__(self, id: str):
name="Member",
slug="member",
description="Default environment member role",
resource_type_slug="organization",
permissions=["documents:read"],
type="EnvironmentRole",
created_at=now,
Expand Down
1 change: 1 addition & 0 deletions tests/utils/fixtures/mock_organization_role.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ def __init__(
name="Admin",
slug="admin",
description="Organization admin role",
resource_type_slug="organization",
permissions=["documents:read", "documents:write"],
type="OrganizationRole",
created_at=now,
Expand Down
1 change: 1 addition & 0 deletions tests/utils/fixtures/mock_permission.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ def __init__(self, id: str, slug: str = "documents:read"):
slug=slug,
name="Read Documents",
description="Allows reading documents",
resource_type_slug="organization",
system=False,
created_at=now,
updated_at=now,
Expand Down