49 lines
1.3 KiB
Rust
49 lines
1.3 KiB
Rust
//! `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, UserId};
|
|
|
|
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: Box<UserId>,
|
|
}
|
|
}
|
|
|
|
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: Box<UserId>) -> Self {
|
|
Self { sub }
|
|
}
|
|
}
|
|
}
|