Lexicon Garden

com.getorbyt.community.manageMember

Mute, ban, or re-role a member. Only an administrator may set a role; a moderator may mute and ban, but never a peer or an administrator. Administration is service state and may be granted to an account that does not hold the declaration record; authority over the record itself is never transferable and always belongs to the repository that holds it.

Repository @getorbyt.com did:plc:2xrqztnmzlckb3xfuuukupso namespace authority
Details · procedure
Kindprocedure
Authoritycommunity.getorbyt.com
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

action

requiredstring
  • knownValues: setRole | mute | unmute | ban | unban

community

requiredstring · at-uri

did

requiredstring · did

durationDays

integer

For mute and ban: how many days it lasts. Absent means until a moderator lifts it.

  • minimum: 1
  • maximum: 999

message

string

For mute and ban: what the member is told.

  • maxLength: 2000

role

string

The role to set. Granting owner grants administration — moderation and role assignment — to another account; it does not move the declaration record, which stays in the repository that holds it, and the holder's own administration can never be revoked.

  • knownValues: owner | moderator | member

roleKey

string

With role moderator, the Community-defined role to give. Absent gives the built-in moderator role. Someone who is not an administrator may only give a role whose permissions they hold themselves, and never owner.

  • maxLength: 64

Output

application/json

restrictedUntil

string · datetime

When a timed mute or ban ends.

status

requiredstring
  • knownValues: none | active | muted | banned

Errors

CommunityNotFound

No description in schema.

InsufficientRole

No description in schema.

InvalidAction

No description in schema.

RoleNotFound

roleKey names no role the Community defined.

AuthenticationRequired

The request carried no service-auth token, or one this service could not verify for the method. Distinct from InsufficientRole: the caller's identity was never established, so no role decision was made. A client should reauthorize and retry once rather than tell the viewer they lack access.

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.community.ban

    procedure

    Bans a member from a community. This removes their member record and stops the community issuing them space credentials. Their existing content is not deleted: it stays in their own repo, where it can still be labelled or filtered.

  • social.colibri.voice.moderate

    procedure not from the namespace authority

    Moderates a member's participation in a voice channel: server-mute, server-deafen, or force-disconnect. Requires the `voice.moderate` community permission and the caller must outrank the target. Server-mute/deafen are enforced by the SFU and persist for the room's lifetime, disconnect is transient (the target may rejoin).

  • com.getorbyt.community.deleteRole

    procedure

    Deletes a role the Community defined, or, for the key moderator, puts the built-in moderator role back to its default permissions. A role someone holds cannot be deleted; move them to another role first. Only an administrator may delete roles. Recorded in the moderation log.

  • social.colibri.beta.community.setMemberRoles

    procedure

    Sets the complete set of roles a member holds.

  • com.getorbyt.community.saveRole

    procedure

    Creates a Community role, or changes one. Without a key it creates a role; with one it replaces that role's name and permissions. The key moderator changes what the built-in moderator role may do, and keeps its name. Only an administrator may define roles. Recorded in the moderation log.