1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

//! Endpoints for user session management.

/// [POST /_matrix/client/r0/login](https://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-login)
pub mod login {
    use ruma_api_macros::ruma_api;
    use ruma_identifiers::UserId;

    ruma_api! {
        metadata {
            description: "Login to the homeserver.",
            method: POST,
            name: "login",
            path: "/_matrix/client/r0/login",
            rate_limited: true,
            requires_authentication: false,
        }

        request {
            /// The user's password.
            pub password: String,
            /// When logging in using a third party identifier, the medium of the identifier.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub medium: Option<Medium>,
            /// The authentication mechanism.
            #[serde(rename = "type")]
            pub login_type: LoginType,
            /// The fully qualified user ID or just local part of the user ID.
            pub user: String,
            /// Third party identifier for the user.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub address: Option<String>,
            /// ID of the client device
            #[serde(skip_serializing_if = "Option::is_none")]
            pub device_id: Option<String>,
        }

        response {
            /// An access token for the account.
            pub access_token: String,
            /// The hostname of the homeserver on which the account has been registered.
            pub home_server: String,
            /// A refresh token may be exchanged for a new access token using the /tokenrefresh API
            /// endpoint.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub refresh_token: Option<String>,
            /// The fully-qualified Matrix ID that has been registered.
            pub user_id: UserId,
            /// ID of the logged-in device.
            ///
            /// Will be the same as the corresponging parameter in the request, if one was
            /// specified.
            pub device_id: String,
        }
    }

    /// The medium of a third party identifier.
    #[derive(Clone, Debug, Deserialize, Serialize)]
    pub enum Medium {
        /// An email address.
        #[serde(rename = "email")]
        Email,
    }

    /// The authentication mechanism.
    #[derive(Clone, Debug, Deserialize, Serialize)]
    pub enum LoginType {
        /// A password is supplied to authenticate.
        #[serde(rename = "m.login.password")]
        Password,
    }
}

/// [POST /_matrix/client/r0/logout](https://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-logout)
pub mod logout {
    use ruma_api_macros::ruma_api;

    ruma_api! {
        metadata {
            description: "Log out of the homeserver.",
            method: POST,
            name: "logout",
            path: "/_matrix/client/r0/logout",
            rate_limited: false,
            requires_authentication: true,
        }

        request {}

        response {}
    }
}