Lexicon Garden

social.colibri.beta.bridge.getPairing

Describes a pending pairing code so an admin can see which bridge they are about to connect.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · query
Kindquery
Authoritybridge.beta.colibri.social
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

code

requiredstring

The pairing code.

  • maxLength: 32

Output

application/json

pairing

requiredref

The pending pairing.

Reference

Errors

AuthRequired

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

PairingNotFound

The code does not exist, has expired, or was already used.

Similar lexicons

semantic match

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

  • social.colibri.beta.bridge.createPairing

    procedure

    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.

  • social.colibri.beta.bridge.redeemPairing

    procedure

    Connects a bridge to a community by redeeming its pairing code. Writes a registration with no linked channels.

  • dev.cocore.devicePair.describe

    query

    Describe a pending pairing attempt by its `userCode`, so the approve screen can say who is asking and for what. Public: it only echoes what the requester supplied at `start` (application name, key name, return URL) plus the attempt's status and remaining lifetime. It never returns the `deviceId` or a session.

  • dev.cocore.devicePair.poll

    query

    Poll a device-pairing attempt by `deviceId`. While the user has not acted, returns `pending`. On approval, returns `session` together with the granted provider session. Terminal negative states are `denied`, `expired`, and `consumed`. An unknown `deviceId` is `unknown`.