Hugging Face · Schema

UserInfo

Properties

Name Type Description
type string Account type (user or organization)
id string
name string Username
fullname string Full display name
email string
emailVerified boolean
plan string Subscription plan
canPay boolean
avatarUrl string
orgs array
auth object
View JSON Schema on GitHub

JSON Schema

hugging-face-userinfo-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserInfo",
  "title": "UserInfo",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Account type (user or organization)",
      "example": "example_value"
    },
    "id": {
      "type": "string",
      "example": "abc123"
    },
    "name": {
      "type": "string",
      "description": "Username",
      "example": "Example Title"
    },
    "fullname": {
      "type": "string",
      "description": "Full display name",
      "example": "example_value"
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "[email protected]"
    },
    "emailVerified": {
      "type": "boolean",
      "example": "[email protected]"
    },
    "plan": {
      "type": "string",
      "description": "Subscription plan",
      "example": "example_value"
    },
    "canPay": {
      "type": "boolean",
      "example": true
    },
    "avatarUrl": {
      "type": "string",
      "format": "uri",
      "example": "https://www.example.com"
    },
    "orgs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "fullname": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "plan": {
            "type": "string"
          },
          "avatarUrl": {
            "type": "string",
            "format": "uri"
          },
          "isEnterprise": {
            "type": "boolean"
          }
        }
      },
      "example": []
    },
    "auth": {
      "type": "object",
      "properties": {
        "accessToken": {
          "type": "object",
          "properties": {
            "displayName": {
              "type": "string"
            },
            "role": {
              "type": "string"
            }
          }
        }
      },
      "example": "example_value"
    }
  }
}