Lexicon Garden

rsvp.atmo.space.invite.create

Create an invite for a space. Caller must be the space owner. Returns the raw token once; only the hash is stored.

Repository @atmo.rsvp did:plc:b63bmauox6z5rbibwrhxrdnw namespace authority
Details · procedure
Kindprocedure
Authorityinvite.space.atmo.rsvp
Indexed

Showing version bafyreigdkrhoh2ox3hjkh4wcf32l4ddoqlmjxrchfoavcf34bopn7ii534. Show the latest

Compare Edit in builder → Fork →
cid bafyreigdkrhoh2ox3hjkh4wcf32l4ddoqlmjxrchfoavcf34bopn7ii534

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.kindNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.input.schema.properties.permsNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.tokenNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Create an invite for a space. Caller must be the space owner. Returns the raw token once; only the hash is stored.",
      "errors": [
        {
          "name": "NotFound"
        },
        {
          "name": "Forbidden"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "expiresAt": {
              "description": "Unix ms timestamp. Omit for no expiry.",
              "type": "integer"
            },
            "kind": {
              "default": "join",
              "description": "join: redeem to become a member. read: bearer-only read access, no membership. read-join: anonymous read + signed-in redeem to join.",
              "knownValues": [
                "join",
                "read",
                "read-join"
              ],
              "type": "string"
            },
            "maxUses": {
              "description": "Caps join redemptions only — read-token reads are unlimited. Omit for unlimited joins.",
              "minimum": 1,
              "type": "integer"
            },
            "note": {
              "maxLength": 500,
              "type": "string"
            },
            "perms": {
              "default": "write",
              "knownValues": [
                "read",
                "write"
              ],
              "type": "string"
            },
            "spaceUri": {
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "spaceUri"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "invite": {
              "ref": "rsvp.atmo.space.defs#inviteView",
              "type": "ref"
            },
            "token": {
              "description": "Raw token. Shown once — cannot be retrieved later.",
              "type": "string"
            }
          },
          "required": [
            "token",
            "invite"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "rsvp.atmo.space.invite.create",
  "lexicon": 1
}