Box · Schema

User (Base)

A mini representation of a user, used when nested within another resource.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
id string The unique identifier for this user
type string `user`
View JSON Schema on GitHub

JSON Schema

box-user-base-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/User--Base",
  "title": "User (Base)",
  "type": "object",
  "x-box-resource-id": "user--base",
  "x-box-tag": "users",
  "x-box-variants": [
    "base",
    "mini",
    "standard",
    "full"
  ],
  "x-box-variant": "base",
  "description": "A mini representation of a user, used when\nnested within another resource.",
  "required": [
    "type",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this user",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`user`",
      "example": "user",
      "nullable": false,
      "enum": [
        "user"
      ]
    }
  }
}