ruma_client_api/server/get_user_info.rs
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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
//! `GET /_matrix/client/*/admin/whois/{userId}`
//!
//! Get information about a particular user.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3adminwhoisuserid
use std::collections::BTreeMap;
use ruma_common::{
api::{request, response, Metadata},
metadata, MilliSecondsSinceUnixEpoch, OwnedUserId,
};
use serde::{Deserialize, Serialize};
const METADATA: Metadata = metadata! {
method: GET,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/admin/whois/:user_id",
1.1 => "/_matrix/client/v3/admin/whois/:user_id",
}
};
/// Request type for the `get_user_info` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The user to look up.
#[ruma_api(path)]
pub user_id: OwnedUserId,
}
/// Response type for the `get_user_info` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {
/// The Matrix user ID of the user.
#[serde(skip_serializing_if = "Option::is_none")]
pub user_id: Option<OwnedUserId>,
/// A map of the user's device identifiers to information about that device.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub devices: BTreeMap<String, DeviceInfo>,
}
impl Request {
/// Creates a new `Request` with the given user id.
pub fn new(user_id: OwnedUserId) -> Self {
Self { user_id }
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Default::default()
}
}
/// Information about a user's device.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct DeviceInfo {
/// A list of user sessions on this device.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub sessions: Vec<SessionInfo>,
}
impl DeviceInfo {
/// Create a new `DeviceInfo` with no sessions.
pub fn new() -> Self {
Self::default()
}
}
/// Information about a user session.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct SessionInfo {
/// A list of connections in this session.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub connections: Vec<ConnectionInfo>,
}
impl SessionInfo {
/// Create a new `SessionInfo` with no connections.
pub fn new() -> Self {
Self::default()
}
}
/// Information about a connection in a user session.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct ConnectionInfo {
/// Most recently seen IP address of the session.
pub ip: Option<String>,
/// Time when that the session was last active.
pub last_seen: Option<MilliSecondsSinceUnixEpoch>,
/// User agent string last seen in the session.
pub user_agent: Option<String>,
}
impl ConnectionInfo {
/// Create a new `ConnectionInfo` with all fields set to `None`.
pub fn new() -> Self {
Self::default()
}
}
}