social.grain.group.createGroup

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.

Repository @grain.social did:plc:e7rftrdyz5e2rw4y6ocszew2 namespace authority
Details · procedure
Kindprocedure
Authoritygroup.grain.social
Commit rev3n2mx2lrcyybg
Indexed

Procedure

procedure · POST

Input

application/json
  • maxLength: 3000
  • maxGraphemes: 300

displayName

requiredstring
  • maxLength: 640
  • maxGraphemes: 64

name

requiredstring

The first label of the group's handle, 3 to 18 characters; the host supplies its domain.

  • minLength: 3
  • maxLength: 18

Output

application/json

did

requiredstring · did

handle

requiredstring · handle

Errors

NotSupported

This Grain starts no groups.

InvalidName

The name is not 3 to 18 letters, digits and hyphens, starting and ending with no hyphen.

HandleUnavailable

The group host refused the handle: taken, or not allowed.

CreateFailed

The group host did not start the group.

PoolFailed

The group was started, but its host did not open its pool.

Similar lexicons

semantic match

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

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

  • create a group

  • The group host this Grain creates groups on, and the domain a new group's handle ends in. Absent when this Grain creates none.

  • Creates a group convo, specifying the members to be added to it. Unlike getConvoForMembers, this isn't idempotent. It will create new groups even if the membership is identical to pre-existing groups. Will create 'request' membership for all members, except the owner who is 'accepted'.