95 lines
3.0 KiB
Rust
95 lines
3.0 KiB
Rust
//! [PUT /_matrix/federation/v1/3pid/onbind](https://matrix.org/docs/spec/server_server/r0.1.4#put-matrix-federation-v1-3pid-onbind)
|
|
|
|
use std::collections::BTreeMap;
|
|
|
|
use ruma_api::ruma_api;
|
|
use ruma_common::thirdparty::Medium;
|
|
use ruma_identifiers::{RoomId, ServerName, ServerSigningKeyId, UserId};
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
ruma_api! {
|
|
metadata: {
|
|
description: "Used by identity servers to notify the homeserver that one of its users has bound a third party identifier successfully",
|
|
method: PUT,
|
|
name: "bind_callback",
|
|
path: "/_matrix/federation/v1/3pid/onbind",
|
|
rate_limited: false,
|
|
authentication: None,
|
|
}
|
|
|
|
request: {
|
|
/// The type of third party identifier.
|
|
///
|
|
/// Currently only `Medium::Email` is supported.
|
|
pub medium: &'a Medium,
|
|
|
|
/// The third party identifier itself.
|
|
///
|
|
/// For example: an email address.
|
|
pub address: &'a str,
|
|
|
|
/// The user that is now bound to the third party identifier.
|
|
pub mxid: &'a UserId,
|
|
|
|
/// A list of pending invites that the third party identifier has received.
|
|
pub invites: &'a [ThirdPartyInvite],
|
|
}
|
|
|
|
response: {}
|
|
}
|
|
|
|
impl<'a> Request<'a> {
|
|
/// Creates a new `Request` with the given medium, address, user ID and third party invites.
|
|
pub fn new(
|
|
medium: &'a Medium,
|
|
address: &'a str,
|
|
mxid: &'a UserId,
|
|
invites: &'a [ThirdPartyInvite],
|
|
) -> Self {
|
|
Self { medium, address, mxid, invites }
|
|
}
|
|
|
|
/// Creates a new `Request` with the given email address, user ID and third party invites.
|
|
pub fn email(address: &'a str, mxid: &'a UserId, invites: &'a [ThirdPartyInvite]) -> Self {
|
|
Self::new(&Medium::Email, address, mxid, invites)
|
|
}
|
|
}
|
|
|
|
/// A pending invite the third party identifier has received.
|
|
#[derive(Debug, Clone, Deserialize, Serialize)]
|
|
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
|
|
pub struct ThirdPartyInvite {
|
|
/// The type of third party invite issues.
|
|
///
|
|
/// Currently only `Medium::Email` is used.
|
|
pub medium: Medium,
|
|
|
|
/// The third party identifier that received the invite.
|
|
pub address: String,
|
|
|
|
/// The now-bound user ID that received the invite.
|
|
pub mxid: Box<UserId>,
|
|
|
|
/// The room ID the invite is valid for.
|
|
pub room_id: Box<RoomId>,
|
|
|
|
/// The user ID that sent the invite.
|
|
pub sender: Box<UserId>,
|
|
|
|
/// Signature from the identity server using a long-term private key.
|
|
pub signed: BTreeMap<Box<ServerName>, BTreeMap<ServerSigningKeyId, String>>,
|
|
}
|
|
|
|
impl ThirdPartyInvite {
|
|
/// Creates a new third party invite with the given parameters.
|
|
pub fn new(
|
|
address: String,
|
|
mxid: Box<UserId>,
|
|
room_id: Box<RoomId>,
|
|
sender: Box<UserId>,
|
|
signed: BTreeMap<Box<ServerName>, BTreeMap<ServerSigningKeyId, String>>,
|
|
) -> Self {
|
|
Self { medium: Medium::Email, address, mxid, room_id, sender, signed }
|
|
}
|
|
}
|