Skip to content

Dedicated MAS API #18520

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
merged 20 commits into from
Jul 21, 2025
Merged

Dedicated MAS API #18520

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
d32c32b
Dedicated API for MAS -> Synapse communication
sandhose Jul 18, 2025
23e7b88
Tests for the dedicated MAS users APIs
sandhose Jul 18, 2025
9ba9989
Tests for the dedicated MAS devices APIs
sandhose Jul 18, 2025
25fade5
Newsfile
sandhose Jul 18, 2025
cfb1ff4
Add doc comments for all new endpoints
sandhose Jul 18, 2025
86e8435
Fix starting up & tests if authlib is not installed
sandhose Jul 21, 2025
ae7c6ff
Change test order for consistency
sandhose Jul 21, 2025
f1647b7
Fix test comment accuracy
sandhose Jul 21, 2025
eb5e7a6
Rename endpoint create_device -> upsert_device
sandhose Jul 21, 2025
f91a698
Put 'email' in a constant
sandhose Jul 21, 2025
47c0161
Rename variable for clarity
sandhose Jul 21, 2025
31b32b3
Expand on why we log early
sandhose Jul 21, 2025
c1f666e
Use RequestBodyModel instead of BaseModel
sandhose Jul 21, 2025
48d7d7b
Rename assert_mas_request -> assert_request_is_from_mas
sandhose Jul 21, 2025
2eb98c0
Fix typo in tests
sandhose Jul 21, 2025
cc6da94
Skip MAS API tests if authlib is not available
sandhose Jul 21, 2025
02bf776
Remove broken test case
sandhose Jul 21, 2025
1fa7898
Import the MemoryReactor from the right place to keep compatibility w…
sandhose Jul 21, 2025
7e8c19e
Use a TypedDict instead of a BaseModel for MasQueryUserResource.Response
sandhose Jul 21, 2025
f8b4656
Use keyword args with the `TypedDict`
sandhose Jul 21, 2025
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
32 changes: 16 additions & 16 deletions synapse/rest/synapse/mas/users.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

import logging
from http import HTTPStatus
from typing import TYPE_CHECKING, Any, Optional, Tuple
from typing import TYPE_CHECKING, Any, Optional, Tuple, TypedDict

from synapse._pydantic_compat import BaseModel, StrictBool, StrictStr, root_validator
from synapse._pydantic_compat import StrictBool, StrictStr, root_validator
from synapse.api.errors import NotFoundError, SynapseError
from synapse.http.servlet import (
parse_and_validate_json_object_from_request,
Expand Down Expand Up @@ -49,16 +49,16 @@ class MasQueryUserResource(MasBaseResource):
def __init__(self, hs: "HomeServer"):
MasBaseResource.__init__(self, hs)

class Response(BaseModel):
user_id: StrictStr
display_name: Optional[StrictStr]
avatar_url: Optional[StrictStr]
is_suspended: StrictBool
is_deactivated: StrictBool
class Response(TypedDict):
user_id: str
display_name: Optional[str]
avatar_url: Optional[str]
is_suspended: bool
is_deactivated: bool

async def _async_render_GET(
self, request: "SynapseRequest"
) -> Tuple[int, JsonDict]:
) -> Tuple[int, Response]:
self.assert_request_is_from_mas(request)

localpart = parse_string(request, "localpart", required=True)
Expand All @@ -70,13 +70,13 @@ async def _async_render_GET(

profile = await self.store.get_profileinfo(user_id=user_id)

return HTTPStatus.OK, self.Response(
user_id=user_id.to_string(),
display_name=profile.display_name,
avatar_url=profile.avatar_url,
is_suspended=user.suspended,
is_deactivated=user.is_deactivated,
).dict()
return HTTPStatus.OK, {
"user_id": user_id.to_string(),
"display_name": profile.display_name,
"avatar_url": profile.avatar_url,
"is_suspended": user.suspended,
"is_deactivated": user.is_deactivated,
}


class MasProvisionUserResource(MasBaseResource):
Expand Down
Loading