social.colibri.beta.community.getHosting

Describes where a community's account lives and whether the AppView can still act for it. Only administrators of the community 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

community

requiredstring · did

The community.

Output

application/json

hosting

requiredref

Where the community's account lives.

Reference

Errors

AuthRequired

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

Forbidden

The requesting user lacks permission for this community.

CommunityNotFound

No community exists at that identifier.

#hostingView

object

Where a community's account lives and whether the AppView can act for it.

Properties

account

requiredstring

The account's handle, or its DID when it has none.

connectedAt

string · datetime

When the AppView was last connected to the account.

connectedBy

string · did

The user who signed in as the account, for kind own.

handOverExpiresAt

string · datetime

When the password from handOverHost stops working, while a hand-over is active.

kind

requiredstring

colibri when the account lives on this AppView's server and the AppView holds its password. own when the account belongs to the community's owner and the AppView acts through a sign-in.

  • knownValues: colibri | own

needsSignIn

requiredboolean

Whether the AppView lost access and needs the owner to sign in again. New writes fail until then.

needsSignInSince

string · datetime

When the AppView lost access.

server

requiredstring · uri

The server the account lives on, as the AppView last reached it.

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.

  • Gets a community by DID or handle.

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

  • Get detailed information about a community. Authentication optional; viewer state will be included if authenticated.

  • Gives an administrator access to a community account that lives on this AppView's server, so they can move it to another server. The AppView sets the given email on the account, so codes the server sends reach the administrator, and returns a new password once. The password works for 60 minutes. If the account has not moved by then, the AppView replaces it and signs out every session.