ruma_client_api/account/
change_password.rs

Help
1//! `POST /_matrix/client/*/account/password`
2//!
3//! Change the password of the current user's account.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3accountpassword
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13    };
14
15    use crate::uiaa::{AuthData, UiaaResponse};
16
17    const METADATA: Metadata = metadata! {
18        method: POST,
19        rate_limited: true,
20        authentication: AccessTokenOptional,
21        history: {
22            1.0 => "/_matrix/client/r0/account/password",
23            1.1 => "/_matrix/client/v3/account/password",
24        }
25    };
26
27    /// Request type for the `change_password` endpoint.
28    #[request(error = UiaaResponse)]
29    pub struct Request {
30        /// The new password for the account.
31        pub new_password: String,
32
33        /// True to revoke the user's other access tokens, and their associated devices if the
34        /// request succeeds.
35        ///
36        /// Defaults to true.
37        ///
38        /// When false, the server can still take advantage of the soft logout method for the
39        /// user's remaining devices.
40        #[serde(
41            default = "ruma_common::serde::default_true",
42            skip_serializing_if = "ruma_common::serde::is_true"
43        )]
44        pub logout_devices: bool,
45
46        /// Additional authentication information for the user-interactive authentication API.
47        #[serde(skip_serializing_if = "Option::is_none")]
48        pub auth: Option<AuthData>,
49    }
50
51    /// Response type for the `change_password` endpoint.
52    #[response(error = UiaaResponse)]
53    #[derive(Default)]
54    pub struct Response {}
55
56    impl Request {
57        /// Creates a new `Request` with the given password.
58        pub fn new(new_password: String) -> Self {
59            Self { new_password, logout_devices: true, auth: None }
60        }
61    }
62
63    impl Response {
64        /// Creates an empty `Response`.
65        pub fn new() -> Self {
66            Self {}
67        }
68    }
69}
ruma_client_api/account/change_password.rs

ruma_client_api/account/
change_password.rs
