diff --git a/synapse/module_api/__init__.py b/synapse/module_api/__init__.py
index d735c1d461..ba9755f08b 100644
--- a/synapse/module_api/__init__.py
+++ b/synapse/module_api/__init__.py
@@ -111,6 +111,7 @@ from synapse.types import (
StateMap,
UserID,
UserInfo,
+ UserProfile,
create_requester,
)
from synapse.util import Clock
@@ -150,6 +151,7 @@ __all__ = [
"EventBase",
"StateMap",
"ProfileInfo",
+ "UserProfile",
]
logger = logging.getLogger(__name__)
@@ -609,15 +611,18 @@ class ModuleApi:
localpart: str,
displayname: Optional[str] = None,
emails: Optional[List[str]] = None,
+ admin: bool = False,
) -> "defer.Deferred[str]":
"""Registers a new user with given localpart and optional displayname, emails.
Added in Synapse v1.2.0.
+ Changed in Synapse v1.56.0: add 'admin' argument to register the user as admin.
Args:
localpart: The localpart of the new user.
displayname: The displayname of the new user.
emails: Emails to bind to the new user.
+ admin: True if the user should be registered as a server admin.
Raises:
SynapseError if there is an error performing the registration. Check the
@@ -631,6 +636,7 @@ class ModuleApi:
localpart=localpart,
default_display_name=displayname,
bind_emails=emails or [],
+ admin=admin,
)
)
@@ -665,7 +671,8 @@ class ModuleApi:
def record_user_external_id(
self, auth_provider_id: str, remote_user_id: str, registered_user_id: str
) -> defer.Deferred:
- """Record a mapping from an external user id to a mxid
+ """Record a mapping between an external user id from a single sign-on provider
+ and a mxid.
Added in Synapse v1.9.0.
@@ -1280,6 +1287,30 @@ class ModuleApi:
"""
await self._registration_handler.check_username(username)
+ async def store_remote_3pid_association(
+ self, user_id: str, medium: str, address: str, id_server: str
+ ) -> None:
+ """Stores an existing association between a user ID and a third-party identifier.
+
+ The association must already exist on the remote identity server.
+
+ Added in Synapse v1.56.0.
+
+ Args:
+ user_id: The user ID that's been associated with the 3PID.
+ medium: The medium of the 3PID (current supported values are "msisdn" and
+ "email").
+ address: The address of the 3PID.
+ id_server: The identity server the 3PID association has been registered on.
+ This should only be the domain (or IP address, optionally with the port
+ number) for the identity server. This will be used to reach out to the
+ identity server using HTTPS (unless specified otherwise by Synapse's
+ configuration) when attempting to unbind the third-party identifier.
+
+
+ """
+ await self._store.add_user_bound_threepid(user_id, medium, address, id_server)
+
class PublicRoomListManager:
"""Contains methods for adding to, removing from and querying whether a room
|
