com.atproto.server.defs Documentation (EN)

inviteCode object

No description available.

Properties

available integer Required

No description available.

code string Required

No description available.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

createdBy string Required

No description available.

disabled boolean Required

No description available.

forAccount string Required

No description available.

uses array of ref#inviteCodeUse Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "code",
    "available",
    "disabled",
    "forAccount",
    "createdBy",
    "createdAt",
    "uses"
  ],
  "properties": {
    "code": {
      "type": "string"
    },
    "uses": {
      "type": "array",
      "items": {
        "ref": "#inviteCodeUse",
        "type": "ref"
      }
    },
    "disabled": {
      "type": "boolean"
    },
    "available": {
      "type": "integer"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "createdBy": {
      "type": "string"
    },
    "forAccount": {
      "type": "string"
    }
  }
}

inviteCodeUse object

No description available.

Properties

usedAt string datetime Required

An RFC 3339 formatted timestamp.

usedBy string did Required

A decentralized identifier (DID).

View raw schema

{
  "type": "object",
  "required": [
    "usedBy",
    "usedAt"
  ],
  "properties": {
    "usedAt": {
      "type": "string",
      "format": "datetime"
    },
    "usedBy": {
      "type": "string",
      "format": "did"
    }
  }
}