fyi.opensocial.access Documentation (EN)

main record

Who may read this space. Present in every space under the group. The group authority issues space credentials according to this record and nothing else.

Record Key literal:self Fixed literal value

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

credentialScopes array of ref #roleScopes Optional

Which OAuth scopes for the group DID each role may request in this space. A role that may write a kind of record as the group here may also publish that kind, as the group, in its public repo; '*' is any kind, in both.

readableBy array of string Required

Role ids that may read the space, or the literal string 'public' meaning any authenticated requester.

writableBy array of string Optional

Who may write into the space in their own name: role ids, or 'public' for anyone signed in. Absent is any member.

View raw schema

{
  "description": "Who may read this space. Present in every space under the group. The group authority issues space credentials according to this record and nothing else.",
  "key": "literal:self",
  "record": {
    "properties": {
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "credentialScopes": {
        "description": "Which OAuth scopes for the group DID each role may request in this space. A role that may write a kind of record as the group here may also publish that kind, as the group, in its public repo; '*' is any kind, in both.",
        "items": {
          "ref": "#roleScopes",
          "type": "ref"
        },
        "type": "array"
      },
      "readableBy": {
        "description": "Role ids that may read the space, or the literal string 'public' meaning any authenticated requester.",
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "writableBy": {
        "description": "Who may write into the space in their own name: role ids, or 'public' for anyone signed in. Absent is any member.",
        "items": {
          "type": "string"
        },
        "type": "array"
      }
    },
    "required": [
      "readableBy",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

roleScopes object

No description available.

Properties

role string Required

A role id: the record key of a fyi.opensocial.role record.

maxLength: 64 bytes

scopes array of string Required

Collections this role may write in the space as the group: an NSID, or * for any. Every write, unless the grant names some: xyz.task?action=create lets the role add tasks but not change or delete them.

View raw schema

{
  "properties": {
    "role": {
      "description": "A role id: the record key of a fyi.opensocial.role record.",
      "maxLength": 64,
      "type": "string"
    },
    "scopes": {
      "description": "Collections this role may write in the space as the group: an NSID, or * for any. Every write, unless the grant names some: xyz.task?action=create lets the role add tasks but not change or delete them.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "role",
    "scopes"
  ],
  "type": "object"
}