Lexicon Garden

social.colibri.beta.role.update

Updates a role's settings.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · procedure
Kindprocedure
Authorityrole.beta.colibri.social
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

badge

ref

An icon badge. Image badges are set with social.colibri.beta.role.putBadgeImage. Takes precedence over removeBadge.

Reference

channelOverrides

array

Per-channel overrides.

itemsref

A per-channel permission override.

Reference

color

string

Hex colour as #rrggbb.

  • maxLength: 7

community

requiredstring · did

The community the role belongs to.

emojiBadge

ref

An emoji badge. Cannot be combined with badge. Takes precedence over removeBadge.

Reference

hoisted

boolean

Whether holders are listed separately in the member list.

mentionable

boolean

Whether @role mentions resolve to this role.

name

string

Display name.

  • minLength: 1
  • maxLength: 32

permissions

array

Permissions granted by this role.

itemsstring

A namespaced permission identifier.

position

integer

Hierarchy position. Higher outranks lower.

removeBadge

boolean

Removes the role's badge, whichever kind it is. Ignored when badge or emojiBadge is also given.

role

requiredstring · record-key

The role's record key.

Output

application/json

role

requiredref

The updated role.

Reference

Errors

AuthRequired

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

Forbidden

The caller lacks the role.manage permission.

CommunityNotFound

No community exists at the given DID.

RoleNotFound

No role exists at the given record key.

RoleProtected

The role is marked protected and cannot be modified.

RoleHierarchy

The change would place the role at or above the caller's highest role position, or grants a permission the caller does not hold.

CredentialsUnavailable

The AppView cannot act as the community because its stored credentials are missing or unusable.

Similar lexicons

semantic match

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