logo
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

//! `GET /_matrix/federation/*/openid/userinfo`
//!
//! Endpdoint for retrieving OpenID userinfo.

pub mod v1 {
    //! `/v1/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.2/server-server-api/#get_matrixfederationv1openiduserinfo

    use ruma_common::{api::ruma_api, OwnedUserId};

    ruma_api! {
        metadata: {
            description: "Exchanges an OpenID access token for information about the user who generated the token.",
            method: GET,
            name: "get_openid_userinfo",
            stable_path: "/_matrix/federation/v1/openid/userinfo",
            rate_limited: false,
            authentication: None,
            added: 1.0,
        }

        request: {
            /// The OpenID access token to get information about the owner for.
            #[ruma_api(query)]
            pub access_token: &'a str,
        }

        response: {
            /// The Matrix User ID who generated the token.
            pub sub: OwnedUserId,
        }
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given access token.
        pub fn new(access_token: &'a str) -> Self {
            Self { access_token }
        }
    }

    impl Response {
        /// Creates a new `Response` with the given user id.
        pub fn new(sub: OwnedUserId) -> Self {
            Self { sub }
        }
    }
}