Lexicon Garden

fyi.opensocial.createGroup

Host-level: create a new group on this host. Authenticated as the founder (service auth from their PDS). The founder and any listed stewards become its first admins. Mints the group DID, creates the meta and members spaces, writes the bootstrap records and, for a discoverable group, a declaration. Modality spaces are left to the apps that use them (createSpace).

Repository @lexicons.opensocial.fyi did:plc:2gqnilpksz2e7faj3bwvo6qc namespace authority
Details · procedure
Kindprocedure
Authorityopensocial.fyi
Indexed

Showing version bafyreiee4hrxg2dmbouj6jssa6kp3qmlxtjztyhwihfw37zqj5ybhik6qi. Show the latest

Compare Edit in builder → Fork →
cid bafyreiee4hrxg2dmbouj6jssa6kp3qmlxtjztyhwihfw37zqj5ybhik6qi

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.joinPolicyNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.input.schema.properties.metaReadableBy.itemsNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Host-level: create a new group on this host. Authenticated as the founder (service auth from their PDS). The founder and any listed stewards become its first admins. Mints the group DID, creates the meta and members spaces, writes the bootstrap records and, for a discoverable group, a declaration. Modality spaces are left to the apps that use them (createSpace).",
      "errors": [
        {
          "name": "HandleTaken"
        },
        {
          "description": "This host only lets the people it names start groups, and the caller isn't one.",
          "name": "NotAllowed"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "description": {
              "maxGraphemes": 300,
              "maxLength": 3000,
              "type": "string"
            },
            "displayName": {
              "maxGraphemes": 64,
              "maxLength": 640,
              "type": "string"
            },
            "handle": {
              "format": "handle",
              "type": "string"
            },
            "joinPolicy": {
              "knownValues": [
                "fyi.opensocial.profile#open",
                "fyi.opensocial.profile#request",
                "fyi.opensocial.profile#invite"
              ],
              "type": "string"
            },
            "metaReadableBy": {
              "description": "Defaults to ['public'].",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "stewards": {
              "description": "Accounts that run the group alongside the founder, as admins from the start.",
              "items": {
                "format": "did",
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "handle",
            "displayName"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "did": {
              "format": "did",
              "type": "string"
            },
            "members": {
              "format": "space-ref",
              "type": "string"
            },
            "meta": {
              "format": "space-ref",
              "type": "string"
            }
          },
          "required": [
            "did",
            "meta",
            "members"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "fyi.opensocial.createGroup",
  "lexicon": 1
}