Lexicon Garden

ai.newnal.illi.home.createInvite

Create an invite link (root admin). The token is shown once and delivered by hand.

Repository @illi-service.newnal.id did:plc:uztm7bi2ce42dez3uu3qafro namespace authority
Details · procedure
Kindprocedure
Authorityhome.illi.newnal.ai
Indexed
Compare Edit in builder → Fork →
cid bafyreiabvirnb5hputay34jaxgth7xomrac5ugb3a2bkokowfpn3apb55q

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.inviteIdNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Create an invite link (root admin). The token is shown once and delivered by hand.",
      "errors": [
        {
          "name": "NotRootAdmin"
        },
        {
          "name": "HomeNotFound"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "expiresInDays": {
              "default": 7,
              "maximum": 30,
              "minimum": 1,
              "type": "integer"
            },
            "homeId": {
              "format": "tid",
              "type": "string"
            },
            "maxUses": {
              "default": 1,
              "maximum": 20,
              "minimum": 1,
              "type": "integer"
            },
            "note": {
              "maxLength": 120,
              "type": "string"
            }
          },
          "required": [
            "homeId"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "expiresAt": {
              "format": "datetime",
              "type": "string"
            },
            "inviteId": {
              "type": "string"
            },
            "inviteUrl": {
              "format": "uri",
              "type": "string"
            },
            "maxUses": {
              "type": "integer"
            }
          },
          "required": [
            "inviteId",
            "inviteUrl",
            "expiresAt",
            "maxUses"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "ai.newnal.illi.home.createInvite",
  "lexicon": 1
}