Box · Schema

User (Mini)

A mini representation of a user, as can be returned when nested within other resources.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
View JSON Schema on GitHub

JSON Schema

box-user-mini-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/User--Mini",
  "title": "User (Mini)",
  "type": "object",
  "x-box-resource-id": "user--mini",
  "x-box-variant": "mini",
  "description": "A mini representation of a user, as can be returned when nested within other\nresources.",
  "allOf": [
    {
      "$ref": "#/components/schemas/User--Base"
    },
    {
      "properties": {
        "name": {
          "type": "string",
          "description": "The display name of this user",
          "example": "Aaron Levie",
          "maxLength": 50,
          "nullable": false
        },
        "login": {
          "type": "string",
          "format": "email",
          "description": "The primary email address of this user",
          "example": "[email protected]",
          "nullable": false
        }
      }
    }
  ]
}