Lexicon Garden

dev.knotless.inviteToOrg

As the organization itself, or one of its admins, asks the organization's gateway to name the account in its records (dev.knotless.putOrgMember). The first invitation an account makes makes it an organization, through the gateway it delegated writes to. The account is a member once it joins. Requires the session cookie the pages' login sets: the appview acts with the session it keeps for that account. Clients holding their own session call the organization's gateway themselves.

Repository @lexicons.knotless.dev did:plc:yqsg7znbbhfmj3a2nrpnaerk namespace authority
Details · procedure
Kindprocedure
Authorityknotless.dev
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

member

requiredstring · at-identifier

The account to invite, by DID or handle.

org

requiredstring · did

The organization.

role

string

What it may do: an admin also invites and removes members. Member when absent.

  • maxLength: 64
  • knownValues: admin | member

Output

application/json

warning

string

Set when the change was made only in part, saying what is left.

  • maxLength: 2000

Errors

InvalidRequest

The change was refused: by the organization's gateway, or as the account may not make it.

AuthenticationRequired

No account is logged in to the pages, or its session has ended.

Similar lexicons

semantic match

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

  • dev.knotless.putOrgMember

    procedure

    Invites an account to an organization, or changes a member's role, through the gateway the organization delegated writes to, which writes as the organization. The caller must be an admin of it who joined. Requires a service token from the caller's PDS, audience the gateway's DID, for this method.

  • dev.knotless.setOrgMembership

    procedure

    Joins an organization as the account logged in to this appview's pages, or shows or hides that membership, as `knotless org join` does.

  • dev.knotless.joinOrg

    procedure

    Takes the caller into an organization that invited them, once they keep a dev.knotless.orgAcceptance record naming it, through the gateway the organization delegated writes to: names them in its public record when their acceptance record is public, and only in its space when it is in their repo there; lets them read its space and its private repositories. Called again after moving the record, it changes how the membership shows. Refused when the invitation lapsed. Requires a service token from t

  • dev.knotless.getOrg

    query

    An organization's members on knotless.

  • dev.knotless.removeFromOrg

    procedure

    Takes an account out of an organization as the account logged in to this appview's pages, or withdraws its invitation, as `knotless org remove` does.