dev.knotless.setOrgMembership

lexicons.knotless.dev

Documentation

Writes the account's dev.knotless.orgAcceptance record where the visibility says, in its public records or in the organization's space, takes back one in the other place, and asks the organization's gateway to take it in (dev.knotless.joinOrg). 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

Writes the account's dev.knotless.orgAcceptance record where the visibility says, in its public records or in the organization's space, takes back one in the other place, and asks the organization's gateway to take it in (dev.knotless.joinOrg). 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
org stringdid Required

The organization.

visibility string Required

Who may see the membership: anyone, or the organization's members alone.

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": "Writes the account's dev.knotless.orgAcceptance record where the visibility says, in its public records or in the organization's space, takes back one in the other place, and asks the organization's gateway to take it in (dev.knotless.joinOrg). 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": {
        "org": {
          "description": "The organization.",
          "format": "did",
          "type": "string"
        },
        "visibility": {
          "description": "Who may see the membership: anyone, or the organization's members alone.",
          "knownValues": [
            "public",
            "hidden"
          ],
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "org",
        "visibility"
      ],
      "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

@