ruwuma/crates/ruma-federation-api/src/openid/get_openid_userinfo.rs

53 lines
1.4 KiB
Rust

//! `GET /_matrix/federation/*/openid/userinfo`
//!
//! Exchange an OpenID access token for information about the user who generated the token.
pub mod v1 {
//! `/v1/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/server-server-api/#get_matrixfederationv1openiduserinfo
use ruma_common::{
api::{request, response, Metadata},
metadata, OwnedUserId,
};
const METADATA: Metadata = metadata! {
method: GET,
rate_limited: false,
authentication: None,
history: {
1.0 => "/_matrix/federation/v1/openid/userinfo",
}
};
/// Request type for the `get_openid_userinfo` endpoint.
#[request]
pub struct Request {
/// The OpenID access token to get information about the owner for.
#[ruma_api(query)]
pub access_token: String,
}
/// Response type for the `get_openid_userinfo` endpoint.
#[response]
pub struct Response {
/// The Matrix User ID who generated the token.
pub sub: OwnedUserId,
}
impl Request {
/// Creates a new `Request` with the given access token.
pub fn new(access_token: String) -> Self {
Self { access_token }
}
}
impl Response {
/// Creates a new `Response` with the given user id.
pub fn new(sub: OwnedUserId) -> Self {
Self { sub }
}
}
}