social.colibri.beta.community.getHostAuthorization

Reports the outcome of a sign-in started with authorizeHost. Only the user who started it can read it.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · query
Kindquery
Authoritycommunity.beta.colibri.social
Indexed

Query

query · GET

Parameters

query string

request

requiredstring

The request returned by authorizeHost.

Output

application/json

community

string · did

The adopted or reconnected community, once done.

failure

string

Why the sign-in failed.

  • knownValues: cancelled | wrongAccount | spacesUnsupported | alreadyHosts | failed

The account the user signed in as, when it was not the expected one.

status

requiredstring

pending until the user finishes signing in, then done or failed.

  • knownValues: pending | done | failed

Errors

AuthRequired

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

RequestNotFound

No sign-in with that request exists for the requesting user.

Similar lexicons

semantic match

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

  • Starts a sign-in as a community host account. The requesting user opens the returned URL, signs in as that account on its own server and allows the AppView to act for it. The AppView then adopts the account as a new community, or reconnects an existing community after its sign-in lapsed or its account moved. Poll getHostAuthorization with the returned request to learn the outcome.

  • Describes where a community's account lives and whether the AppView can still act for it. Only administrators of the community can read it.