mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-11-28 07:00:51 +03:00
Code Issues Projects Releases Packages Wiki Activity

Allow registering admin users using the module API (#12250)

Browse source 
Signed-off-by: Nicolas Werner <n.werner@famedly.com>
This commit is contained in:
Nicolas Werner 2022-03-23 11:48:47 +00:00 committed by GitHub
parent 516d092ff9
commit 692b82838e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/12250.feature Normal file
View file

@ -0,0 +1 @@
Allow registering admin users using the module API. Contributed by Famedly.

4
synapse/module_api/__init__.py
View file

@ -611,15 +611,18 @@ class ModuleApi:
localpart: str, localpart: str,
displayname: Optional[str] = None, displayname: Optional[str] = None,
emails: Optional[List[str]] = None, emails: Optional[List[str]] = None,
admin: bool = False,
) -> "defer.Deferred[str]": ) -> "defer.Deferred[str]":
"""Registers a new user with given localpart and optional displayname, emails. """Registers a new user with given localpart and optional displayname, emails.
Added in Synapse v1.2.0. Added in Synapse v1.2.0.
Changed in Synapse v1.56.0: add 'admin' argument to register the user as admin.
Args: Args:
localpart: The localpart of the new user. localpart: The localpart of the new user.
displayname: The displayname of the new user. displayname: The displayname of the new user.
emails: Emails to bind to the new user. emails: Emails to bind to the new user.
admin: True if the user should be registered as a server admin.
Raises: Raises:
SynapseError if there is an error performing the registration. Check the SynapseError if there is an error performing the registration. Check the
@ -633,6 +636,7 @@ class ModuleApi:
localpart=localpart, localpart=localpart,
default_display_name=displayname, default_display_name=displayname,
bind_emails=emails or [], bind_emails=emails or [],
admin=admin,
) )
) )

10
tests/module_api/test_api.py
View file

@ -86,6 +86,16 @@ class ModuleApiTestCase(HomeserverTestCase):
displayname = self.get_success(self.store.get_profile_displayname("bob")) displayname = self.get_success(self.store.get_profile_displayname("bob"))
self.assertEqual(displayname, "Bobberino") self.assertEqual(displayname, "Bobberino")
def test_can_register_admin_user(self):
user_id = self.get_success(
self.register_user(
"bob_module_admin", "1234", displayname="Bobberino Admin", admin=True
)
)
found_user = self.get_success(self.module_api.get_userinfo_by_id(user_id))
self.assertEqual(found_user.user_id.to_string(), user_id)
self.assertIdentical(found_user.is_admin, True)
def test_get_userinfo_by_id(self): def test_get_userinfo_by_id(self):
user_id = self.register_user("alice", "1234") user_id = self.register_user("alice", "1234")
found_user = self.get_success(self.module_api.get_userinfo_by_id(user_id)) found_user = self.get_success(self.module_api.get_userinfo_by_id(user_id))