social.colibri.beta.member Documentation (EN)

main record

A community member. The record key is the member's DID, so membership is a direct lookup and a member cannot hold two of these.

Record Key any Any valid record key

Properties

joinedAt string datetime Required

When the member was admitted.

nickname string Optional

Per-community display name override.

maxLength: 32 bytes

roles array of string record-key Optional

Roles assigned to this member.

subject string did Required

The member's DID. Matches the record key.

View raw schema

{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "subject",
      "joinedAt"
    ],
    "properties": {
      "roles": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "record-key",
          "description": "A role in this community."
        },
        "description": "Roles assigned to this member."
      },
      "subject": {
        "type": "string",
        "format": "did",
        "description": "The member's DID. Matches the record key."
      },
      "joinedAt": {
        "type": "string",
        "format": "datetime",
        "description": "When the member was admitted."
      },
      "nickname": {
        "type": "string",
        "maxLength": 32,
        "description": "Per-community display name override."
      }
    }
  },
  "description": "A community member. The record key is the member's DID, so membership is a direct lookup and a member cannot hold two of these."
}