Register Users

Endpoints

RegisterUsers

This API allows for the creation of users in an administrative and non-interactive way. This is generally used for bootstrapping a Synapse instance with administrator accounts.

Source code in matrix_admin_sdk/endpoints/v1/register_user.py

class RegisterUsers(Endpoint):
    """
    This API allows for the creation of users in an administrative and non-interactive
    way. This is generally used for bootstrapping a Synapse instance with
    administrator accounts.
    """

    async def get_nonce(self) -> str:
        """
        To authenticate yourself to the server, you will need both the shared secret
        (registration_shared_secret in the homeserver configuration),
        and a one-time nonce. If the registration shared secret is not configured,
        this API is not enabled.

        To fetch the nonce, you need to request one from the API
        """
        url = self.url("register")
        result = await self.request(RequestMethods.GET, url)
        nonce: str = result["nonce"]
        return nonce

    async def register(
        self,
        nonce: str,
        username: str,
        displayname: str,
        password: str,
        admin: bool,
        mac: str,
    ) -> NewUserModel:
        """
        Register a new user.
        Args:
            nonce: nonce returned by get_nonce
            username: user's name
            displayname: user's display name
            password: user's password
            admin: is user an admin
            mac: please use utils.generate_mac to generate this

        Returns: new user model

        """
        url = self.url("register")
        data = {
            "nonce": nonce,
            "username": username,
            "displayname": displayname,
            "password": password,
            "admin": admin,
            "mac": mac,
        }
        result = await self.request(RequestMethods.POST, url, json=data)
        res: NewUserModel = NewUserModel.from_dict(result)
        return res

get_nonce(self) async

To authenticate yourself to the server, you will need both the shared secret (registration_shared_secret in the homeserver configuration), and a one-time nonce. If the registration shared secret is not configured, this API is not enabled.

To fetch the nonce, you need to request one from the API

Source code in matrix_admin_sdk/endpoints/v1/register_user.py

async def get_nonce(self) -> str:
    """
    To authenticate yourself to the server, you will need both the shared secret
    (registration_shared_secret in the homeserver configuration),
    and a one-time nonce. If the registration shared secret is not configured,
    this API is not enabled.

    To fetch the nonce, you need to request one from the API
    """
    url = self.url("register")
    result = await self.request(RequestMethods.GET, url)
    nonce: str = result["nonce"]
    return nonce

register(self, nonce, username, displayname, password, admin, mac) async

Register a new user.

Parameters:

Name	Type	Description	Default
nonce	str	nonce returned by get_nonce	required
username	str	user's name	required
displayname	str	user's display name	required
password	str	user's password	required
admin	bool	is user an admin	required
mac	str	please use utils.generate_mac to generate this	required

Source code in matrix_admin_sdk/endpoints/v1/register_user.py

async def register(
    self,
    nonce: str,
    username: str,
    displayname: str,
    password: str,
    admin: bool,
    mac: str,
) -> NewUserModel:
    """
    Register a new user.
    Args:
        nonce: nonce returned by get_nonce
        username: user's name
        displayname: user's display name
        password: user's password
        admin: is user an admin
        mac: please use utils.generate_mac to generate this

    Returns: new user model

    """
    url = self.url("register")
    data = {
        "nonce": nonce,
        "username": username,
        "displayname": displayname,
        "password": password,
        "admin": admin,
        "mac": mac,
    }
    result = await self.request(RequestMethods.POST, url, json=data)
    res: NewUserModel = NewUserModel.from_dict(result)
    return res

Models

NewUserModel

NewUserModel(access_token: str, user_id: str, home_server: str, device_id: str)

Source code in matrix_admin_sdk/models/v1/register_user.py

class NewUserModel(BaseModel):
    access_token: str
    user_id: str
    home_server: str
    device_id: str