ruma_appservice_api/thirdparty/
get_user_for_protocol.rs

Help
1//! `GET /_matrix/app/*/thirdparty/user/{protocol}`
2//!
3//! Retrieve a Matrix User ID linked to a user on the third party network, given a set of user
4//! parameters.
5
6pub mod v1 {
7    //! `/v1/` ([spec])
8    //!
9    //! [spec]: https://spec.matrix.org/latest/application-service-api/#get_matrixappv1thirdpartyuserprotocol
10
11    use std::collections::BTreeMap;
12
13    use ruma_common::{
14        api::{request, response, Metadata},
15        metadata,
16        thirdparty::User,
17    };
18
19    const METADATA: Metadata = metadata! {
20        method: GET,
21        rate_limited: false,
22        authentication: AccessToken,
23        history: {
24            1.0 => "/_matrix/app/v1/thirdparty/user/:protocol",
25        }
26    };
27
28    /// Request type for the `get_user_for_protocol` endpoint.
29    #[request]
30    pub struct Request {
31        /// The protocol used to communicate to the third party network.
32        #[ruma_api(path)]
33        pub protocol: String,
34
35        /// One or more custom fields that are passed to the AS to help identify the user.
36        #[ruma_api(query_all)]
37        pub fields: BTreeMap<String, String>,
38    }
39
40    /// Response type for the `get_user_for_protocol` endpoint.
41    #[response]
42    pub struct Response {
43        /// List of matched third party users.
44        #[ruma_api(body)]
45        pub users: Vec<User>,
46    }
47
48    impl Request {
49        /// Creates a new `Request` with the given protocol name.
50        pub fn new(protocol: String) -> Self {
51            Self { protocol, fields: BTreeMap::new() }
52        }
53    }
54
55    impl Response {
56        /// Creates a new `Response` with the given users.
57        pub fn new(users: Vec<User>) -> Self {
58            Self { users }
59        }
60    }
61}
ruma_appservice_api/thirdparty/get_user_for_protocol.rs

ruma_appservice_api/thirdparty/
get_user_for_protocol.rs
