mtx::requests::Login struct

Request payload for the POST /_matrix/client/r0/login endpoint.

Public variables

std::string type
The login type being used. One of ["m.login.password", "m.login.token"].
std::variant<login_identifier::User, login_identifier::Thirdparty, login_identifier::PhoneNumber> identifier
Identification information for the user. Usually you use login_identifier::User with an mxid. Required.
std::string token
Required when type is m.login.token. The login token.
std::string password
Required when type is m.login.password. The user's password.
std::string device_id
ID of the client device. If this does not correspond to a known client device, a new device will be created. The server will auto-generate a device_id if this is not specified.
std::string initial_device_display_name
A display name to assign to the newly-created device. Ignored if device_id corresponds to a known device.