matrix-js-sdk
    Preparing search index...

    Interface RegisterRequest

    The request body of a call to POST /_matrix/client/v3/register.

    https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3register

    interface RegisterRequest {
        auth?: AuthDict;
        guest_access_token?: string;
        inhibit_login?: boolean;
        initial_device_display_name?: string;
        password?: string;
        refresh_token?: boolean;
        username?: string;
    }
    Index

    Properties

    auth? guest_access_token? inhibit_login? initial_device_display_name? password? refresh_token? username?

    Properties

    auth?: AuthDict

    Additional authentication information for the user-interactive authentication API. Note that this information is not used to define how the registered user should be authenticated, but is instead used to authenticate the register call itself.

    guest_access_token?: string

    Guest users can also upgrade their account by going through the ordinary register flow, but specifying the additional POST parameter guest_access_token containing the guest’s access token. They are also required to specify the username parameter to the value of the local part of their username, which is otherwise optional.

    https://spec.matrix.org/v1.10/client-server-api/#guest-access

    inhibit_login?: boolean

    If true, an access_token and device_id should not be returned from this call, therefore preventing an automatic login. Defaults to false.

    initial_device_display_name?: string

    A display name to assign to the newly-created device. Ignored if device_id corresponds to a known device.

    password?: string

    The desired password for the account.

    refresh_token?: boolean

    If true, the client supports refresh tokens.

    username?: string

    The basis for the localpart of the desired Matrix ID. If omitted, the homeserver MUST generate a Matrix ID local part.

    Settings

    Member Visibility

    On This Page

    Properties