Lexicon Garden

fyi.opensocial.requestJoin

Ask to join a group, optionally redeeming an invitation. An invite the group has sent the caller, neither taken back nor past its expiresAt, admits them at once, whatever the group's join policy, with the group's default roles; one named that is not such an invite is refused. Unnamed, a waiting invite is redeemed all the same. No role required; authenticated as the requester.

Repository @lexicons.opensocial.fyi did:plc:2gqnilpksz2e7faj3bwvo6qc namespace authority
Details · procedure
Kindprocedure
Authorityopensocial.fyi
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

group

requiredstring · did

The group DID. Every method is served by the group's host and authorized against that group's roles.

invite

string · at-uri

An invitation from this group to the caller.

message

string
  • maxLength: 20000
  • maxGraphemes: 2000

Output

application/json

membership

ref

Present when admitted.

Reference

request

ref

Present when pending.

Reference

status

requiredstring
  • knownValues: pending | admitted

Errors

GroupNotFound

The group isn't hosted here.

InvalidInvite

The invitation is expired, revoked, or not addressed to the caller.

JoinClosed

The group requires an invitation.

AlreadyMember

The caller is a member already.

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

    procedure not from the namespace authority

    Ask a group's group host to admit the viewer: Grain mints service auth for the host from the viewer's PDS and calls fyi.opensocial.requestJoin. Admitted immediately when the group is open; queued for its moderators when it takes requests.

  • fyi.opensocial.getJoinRequest

    query

    The caller's own pending request to join, if they have one. Requires no action: listJoinRequests is the moderator's queue and needs `admit`, which leaves a requester unable to see the request they themselves made. Returns nothing once a request has been decided, so a denial is not disclosed.

  • fyi.opensocial.admitMember

    procedure

    Approve a join request, giving the requester their roles. Requires admit. denyJoinRequest declines one.

  • fyi.opensocial.denyJoinRequest

    procedure

    Deny a pending join request. Requires admit. The requester sees it as no request at all, and may ask again.

  • chat.bsky.group.requestJoin

    procedure

    Sends a request to join a group (via join link) to the group owner. Action taken by the prospective group member.