ruma_identity_service_api/lookup/
lookup_3pid.rs

Help
1//! `POST /_matrix/identity/*/lookup`
2//!
3//! Looks up the set of Matrix User IDs which have bound the 3PIDs given, if bindings are available.
4
5pub mod v2 {
6    //! `/v2/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/identity-service-api/#post_matrixidentityv2lookup
9
10    use std::collections::BTreeMap;
11
12    use ruma_common::{
13        api::{request, response, Metadata},
14        metadata, OwnedUserId,
15    };
16
17    use crate::lookup::IdentifierHashingAlgorithm;
18
19    const METADATA: Metadata = metadata! {
20        method: POST,
21        rate_limited: false,
22        authentication: AccessToken,
23        history: {
24            1.0 => "/_matrix/identity/v2/lookup",
25        }
26    };
27
28    /// Request type for the `lookup_3pid` endpoint.
29    #[request]
30    pub struct Request {
31        /// The algorithm the client is using to encode the `addresses`. This should be one of the
32        /// available options from `/hash_details`.
33        pub algorithm: IdentifierHashingAlgorithm,
34
35        /// The pepper from `/hash_details`. This is required even when the `algorithm` does not
36        /// make use of it.
37        pub pepper: String,
38
39        /// The addresses to look up.
40        ///
41        /// The format of the entries here depend on the `algorithm` used. Note that queries which
42        /// have been incorrectly hashed or formatted will lead to no matches.
43        pub addresses: Vec<String>,
44    }
45
46    /// Response type for the `lookup_3pid` endpoint.
47    #[response]
48    pub struct Response {
49        /// Any applicable mappings of `addresses` to Matrix User IDs.
50        ///
51        /// Addresses which do not have associations will not be included, which can make this
52        /// property be an empty object.
53        pub mappings: BTreeMap<String, OwnedUserId>,
54    }
55
56    impl Request {
57        /// Create a `Request` with algorithm, pepper and addresses to loop up.
58        pub fn new(
59            algorithm: IdentifierHashingAlgorithm,
60            pepper: String,
61            addresses: Vec<String>,
62        ) -> Self {
63            Self { algorithm, pepper, addresses }
64        }
65    }
66
67    impl Response {
68        /// Create a `Response` with the BTreeMap which map addresses from the request which were
69        /// found to their corresponding User IDs.
70        pub fn new(mappings: BTreeMap<String, OwnedUserId>) -> Self {
71            Self { mappings }
72        }
73    }
74}
ruma_identity_service_api/lookup/lookup_3pid.rs

ruma_identity_service_api/lookup/
lookup_3pid.rs
