social.colibri.beta.bridge.createPairing

Starts 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.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · procedure
Kindprocedure
Authoritybridge.beta.colibri.social
Indexed

Procedure

procedure · POST

Input

application/json

platform

requiredstring

The service the bridge connects to.

  • maxLength: 64

remoteSpace

requiredstring

The id of the server, workspace or network on the other service.

  • maxLength: 256

remoteSpaceName

requiredstring

Its name on the other service.

  • maxLength: 128

Output

application/json

code

requiredstring

The single-use pairing code.

  • maxLength: 32

expiresAt

requiredstring · datetime

When the code stops working.

Errors

AuthRequired

The request is missing, malformed, or unverifiable service auth.

RateLimited

The bridge sent too many requests. Retry after the interval in the response headers.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.