Lexicon Garden

dev.knotless.putOrgMember

The invitation is kept in the organization's space where its PDS has spaces, else in its public records. Invited again, an invitation that lapsed starts over.

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 · did

The account to invite.

org

requiredstring · did

The organization.

role

string

Their role; member when absent.

  • maxLength: 64
  • knownValues: admin | member

Output

application/json

first

requiredboolean

Whether this made the account an organization.

had

string

The role they had before, if they had one.

  • maxLength: 64
  • knownValues: admin | member

org

requiredstring

The organization's handle, or its DID when none resolves back to it.

  • maxLength: 300

private

requiredboolean

Whether the invitation is in the organization's space, which only it and its members read; else in its public records.

role

requiredstring

Their role now.

  • maxLength: 64
  • knownValues: admin | member

was

string

Where they stood before: invited, lapsed (invited over 7 days ago), or a public or hidden member. Absent when they were not invited.

  • maxLength: 64
  • knownValues: invited | lapsed | public | hidden

who

requiredstring

The invitee's handle, or their DID when none resolves back to it.

  • maxLength: 300

Similar lexicons

semantic match

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

  • dev.knotless.inviteToOrg

    procedure

    Invites an account to an organization as the account logged in to this appview's pages, or changes its role, as `knotless org add` 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.removeOrgMember

    procedure

    Takes a member out of an organization, or withdraws an invitation, through the gateway the organization delegated writes to, which writes as the organization: out of its records, its space and its private repositories' spaces, but for repositories shared with them on their own. 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.getOrg

    query

    An organization's members on knotless.

  • dev.knotless.orgMember

    record

    An organization's side of its membership: an account it invited, and their roles.