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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
//! `PUT /_matrix/federation/*/3pid/onbind`
//!
//! Used by identity servers to notify the homeserver that one of its users has bound a third party
//! identifier successfully, including any pending room invites the identity server has been made
//! aware of.
pub mod v1 {
//! `/v1/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/server-server-api/#put_matrixfederationv13pidonbind
use std::collections::BTreeMap;
use ruma_common::{
api::{request, response, Metadata},
metadata,
thirdparty::Medium,
OwnedRoomId, OwnedServerName, OwnedServerSigningKeyId, OwnedUserId,
};
use serde::{Deserialize, Serialize};
const METADATA: Metadata = metadata! {
method: PUT,
rate_limited: false,
authentication: None,
history: {
1.0 => "/_matrix/federation/v1/3pid/onbind",
}
};
/// Request type for the `bind_callback` endpoint.
#[request]
pub struct Request {
/// The type of third party identifier.
///
/// Currently only `Medium::Email` is supported.
pub medium: Medium,
/// The third party identifier itself.
///
/// For example: an email address.
pub address: String,
/// The user that is now bound to the third party identifier.
pub mxid: OwnedUserId,
/// A list of pending invites that the third party identifier has received.
pub invites: Vec<ThirdPartyInvite>,
}
/// Response type for the `bind_callback` endpoint.
#[response]
pub struct Response {}
impl Request {
/// Creates a new `Request` with the given medium, address, user ID and third party invites.
pub fn new(
medium: Medium,
address: String,
mxid: OwnedUserId,
invites: Vec<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: String, mxid: OwnedUserId, invites: Vec<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: OwnedUserId,
/// The room ID the invite is valid for.
pub room_id: OwnedRoomId,
/// The user ID that sent the invite.
pub sender: OwnedUserId,
/// Signature from the identity server using a long-term private key.
pub signed: BTreeMap<OwnedServerName, BTreeMap<OwnedServerSigningKeyId, String>>,
}
impl ThirdPartyInvite {
/// Creates a new third party invite with the given parameters.
pub fn new(
address: String,
mxid: OwnedUserId,
room_id: OwnedRoomId,
sender: OwnedUserId,
signed: BTreeMap<OwnedServerName, BTreeMap<OwnedServerSigningKeyId, String>>,
) -> Self {
Self { medium: Medium::Email, address, mxid, room_id, sender, signed }
}
}
}