ruma_client_api/account/
request_openid_token.rs

Help
1//! `POST /_matrix/client/*/user/{userId}/openid/request_token`
2//!
3//! Request an OpenID 1.0 token to verify identity with a third party.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3useruseridopenidrequest_token
9
10    use std::time::Duration;
11
12    use ruma_common::{
13        api::{request, response, Metadata},
14        authentication::TokenType,
15        metadata, OwnedServerName, OwnedUserId,
16    };
17
18    const METADATA: Metadata = metadata! {
19        method: POST,
20        rate_limited: true,
21        authentication: AccessToken,
22        history: {
23            1.0 => "/_matrix/client/r0/user/:user_id/openid/request_token",
24            1.1 => "/_matrix/client/v3/user/:user_id/openid/request_token",
25        }
26    };
27
28    /// Request type for the `request_openid_token` endpoint.
29    #[request(error = crate::Error)]
30    pub struct Request {
31        /// User ID of authenticated user.
32        #[ruma_api(path)]
33        pub user_id: OwnedUserId,
34    }
35
36    /// Response type for the `request_openid_token` endpoint.
37    #[response(error = crate::Error)]
38    pub struct Response {
39        /// Access token for verifying user's identity.
40        pub access_token: String,
41
42        /// Access token type.
43        pub token_type: TokenType,
44
45        /// Homeserver domain for verification of user's identity.
46        pub matrix_server_name: OwnedServerName,
47
48        /// Seconds until token expiration.
49        #[serde(with = "ruma_common::serde::duration::secs")]
50        pub expires_in: Duration,
51    }
52
53    impl Request {
54        /// Creates a new `Request` with the given user ID.
55        pub fn new(user_id: OwnedUserId) -> Self {
56            Self { user_id }
57        }
58    }
59
60    impl Response {
61        /// Creates a new `Response` with the given access token, token type, server name and
62        /// expiration duration.
63        pub fn new(
64            access_token: String,
65            token_type: TokenType,
66            matrix_server_name: OwnedServerName,
67            expires_in: Duration,
68        ) -> Self {
69            Self { access_token, token_type, matrix_server_name, expires_in }
70        }
71    }
72}
ruma_client_api/account/request_openid_token.rs

ruma_client_api/account/
request_openid_token.rs
