MenuMethods

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.

MethodRequiresPurpose
updateProfilegroup.configureReplace the profile.
uploadImagegroup.configureUpload an avatar or banner image.
putRulegroup.configureCreate or update a rule.
deleteRulegroup.configureRemove a rule.
putRolegroup.configureCreate or update a role and its action bindings.
deleteRolegroup.configureRemove a role.
createSpacespace.createAdd a modality space to the group.
updateSpacespace.configureChange a space's config, including who can read it.
deleteSpacespace.deleteRemove a space. Refuses the two well-known spaces.
assignRolesrole.assignSet a member's full role set.
ejectMemberejectRemove a member and their access.
createInviteinviteWrite an invite into someone's own invites space.
listInvitesinviteOutstanding invites.
revokeInviteinviteRetract an outstanding invite.
requestJoinanyoneAsk to join, or redeem an invite.
cancelJoinRequestanyoneWithdraw a pending join request.
leaveGroupanyoneLeave the group.
listJoinRequestsadmitThe pending-requests queue.
admitMemberadmitApprove or deny a join request.
listSubjectsmod.readThe moderation queue.
getSubjectHistorymod.readEvery event on one subject.
resolveSubjectmod.resolveResolve or escalate a subject, optionally with a note.
applyLabellabel / takedownWrite a label into the subject's space.
negateLabellabel / takedownNegate a previously applied label.