Lexicon Garden

social.colibri.beta.role

A named bundle of permissions assignable to community members.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · record, key tid
Kindrecord
Record keytid
Authoritybeta.colibri.social
Indexed

Showing version bafyreig64cfjfz2xosxspe6iujf3duarq24hmqocmjgvtaov5h7k2l3nya. Show the latest

Compare Edit in builder → Fork →

Record

record · key tid

Properties

badge

union

A small badge shown next to the names of members holding this role.

One of

channelOverrides

array

Per-channel permission overrides.

itemsref
Reference

color

string

Hex colour as #rrggbb.

  • maxLength: 7

default

boolean

Whether every member holds this role from the moment they join. Set on the members role created with the community. A default role cannot be deleted.

  • default: false

hoisted

boolean

Whether holders are listed separately in the member list.

  • default: false

mentionable

boolean

Whether @role mentions resolve to this role.

  • default: false

name

requiredstring

Display name.

  • minLength: 1
  • maxLength: 32

permissions

requiredarray

Permissions granted by this role.

itemsstring

A namespaced permission identifier.

position

requiredinteger

Hierarchy position. Higher outranks lower.

protected

boolean

Whether this role is exempt from modification and deletion. Set on the owner role created with the community.

  • default: false

#channelOverride

object

Allow and deny lists scoped to a single channel.

Properties

allow

array

Permissions granted within this channel.

itemsstring

channel

requiredstring · record-key

The space key of the channel this override applies to.

deny

array

Permissions denied within this channel. Deny beats both the base permissions and allow.

itemsstring

#emojiBadge

object

A badge drawn from an emoji. Exactly one of emoji and customEmoji is set.

Properties

customEmoji

ref

The record of a custom emoji.

Reference

emoji

string

A Unicode emoji.

  • maxLength: 64
  • maxGraphemes: 1

#iconBadge

object

A badge drawn from the client's curated icon set.

Properties

color

string

Hex colour as #rrggbb. Absent means the role colour, or the client's default badge colour when the role has none.

  • maxLength: 7

icon

requiredstring

The icon's identifier in the curated set, for example shield-check.

  • minLength: 1
  • maxLength: 64

#imageBadge

object

A badge drawn from an uploaded image.

Properties

image

requiredblob

A square image, shown at about 16 pixels.

  • maxSize: 262144
  • accept: image/jpeg, image/png, image/gif, image/webp

Similar lexicons

semantic match

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

  • social.colibri.role

    record

    A named bundle of permissions assignable to community members. Lives on the community repo.

  • social.colibri.beta.role.update

    procedure

    Updates a role's settings.

  • social.colibri.beta.role.create

    procedure

    Creates a role in a community.

  • chat.yakka.role

    record

    A role that may be granted to members. Authority-written (ADR 0006). Roles carry no permissions of their own — they are named subjects that channel gates and the mint policy refer to (ADR 0007).

  • fyi.opensocial.role

    record

    Declares that a role exists, in the members space. The record key is the role id, of 64 characters at most. A role is deleted only once no member holds it and the permissions record grants it nothing.