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).

Details · procedure
Kindprocedure
Authorityopensocial.fyi
Indexed

Procedure

procedure · POST

Input

application/json
  • maxLength: 20000
  • maxGraphemes: 2000

displayName

requiredstring
  • maxLength: 640
  • maxGraphemes: 64

handle

requiredstring · handle

Defaults to approval.

Defaults to ['public'].

itemsref

Accounts that run the group alongside the founder, as admins from the start.

itemsref

Output

application/json

did

requiredstring · did

members

requiredstring · space-ref

meta

requiredstring · space-ref

Errors

InvalidHandle

The handle is not one label under this host's handle domain.

HandleTaken

No description in schema.

AccountCreationFailed

The PLC directory did not take the group's new DID.

NotAllowed

This host only lets the people it names start groups, and the caller isn't one.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • social.grain.unspecced.createGroup

    procedure not from the namespace authority

    Start a group on Grain's group host. The host creates the group with the viewer as its founder and hands Grain its own session on it (fyi.opensocial.provisionGroup); Grain then gives the group its pool and its Grain profile. The viewer never leaves Grain.

  • Host-level: an app creates a group for a person and gets its own OAuth session on it. Authenticated twice: the person asking, by service auth from their PDS (they become the founder), and the app, by OAuth client authentication in the body (a client assertion for a confidential client) with a DPoP proof in the `DPoP` header, exactly as at the token endpoint. The app must be one this host provisions for. Returns the group and a token response bound to the proof's key, issued to the app's client i

  • create a group

  • Create a space under the group with its access record and, unless index is false, an index entry. Requires space.create.

  • Marks a DID as a group. Lives in the public repo. Points at the meta space. Discovery only.