social.colibri.beta.bridge.redeemPairing
Connects a bridge to a community by redeeming its pairing code. Writes a registration with no linked channels.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | bridge.beta.colibri.social |
| Indexed |
Procedure
procedure · POSTInput
application/jsonOutput
application/jsonThe registration.
Errors
AuthRequired
The request is missing, malformed, or unverifiable service auth.
Forbidden
The caller lacks the community.manage permission.
CommunityNotFound
No community exists at the given DID.
PairingNotFound
The code does not exist, has expired, or was already used.
AlreadyRegistered
This bridge is already connected to the same remote space in this community.
CredentialsUnavailable
The AppView cannot act as the community because its stored credentials are missing or unusable.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
social.colibri.beta.bridge.createPairing
procedureStarts pairing a bridge with a community. Called by the bridge, which shows the returned code to an admin on the other service. A Colibri admin then redeems the code, which proves both sides agreed.
-
Describes a pending pairing code so an admin can see which bridge they are about to connect.
-
social.colibri.beta.bridge.revoke
procedureDisconnects a bridge from a community and deletes its registration. Messages it already relayed stay.
-
social.colibri.beta.bridge.leave
procedureDisconnects the calling bridge from a community and deletes its registration, for when the remote space removed the bridge. Messages it already relayed stay.
-
Lists the bridges connected to a community.