Skip to content

Commit

Permalink
register-new-matrix-user: add a flag to ignore already existing users
Browse files Browse the repository at this point in the history
This allows to register users in a more declarative and stateless way.

Signed-off-by: Jörg Thalheim <joerg@thalheim.io>
  • Loading branch information
Mic92 committed Jun 14, 2024
1 parent bc199a2 commit 6cc9192
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion synapse/_scripts/register_new_matrix_user.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ def request_registration(
user_type: Optional[str] = None,
_print: Callable[[str], None] = print,
exit: Callable[[int], None] = sys.exit,
exists_ok: bool = False,
) -> None:
url = "%s/_synapse/admin/v1/register" % (server_location.rstrip("/"),)

Expand Down Expand Up @@ -97,6 +98,10 @@ def request_registration(
r = requests.post(url, json=data)

if r.status_code != 200:
response = r.json()
if exists_ok and response["errcode"] == "M_USER_IN_USE":
_print("User already exists. Skipping.")
return
_print("ERROR! Received %d %s" % (r.status_code, r.reason))
if 400 <= r.status_code < 500:
try:
Expand All @@ -115,6 +120,7 @@ def register_new_user(
shared_secret: str,
admin: Optional[bool],
user_type: Optional[str],
exists_ok: bool = False,
) -> None:
if not user:
try:
Expand Down Expand Up @@ -154,7 +160,13 @@ def register_new_user(
admin = False

request_registration(
user, password, server_location, shared_secret, bool(admin), user_type
user,
password,
server_location,
shared_secret,
bool(admin),
user_type,
exists_ok=exists_ok,
)


Expand All @@ -173,6 +185,11 @@ def main() -> None:
default=None,
help="Local part of the new user. Will prompt if omitted.",
)
parser.add_argument(
"--exists-ok",
action="store_true",
help="Do not fail if user already exists.",
)
password_group = parser.add_mutually_exclusive_group()
password_group.add_argument(
"-p",
Expand All @@ -192,6 +209,7 @@ def main() -> None:
default=None,
help="User type as specified in synapse.api.constants.UserTypes",
)

admin_group = parser.add_mutually_exclusive_group()
admin_group.add_argument(
"-a",
Expand Down

0 comments on commit 6cc9192

Please sign in to comment.