synapse-admin-api 0.10.0

Types for the endpoints in the synapse admin API.
Documentation 
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

//! [POST /_synapse/admin/v1/reset_password/:user_id](https://github.com/element-hq/synapse/blob/master/docs/admin_api/user_admin_api.md#reset-password)

use ruma::{
    OwnedUserId,
    api::{auth_scheme::AccessToken, metadata, request, response},
};

metadata! {
    method: POST,
    rate_limited: false,
    authentication: AccessToken,
    path: "/_synapse/admin/v1/reset_password/{user_id}",
}

#[request]
pub struct Request {
    /// user ID of the account to reset the password
    #[ruma_api(path)]
    pub user_id: OwnedUserId,

    /// new password
    pub new_password: String,

    /// Logout all devices of the user, so it necessary to login with the new password again.
    /// Defaults to true.
    #[serde(default = "ruma::serde::default_true")]
    pub logout_devices: bool,
}

#[derive(Default)]
#[response]
pub struct Response {}

impl Request {
    /// Creates an `Request` with the given user ID and the new password.
    pub fn new(user_id: OwnedUserId, new_password: String) -> Self {
        Self { user_id, new_password, logout_devices: true }
    }
}

impl Response {
    /// Creates an empty `Response`.
    pub fn new() -> Self {
        Self {}
    }
}