Methods
The calls an app makes to a group's host, and the action each one requires.
Every method is served by the group’s host and authorized against that group’s roles. Each takes the group’s DID as group. The caller authenticates as themselves, with service auth from their own PDS, so the host knows who is asking without holding any of their credentials.
All names are under group.opensocial.
| Method | Requires | Purpose |
|---|---|---|
updateProfile | group.configure | Replace the profile. |
uploadImage | group.configure | Upload an avatar or banner image. |
putRule | group.configure | Create or update a rule. |
deleteRule | group.configure | Remove a rule. |
putRole | group.configure | Create or update a role and its action bindings. |
deleteRole | group.configure | Remove a role. |
createSpace | space.create | Add a modality space to the group. |
updateSpace | space.configure | Change a space's config, including who can read it. |
deleteSpace | space.delete | Remove a space. Refuses the two well-known spaces. |
assignRoles | role.assign | Set a member's full role set. |
ejectMember | eject | Remove a member and their access. |
createInvite | invite | Write an invite into someone's own invites space. |
listInvites | invite | Outstanding invites. |
revokeInvite | invite | Retract an outstanding invite. |
requestJoin | anyone | Ask to join, or redeem an invite. |
cancelJoinRequest | anyone | Withdraw a pending join request. |
leaveGroup | anyone | Leave the group. |
listJoinRequests | admit | The pending-requests queue. |
admitMember | admit | Approve or deny a join request. |
listSubjects | mod.read | The moderation queue. |
getSubjectHistory | mod.read | Every event on one subject. |
resolveSubject | mod.resolve | Resolve or escalate a subject, optionally with a note. |
applyLabel | label / takedown | Write a label into the subject's space. |
negateLabel | label / takedown | Negate a previously applied label. |