dev.knotless.inviteToOrg

lexicons.knotless.dev

Documentation

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.

main procedure

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.

Input

Encodingapplication/json
member stringat-identifier Required

The account to invite, by DID or handle.

org stringdid Required

The organization.

role string Optional

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

maxLength: 64 bytes

Output

Encodingapplication/json
warning string Optional

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

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.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "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.",
  "errors": [
    {
      "description": "The change was refused: by the organization's gateway, or as the account may not make it.",
      "name": "InvalidRequest"
    },
    {
      "description": "No account is logged in to the pages, or its session has ended.",
      "name": "AuthenticationRequired"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "member": {
          "description": "The account to invite, by DID or handle.",
          "format": "at-identifier",
          "type": "string"
        },
        "org": {
          "description": "The organization.",
          "format": "did",
          "type": "string"
        },
        "role": {
          "description": "What it may do: an admin also invites and removes members. Member when absent.",
          "knownValues": [
            "admin",
            "member"
          ],
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "org",
        "member"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "warning": {
          "description": "Set when the change was made only in part, saying what is left.",
          "maxLength": 2000,
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@