social.colibri.beta.role

colibri.social

Documentation

A named bundle of permissions assignable to community members.

main record

A named bundle of permissions assignable to community members.

Record Key tid Timestamp-based ID

Properties

channelOverrides array of ref #channelOverride Optional

Per-channel permission overrides.

color string Optional

Hex colour as #rrggbb.

maxLength: 7 bytes
hoisted boolean Optional

Whether holders are listed separately in the member list.

Default: false
mentionable boolean Optional

Whether @role mentions resolve to this role.

Default: false
name string Required

Display name.

maxLength: 32 bytesminLength: 1 bytes
permissions array of string Required

Permissions granted by this role.

position integer Required

Hierarchy position. Higher outranks lower.

protected boolean Optional

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

Default: false
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "permissions",
      "position"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 32,
        "minLength": 1,
        "description": "Display name."
      },
      "color": {
        "type": "string",
        "maxLength": 7,
        "description": "Hex colour as #rrggbb."
      },
      "hoisted": {
        "type": "boolean",
        "default": false,
        "description": "Whether holders are listed separately in the member list."
      },
      "position": {
        "type": "integer",
        "description": "Hierarchy position. Higher outranks lower."
      },
      "protected": {
        "type": "boolean",
        "default": false,
        "description": "Whether this role is exempt from modification and deletion. Set on the owner role created with the community."
      },
      "mentionable": {
        "type": "boolean",
        "default": false,
        "description": "Whether @role mentions resolve to this role."
      },
      "permissions": {
        "type": "array",
        "items": {
          "type": "string",
          "description": "A namespaced permission identifier."
        },
        "description": "Permissions granted by this role."
      },
      "channelOverrides": {
        "type": "array",
        "items": {
          "ref": "#channelOverride",
          "type": "ref"
        },
        "description": "Per-channel permission overrides."
      }
    }
  },
  "description": "A named bundle of permissions assignable to community members."
}
channelOverride object

Allow and deny lists scoped to a single channel.

Properties

allow array of string Optional

Permissions granted within this channel.

channel string record-key Required

The space key of the channel this override applies to.

deny array of string Optional

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

View raw schema 
{
  "type": "object",
  "required": [
    "channel"
  ],
  "properties": {
    "deny": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Permissions denied within this channel. Deny beats both the base permissions and allow."
    },
    "allow": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Permissions granted within this channel."
    },
    "channel": {
      "type": "string",
      "format": "record-key",
      "description": "The space key of the channel this override applies to."
    }
  },
  "description": "Allow and deny lists scoped to a single channel."
}

Lexicon Garden

@