Misskey · Schema

UserLite

Open-SourceSocial NetworksFediverseActivityPubDecentralized

Properties

Name Type Description
id string
name stringnull
username string
host stringnull The local host is represented with `null`.
avatarUrl stringnull
avatarBlurhash stringnull
avatarDecorations array
isBot boolean
isCat boolean
requireSigninToViewContents boolean
makeNotesFollowersOnlyBefore numbernull
makeNotesHiddenBefore numbernull
instance object
emojis object
onlineStatus string
badgeRoles array
View JSON Schema on GitHub

JSON Schema

misskey-userlite-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://misskey.io/schemas/UserLite",
  "title": "UserLite",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "id",
      "example": "xxxxxxxxxx"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "example": "\u85cd"
    },
    "username": {
      "type": "string",
      "example": "ai"
    },
    "host": {
      "type": [
        "string",
        "null"
      ],
      "example": "misskey.example.com",
      "description": "The local host is represented with `null`."
    },
    "avatarUrl": {
      "type": [
        "string",
        "null"
      ],
      "format": "url"
    },
    "avatarBlurhash": {
      "type": [
        "string",
        "null"
      ]
    },
    "avatarDecorations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "id"
          },
          "angle": {
            "type": "number"
          },
          "flipH": {
            "type": "boolean"
          },
          "url": {
            "type": "string",
            "format": "url"
          },
          "offsetX": {
            "type": "number"
          },
          "offsetY": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "url"
        ]
      }
    },
    "isBot": {
      "type": "boolean"
    },
    "isCat": {
      "type": "boolean"
    },
    "requireSigninToViewContents": {
      "type": "boolean"
    },
    "makeNotesFollowersOnlyBefore": {
      "type": [
        "number",
        "null"
      ]
    },
    "makeNotesHiddenBefore": {
      "type": [
        "number",
        "null"
      ]
    },
    "instance": {
      "type": "object",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "softwareName": {
          "type": [
            "string",
            "null"
          ]
        },
        "softwareVersion": {
          "type": [
            "string",
            "null"
          ]
        },
        "iconUrl": {
          "type": [
            "string",
            "null"
          ]
        },
        "faviconUrl": {
          "type": [
            "string",
            "null"
          ]
        },
        "themeColor": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "name",
        "softwareName",
        "softwareVersion",
        "iconUrl",
        "faviconUrl",
        "themeColor"
      ]
    },
    "emojis": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "onlineStatus": {
      "type": "string",
      "enum": [
        "unknown",
        "online",
        "active",
        "offline"
      ]
    },
    "badgeRoles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "iconUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "displayOrder": {
            "type": "number"
          },
          "behavior": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "iconUrl",
          "displayOrder"
        ]
      }
    }
  },
  "required": [
    "id",
    "name",
    "username",
    "host",
    "avatarUrl",
    "avatarBlurhash",
    "avatarDecorations",
    "emojis",
    "onlineStatus"
  ]
}