social.colibri.beta.community.handOverHost

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.

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

Procedure

procedure · POST

Input

application/json

community

requiredstring · did

The community.

email

requiredstring

The address that receives the server's codes for the move.

  • maxLength: 254

Output

application/json

expiresAt

requiredstring · datetime

When the password stops working.

identifier

requiredstring

The account's handle, to sign in with.

password

requiredstring

The account's new password. It is not shown again.

Errors

AuthRequired

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

Forbidden

The requesting user lacks permission for this community.

InvalidRequest

The arguments are inconsistent or malformed beyond schema validation.

CommunityNotFound

No community exists at that identifier.

HandOverUnavailable

The account does not live on this AppView's server, already moved, or the AppView cannot manage accounts there.

UpstreamFailure

A PDS or third-party call the AppView depends on failed.

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.

  • Hands the AppView credentials for a community hosted elsewhere, so it can administer a community it did not create. The password is stored encrypted at rest.