ruma_client_api/account/
whoami.rs

1//! `GET /_matrix/client/*/account/whoami`
2//!
3//! Get information about the owner of a given access token.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3accountwhoami
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedDeviceId, OwnedUserId,
13    };
14
15    const METADATA: Metadata = metadata! {
16        method: GET,
17        rate_limited: true,
18        authentication: AccessToken,
19        history: {
20            1.0 => "/_matrix/client/r0/account/whoami",
21            1.1 => "/_matrix/client/v3/account/whoami",
22        }
23    };
24
25    /// Request type for the `whoami` endpoint.
26    #[request(error = crate::Error)]
27    #[derive(Default)]
28    pub struct Request {}
29
30    /// Response type for the `whoami` endpoint.
31    #[response(error = crate::Error)]
32    pub struct Response {
33        /// The id of the user that owns the access token.
34        pub user_id: OwnedUserId,
35
36        /// The device ID associated with the access token, if any.
37        #[serde(skip_serializing_if = "Option::is_none")]
38        pub device_id: Option<OwnedDeviceId>,
39
40        /// If `true`, the user is a guest user.
41        #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
42        pub is_guest: bool,
43    }
44
45    impl Request {
46        /// Creates an empty `Request`.
47        pub fn new() -> Self {
48            Self {}
49        }
50    }
51
52    impl Response {
53        /// Creates a new `Response` with the given user ID.
54        pub fn new(user_id: OwnedUserId, is_guest: bool) -> Self {
55            Self { user_id, device_id: None, is_guest }
56        }
57    }
58}
ruma_client_api/account/whoami.rs

ruma_client_api/account/
whoami.rs
