wiki.lichen.membership Documentation (EN)

main record

A membership grant for a wiki. The rkey is a TID. The member's DID lives in the record body.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

When the membership was granted.

memberDid string did Required

DID of the member being granted access.

maxLength: 2048 bytes

role string Required

admin manages members and settings and can edit. contributor can edit notes. viewer can read a private wiki.

maxLength: 32 bytes

Known values: admin, contributor, viewer

wikiRef string at-uri Required

AT-URI of the wiki.

View raw schema

{
  "description": "A membership grant for a wiki. The rkey is a TID. The member's DID lives in the record body.",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "description": "When the membership was granted.",
        "format": "datetime",
        "type": "string"
      },
      "memberDid": {
        "description": "DID of the member being granted access.",
        "format": "did",
        "maxLength": 2048,
        "type": "string"
      },
      "role": {
        "description": "admin manages members and settings and can edit. contributor can edit notes. viewer can read a private wiki.",
        "knownValues": [
          "admin",
          "contributor",
          "viewer"
        ],
        "maxLength": 32,
        "type": "string"
      },
      "wikiRef": {
        "description": "AT-URI of the wiki.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "memberDid",
      "wikiRef",
      "role",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}