Lexicon Garden

com.getorbyt.community.saveRole

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.

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

community

requiredstring · at-uri

key

string

The role to change. Absent creates a role.

  • maxLength: 64

name

string

Required for a role the Community defined. Ignored for moderator.

  • maxLength: 320
  • maxGraphemes: 32

permissions

requiredarray
  • maxLength: 16
itemsstring
  • knownValues: manage-posts | manage-reports | manage-members | manage-roles | manage-settings | manage-mail | view-log

Output

application/json

Errors

AuthenticationRequired

No description in schema.

CommunityNotFound

No description in schema.

InsufficientRole

No description in schema.

InvalidRequest

No description in schema.

RoleNotFound

No role with this key exists in the Community.

TooManyRoles

The Community already defines the most roles it may.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • 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.

  • social.colibri.beta.role.create

    procedure

    Creates a role in a community.

  • com.getorbyt.community.manageMember

    procedure

    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.

  • social.colibri.role.create

    procedure not from the namespace authority

    Creates a role in a community.