Box · Schema

User (Full)

A full representation of a user, as can be returned from any user API endpoint.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile SharingBoxStorage

Properties

Name Type Description
role string The user’s enterprise role
tracking_codes array Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.
can_see_managed_users boolean Whether the user can see other enterprise users in their contact list
is_sync_enabled boolean Whether the user can use Box Sync
is_external_collab_restricted boolean Whether the user is allowed to collaborate with users outside their enterprise
is_exempt_from_device_limits boolean Whether to exempt the user from Enterprise device limits
is_exempt_from_login_verification boolean Whether the user must use two-factor authentication
enterprise object
my_tags array Tags for all files and folders owned by the user. Values returned will only contain tags that were set by the requester.
hostname string The root (protocol, subdomain, domain) of any links that need to be generated for the user
is_platform_access_only boolean Whether the user is an App User
external_app_user_id string An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users.
View JSON Schema on GitHub

JSON Schema

box-user-full-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/User--Full",
  "title": "User (Full)",
  "type": "object",
  "x-box-resource-id": "user--full",
  "x-box-variant": "full",
  "description": "A full representation of a user, as can be returned from any\nuser API endpoint.",
  "allOf": [
    {
      "$ref": "#/components/schemas/User"
    },
    {
      "properties": {
        "role": {
          "type": "string",
          "enum": [
            "admin",
            "coadmin",
            "user"
          ],
          "description": "The user\u2019s enterprise role",
          "example": "admin"
        },
        "tracking_codes": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TrackingCode"
          },
          "description": "Tracking codes allow an admin to generate reports from the\nadmin console and assign an attribute to a specific group\nof users. This setting must be enabled for an enterprise\nbefore it can be used."
        },
        "can_see_managed_users": {
          "type": "boolean",
          "example": true,
          "description": "Whether the user can see other enterprise users in their contact list"
        },
        "is_sync_enabled": {
          "type": "boolean",
          "description": "Whether the user can use Box Sync",
          "example": true
        },
        "is_external_collab_restricted": {
          "type": "boolean",
          "example": true,
          "description": "Whether the user is allowed to collaborate with users outside their\nenterprise"
        },
        "is_exempt_from_device_limits": {
          "type": "boolean",
          "example": true,
          "description": "Whether to exempt the user from Enterprise device limits"
        },
        "is_exempt_from_login_verification": {
          "type": "boolean",
          "example": true,
          "description": "Whether the user must use two-factor authentication"
        },
        "enterprise": {
          "allOf": [
            {
              "title": "Enterprise",
              "type": "object",
              "description": "A representation of a Box enterprise",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The unique identifier for this enterprise.",
                  "example": "11446498"
                },
                "type": {
                  "type": "string",
                  "description": "`enterprise`",
                  "example": "enterprise",
                  "enum": [
                    "enterprise"
                  ]
                },
                "name": {
                  "description": "The name of the enterprise",
                  "example": "Acme Inc.",
                  "type": "string"
                }
              }
            },
            {
              "description": "Representation of the user\u2019s enterprise"
            }
          ]
        },
        "my_tags": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "important"
          ],
          "description": "Tags for all files and folders owned by the user. Values returned\nwill only contain tags that were set by the requester."
        },
        "hostname": {
          "type": "string",
          "example": "https://example.app.box.com/",
          "description": "The root (protocol, subdomain, domain) of any links that need to be\ngenerated for the user"
        },
        "is_platform_access_only": {
          "type": "boolean",
          "example": true,
          "description": "Whether the user is an App User"
        },
        "external_app_user_id": {
          "type": "string",
          "example": "my-user-1234",
          "description": "An external identifier for an app user, which can be used to look up\nthe user. This can be used to tie user IDs from external identity\nproviders to Box users."
        }
      }
    }
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/box-user-full"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.